AndroidのAppWidgetProviderについて

Android Studioではガイドを利用することができます。

ファイルツリーで右クリックしてウィジェットを追加します。

新規ウィジェットの設定画面が開きます。

ここでは名前をSampleAppWidgetにして、幅を4、高さを1に設定してます。

ウィジェットのjavaソースコードとlayoutファイルが追加されました。

AndroidManifest.xmlにも設定が追加されています。

インストールしてホーム画面に追加すると以下のようになりました。

receiverの値にAppWidgetProviderを拡張したクラスを設定しています。

ガイドを使った場合はandroid:updatePeriodMillisの記述はありません。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.hiroom2.sampleappwidget" >

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:supportsRtl="true"
        android:theme="@style/AppTheme" >
        <receiver android:name=".SampleAppWidget"
                  android:updatePeriodMillis="0" >
            <intent-filter>
                <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
            </intent-filter>

            <meta-data
                android:name="android.appwidget.provider"
                android:resource="@xml/sample_app_widget_info" />
        </receiver>
    </application>

</manifest>

package com.hiroom2.sampleappwidget;

import android.appwidget.AppWidgetManager;
import android.appwidget.AppWidgetProvider;
import android.content.Context;
import android.widget.RemoteViews;

/**
 * Implementation of App Widget functionality.
 */
public class SampleAppWidget extends AppWidgetProvider {

  @Override
  public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
    // There may be multiple widgets active, so update all of them
    for (int appWidgetId : appWidgetIds) {
      updateAppWidget(context, appWidgetManager, appWidgetId);
    }
  }

  @Override
  public void onEnabled(Context context) {
    // Enter relevant functionality for when the first widget is created
  }

  @Override
  public void onDisabled(Context context) {
    // Enter relevant functionality for when the last widget is disabled
  }

  static void updateAppWidget(Context context, AppWidgetManager appWidgetManager,
                              int appWidgetId) {
    CharSequence widgetText = context.getString(R.string.appwidget_text);
    // Construct the RemoteViews object
    RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.sample_app_widget);
    views.setTextViewText(R.id.appwidget_text, widgetText);

    // Instruct the widget manager to update the widget
    appWidgetManager.updateAppWidget(appWidgetId, views);
  }
}

各メソッドが実行されるタイミングは以下のとおりです。

AndroidManifest.xmlでandroid:updatePeriodMillisを設定することで、onUpdateメソッドが周期的に呼ばれるようになります。

android:updatePeriodMillisの値を0にする、あるいは記述しない場合はonUpdateは周期的に呼ばれません。

ただし、端末機同時やウィジェット追加時にonUpdateは一度呼ばれます。これはウィジェットの初期化に使うことができます。

android:updatePeriodMillisの最小値は30分です（1800000）。つまり、android:updatePeriodMillisを設定してonUpdateメソッドによるウィジェットの更新は30分に1回が限界です。これは電力消費量を抑えるためです。

天気予報をインターネット経由で取得して表示するようなウィジェットは1日1回で十分なのでandroid:updatePeriodMillisを用いれば良いでしょう。

もっと頻繁に更新が必要なウィジェットはAlarmやThread等で更新します。

ウィジェットを更新するメソッドです。

ホーム画面に表示されているウィジェットのに割り振られたIDを指定する方法とComponentNameにAppWidgetProviderを拡張したクラスを指定する方法があります。

AppWidgetProviderを拡張したクラスが提供するウィジェットを２つホーム画面に表示させた場合、２つのIDが存在することになります。

IDを指定したupdateAppWidgetメソッドは以下のとおりです。

public void updateAppWidget (int appWidgetId, RemoteViews views)
public void updateAppWidget (int[] appWidgetIds, RemoteViews views)

ComponentNameを用いた場合、AppWidgetが提供する全てのウィジェットを更新します。

public void updateAppWidget (ComponentName provider, RemoteViews views)

ホーム画面に複数ウィジェットを表示させた場合、onUpdateの引数int[] appWidgetIdsにIDがまとめられるとは限りません。

ホーム画面に割り当てた直後だと別々になっています。

つまりその時はAppWidgetProviderを拡張したクラスのインスタンスが2つ存在し、onUpdateが2回呼ばれることになります。

端末を再起動するとまとめられ、AppWidgetProviderを拡張したクラスのインスタンスは一つとなります。

このように、IDを意識する必要がある場合は実装が面倒になります。