アプリ ウィジェットは、他のアプリ(ホーム画面など)に埋め込んで定期的に更新を受け取ることができる小さなアプリビューです。このようなビューは、ユーザー インターフェースではウィジェットと呼ばれます。アプリ ウィジェット プロバイダ(またはウィジェット プロバイダ)を使って公開できます。他のウィジェットを保持するアプリ コンポーネントは、アプリ ウィジェット ホスト(またはウィジェット ホスト)と呼ばれます。図 1 にサンプルの音楽ウィジェットを示します。
このドキュメントでは、ウィジェット プロバイダを使用してウィジェットを公開する方法について説明します。アプリ ウィジェットをホストする独自の AppWidgetHost
を作成する方法については、ウィジェット ホストを作成するをご覧ください。
ウィジェットの設計方法については、アプリ ウィジェットの概要をご覧ください。
ウィジェット コンポーネント
ウィジェットを作成するには、次の基本コンポーネントが必要です。
AppWidgetProviderInfo
オブジェクト- ウィジェットのレイアウト、更新頻度、
AppWidgetProvider
クラスなど、ウィジェットのメタデータを記述します。このドキュメントで説明するように、AppWidgetProviderInfo
は XML で定義されます。 AppWidgetProvider
クラス- プログラムでウィジェットとインターフェースするための基本的なメソッドを定義します。このコンポーネントを介して、ウィジェットが更新、有効化、無効化、または削除されたときに、ブロードキャストを受信します。このドキュメントの説明に沿って、マニフェストで
AppWidgetProvider
を宣言し、実装します。 - ビューのレイアウト
- ウィジェットの初期レイアウトを定義します。このドキュメントで説明するように、レイアウトは XML で定義されます。
図 2 は、これらのコンポーネントがアプリ ウィジェットの処理フロー全体にどのように適合するかを示しています。
ウィジェットにユーザー構成が必要な場合は、アプリ ウィジェット構成アクティビティを実装します。このアクティビティにより、ユーザーはウィジェットの設定(時計ウィジェットのタイムゾーンなど)を変更できます。
- Android 12(API レベル 31)以降では、デフォルト構成を提供し、ユーザーが後でウィジェットを再構成できるようにすることができます。詳細については、ウィジェットのデフォルト構成を使用すると配置したウィジェットをユーザーが再構成できるようにするをご覧ください。
- Android 11(API レベル 30)以前では、ユーザーがホーム画面にウィジェットを追加するたびにこのアクティビティが起動されます。
また、柔軟なウィジェット レイアウト、その他の機能強化、高度なウィジェット、コレクション ウィジェット、ウィジェット ホストの作成といった改善もおすすめします。
AppWidgetProviderInfo XML を宣言する
AppWidgetProviderInfo
オブジェクトは、ウィジェットの基本的な性質を定義します。単一の <appwidget-provider>
要素を使用して XML リソース ファイルに AppWidgetProviderInfo
オブジェクトを定義し、プロジェクトの res/xml/
フォルダに保存します。
これを次の例に示します。
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
android:minWidth="40dp"
android:minHeight="40dp"
android:targetCellWidth="1"
android:targetCellHeight="1"
android:maxResizeWidth="250dp"
android:maxResizeHeight="120dp"
android:updatePeriodMillis="86400000"
android:description="@string/example_appwidget_description"
android:previewLayout="@layout/example_appwidget_preview"
android:initialLayout="@layout/example_loading_appwidget"
android:configure="com.example.android.ExampleAppWidgetConfigurationActivity"
android:resizeMode="horizontal|vertical"
android:widgetCategory="home_screen"
android:widgetFeatures="reconfigurable|configuration_optional">
</appwidget-provider>
ウィジェットのサイズ属性
デフォルトのホーム画面では、高さと幅が定義されたセルのグリッドに基づいて、ウィンドウ内にウィジェットが配置されます。ほとんどのホーム画面では、ウィジェットのサイズは、グリッドセルの整数倍のサイズ(たとえば、横方向に 2 つ、縦方向に 3 つのセル)しか設定できません。
ウィジェットのサイズ属性を使用すると、ウィジェットのデフォルトのサイズを指定し、ウィジェットのサイズの下限と上限を指定できます。このコンテキストでは、ウィジェットのデフォルト サイズは、最初にホーム画面に追加されたときにウィジェットが占有するサイズになります。
次の表に、ウィジェットのサイズ設定に関連する <appwidget-provider>
属性を示します。
属性と説明 | |
---|---|
targetCellWidth 、targetCellHeight (Android 12)、minWidth 、minHeight |
targetCellWidth と targetCellHeight をサポートしていない場合、アプリが minWidth と minHeight を使用するようフォールバックできるように、両方の属性セット(targetCellWidth と targetCellHeight 、および minWidth と minHeight )を指定することをおすすめします。サポートされている場合、targetCellWidth 属性と targetCellHeight 属性が minWidth 属性と minHeight 属性よりも優先されます。 |
minResizeWidth 、minResizeHeight |
ウィジェットの最小サイズ(絶対値)を指定します。これらの値は、ウィジェットが判読不能または使用不能になるサイズを指定します。これらの属性を使用すると、ユーザーはウィジェットをデフォルトのウィジェット サイズよりも小さいサイズに変更できます。minResizeWidth 属性は、minWidth より大きい場合、または水平方向のサイズ変更が有効になっていない場合、無視されます。resizeMode をご覧ください。同様に、minResizeHeight 属性は minHeight より大きい場合、または縦方向のサイズ変更が有効になっていない場合は無視されます。 |
maxResizeWidth 、maxResizeHeight |
ウィジェットの推奨最大サイズを指定します。値がグリッドセルの寸法の倍数でない場合、最も近いセルサイズに切り上げられます。maxResizeWidth 属性は、minWidth より小さい場合、または水平方向のサイズ変更が有効になっていない場合、無視されます。resizeMode をご覧ください。同様に、maxResizeHeight 属性は、minHeight より大きい場合、または縦方向のサイズ変更が有効になっていない場合は無視されます。Android 12 で導入されました。 |
resizeMode |
ウィジェットのサイズ変更を許可するルールを指定します。この属性を使用して、ホーム画面ウィジェットを水平方向、垂直方向、または両軸でサイズ変更可能にすることができます。ユーザーはウィジェットを長押ししてサイズ変更ハンドルを表示し、横方向または縦方向のハンドルをドラッグしてレイアウト グリッド上でサイズを変更します。resizeMode 属性の値には、horizontal 、vertical 、none があります。ウィジェットを水平方向と垂直方向にサイズ変更可能として宣言するには、horizontal|vertical を使用します。 |
例
上の表の属性がウィジェットのサイズにどのように影響するかを説明するために、次の仕様を想定します。
- グリッドセルは幅 30 dp、高さ 50 dp です。
- 次の属性指定が指定されています。
<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
android:minWidth="80dp"
android:minHeight="80dp"
android:targetCellWidth="2"
android:targetCellHeight="2"
android:minResizeWidth="40dp"
android:minResizeHeight="40dp"
android:maxResizeWidth="120dp"
android:maxResizeHeight="120dp"
android:resizeMode="horizontal|vertical" />
Android 12 以降:
ウィジェットのデフォルト サイズとして targetCellWidth
属性と targetCellHeight
属性を使用します。
ウィジェットのサイズは、デフォルトでは 2x2 です。ウィジェットのサイズは、2x1 または 4x3 まで縮小できます。
Android 11 以前:
ウィジェットのデフォルト サイズを計算するには、minWidth
属性と minHeight
属性を使用します。
デフォルトの幅 = Math.ceil(80 / 30)
= 3
デフォルトの高さ = Math.ceil(80 / 50)
= 2
ウィジェットのサイズは、デフォルトでは 3x2 です。ウィジェットのサイズは、2x1 または最大全画面表示に変更できます。
その他のウィジェット属性
次の表に、ウィジェットのサイズ設定以外の品質に関する <appwidget-provider>
属性を示します。
属性と説明 | |
---|---|
updatePeriodMillis |
ウィジェット フレームワークが onUpdate() コールバック メソッドを呼び出して、AppWidgetProvider からの更新をリクエストする頻度を定義します。実際の更新がこの値を使用して正確に行われるとは限りません。バッテリーを節約するために、更新の頻度はできるだけ少なく(1 時間に 1 回未満)ことをおすすめします。適切な更新期間を選択するための考慮事項の一覧については、ウィジェット コンテンツの更新に関する最適化をご覧ください。 |
initialLayout |
ウィジェット レイアウトを定義するレイアウト リソースを参照します。 |
configure |
ユーザーがウィジェットを追加したときに起動するアクティビティを定義し、ユーザーがウィジェットのプロパティを設定できるようにします。ユーザーがウィジェットを設定できるようにするをご覧ください。Android 12 以降では、初期構成をスキップできます。詳しくは、ウィジェットのデフォルト構成を使用するをご覧ください。 |
description |
ウィジェットに表示するウィジェット選択ツールの説明を指定します。Android 12 で導入されました。 |
previewLayout (Android 12)と previewImage (Android 11 以前) |
previewLayout をサポートしていない場合、アプリが previewImage を使用するようフォールバックできるように、previewImage 属性と previewLayout 属性の両方を指定することをおすすめします。詳細については、スケーラブルなウィジェット プレビューとの下位互換性をご覧ください。 |
autoAdvanceViewId |
ウィジェットのホストによって自動的に進むウィジェット サブビューのビュー ID を指定します。 |
widgetCategory |
ウィジェットをホーム画面(home_screen )、ロック画面(keyguard )、またはその両方に表示できるかどうかを宣言します。Android 5.0 以降では、home_screen のみ有効です。 |
widgetFeatures |
ウィジェットがサポートする機能を宣言します。たとえば、ユーザーがウィジェットを追加したときにデフォルト構成を使用するには、configuration_optional フラグと reconfigurable フラグの両方を指定します。これにより、ユーザーがウィジェットを追加した後に構成アクティビティが起動されることを回避できます。ユーザーは後でウィジェットを再構成できます。 |
AppWidgetProvider クラスを使用してウィジェット ブロードキャストを処理する
AppWidgetProvider
クラスは、ウィジェット ブロードキャストを処理し、ウィジェットのライフサイクル イベントに応じてウィジェットを更新します。以降のセクションでは、マニフェストで AppWidgetProvider
を宣言して実装する方法について説明します。
マニフェストでウィジェットを宣言する
まず、次の例に示すように、アプリの AndroidManifest.xml
ファイル内で AppWidgetProvider
クラスを宣言します。
<receiver android:name="ExampleAppWidgetProvider"
android:exported="false">
<intent-filter>
<action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
</intent-filter>
<meta-data android:name="android.appwidget.provider"
android:resource="@xml/example_appwidget_info" />
</receiver>
<receiver>
要素には、ウィジェットで使用される AppWidgetProvider
を指定する android:name
属性が必要です。別のプロセスで AppWidgetProvider
にブロードキャストする必要がある場合以外は、コンポーネントはエクスポートしないでください。
<intent-filter>
要素には、android:name
属性が指定された <action>
要素を含める必要があります。この属性は、AppWidgetProvider
が ACTION_APPWIDGET_UPDATE
ブロードキャストを受け入れることを指定します。明示的に宣言する必要があるブロードキャストはこれだけです。AppWidgetManager
は、必要に応じて他のすべてのウィジェット ブロードキャストを AppWidgetProvider
に自動的に送信します。
<meta-data>
要素には AppWidgetProviderInfo
リソースを指定します。次の属性が必要です。
android:name
: メタデータ名を指定します。android.appwidget.provider
を使用して、データをAppWidgetProviderInfo
記述子として識別します。android:resource
:AppWidgetProviderInfo
リソース ロケーションを指定します。
AppWidgetProvider クラスを実装する
AppWidgetProvider
クラスは、ウィジェット ブロードキャストを処理するためのコンビニエンス クラスとして BroadcastReceiver
を拡張します。ウィジェットが更新、削除、有効化、無効化された場合など、ウィジェットに関連するイベント ブロードキャストのみを受信します。これらのブロードキャスト イベントが発生すると、次の AppWidgetProvider
メソッドが呼び出されます。
onUpdate()
AppWidgetProviderInfo
のupdatePeriodMillis
属性で定義された間隔でウィジェットを更新するために呼び出されます。詳しくは、このページのその他のウィジェット属性の表をご覧ください。- このメソッドは、ユーザーがウィジェットを追加したときにも呼び出されるため、
View
オブジェクトのイベント ハンドラの定義や、ウィジェットに表示するデータの読み込みジョブの開始など、重要な設定が行われます。ただし、configuration_optional
フラグを指定せずに構成アクティビティを宣言した場合、このメソッドは、ユーザーがウィジェットを追加したときに呼び出されませんが、その後の更新では呼び出されます。構成の完了時に最初の更新を実行するのは、構成アクティビティの役割です。詳細については、ユーザーがアプリ ウィジェットを設定できるようにするをご覧ください。 - 最も重要なコールバックは
onUpdate()
です。詳しくは、このページのonUpdate()
クラスでイベントを処理するをご覧ください。 onAppWidgetOptionsChanged()
このメソッドは、ウィジェットが最初に配置されたときと、ウィジェットのサイズが変更されたときに呼び出されます。このコールバックを使用して、ウィジェットのサイズ範囲に基づいてコンテンツの表示と非表示を切り替えます。サイズ範囲(Android 12 以降では、ウィジェット インスタンスが許容できるサイズのリスト)を取得するには、以下を含む
Bundle
を返すgetAppWidgetOptions()
を呼び出します。OPTION_APPWIDGET_MIN_WIDTH
: ウィジェット インスタンスの幅の下限(dp 単位)が含まれます。OPTION_APPWIDGET_MIN_HEIGHT
: ウィジェット インスタンスの高さの下限(dp 単位)が含まれます。OPTION_APPWIDGET_MAX_WIDTH
: ウィジェット インスタンスの幅の上限を dp 単位で指定します。OPTION_APPWIDGET_MAX_HEIGHT
: ウィジェット インスタンスの高さの上限を dp 単位で指定します。OPTION_APPWIDGET_SIZES
: ウィジェット インスタンスが使用できるサイズ(List<SizeF>
)のリストを dp 単位で指定します。Android 12 で導入されました。
onDeleted(Context, int[])
このメソッドは、ウィジェットがウィジェット ホストから削除されるたびに呼び出されます。
onEnabled(Context)
このメソッドは、ウィジェットのインスタンスが初めて作成されたときに呼び出されます。たとえば、ユーザーがウィジェットのインスタンスを 2 つ追加した場合、これは初回のみ呼び出されます。新しいデータベースを開く必要がある場合や、すべてのウィジェット インスタンスで 1 回だけ行う必要がある別のセットアップを行う必要がある場合は、ここで行うことをおすすめします。
onDisabled(Context)
このメソッドは、ウィジェットの最後のインスタンスがウィジェット ホストから削除されたときに呼び出されます。ここで、一時データベースの削除など、
onEnabled(Context)
で行われたすべての作業をクリーンアップします。onReceive(Context, Intent)
これは、すべてのブロードキャストで、先行する各コールバック メソッドの前に呼び出されます。デフォルトの
AppWidgetProvider
実装では、すべてのウィジェット ブロードキャストがフィルタされ、必要に応じて上記のメソッドが呼び出されるため、通常、このメソッドを実装する必要はありません。
AndroidManifest
で <receiver>
要素を使用して、AppWidgetProvider
クラスの実装をブロードキャスト レシーバとして宣言する必要があります。詳細については、このページのマニフェストでウィジェットを宣言するをご覧ください。
onUpdate() クラスを使用してイベントを処理する
最も重要な AppWidgetProvider
コールバックは onUpdate()
です。これは、configuration_optional
フラグを指定せずに構成アクティビティを使用する場合を除き、各ウィジェットがホストに追加されたときに呼び出されるためです。ウィジェットがユーザー操作イベントを受け入れる場合は、このコールバックにイベント ハンドラを登録します。ウィジェットで一時ファイルやデータベースが作成されない場合、またはクリーンアップが必要な他の作業が行われない場合は、onUpdate()
を唯一のコールバック メソッドとして定義する必要があるかもしれません。
たとえば、タップされたときにアクティビティを起動するボタンを備えたウィジェットが必要な場合は、AppWidgetProvider
の次の実装を使用できます。
Kotlin
class ExampleAppWidgetProvider : AppWidgetProvider() { override fun onUpdate( context: Context, appWidgetManager: AppWidgetManager, appWidgetIds: IntArray ) { // Perform this loop procedure for each widget that belongs to this // provider. appWidgetIds.forEach { appWidgetId -> // Create an Intent to launch ExampleActivity. val pendingIntent: PendingIntent = PendingIntent.getActivity( /* context = */ context, /* requestCode = */ 0, /* intent = */ Intent(context, ExampleActivity::class.java), /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE ) // Get the layout for the widget and attach an onClick listener to // the button. val views: RemoteViews = RemoteViews( context.packageName, R.layout.appwidget_provider_layout ).apply { setOnClickPendingIntent(R.id.button, pendingIntent) } // Tell the AppWidgetManager to perform an update on the current // widget. appWidgetManager.updateAppWidget(appWidgetId, views) } } }
Java
public class ExampleAppWidgetProvider extends AppWidgetProvider { public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) { // Perform this loop procedure for each widget that belongs to this // provider. for (int i=0; i < appWidgetIds.length; i++) { int appWidgetId = appWidgetIds[i]; // Create an Intent to launch ExampleActivity Intent intent = new Intent(context, ExampleActivity.class); PendingIntent pendingIntent = PendingIntent.getActivity( /* context = */ context, /* requestCode = */ 0, /* intent = */ intent, /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE ); // Get the layout for the widget and attach an onClick listener to // the button. RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.example_appwidget_layout); views.setOnClickPendingIntent(R.id.button, pendingIntent); // Tell the AppWidgetManager to perform an update on the current app // widget. appWidgetManager.updateAppWidget(appWidgetId, views); } } }
この AppWidgetProvider
は onUpdate()
メソッドのみを定義し、このメソッドを使用して PendingIntent
を作成します。このメソッドは Activity
を起動し、setOnClickPendingIntent(int,
PendingIntent)
を使用してウィジェットのボタンにアタッチします。appWidgetIds
の各エントリを反復処理するループが含まれています。これは、このプロバイダによって作成された各ウィジェットを識別する ID の配列です。ユーザーがウィジェットの複数のインスタンスを作成すると、それらすべてが同時に更新されます。ただし、ウィジェットのすべてのインスタンスで 1 つの updatePeriodMillis
スケジュールのみが管理されます。たとえば、更新スケジュールが 2 時間ごとに定義されていて、最初の更新から 1 時間後にウィジェットの 2 番目のインスタンスが追加された場合、それらは最初に定義された期間に両方とも更新され、2 番目の更新期間は無視されます。どちらも 1 時間ごとではなく 2 時間ごとに更新されます。
詳しくは、ExampleAppWidgetProvider.java
サンプルクラスをご覧ください。
ウィジェット ブロードキャスト インテントを受信する
AppWidgetProvider
はコンビニエンス クラスです。ウィジェット ブロードキャストを直接受信する場合は、独自の BroadcastReceiver
を実装するか、onReceive(Context,Intent)
コールバックをオーバーライドします。注意が必要なインテントは次のとおりです。
ACTION_APPWIDGET_UPDATE
ACTION_APPWIDGET_DELETED
ACTION_APPWIDGET_ENABLED
ACTION_APPWIDGET_DISABLED
ACTION_APPWIDGET_OPTIONS_CHANGED
ウィジェット レイアウトを作成する
ウィジェットの初期レイアウトを XML で定義し、プロジェクトの res/layout/
ディレクトリに保存する必要があります。詳細については、設計ガイドラインをご覧ください。
レイアウトに精通していれば、ウィジェット レイアウトの作成は簡単です。ただし、ウィジェットのレイアウトは RemoteViews
に基づいています。すべての種類のレイアウトまたはビュー ウィジェットがサポートされているわけではありません。RemoteViews
でサポートされているビューのカスタムビューまたはサブクラスは使用できません。
RemoteViews
は ViewStub
もサポートしています。これは、目に見えないゼロサイズの View
で、これを使用するとレイアウト リソースのインフレートを実行時に遅延できます。
ステートフル動作のサポート
Android 12 では、次の既存のコンポーネントを使用したステートフル動作のサポートが追加されています。
このウィジェットはまだステートレスであるため、アプリが状態を保存し、状態変化イベントを登録できるようにする必要があります。
次のコードサンプルは、これらのコンポーネントを実装する方法を示しています。
Kotlin
// Check the view. remoteView.setCompoundButtonChecked(R.id.my_checkbox, true) // Check a radio group. remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2) // Listen for check changes. The intent has an extra with the key // EXTRA_CHECKED that specifies the current checked state of the view. remoteView.setOnCheckedChangeResponse( R.id.my_checkbox, RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent) )
Java
// Check the view. remoteView.setCompoundButtonChecked(R.id.my_checkbox, true); // Check a radio group. remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2); // Listen for check changes. The intent has an extra with the key // EXTRA_CHECKED that specifies the current checked state of the view. remoteView.setOnCheckedChangeResponse( R.id.my_checkbox, RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent));
2 つのレイアウトを指定します。1 つは Android 12 以降を搭載しているデバイスをターゲットとする res/layout-v31
で、もう 1 つはデフォルトの res/layout
フォルダにあります。
角の丸みを実装する
Android 12 では、ウィジェットの角の半径を設定するための次のシステム パラメータが導入されています。
system_app_widget_background_radius
: ウィジェットの背景の角の丸み(28 dp 以下)。system_app_widget_inner_radius
: ウィジェット内のビューの角の丸み。これは背景の半径よりちょうど 8 dp 小さくなっており、8 dp のパディングを使用する場合に適切に配置されます。
次の例は、system_app_widget_background_radius
をウィジェットの角に、system_app_widget_inner_radius
をウィジェット内のビューに使用したウィジェットを示しています。
1 ウィジェットの角。
2 ウィジェット内のビューの角。
角の丸みに関する重要な考慮事項
- サードパーティのランチャーとデバイス メーカーは、
system_app_widget_background_radius
パラメータをオーバーライドして 28 dp 未満にできます。system_app_widget_inner_radius
パラメータは常にsystem_app_widget_background_radius
の値より 8 dp 小さくなります。 - ウィジェットで
@android:id/background
を使用しない場合、またはアウトラインに基づいてコンテンツをクリップする背景を定義していない場合(android:clipToOutline
をtrue
に設定している場合)、ランチャーは自動的に背景を識別し、角の丸い長方形を使用してウィジェットをクリップします(最大 16 dp)。ウィジェットが Android 12 に対応していることを確認するをご覧ください。
以前のバージョンの Android とのウィジェットの互換性を維持するため、次のサンプル XML ファイルに示すように、カスタム属性を定義し、カスタムテーマを使用して Android 12 用にオーバーライドすることをおすすめします。
/values/attrs.xml
<resources>
<attr name="backgroundRadius" format="dimension" />
</resources>
/values/styles.xml
<resources>
<style name="MyWidgetTheme">
<item name="backgroundRadius">@dimen/my_background_radius_dimen</item>
</style>
</resources>
/values-31/styles.xml
<resources>
<style name="MyWidgetTheme" parent="@android:style/Theme.DeviceDefault.DayNight">
<item name="backgroundRadius">@android:dimen/system_app_widget_background_radius</item>
</style>
</resources>
/drawable/my_widget_background.xml
<shape xmlns:android="http://schemas.android.com/apk/res/android"
android:shape="rectangle">
<corners android:radius="?attr/backgroundRadius" />
...
</shape>
/layout/my_widget_layout.xml
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
...
android:background="@drawable/my_widget_background" />