概要:
App Widget应用小控件,用户可以通过长按屏幕,然后添加小控件倒桌面,这些小控件一般都是为了显示一些信息在桌面上,同时方便用户通过点击桌面上的小控件来访问你的程序。
基础知识:
开发一个小控件,我们需要:
AppWidgetProvider
继承AppWidgetProvider类,并重载一些方法(onUpdate方法尤为重要,后面描述Why),AppWidgetProvider其实也是一个BroadcastReceiver,因此我们也可以象扑通的BroadcastReceiver一样监听广播事件。
AppWidgetProviderInfo
在XML文件中,描述AppWidgetProvider的Metadata信息,如声明AppWidgetProvider类,Layout,更新间隔,配置AppWidget的Activity等。。。
Layout
定义一个App Widget,我们也需要定义它的Layout文件。在App Widget中,不是所有的Android控件都能放入App Widget的Layout中去的,现阶段只有下面一些Layout和控件才能放入App Widget中。
还有在程序中要控制App Widget的控件都通过RemoteViews来控制。
Layout类:LinearLayout, FrameLayout,RelativeLayout
控件类:
AnalogClock,Button,Chronometer,ImageButton,ImageView,ProgressBar
TextView,ViewFlipper,ListView,GridView,StackView,AdapterViewFlipper
如果上述以外的控件或者Layout类被放入App Widget的Layout文件中的话,App Widget将不能在桌面显示。开发流程:
Step1.继承AppWidgetProvider类,并重载下列方法(如有必要的话)
*应为用户可以在桌面添加多个相同的App Widget,因此系统调用我们重载的方法时,很多时候都是传给我们一个id数组。
public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds)
onUpdate是非常重要的一个方法。当用户在桌面添加一个App Widget时,或者用户定义的时钟updatePeriodMillis响应时,此方法都会被调用。
*但是如果用户定义了configuration Activity时,在用户添加小控件时,onUpdate不会被调用。
public void onDeleted(Context context, int[] appWidgetIds)
每一个App Widget从桌面删除时,onDeleted都会被调用。
public void onEnabled(Context context)
用户初次添加App Widget时,onEnabled会被调用。
public void onDisabled(Context context)
当用户删除了所有的App Widget时,onDisabled会被调用
Step2.定义AppWidgetProviderInfo
在res文件夹下创建名为xml的文件夹,然后添加一xml,Tag为appwidget-provider,
屏幕一般被分为,4x4单元,因此我们定义的miniHeight和miniWidth不要超过4x4单元的大小,每一单元大小为72x72dp
initialLayout用来声明Layout文件,updatePeriodMills来定义更新App Widget的时钟,当不需要更新时设置为0
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
android:initialLayout="@layout/example_app_widget_provider"
android:minHeight="72dp"
android:minWidth="200dp"
android:updatePeriodMillis="60000" >
</appwidget-provider>
Step3.定义Manifest
前面已经讲过,所有的AppWidgetProvider实际上都是BroadcastReceiver,因此在Manifest里面申明时使用receiver标签。meta-data标签的名字固定为"android.appwidget.provider",resource用来声明AppWidgetProviderInfo xml,intent-filter里面添加“android.appwidget.action.APPWIDGET_UPDATE”,当我们定义的时钟android:updatePeriodMillis响应时,会广播APPWIDGET_UPDATE,此时我们的onUpdate会被调用。
<receiver android:name="...ExampleAppWidgetProvider" >
<meta-data
android:name="android.appwidget.provider"
android:resource="@xml/app_widget_provider_info" />
<intent-filter>
<action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
</intent-filter>
</receiver>
源代码:
<Java>
ExampleAppWidgetProvider.java
package com.jumper.android.demos.appwidget; import com.jumper.android.demos.R; import android.app.PendingIntent; import android.appwidget.AppWidgetManager; import android.appwidget.AppWidgetProvider; import android.content.Context; import android.content.Intent; import android.util.Log; import android.widget.RemoteViews; public class ExampleAppWidgetProvider extends AppWidgetProvider { private final static String lOG_TAG = ExampleAppWidgetProvider.class.getName(); public final static String SUBMIT_ACTION = "com.jumper.android.demos.appwidget.SUBMIT"; @Override public void onDeleted(Context context, int[] appWidgetIds) { super.onDeleted(context, appWidgetIds); } @Override public void onDisabled(Context context) { super.onDisabled(context); } @Override public void onEnabled(Context context) { super.onEnabled(context); } @Override public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { super.onUpdate(context, appWidgetManager, appWidgetIds); Log.v(lOG_TAG, "onUpdate=" + appWidgetIds.length); int length = appWidgetIds.length; for(int i=0; i<length; i++) { updateWidget(context, appWidgetManager, appWidgetIds[i]); } } private void updateWidget(Context context, AppWidgetManager appwidgetmanager, int appwidgetid) { Log.v(lOG_TAG, "updateWidget ID=" + appwidgetid); Intent intent = new Intent(); intent.setAction(SUBMIT_ACTION); intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appwidgetid); PendingIntent pendingintent = PendingIntent.getBroadcast(context, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT); RemoteViews removteviews = new RemoteViews(context.getPackageName(), R.layout.example_app_widget_provider); removteviews.setOnClickPendingIntent(R.id.app_widget_submit, pendingintent); appwidgetmanager.updateAppWidget(appwidgetid, removteviews); } }
ExampleAppWidgetReceiver.java
package com.jumper.android.demos.appwidget; import com.jumper.android.demos.R; import android.app.PendingIntent; import android.appwidget.AppWidgetManager; import android.content.BroadcastReceiver; import android.content.Context; import android.content.Intent; import android.util.Log; import android.widget.RemoteViews; public class ExampleAppWidgetReceiver extends BroadcastReceiver { private final String lOG_TAG = this.getClass().getName(); @Override public void onReceive(Context context, Intent intent) { String action = intent.getAction(); Log.v(lOG_TAG, "onReceive=" + action); if(action.equals(ExampleAppWidgetProvider.SUBMIT_ACTION)) { int appwidgetid = intent.getIntExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, 0); Log.v(lOG_TAG, "ID=" + appwidgetid); updateWidget(context, AppWidgetManager.getInstance(context), appwidgetid); } } private void updateWidget(Context context, AppWidgetManager appwidgetmanager, int appwidgetid) { Log.v(lOG_TAG, "updateWidget ID=" + appwidgetid); RemoteViews removteviews = new RemoteViews(context.getPackageName(), R.layout.example_app_widget_provider); removteviews.setTextViewText(R.id.app_widget_output, "WidgetID:" + appwidgetid + " " + System.currentTimeMillis()); appwidgetmanager.updateAppWidget(appwidgetid, removteviews); } }
<AppWidgetProviderInfo>Xml
<?xml version="1.0" encoding="utf-8"?>
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
android:initialLayout="@layout/example_app_widget_provider"
android:minHeight="72dp"
android:minWidth="286dp"
android:updatePeriodMillis="60000" >
</appwidget-provider>
<Layout>
example_app_widget_provider.xml
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="160dp"
android:layout_height="80dp"
android:orientation="vertical" >
<LinearLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:gravity="center"
>
<TextView
android:id="@+id/app_widget_output"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginLeft="10.0dip"
android:text="Medium Text"
android:textAppearance="?android:attr/textAppearanceMedium" />
<ImageView
android:id="@+id/app_widget_submit"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginLeft="5.0dip"
android:src="@drawable/ic_menu_market_search" />
</LinearLayout>
</LinearLayout>
<Manifest>
<receiver android:name="com.jumper.android.demos.appwidget.ExampleAppWidgetProvider" >
<meta-data
android:name="android.appwidget.provider"
android:resource="@xml/app_widget_provider_info" />
<intent-filter>
<action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
</intent-filter>
</receiver>
<receiver android:name="com.jumper.android.demos.appwidget.ExampleAppWidgetReceiver" >
<intent-filter>
<action android:name="com.jumper.android.demos.appwidget.SUBMIT" />
<action android:name="android.intent.ACTION_TIMEZONE_CHANGED" />
<action android:name="android.intent.ACTION_TIME" />
</intent-filter>
</receiver>