Android 案頭組件【widget】初探

http://www.cnblogs.com/TerryBlog/archive/2010/07/29/1788319.html

 

 

本來打算晚上繼續 Api Demos 系列的，不過今天下午的時候無聊去玩了一下案頭組件 App Widget 覺得挺不錯的一個東西，對它很是感興趣，玩了一下碰到很多問題，一直在解決問題到了晚上10點。只能怪自己理解不深刻，不過最後還是解決了，把一些領悟寫出來也算給自己一個交代。下面是本篇的大綱：

• 1、AppWidget 架構類
• 2、在 Android 如何使用 Widget
• 3、AppWidget 架構的主要類介紹
• 4、DEMO 講解

1、AppWidget 架構類

• 1、AppWidgetProvider ：繼承自 BroadcastRecevier ， 在AppWidget 應用 update、enable、disable 和 delete 時接收通知。其中，onUpdate、onReceive 是最常用到的方法，它們接收更新通知。
• 2、 AppWidgetProvderInfo：描述 AppWidget 的大小、更新頻率和初始介面等資訊，以XML 檔案形式存在於應用的 res/xml/目錄下。
• 3、AppWidgetManger ：負責管理 AppWidget ，向 AppwidgetProvider 發送通知。
• 4、RemoteViews ：一個可以在其他應用進程中啟動並執行類，向 AppWidgetProvider 發送通知。

2、在 Android 如何使用 Widget

• 1、長按主介面
  
• 2、之後彈出一個對話方塊，裡面就有android 內建的一些案頭組件
  

 

 3、AppWidget 架構的主要類介紹

 1) AppWidgetManger 類

• bindAppWidgetId(int appWidgetId, ComponentName provider)
  通過給定的ComponentName 綁定appWidgetId
• getAppWidgetIds(ComponentName provider)
  通過給定的ComponentName 擷取AppWidgetId
• getAppWidgetInfo(int appWidgetId)
  通過AppWidgetId 擷取 AppWidget 資訊
• getInstalledProviders()
  返回一個List<AppWidgetProviderInfo>的資訊
• getInstance(Context context)
  擷取 AppWidgetManger 執行個體使用的內容物件
• updateAppWidget(int[] appWidgetIds, RemoteViews views)
  通過appWidgetId 對傳進來的 RemoteView 進行修改，並重新重新整理AppWidget 組件
• updateAppWidget(ComponentName provider, RemoteViews views)
  通過 ComponentName 對傳進來的 RemoeteView 進行修改，並重新重新整理AppWidget 組件
• updateAppWidget(int appWidgetId, RemoteViews views)
  通過appWidgetId 對傳進來的 RemoteView 進行修改，並重新重新整理AppWidget 組件

2) 繼承自 AppWidgetProvider 可實現的方法為如下：

• 1、onDeleted(Context context, int[] appWidgetIds)
• 2、onDisabled(Context context)
• 3、onEnabled(Context context)
• 4、onReceive(Context context, Intent intent)
  Tip:因為 AppWidgetProvider 是繼承自BroadcastReceiver  所以可以重寫onRecevie 方法，當然必須在後台註冊Receiver
• 5、onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds)

4、Demo講解

下面是我今天做的一個執行個體，提供給大家練習時做參考，效果如下：在布局中放一個 TextView 做案頭組件，然後設定TextView 的 Clickable="true" 使其有點擊的功能，然後我們點擊它時改變它的字型，再點擊時變回來，詳細操作如下流程：

• 1、建立AppWidgetProvderInfo
• 2、寫一個類繼承自AppWidgetProvider
• 3、後台註冊Receiver
• 4、使 AppWidget 組件支援點擊事件
• 5、如何使TextView 在兩種文本間來回跳轉

問題拋出來了，那麼一起解決它吧。

1、建立AppWidgetProvderInfo

代碼如下：

 

<?xml version="1.0" encoding="UTF-8"?>
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="60dp"
    android:minHeight="30dp"
    android:updatePeriodMillis="86400000"
     
    android:initialLayout="@layout/main">
</appwidget-provider>

 

 

Tip:上文說過AppWidgetProvderInfo 是在res/xml 的檔案形式存在的，看參數不難理解，比較重要的是這裡android:initialLayout="@layout/main" 此句為指定案頭組件的布局檔案。

2、寫一個類繼承自AppWidgetProvider

主要代碼如下：

 

public class widgetProvider extends AppWidgetProvider

 

 

並重寫兩個方法

 

@Override
    public void onUpdate(Context context, AppWidgetManager appWidgetManager,
            int[] appWidgetIds) {}

@Override
    public void onReceive(Context context, Intent intent) {}

 

 

Tip：onUpdate 為組件在案頭上產生時調用，並更新群組件UI，onReceiver 為接收廣播時調用更新UI，一般這兩個方法是比較常用的。

3、後台註冊Receiver

後台設定檔代碼如下：

 

<receiver android:name=".widgetProvider">
            <meta-data android:name="android.appwidget.provider"
                android:resource="@xml/appwidget_provider"></meta-data>
            <intent-filter>
                <action android:name="com.terry.action.widget.click"></action>
                <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
                 
            </intent-filter>
        </receiver>

 

Tip:因為是案頭組件，所以暫時不考慮使用Activity 介面，當然你在實現做項目時可能會需要點擊時跳轉到Activity 應用程式上做操作，典型的案例為Android  提供的音樂播放器。上面代碼中比較重要的是這一句 <meta-data android:name="android.appwidget.provider"  android:resource="@xml/appwidget_provider"></meta-data>  大意為指定傳統型應用程式的AppWidgetProvderInfo  檔案，使其可作其管理檔案。

4、使 AppWidget 組件支援點擊事件

先看代碼：

 

public static void updateAppWidget(Context context,
            AppWidgetManager appWidgeManger, int appWidgetId) {
        rv = new RemoteViews(context.getPackageName(), R.layout.main);
        Intent intentClick = new Intent(CLICK_NAME_ACTION);
        PendingIntent pendingIntent = PendingIntent.getBroadcast(context, 0,
                intentClick, 0);
        rv.setOnClickPendingIntent(R.id.TextView01, pendingIntent);
        appWidgeManger.updateAppWidget(appWidgetId, rv);
    }

 

此方法為建立組件時 onUpdate 調用的更新UI的方法，代碼中使用RemoteView 找到組件的布局檔案，同時為其設定廣播接收器CLICK_NAME_ACTION並且通過RemoteView 的setOnClickPendingIntent 方法找到我想觸發事件的TextView 為其設定廣播。接著

 

@Override
    public void onReceive(Context context, Intent intent) {
        // TODO Auto-generated method stub
        super.onReceive(context, intent);

        if (rv == null) {
            rv = new RemoteViews(context.getPackageName(), R.layout.main);
        }
        if (intent.getAction().equals(CLICK_NAME_ACTION)) {
            if (uitil.isChange) {
                rv.setTextViewText(R.id.TextView01, context.getResources()
                        .getString(R.string.load));

            } else {
                rv.setTextViewText(R.id.TextView01, context.getResources()
                        .getString(R.string.change));

            }
            Toast.makeText(context, Boolean.toString(uitil.isChange),
                    Toast.LENGTH_LONG).show();
            uitil.isChange = !uitil.isChange;

        }
        AppWidgetManager appWidgetManger = AppWidgetManager
                .getInstance(context);
        int[] appIds = appWidgetManger.getAppWidgetIds(new ComponentName(
                context, widgetProvider.class));
        appWidgetManger.updateAppWidget(appIds, rv);
    }

 

 

在onReceiver 中通過判斷傳進來的廣播來觸發動作。

 

5、如何使TextView 在兩種文本間來回跳轉

如何 TextView 在來兩種狀態中來回呢？這也是我比較調試最久的一個痛點，問題出在對 AppWidget 的理解不夠深入。 如果我的設想沒錯的話AppWidget 的生命週期應該在每接收一次廣播執行一次為一個生命週期結束，也就是說你在重寫的 AppWidgetProvider 類裡面聲明全域變數做狀態判斷，每次狀態改變AppWidgetProvider 再接收第二次廣播時即為你重新初始化也就是說桌件為你重新執行個體化了一次AppWidgetProvider 。今天我因為在裡面放了一個boolean 值初始化為true ，觀察調試看到每次進入都為TRUE 故你在設定案頭組件時，全域變數把它聲明在另外一個實體類用來判斷是沒問題的，切忌放在本類。代碼參考onReceiver方法。

如下：

 

代碼：

 

代碼

package com.terry;

import android.app.PendingIntent;
import android.appwidget.AppWidgetManager;
import android.appwidget.AppWidgetProvider;
import android.content.ComponentName;
import android.content.Context;
import android.content.Intent;
import android.widget.RemoteViews;
import android.widget.Toast;

public class widgetProvider extends AppWidgetProvider {
    private static final String CLICK_NAME_ACTION = "com.terry.action.widget.click";

    private static RemoteViews rv;

    @Override
    public void onUpdate(Context context, AppWidgetManager appWidgetManager,
            int[] appWidgetIds) {
        // TODO Auto-generated method stub
        final int N = appWidgetIds.length;
        for (int i = 0; i < N; i++) {
            int appWidgetId = appWidgetIds[i];
            updateAppWidget(context, appWidgetManager, appWidgetId);
        }
    }

    @Override
    public void onReceive(Context context, Intent intent) {
        // TODO Auto-generated method stub
        super.onReceive(context, intent);

        if (rv == null) {
            rv = new RemoteViews(context.getPackageName(), R.layout.main);
        }
        if (intent.getAction().equals(CLICK_NAME_ACTION)) {
            if (uitil.isChange) {
                rv.setTextViewText(R.id.TextView01, context.getResources()
                        .getString(R.string.load));

            } else {
                rv.setTextViewText(R.id.TextView01, context.getResources()
                        .getString(R.string.change));

            }
            Toast.makeText(context, Boolean.toString(uitil.isChange),
                    Toast.LENGTH_LONG).show();
            uitil.isChange = !uitil.isChange;

        }
        AppWidgetManager appWidgetManger = AppWidgetManager
                .getInstance(context);
        int[] appIds = appWidgetManger.getAppWidgetIds(new ComponentName(
                context, widgetProvider.class));
        appWidgetManger.updateAppWidget(appIds, rv);
    }

    public static void updateAppWidget(Context context,
            AppWidgetManager appWidgeManger, int appWidgetId) {
        rv = new RemoteViews(context.getPackageName(), R.layout.main);
        Intent intentClick = new Intent(CLICK_NAME_ACTION);
        PendingIntent pendingIntent = PendingIntent.getBroadcast(context, 0,
                intentClick, 0);
        rv.setOnClickPendingIntent(R.id.TextView01, pendingIntent);
        appWidgeManger.updateAppWidget(appWidgetId, rv);
    }
}另經測試以上內容，註解如下：    void updateAppWidget(Context context, AppWidgetManager appWidgetManager,            int appWidgetId) {        RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.appwidget_provider);    Intent it = new Intent(context, xxxx.class);    PendingIntent pit = PendingIntent.getActivity(context, 0, it, 0);        views.setOnClickPendingIntent(R.id.appwidget_Image, pit);        appWidgetManager.updateAppWidget(appWidgetId, views);    }如上修改 updateAppWidget可啟動xxxx activity, 注意：appWidgetManager.updateAppWidget(appWidgetId, views);應在最後一行，否則無效。

 

另可參考android music常式中的widget.