Usar widgets de coleção

Os widgets de coleção são especializados na exibição de muitos elementos do mesmo tipo, como coleções de imagens de um app de galeria, artigos de um app de notícias ou mensagens de um app de comunicação. Os widgets de coleção normalmente se concentram em dois casos de uso: navegar pela coleção e abrir um elemento da coleção na visualização detalhada. Os widgets de coleção podem apresentar rolagem vertical.

Esses widgets usam o RemoteViewsService para exibir coleções que usam dados remotos, como de um provedor de conteúdo. O widget apresenta os dados usando um dos tipos de visualização abaixo, conhecidos como visualizações de coleção:

ListView
Uma visualização que mostra itens em uma lista de rolagem vertical.
GridView
Uma visualização que mostra itens em uma grade de rolagem bidimensional.
StackView
Uma visualização de card empilhada, como uma rolodex, em que o usuário pode virar o card da frente para cima ou para baixo para ver o card anterior ou seguinte, respectivamente.
AdapterViewFlipper
Um ViewAnimator simples compatível com adaptadores que é animado entre duas ou mais visualizações. Apenas uma criança é exibida por vez.

Como essas visualizações de coleção exibem coleções com suporte de dados remotos, elas usam um Adapter para vincular a interface do usuário aos dados. Um Adapter vincula itens individuais de um conjunto de dados a objetos View individuais.

E, como essas visualizações de coleção usam adaptadores, o framework do Android precisa incluir uma arquitetura extra para oferecer suporte ao uso em widgets. No contexto de um widget, o Adapter é substituído por um RemoteViewsFactory, que é um wrapper fino ao redor da interface Adapter. Quando solicitado para um item específico na coleção, o RemoteViewsFactory cria e retorna o item para a coleção como um objeto RemoteViews. Para incluir uma visualização de coleção no widget, implemente RemoteViewsService e RemoteViewsFactory.

O RemoteViewsService é um serviço que permite que um adaptador remoto solicite objetos RemoteViews. RemoteViewsFactory é uma interface para um adaptador entre uma visualização de coleção, como ListView, GridView e StackView, e os dados subjacentes dessa visualização. No exemplo StackWidget (link em inglês), confira um exemplo de código boilerplate para implementar esse serviço e essa interface:

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.

}

App de exemplo

Os trechos de código desta seção também foram extraídos do exemplo StackWidget (link em inglês):

Figura 1. Uma StackWidget.

Essa amostra consiste em uma pilha de dez visualizações que mostram os valores de zero a nove. O widget de amostra tem os seguintes comportamentos principais:

  • O usuário pode deslizar verticalmente a visualização superior no widget para exibir a visualização próxima ou anterior. Esse é um comportamento StackView integrado.

  • Sem nenhuma interação do usuário, o widget avança automaticamente nas visualizações em sequência, como uma apresentação de slides. Isso ocorre devido à configuração android:autoAdvanceViewId="@id/stack_view" no arquivo res/xml/stackwidgetinfo.xml. Essa configuração se aplica ao ID da visualização, que nesse caso é o ID da visualização em pilha.

  • Se o usuário tocar na visualização superior, o widget vai mostrar a mensagem Toast "Visualização tocada n", em que n é o índice (posição) da visualização tocada. Para saber mais sobre como implementar comportamentos, consulte a seção Adicionar comportamento a itens individuais.

Implementar widgets com coleções

Para implementar um widget com coleções, siga o procedimento para implementar qualquer widget, seguido por mais algumas etapas: modificar o manifesto, adicionar uma visualização de coleção ao layout do widget e modificar a subclasse AppWidgetProvider.

Manifesto para widgets com coleções

Além dos requisitos listados em Declarar um widget no manifesto, você precisa possibilitar que widgets com coleções sejam vinculados ao RemoteViewsService. Para isso, declare o serviço no arquivo de manifesto com a permissão BIND_REMOTEVIEWS. Isso impede que outros aplicativos acessem livremente os dados do seu widget.

Por exemplo, ao criar um widget que usa RemoteViewsService para preencher uma visualização de coleção, a entrada do manifesto pode ter esta aparência:

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

Neste exemplo, android:name="MyWidgetService" se refere à subclasse de RemoteViewsService.

Layout para widgets com coleções

O principal requisito para o arquivo XML de layout do widget é que ele inclua uma das visualizações de coleção: ListView, GridView, StackView ou AdapterViewFlipper. Este é o arquivo widget_layout.xml do exemplo StackWidget (link em inglês):

<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>

As visualizações vazias precisam ser irmãs da visualização de coleção em que a visualização vazia representa um estado vazio.

Além do arquivo de layout de todo o widget, crie outro arquivo de layout que defina o layout de cada item na coleção, por exemplo, um layout para cada livro em uma coleção de livros. O exemplo StackWidget tem apenas um arquivo de layout de item, widget_item.xml, já que todos os itens usam o mesmo layout.

Classe AppWidgetProvider para widgets com coleções

Assim como acontece com os widgets normais, a maior parte do código na subclasse AppWidgetProvider geralmente fica em onUpdate(). A principal diferença na sua implementação de onUpdate() ao criar um widget com coleções é que você precisa chamar setRemoteAdapter(). Isso informa à visualização da coleção onde obter os dados. O RemoteViewsService pode retornar a implementação de RemoteViewsFactory, e o widget pode mostrar os dados adequados. Ao chamar esse método, transmita uma intent que aponte para a implementação de RemoteViewsService e o ID do widget que especifica o widget a ser atualizado.

Confira como o exemplo de StackWidget implementa o método de callback onUpdate() para definir o RemoteViewsService como o adaptador remoto da coleção de widgets:

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);
}

Persistir dados

Conforme descrito nesta página, a subclasse RemoteViewsService fornece o RemoteViewsFactory usado para preencher a visualização de coleção remota.

Especificamente, execute estas etapas:

  1. Coloque RemoteViewsService em subclasse. RemoteViewsService é o serviço pelo qual um adaptador remoto pode solicitar RemoteViews.

  2. Na subclasse RemoteViewsService, inclua uma classe que implemente a interface RemoteViewsFactory. RemoteViewsFactory é uma interface para um adaptador entre uma visualização de coleção remota, como ListView, GridView, StackView, e os dados subjacentes dessa visualização. Sua implementação é responsável por criar um objeto RemoteViews para cada item no conjunto de dados. Essa interface é um wrapper fino em torno de Adapter.

Não é possível confiar em uma única instância do serviço ou nos dados contidos nele para persistir. Não armazene dados no RemoteViewsService, a menos que eles sejam estáticos. Se você quiser que os dados do widget sejam mantidos, a melhor abordagem é usar um ContentProvider cujos dados persistam além do ciclo de vida do processo. Por exemplo, um widget de supermercado pode armazenar o estado de cada item da lista de compras em um local persistente, como um banco de dados SQL.

O conteúdo principal da implementação de RemoteViewsService é o RemoteViewsFactory, descrito na seção a seguir.

Interface RemoteViewsFactory

A classe personalizada que implementa a interface RemoteViewsFactory fornece ao widget os dados dos itens na coleção dela. Para fazer isso, ele combina o arquivo de layout XML do item de widget com uma fonte de dados. Essa fonte de dados pode ser qualquer coisa, desde um banco de dados até uma matriz simples. Na amostra StackWidget, a fonte de dados é uma matriz de WidgetItems. O RemoteViewsFactory funciona como um adaptador para colar os dados na visualização de coleção remota.

Os dois métodos mais importantes que você precisa implementar para a subclasse RemoteViewsFactory são onCreate() e getViewAt().

O sistema chama onCreate() ao criar sua fábrica pela primeira vez. É aqui que você configura as conexões ou cursores para sua fonte de dados. Por exemplo, a amostra StackWidget usa onCreate() para inicializar uma matriz de objetos WidgetItem. Quando o widget está ativo, o sistema acessa esses objetos usando a posição do índice deles na matriz e exibe o texto que eles contêm.

Veja um trecho da implementação de RemoteViewsFactory da amostra StackWidget que mostra partes do método 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 + "!"));
        }
        ...
    }
...

O método RemoteViewsFactory getViewAt() retorna um objeto RemoteViews correspondente aos dados no position especificado no conjunto de dados. Confira um trecho da implementação de RemoteViewsFactory de exemplo de StackWidget:

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;
}

Adicionar comportamento a itens individuais

As seções anteriores mostram como vincular seus dados à coleção de widgets. Mas e se você quiser adicionar um comportamento dinâmico a itens individuais na visualização de coleção?

Conforme descrito em Processar eventos com a classe onUpdate(), você normalmente usa setOnClickPendingIntent() para definir o comportamento de clique de um objeto, por exemplo, para fazer com que um botão inicie uma Activity. No entanto, essa abordagem não é permitida para visualizações filhas em um item de coleção individual. Por exemplo, você pode usar setOnClickPendingIntent() para configurar um botão global no widget do Gmail que inicia o app, mas não nos itens da lista individuais.

Em vez disso, para adicionar o comportamento de clique a itens individuais em uma coleção, use setOnClickFillInIntent(). Isso envolve configurar um modelo de intent pendente para a visualização de coleção e, em seguida, definir uma intent de preenchimento em cada item na coleção usando seu RemoteViewsFactory.

Esta seção usa a amostra StackWidget para descrever como adicionar um comportamento a itens individuais. No exemplo de StackWidget, se o usuário tocar na visualização superior, o widget vai mostrar a mensagem Toast "Visualização tocada n", em que n é o índice (posição) da visualização tocada. Veja como funciona:

  • A StackWidgetProvider, uma subclasse AppWidgetProvider, cria uma intent pendente com uma ação personalizada chamada TOAST_ACTION.

  • Quando o usuário toca em uma visualização, a intent é disparada e transmite TOAST_ACTION.

  • Essa transmissão é interceptada pelo método onReceive() da classe StackWidgetProvider, e o widget exibe a mensagem Toast para a visualização tocada. Os dados dos itens da coleção são fornecidos pelo RemoteViewsFactory pelo RemoteViewsService.

Configurar o modelo de intent pendente

O StackWidgetProvider (uma subclasse AppWidgetProvider) configura uma intent pendente. Itens individuais de uma coleção não podem configurar intents pendentes. Em vez disso, a coleção como um todo configura um modelo de intent pendente, e os itens individuais definem uma intent de preenchimento para criar um comportamento exclusivo para cada item.

Essa classe também recebe a transmissão que é enviada quando o usuário toca em uma visualização. Ela processa esse evento no método onReceive(). Se a ação da intent for TOAST_ACTION, o widget exibirá uma mensagem Toast para a visualização atual.

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);
    }
}

Definir a intent de preenchimento

Seu RemoteViewsFactory precisa definir uma intent de preenchimento para cada item na coleção. Isso possibilita distinguir a ação individual de um clique de um determinado item. Em seguida, a intent de preenchimento é combinada com o modelo PendingIntent para determinar a intent final executada quando o item é tocado.

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;
    }
    ...
}

Manter os dados da coleção atualizados

A Figura 2 ilustra o fluxo de atualização em um widget que usa coleções. Ele mostra como o código do widget interage com o RemoteViewsFactory e como você pode acionar atualizações:

Figura 2. Interação com RemoteViewsFactory durante atualizações.

Os widgets que usam coleções podem fornecer aos usuários conteúdo atualizado. Por exemplo, o widget do Gmail oferece aos usuários um resumo da caixa de entrada deles. Para que isso possível, acione seu RemoteViewsFactory e a visualização de coleção para buscar e mostrar novos dados.

Para fazer isso, use o AppWidgetManager para chamar notifyAppWidgetViewDataChanged(). Essa chamada resulta em um callback para o método onDataSetChanged() do objeto RemoteViewsFactory, que permite buscar novos dados.

É possível executar operações de processamento intensivo de forma síncrona dentro do callback onDataSetChanged(). Essa chamada vai ser concluída antes que os metadados ou os dados de visualização sejam buscados no RemoteViewsFactory. Também é possível executar operações de processamento intensivo no método getViewAt(). Se essa chamada demorar muito, a visualização de carregamento, especificada pelo método getLoadingView() do objeto RemoteViewsFactory, será mostrada na posição correspondente da visualização da coleção até que ela seja retornada.

Usar RemoteCollectionItems para transmitir uma coleção diretamente

O Android 12 (nível 31 da API) adiciona o método setRemoteAdapter(int viewId, RemoteViews.RemoteCollectionItems items), que permite que o app transmita uma coleção diretamente ao preencher uma visualização de coleção. Se você definir o adaptador usando esse método, não será necessário implementar um RemoteViewsFactory nem chamar notifyAppWidgetViewDataChanged().

Além de facilitar o preenchimento do adaptador, essa abordagem também remove a latência para preencher novos itens quando os usuários rolam a lista para baixo para revelar um novo item. Essa abordagem para definir o adaptador é preferível, desde que o conjunto de itens de coleção seja relativamente pequeno. No entanto, essa abordagem não funciona bem se a coleção tiver vários Bitmaps sendo transmitidos para setImageViewBitmap.

Se a coleção não usar um conjunto constante de layouts, ou seja, se alguns itens só estiverem presentes, use setViewTypeCount para especificar o número máximo de layouts exclusivos que a coleção pode conter. Isso permite que o adaptador seja reutilizado nas atualizações do widget do app.

Veja um exemplo de como implementar coleções RemoteViews simplificadas.

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()
);