使用集合小部件

集合小部件专门用于显示许多相同类型的元素,例如图库应用中的图片集合、新闻应用中的文章或通信应用中的消息。集合小部件通常侧重于两种用例:浏览集合和打开集合中的元素以查看其详细信息。集合小部件可以垂直滚动。

这些小部件使用 RemoteViewsService 来显示由远程数据支持的集合,例如来自 内容提供程序 的数据。小部件使用以下视图类型之一呈现数据,这些视图类型称为集合视图

ListView
以垂直滚动列表显示项目的视图。
GridView
以二维滚动网格显示项目的视图。
StackView
堆叠卡片视图——有点像旋转文件架——用户可以在其中向上或向下轻弹前一张卡片以分别查看前一张或后一张卡片。
AdapterViewFlipper
一个适配器支持的简单 ViewAnimator,它在两个或多个视图之间进行动画处理。一次只显示一个子项。

由于这些集合视图显示由远程数据支持的集合,因此它们使用 Adapter 将其用户界面绑定到其数据。一个 Adapter 将一组数据中的各个项目绑定到各个 View 对象。

并且由于这些集合视图由适配器支持,因此 Android 框架必须包含额外的架构来支持它们在小部件中的使用。在小部件的上下文中,AdapterRemoteViewsFactory 替换,它是一个围绕 Adapter 接口的薄包装器。当请求集合中的特定项目时,RemoteViewsFactory 会创建并返回集合中该项目作为 RemoteViews 对象。要在您的 Widget 中包含集合视图,请实现 RemoteViewsServiceRemoteViewsFactory

RemoteViewsService 是一种服务,它允许远程适配器请求 RemoteViews 对象。RemoteViewsFactory 是集合视图(例如 ListViewGridViewStackView)与其底层数据之间的适配器的接口。从 StackWidget 示例 中,以下是如何实现此服务和接口的样板代码示例

Kotlin

class StackWidgetService : RemoteViewsService() {

    override fun onGetViewFactory(intent: Intent): RemoteViewsFactory {
        return StackRemoteViewsFactory(this.applicationContext, intent)
    }
}

class StackRemoteViewsFactory(
        private val context: Context,
        intent: Intent
) : RemoteViewsService.RemoteViewsFactory {

// See the RemoteViewsFactory API reference for the full list of methods to
// implement.

}

Java

public class StackWidgetService extends RemoteViewsService {
    @Override
    public RemoteViewsFactory onGetViewFactory(Intent intent) {
        return new StackRemoteViewsFactory(this.getApplicationContext(), intent);
    }
}

class StackRemoteViewsFactory implements RemoteViewsService.RemoteViewsFactory {

// See the RemoteViewsFactory API reference for the full list of methods to
// implement.

}

示例应用程序

本节中的代码摘录也来自 StackWidget 示例

图 1. StackWidget

此示例由十个视图的堆栈组成,这些视图显示值零到九。示例 Widget 具有以下主要行为

  • 用户可以垂直轻弹 Widget 中的顶部视图以显示下一个或上一个视图。这是 StackView 的内置行为。

  • 在没有任何用户交互的情况下,Widget 会自动按顺序依次遍历其视图,就像幻灯片放映一样。这是由于 res/xml/stackwidgetinfo.xml 文件中设置了 android:autoAdvanceViewId="@id/stack_view"。此设置适用于视图 ID,在本例中为堆栈视图的视图 ID。

  • 如果用户触摸顶部视图,则 Widget 会显示 Toast 消息“Touched view n”,其中 n 是触摸视图的索引(位置)。有关如何实现行为的更多讨论,请参阅 向各个项目添加行为 部分。

使用集合实现 Widget

要使用集合实现 Widget,请按照 实现任何 Widget 的步骤进行操作,然后执行以下几个步骤:修改清单、向 Widget 布局添加集合视图并修改您的 AppWidgetProvider 子类。

具有集合的 Widget 的清单

除了 在清单中声明 Widget 中列出的要求之外,您还需要使具有集合的 Widget 能够绑定到您的 RemoteViewsService。通过在您的清单文件中声明该服务并使用权限 BIND_REMOTEVIEWS 来实现此目的。这可以防止其他应用程序随意访问您的 Widget 的数据。

例如,在创建使用 RemoteViewsService 来填充集合视图的 Widget 时,清单条目可能如下所示

<service android:name="MyWidgetService"
    android:permission="android.permission.BIND_REMOTEVIEWS" />

在此示例中,android:name="MyWidgetService" 指的是您的 RemoteViewsService 子类。

具有集合的 Widget 的布局

您的 Widget 布局 XML 文件的主要要求是包含以下集合视图之一:ListViewGridViewStackViewAdapterViewFlipper。以下是 StackWidget 示例widget_layout.xml 文件

<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    <StackView
        android:id="@+id/stack_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:gravity="center"
        android:loopViews="true" />
    <TextView
        android:id="@+id/empty_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:gravity="center"
        android:background="@drawable/widget_item_background"
        android:textColor="#ffffff"
        android:textStyle="bold"
        android:text="@string/empty_view_text"
        android:textSize="20sp" />
</FrameLayout>

请注意,空视图必须是其空视图表示空状态的集合视图的同级元素。

除了整个 Widget 的布局文件之外,还要创建另一个布局文件,用于定义集合中每个项目的布局——例如,书籍集合中每本书的布局。StackWidget 示例只有一个项目布局文件 widget_item.xml,因为所有项目都使用相同的布局。

具有集合的 Widget 的 AppWidgetProvider 类

与常规 Widget 一样,您的 AppWidgetProvider 子类中的大部分代码通常位于 onUpdate() 中。在创建具有集合的 Widget 时,您的 onUpdate() 实现的主要区别在于您必须调用 setRemoteAdapter()。这会告诉集合视图从哪里获取其数据。然后,RemoteViewsService 可以返回您对 RemoteViewsFactory 的实现,并且 Widget 可以提供适当的数据。调用此方法时,请传递一个指向您对 RemoteViewsService 的实现的 Intent 和指定要更新的 Widget 的 Widget ID。

例如,以下是 StackWidget 示例如何实现 onUpdate() 回调方法以将 RemoteViewsService 作为 Widget 集合的远程适配器

Kotlin

override fun onUpdate(
        context: Context,
        appWidgetManager: AppWidgetManager,
        appWidgetIds: IntArray
) {
    // Update each of the widgets with the remote adapter.
    appWidgetIds.forEach { appWidgetId ->

        // Set up the intent that starts the StackViewService, which
        // provides the views for this collection.
        val intent = Intent(context, StackWidgetService::class.java).apply {
            // Add the widget ID to the intent extras.
            putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
            data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))
        }
        // Instantiate the RemoteViews object for the widget layout.
        val views = RemoteViews(context.packageName, R.layout.widget_layout).apply {
            // Set up the RemoteViews object to use a RemoteViews adapter.
            // This adapter connects to a RemoteViewsService through the
            // specified intent.
            // This is how you populate the data.
            setRemoteAdapter(R.id.stack_view, intent)

            // The empty view is displayed when the collection has no items.
            // It must be in the same layout used to instantiate the
            // RemoteViews object.
            setEmptyView(R.id.stack_view, R.id.empty_view)
        }

        // Do additional processing specific to this widget.

        appWidgetManager.updateAppWidget(appWidgetId, views)
    }
    super.onUpdate(context, appWidgetManager, appWidgetIds)
}

Java

public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
    // Update each of the widgets with the remote adapter.
    for (int i = 0; i < appWidgetIds.length; ++i) {

        // Set up the intent that starts the StackViewService, which
        // provides the views for this collection.
        Intent intent = new Intent(context, StackWidgetService.class);
        // Add the widget ID to the intent extras.
        intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetIds[i]);
        intent.setData(Uri.parse(intent.toUri(Intent.URI_INTENT_SCHEME)));
        // Instantiate the RemoteViews object for the widget layout.
        RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.widget_layout);
        // Set up the RemoteViews object to use a RemoteViews adapter.
        // This adapter connects to a RemoteViewsService through the specified
        // intent.
        // This is how you populate the data.
        views.setRemoteAdapter(R.id.stack_view, intent);

        // The empty view is displayed when the collection has no items.
        // It must be in the same layout used to instantiate the RemoteViews
        // object.
        views.setEmptyView(R.id.stack_view, R.id.empty_view);

        // Do additional processing specific to this widget.

        appWidgetManager.updateAppWidget(appWidgetIds[i], views);
    }
    super.onUpdate(context, appWidgetManager, appWidgetIds);
}

持久化数据

如本页所述,RemoteViewsService 子类提供用于填充远程集合视图的 RemoteViewsFactory

具体来说,请执行以下步骤

  1. RemoteViewsService 进行子类化。RemoteViewsService 是远程适配器可以通过其请求 RemoteViews 的服务。

  2. 在您的 RemoteViewsService 子类中,包含一个实现 RemoteViewsFactory 接口的类。RemoteViewsFactory 是远程集合视图(例如 ListViewGridViewStackView)与其底层数据之间的适配器的接口。您的实现负责为数据集中的每个项目创建 RemoteViews 对象。此接口是 Adapter 的薄包装器。

您不能依赖服务的单个实例或其包含的任何数据来持久化。除非数据是静态的,否则请不要在您的 RemoteViewsService 中存储数据。如果希望您的 Widget 的数据持久化,最好的方法是使用 ContentProvider,其数据在进程生命周期之外持久化。例如,杂货店 Widget 可以将每个杂货清单项目的狀態存储在持久位置(例如 SQL 数据库)中。

RemoteViewsService 实现的主要内容是其 RemoteViewsFactory,下一节将对其进行描述。

RemoteViewsFactory 接口

实现 RemoteViewsFactory 接口的自定义类为小部件提供其集合中项目的数据。为此,它将小部件项目 XML 布局文件与数据源结合使用。此数据源可以是任何东西,从数据库到简单的数组。在 StackWidget 示例中,数据源是 WidgetItems 的数组。 RemoteViewsFactory 充当适配器,将数据粘合到远程集合视图。

对于 RemoteViewsFactory 子类,您需要实现的两个最重要的方法是 onCreate()getViewAt()

系统在首次创建工厂时调用 onCreate()。在这里,您可以设置与数据源的任何连接或游标。例如,StackWidget 示例使用 onCreate() 初始化一个 WidgetItem 对象数组。当您的部件处于活动状态时,系统会使用这些对象在数组中的索引位置访问它们,并显示它们包含的文本。

以下是 StackWidget 示例的 RemoteViewsFactory 实现中显示 onCreate() 方法部分的摘录

Kotlin

private const val REMOTE_VIEW_COUNT: Int = 10

class StackRemoteViewsFactory(
        private val context: Context
) : RemoteViewsService.RemoteViewsFactory {

    private lateinit var widgetItems: List<WidgetItem>

    override fun onCreate() {
        // In onCreate(), set up any connections or cursors to your data
        // source. Heavy lifting, such as downloading or creating content,
        // must be deferred to onDataSetChanged() or getViewAt(). Taking
        // more than 20 seconds on this call results in an ANR.
        widgetItems = List(REMOTE_VIEW_COUNT) { index -> WidgetItem("$index!") }
        ...
    }
    ...
}

Java

class StackRemoteViewsFactory implements RemoteViewsService.RemoteViewsFactory {
    private static final int REMOTE_VIEW_COUNT = 10;
    private List<WidgetItem> widgetItems = new ArrayList<WidgetItem>();

    public void onCreate() {
        // In onCreate(), setup any connections or cursors to your data
        // source. Heavy lifting, such as downloading or creating content,
        // must be deferred to onDataSetChanged() or getViewAt(). Taking
        // more than 20 seconds on this call results in an ANR.
        for (int i = 0; i < REMOTE_VIEW_COUNT; i++) {
            widgetItems.add(new WidgetItem(i + "!"));
        }
        ...
    }
...

RemoteViewsFactory 方法 getViewAt() 返回一个 RemoteViews 对象,该对象对应于数据集中指定 position 处的数据。以下是 StackWidget 示例的 RemoteViewsFactory 实现中的摘录

Kotlin

override fun getViewAt(position: Int): RemoteViews {
    // Construct a remote views item based on the widget item XML file
    // and set the text based on the position.
    return RemoteViews(context.packageName, R.layout.widget_item).apply {
        setTextViewText(R.id.widget_item, widgetItems[position].text)
    }
}

Java

public RemoteViews getViewAt(int position) {
    // Construct a remote views item based on the widget item XML file
    // and set the text based on the position.
    RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.widget_item);
    views.setTextViewText(R.id.widget_item, widgetItems.get(position).text);
    return views;
}

为单个项目添加行为

前面的部分介绍了如何将数据绑定到小部件集合。但是,如果要为集合视图中的各个项目添加动态行为,该怎么办?

使用 onUpdate() 类处理事件 中所述,您通常使用 setOnClickPendingIntent() 设置对象的点击行为,例如导致按钮启动 Activity。但是,此方法不允许用于单个集合项目中的子视图。例如,您可以使用 setOnClickPendingIntent() 设置 Gmail 小部件中的全局按钮以启动应用程序,例如,但不能在单个列表项上使用。

相反,要为集合中的各个项目添加点击行为,请使用 setOnClickFillInIntent()。这需要为集合视图设置一个挂起意图模板,然后通过您的 RemoteViewsFactory 在集合中的每个项目上设置填充意图。

本节使用 StackWidget 示例来描述如何为各个项目添加行为。在 StackWidget 示例中,如果用户触摸顶部视图,则小部件会显示“Touched view n”的 Toast 消息,其中 n 是所触摸视图的索引(位置)。其工作原理如下

  • StackWidgetProvider(一个 AppWidgetProvider 子类)使用名为 TOAST_ACTION 的自定义操作创建挂起意图。

  • 当用户触摸视图时,意图将触发并广播 TOAST_ACTION

  • 此广播由 StackWidgetProvider 类的 onReceive() 方法拦截,并且小部件会显示所触摸视图的 Toast 消息。集合项目的相关数据由 RemoteViewsFactory 通过 RemoteViewsService 提供。

设置挂起意图模板

StackWidgetProvider(一个 AppWidgetProvider 子类)设置挂起意图。集合的各个项目无法设置自己的挂起意图。相反,整个集合设置挂起意图模板,并且各个项目设置填充意图以逐项创建唯一的行为。

此类还接收在用户触摸视图时发送的广播。它在其 onReceive() 方法中处理此事件。如果意图的操作是 TOAST_ACTION,则小部件会显示当前视图的 Toast 消息。

Kotlin

const val TOAST_ACTION = "com.example.android.stackwidget.TOAST_ACTION"
const val EXTRA_ITEM = "com.example.android.stackwidget.EXTRA_ITEM"

class StackWidgetProvider : AppWidgetProvider() {

    ...

    // Called when the BroadcastReceiver receives an Intent broadcast.
    // Checks whether the intent's action is TOAST_ACTION. If it is, the
    // widget displays a Toast message for the current item.
    override fun onReceive(context: Context, intent: Intent) {
        val mgr: AppWidgetManager = AppWidgetManager.getInstance(context)
        if (intent.action == TOAST_ACTION) {
            val appWidgetId: Int = intent.getIntExtra(
                    AppWidgetManager.EXTRA_APPWIDGET_ID,
                    AppWidgetManager.INVALID_APPWIDGET_ID
            )
            // EXTRA_ITEM represents a custom value provided by the Intent
            // passed to the setOnClickFillInIntent() method to indicate the
            // position of the clicked item. See StackRemoteViewsFactory in
            // Set the fill-in Intent for details.
            val viewIndex: Int = intent.getIntExtra(EXTRA_ITEM, 0)
            Toast.makeText(context, "Touched view $viewIndex", Toast.LENGTH_SHORT).show()
        }
        super.onReceive(context, intent)
    }

    override fun onUpdate(
            context: Context,
            appWidgetManager: AppWidgetManager,
            appWidgetIds: IntArray
    ) {
        // Update each of the widgets with the remote adapter.
        appWidgetIds.forEach { appWidgetId ->

            // Sets up the intent that points to the StackViewService that
            // provides the views for this collection.
            val intent = Intent(context, StackWidgetService::class.java).apply {
                putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
                // When intents are compared, the extras are ignored, so embed
                // the extra sinto the data so that the extras are not ignored.
                data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))
            }
            val rv = RemoteViews(context.packageName, R.layout.widget_layout).apply {
                setRemoteAdapter(R.id.stack_view, intent)

                // The empty view is displayed when the collection has no items.
                // It must be a sibling of the collection view.
                setEmptyView(R.id.stack_view, R.id.empty_view)
            }

            // This section makes it possible for items to have individualized
            // behavior. It does this by setting up a pending intent template.
            // Individuals items of a collection can't set up their own pending
            // intents. Instead, the collection as a whole sets up a pending
            // intent template, and the individual items set a fillInIntent
            // to create unique behavior on an item-by-item basis.
            val toastPendingIntent: PendingIntent = Intent(
                    context,
                    StackWidgetProvider::class.java
            ).run {
                // Set the action for the intent.
                // When the user touches a particular view, it has the effect of
                // broadcasting TOAST_ACTION.
                action = TOAST_ACTION
                putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
                data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))

                PendingIntent.getBroadcast(context, 0, this, PendingIntent.FLAG_UPDATE_CURRENT)
            }
            rv.setPendingIntentTemplate(R.id.stack_view, toastPendingIntent)

            appWidgetManager.updateAppWidget(appWidgetId, rv)
        }
        super.onUpdate(context, appWidgetManager, appWidgetIds)
    }
}

Java

public class StackWidgetProvider extends AppWidgetProvider {
    public static final String TOAST_ACTION = "com.example.android.stackwidget.TOAST_ACTION";
    public static final String EXTRA_ITEM = "com.example.android.stackwidget.EXTRA_ITEM";

    ...

    // Called when the BroadcastReceiver receives an Intent broadcast.
    // Checks whether the intent's action is TOAST_ACTION. If it is, the
    // widget displays a Toast message for the current item.
    @Override
    public void onReceive(Context context, Intent intent) {
        AppWidgetManager mgr = AppWidgetManager.getInstance(context);
        if (intent.getAction().equals(TOAST_ACTION)) {
            int appWidgetId = intent.getIntExtra(AppWidgetManager.EXTRA_APPWIDGET_ID,
                AppWidgetManager.INVALID_APPWIDGET_ID);
            // EXTRA_ITEM represents a custom value provided by the Intent
            // passed to the setOnClickFillInIntent() method to indicate the
            // position of the clicked item. See StackRemoteViewsFactory in
            // Set the fill-in Intent for details.
            int viewIndex = intent.getIntExtra(EXTRA_ITEM, 0);
            Toast.makeText(context, "Touched view " + viewIndex, Toast.LENGTH_SHORT).show();
        }
        super.onReceive(context, intent);
    }

    @Override
    public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        // Update each of the widgets with the remote adapter.
        for (int i = 0; i < appWidgetIds.length; ++i) {

            // Sets up the intent that points to the StackViewService that
            // provides the views for this collection.
            Intent intent = new Intent(context, StackWidgetService.class);
            intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetIds[i]);
            // When intents are compared, the extras are ignored, so embed
            // the extras into the data so that the extras are not
            // ignored.
            intent.setData(Uri.parse(intent.toUri(Intent.URI_INTENT_SCHEME)));
            RemoteViews rv = new RemoteViews(context.getPackageName(), R.layout.widget_layout);
            rv.setRemoteAdapter(appWidgetIds[i], R.id.stack_view, intent);

            // The empty view is displayed when the collection has no items. It
            // must be a sibling of the collection view.
            rv.setEmptyView(R.id.stack_view, R.id.empty_view);

            // This section makes it possible for items to have individualized
            // behavior. It does this by setting up a pending intent template.
            // Individuals items of a collection can't set up their own pending
            // intents. Instead, the collection as a whole sets up a pending
            // intent template, and the individual items set a fillInIntent
            // to create unique behavior on an item-by-item basis.
            Intent toastIntent = new Intent(context, StackWidgetProvider.class);
            // Set the action for the intent.
            // When the user touches a particular view, it has the effect of
            // broadcasting TOAST_ACTION.
            toastIntent.setAction(StackWidgetProvider.TOAST_ACTION);
            toastIntent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetIds[i]);
            intent.setData(Uri.parse(intent.toUri(Intent.URI_INTENT_SCHEME)));
            PendingIntent toastPendingIntent = PendingIntent.getBroadcast(context, 0, toastIntent,
                PendingIntent.FLAG_UPDATE_CURRENT);
            rv.setPendingIntentTemplate(R.id.stack_view, toastPendingIntent);

            appWidgetManager.updateAppWidget(appWidgetIds[i], rv);
        }
        super.onUpdate(context, appWidgetManager, appWidgetIds);
    }
}

设置填充意图

您的 RemoteViewsFactory 必须在集合中的每个项目上设置填充意图。这使得可以区分给定项目的单个点击操作。然后将填充意图与 PendingIntent 模板组合,以确定在点击项目时执行的最终意图。

Kotlin

private const val REMOTE_VIEW_COUNT: Int = 10

class StackRemoteViewsFactory(
        private val context: Context,
        intent: Intent
) : RemoteViewsService.RemoteViewsFactory {

    private lateinit var widgetItems: List<WidgetItem>
    private val appWidgetId: Int = intent.getIntExtra(
            AppWidgetManager.EXTRA_APPWIDGET_ID,
            AppWidgetManager.INVALID_APPWIDGET_ID
    )

    override fun onCreate() {
        // In onCreate(), set up any connections or cursors to your data source.
        // Heavy lifting, such as downloading or creating content, must be
        // deferred to onDataSetChanged() or getViewAt(). Taking more than 20
        // seconds on this call results in an ANR.
        widgetItems = List(REMOTE_VIEW_COUNT) { index -> WidgetItem("$index!") }
        ...
    }
    ...

    override fun getViewAt(position: Int): RemoteViews {
        // Construct a remote views item based on the widget item XML file
        // and set the text based on the position.
        return RemoteViews(context.packageName, R.layout.widget_item).apply {
            setTextViewText(R.id.widget_item, widgetItems[position].text)

            // Set a fill-intent to fill in the pending intent template.
            // that is set on the collection view in StackWidgetProvider.
            val fillInIntent = Intent().apply {
                Bundle().also { extras ->
                    extras.putInt(EXTRA_ITEM, position)
                    putExtras(extras)
                }
            }
            // Make it possible to distinguish the individual on-click
            // action of a given item.
            setOnClickFillInIntent(R.id.widget_item, fillInIntent)
            ...
        }
    }
    ...
}

Java

public class StackWidgetService extends RemoteViewsService {
    @Override
    public RemoteViewsFactory onGetViewFactory(Intent intent) {
        return new StackRemoteViewsFactory(this.getApplicationContext(), intent);
    }
}

class StackRemoteViewsFactory implements RemoteViewsService.RemoteViewsFactory {
    private static final int count = 10;
    private List<WidgetItem> widgetItems = new ArrayList<WidgetItem>();
    private Context context;
    private int appWidgetId;

    public StackRemoteViewsFactory(Context context, Intent intent) {
        this.context = context;
        appWidgetId = intent.getIntExtra(AppWidgetManager.EXTRA_APPWIDGET_ID,
                AppWidgetManager.INVALID_APPWIDGET_ID);
    }

    // Initialize the data set.
    public void onCreate() {
        // In onCreate(), set up any connections or cursors to your data
        // source. Heavy lifting, such as downloading or creating
        // content, must be deferred to onDataSetChanged() or
        // getViewAt(). Taking more than 20 seconds on this call results
        // in an ANR.
        for (int i = 0; i < count; i++) {
            widgetItems.add(new WidgetItem(i + "!"));
        }
        ...
    }

    // Given the position (index) of a WidgetItem in the array, use the
    // item's text value in combination with the widget item XML file to
    // construct a RemoteViews object.
    public RemoteViews getViewAt(int position) {
        // Position always ranges from 0 to getCount() - 1.

        // Construct a RemoteViews item based on the widget item XML
        // file and set the text based on the position.
        RemoteViews rv = new RemoteViews(context.getPackageName(), R.layout.widget_item);
        rv.setTextViewText(R.id.widget_item, widgetItems.get(position).text);

        // Set a fill-intent to fill in the pending
        // intent template that is set on the collection view in
        // StackWidgetProvider.
        Bundle extras = new Bundle();
        extras.putInt(StackWidgetProvider.EXTRA_ITEM, position);
        Intent fillInIntent = new Intent();
        fillInIntent.putExtras(extras);
        // Make it possible to distinguish the individual on-click
        // action of a given item.
        rv.setOnClickFillInIntent(R.id.widget_item, fillInIntent);

        // Return the RemoteViews object.
        return rv;
    }
    ...
}

保持集合数据最新

图 2 说明了使用集合的小部件中的更新流程。它显示了小部件代码如何与 RemoteViewsFactory 交互以及如何触发更新

图 2. 更新期间与 RemoteViewsFactory 的交互。

使用集合的小部件可以为用户提供最新的内容。例如,Gmail 小部件为用户提供其收件箱的快照。要实现此目的,请触发 RemoteViewsFactory 和集合视图以获取和显示新数据。

为此,请使用 AppWidgetManager 调用 notifyAppWidgetViewDataChanged()。此调用会导致回调到 RemoteViewsFactory 对象的 onDataSetChanged() 方法,这使您可以获取任何新数据。

您可以在 onDataSetChanged() 回调中同步执行处理密集型操作。可以保证在从 RemoteViewsFactory 获取元数据或视图数据之前完成此调用。您还可以在 getViewAt() 方法中执行处理密集型操作。如果此调用花费时间过长,则将显示加载视图(由 RemoteViewsFactory 对象的 getLoadingView() 方法指定)在集合视图的相应位置,直到它返回。

使用 RemoteCollectionItems 直接传递集合

Android 12(API 级别 31)添加了 setRemoteAdapter(int viewId, RemoteViews.RemoteCollectionItems items) 方法,该方法允许您的应用在填充集合视图时直接传递集合。如果您使用此方法设置适配器,则无需实现 RemoteViewsFactory,也无需调用 notifyAppWidgetViewDataChanged()

除了简化适配器填充之外,此方法还可以消除在用户向下滚动列表以显示新项目时填充新项目的延迟。只要您的集合项目集相对较小,此设置适配器的方法就是首选方法。但是,例如,如果您的集合包含许多传递到 setImageViewBitmapBitmaps,则此方法效果不佳。

如果集合不使用恒定的布局集(即,某些项目并非始终存在),请使用 setViewTypeCount 指定集合可以包含的最大唯一布局数。这使得适配器可以在应用小部件的更新中重复使用。

以下是如何实现简化的 RemoteViews 集合的示例。

Kotlin

val itemLayouts = listOf(
        R.layout.item_type_1,
        R.layout.item_type_2,
        ...
)

remoteView.setRemoteAdapter(
        R.id.list_view,
        RemoteViews.RemoteCollectionItems.Builder()
            .addItem(/* id= */ ID_1, RemoteViews(context.packageName, R.layout.item_type_1))
            .addItem(/* id= */ ID_2, RemoteViews(context.packageName, R.layout.item_type_2))
            ...
            .setViewTypeCount(itemLayouts.count())
            .build()
)

Java

List<Integer> itemLayouts = Arrays.asList(
    R.layout.item_type_1,
    R.layout.item_type_2,
    ...
);

remoteView.setRemoteAdapter(
    R.id.list_view,
    new RemoteViews.RemoteCollectionItems.Builder()
        .addItem(/* id= */ ID_1, new RemoteViews(context.getPackageName(), R.layout.item_type_1))
        .addItem(/* id= */ ID_2, new RemoteViews(context.getPackageName(), R.layout.item_type_2))
        ...
        .setViewTypeCount(itemLayouts.size())
        .build()
);