Utilizzo dei widget raccolta

Prova Compose

Jetpack Compose è il toolkit UI consigliato per Android. Scopri come creare widget utilizzando le API in stile Compose.

Jetpack Glance →

I widget di raccolta sono specializzati nella visualizzazione di molti elementi dello stesso tipo, ad esempio raccolte di immagini da un'app di galleria, articoli da un'app di notizie o messaggi da un'app di comunicazione. I widget di raccolta in genere si concentrano su due casi d'uso: sfogliare la raccolta e aprire un elemento della raccolta nella visualizzazione dei dettagli. I widget di raccolta possono scorrere verticalmente.

Questi widget utilizzano RemoteViewsService per visualizzare raccolte supportate da dati remoti, ad esempio da un content provider. Il widget presenta i dati utilizzando uno dei seguenti tipi di visualizzazione, noti come visualizzazioni di raccolta:

ListView

Una visualizzazione che mostra gli elementi in un elenco a scorrimento verticale.

GridView

Una visualizzazione che mostra gli elementi in una griglia a scorrimento bidimensionale.

StackView

Una visualizzazione di schede impilate, simile a un rolodex, in cui l'utente può scorrere la scheda anteriore verso l'alto o verso il basso per visualizzare rispettivamente la scheda precedente o successiva.

AdapterViewFlipper

Un semplice ViewAnimator supportato da un adattatore che anima due o più visualizzazioni. Viene visualizzato un solo elemento secondario alla volta.

Poiché queste visualizzazioni di raccolta mostrano raccolte supportate da dati remoti, utilizzano un Adapter per associare la loro interfaccia utente ai dati. Un Adapter associa i singoli elementi di un insieme di dati ai singoli View oggetti.

Poiché queste visualizzazioni di raccolta sono supportate da adattatori, il framework Android deve includere un'architettura aggiuntiva per supportarne l'utilizzo nei widget. Nel contesto di un widget, Adapter viene sostituito da RemoteViewsFactory, che è un wrapper sottile intorno all'inter0/}faccia.Adapter Quando viene richiesto un elemento specifico nella raccolta, RemoteViewsFactory crea e restituisce l'elemento per la raccolta come un RemoteViews oggetto. Per includere una visualizzazione di raccolta nel widget, implementa RemoteViewsService e RemoteViewsFactory.

RemoteViewsService è un servizio che consente a un adattatore remoto di richiedere RemoteViews oggetti. RemoteViewsFactory è un'interfaccia per un adattatore tra una visualizzazione di raccolta, ad esempio ListView, GridView e StackView, e i dati sottostanti per quella visualizzazione. Dall'StackWidget esempio, di seguito è riportato un esempio del codice boilerplate per implementare questo servizio e questa interfaccia:

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.

}

Applicazione di esempio

Gli estratti di codice in questa sezione sono tratti anche dall'esempio StackWidget sample:

Figura 1. Un StackWidget.

Questo esempio è costituito da una pila di dieci visualizzazioni che mostrano i valori da zero a nove. Il widget di esempio ha questi comportamenti principali:

• L'utente può scorrere velocemente in verticale la vista dall'alto nel widget per visualizzare la visualizzazione successiva o precedente. Questo è un comportamento integrato di StackView.

• Senza alcuna interazione dell'utente, il widget scorre automaticamente le visualizzazioni in sequenza, come una presentazione. Ciò è dovuto all'impostazione android:autoAdvanceViewId="@id/stack_view" nel res/xml/stackwidgetinfo.xml file. Questa impostazione si applica all'ID della visualizzazione, che in questo caso è l'ID della visualizzazione della pila.

• Se l'utente tocca la vista dall'alto, il widget visualizza il Toast messaggio "Touched view n," dove n è l'indice (posizione) della visualizzazione toccata. Per ulteriori informazioni su come implementare i comportamenti, consulta la sezione Aggiungere un comportamento ai singoli elementi.

Implementare widget con raccolte

Per implementare un widget con raccolte, segui la procedura per implementare qualsiasi widget, seguita da alcuni passaggi aggiuntivi: modifica il file manifest, aggiungi una visualizzazione di raccolta al layout del widget e modifica la tua AppWidgetProvider sottoclasse.

File manifest per i widget con raccolte

Oltre ai requisiti elencati in Dichiarare un widget nel file manifest, devi consentire ai widget con raccolte di eseguire l'associazione a RemoteViewsService. Per farlo, dichiara il servizio nel file manifest con l'autorizzazione BIND_REMOTEVIEWS. In questo modo, le altre applicazioni non possono accedere liberamente ai dati del widget.

Ad esempio, quando crei un widget che utilizza RemoteViewsService per popolare una visualizzazione di raccolta, la voce del file manifest potrebbe essere simile alla seguente:

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

In questo esempio, android:name="MyWidgetService" si riferisce alla sottoclasse di RemoteViewsService.

Layout per i widget con raccolte

Il requisito principale per il file XML di layout del widget è che includa una delle visualizzazioni di raccolta: ListView, GridView, StackView o AdapterViewFlipper. Di seguito è riportato il widget_layout.xml file per l' StackWidget esempio:

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

Tieni presente che le visualizzazioni vuote devono essere elementi di pari livello della visualizzazione di raccolta per cui la visualizzazione vuota rappresenta lo stato vuoto.

Oltre al file di layout per l'intero widget, crea un altro file di layout che definisca il layout per ogni elemento della raccolta, ad esempio un layout per ogni libro in una raccolta di libri. L'esempio StackWidget ha un solo file di layout degli elementi, widget_item.xml, poiché tutti gli elementi utilizzano lo stesso layout.

Classe AppWidgetProvider per i widget con raccolte

Come per i widget normali, la maggior parte del codice nella AppWidgetProvider sottoclasse in genere si trova in onUpdate(). La principale differenza nell'implementazione di onUpdate() quando crei un widget con raccolte è che devi chiamare setRemoteAdapter(). In questo modo, la visualizzazione di raccolta sa dove recuperare i dati. RemoteViewsService può quindi restituire l'implementazione di RemoteViewsFactory e il widget può pubblicare i dati appropriati. Quando chiami questo metodo, passa un intent che rimanda all'implementazione di RemoteViewsService e all'ID del widget che specifica il widget da aggiornare.

Ad esempio, ecco come l'esempio StackWidget implementa il metodo di callback onUpdate() per impostare RemoteViewsService come adattatore remoto per la raccolta di 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);
}

Persistere i dati

Come descritto in questa pagina, la sottoclasse RemoteViewsService fornisce RemoteViewsFactory utilizzata per popolare la visualizzazione di raccolta remota.

In particolare, esegui questi passaggi:

1. Sottoclasse RemoteViewsService. RemoteViewsService è il servizio tramite il quale un adattatore remoto può richiedere RemoteViews.

2. Nella sottoclasse RemoteViewsService, includi una classe che implementa l'interfaccia RemoteViewsFactory. RemoteViewsFactory è un'interfaccia per un adattatore tra una visualizzazione di raccolta remota, ad esempio ListView, GridView, StackView, e i dati sottostanti per quella visualizzazione. L'implementazione è responsabile della creazione di un oggetto RemoteViews per ogni elemento del set di dati. Questa interfaccia è un wrapper sottile intorno a Adapter.

Non puoi fare affidamento sulla persistenza di una singola istanza del servizio o di tutti i dati che contiene. Non archiviare i dati in RemoteViewsService a meno che non siano statici. Se vuoi che i dati del widget siano persistenti, l'approccio migliore è utilizzare un ContentProvider i cui dati persistono oltre il ciclo di vita del processo. Ad esempio, un widget di un negozio di alimentari può memorizzare lo stato di ogni articolo della lista della spesa in una posizione persistente, ad esempio un database SQL.

Nota: consulta WeatherDataProvider.java per un esempio di codice che mostra come rendere persistenti i dati sottostanti di un widget utilizzando ContentProvider.

Il contenuto principale dell'implementazione di RemoteViewsService è RemoteViewsFactory, descritta nella sezione seguente.

Interfaccia RemoteViewsFactory

La classe personalizzata che implementa l'interfaccia RemoteViewsFactory fornisce al widget i dati per gli elementi della raccolta. Per farlo, combina il file di layout XML dell'elemento del widget con un'origine dati. Questa origine dati può essere qualsiasi cosa, da un database a un semplice array. Nell'esempio StackWidget, l'origine dati è un array di WidgetItems. RemoteViewsFactory funge da adattatore per collegare i dati alla visualizzazione di raccolta remota.

I due metodi più importanti che devi implementare per la tua RemoteViewsFactory sottoclasse sono onCreate() e getViewAt().

Il sistema chiama onCreate() quando crea la factory per la prima volta. È qui che configuri eventuali connessioni o cursori all'origine dati. Ad esempio, l'esempio StackWidget utilizza onCreate() per inizializzare un array di oggetti WidgetItem. Quando il widget è attivo, il sistema accede a questi oggetti utilizzando la loro posizione di indice nell'array e visualizza il testo che contengono.

Di seguito è riportato un estratto dell'implementazione di RemoteViewsFactory dell'esempio StackWidget che mostra le parti del metodo 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 + "!"));
        }
        ...
    }
...

Il metodo RemoteViewsFactory getViewAt() restituisce un oggetto RemoteViews corrispondente ai dati nella position specificata nel set di dati. Di seguito è riportato un estratto dell'implementazione di RemoteViewsFactory dell'esempio 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;
}

Aggiungere un comportamento ai singoli elementi

Le sezioni precedenti mostrano come associare i dati alla raccolta di widget. Ma cosa succede se vuoi aggiungere un comportamento dinamico ai singoli elementi della visualizzazione di raccolta?

Come descritto in Gestire gli eventi con la onUpdate() classe, in genere utilizzi setOnClickPendingIntent() per impostare il comportamento di clic di un oggetto, ad esempio per fare in modo che un pulsante avvii un'Activity. Tuttavia, questo approccio non è consentito per le visualizzazioni secondarie in un singolo elemento di raccolta. Ad esempio, puoi utilizzare setOnClickPendingIntent() per configurare un pulsante globale nel widget di Gmail che avvia l'app, ad esempio, ma non sui singoli elementi dell'elenco.

Per aggiungere un comportamento di clic ai singoli elementi di una raccolta, utilizza invece setOnClickFillInIntent(). Ciò comporta la configurazione di un modello di pending intent per la visualizzazione di raccolta e l'impostazione di un intent di riempimento su ogni elemento della raccolta tramite RemoteViewsFactory.

Questa sezione utilizza l'esempio StackWidget per descrivere come aggiungere un comportamento ai singoli elementi. Nell'esempio StackWidget, se l'utente tocca la visualizzazione in alto, il widget visualizza il messaggio Toast "Touched view n," dove n è l'indice (posizione) della visualizzazione toccata. Ecco come funziona:

• Il StackWidgetProvider, una sottoclasse AppWidgetProvider , crea un pending intent con un'azione personalizzata denominata TOAST_ACTION.

• Quando l'utente tocca una visualizzazione, l'intent viene attivato e trasmette TOAST_ACTION.

• Questa trasmissione viene intercettata dal metodo onReceive() della classe StackWidgetProvider e il widget visualizza il messaggio Toast per la visualizzazione toccata. I dati per gli elementi della raccolta vengono forniti da RemoteViewsFactory tramite RemoteViewsService.

Nota: L'esempio StackWidget utilizza una trasmissione, ma in genere un widget avvia un'attività in uno scenario come questo.

Configurare il modello di pending intent

The StackWidgetProvider (una sottoclasse AppWidgetProvider) configura un intent in attesa. I singoli elementi di una raccolta non possono configurare i propri intent in attesa. Al contrario, la raccolta nel suo complesso configura un modello di intent in attesa e i singoli elementi impostano un intent di riempimento per creare un comportamento univoco elemento per elemento.

Questa classe riceve anche la trasmissione inviata quando l'utente tocca una visualizzazione. Elabora questo evento nel metodo onReceive(). Se l'azione dell'intent è TOAST_ACTION, il widget visualizza un messaggio Toast per la visualizzazione corrente.

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

Impostare l'intent di riempimento

RemoteViewsFactory deve impostare un intent di riempimento su ogni elemento della raccolta. In questo modo è possibile distinguere la singola azione di clic di un determinato elemento. L'intent di riempimento viene quindi combinato con il PendingIntent modello per determinare l'intent finale che viene eseguito quando l'elemento viene toccato.

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

Mantenere aggiornati i dati della raccolta

La Figura 2 illustra il flusso di aggiornamento in un widget che utilizza le raccolte. Mostra come il codice del widget interagisce con RemoteViewsFactory e come puoi attivare gli aggiornamenti:

Figura 2. Interazione con RemoteViewsFactory durante gli aggiornamenti.

I widget che utilizzano le raccolte possono fornire agli utenti contenuti aggiornati. Ad esempio, il widget di Gmail offre agli utenti un'istantanea della loro Posta in arrivo. Per farlo, attiva RemoteViewsFactory e la visualizzazione di raccolta per recuperare e visualizzare i nuovi dati.

Per farlo, utilizza il AppWidgetManager per chiamare il notifyAppWidgetViewDataChanged(). Questa chiamata genera una callback al metodo dell'oggetto RemoteViewsFactory onDataSetChanged(), che ti consente di recuperare eventuali nuovi dati.

Puoi eseguire operazioni a elevato utilizzo di risorse in modo sincrono all'interno della callback onDataSetChanged(). Ti viene garantito che questa chiamata viene completata prima che i metadati o i dati della visualizzazione vengano recuperati da RemoteViewsFactory. Puoi anche eseguire operazioni a elevato utilizzo di risorse all'interno del metodo getViewAt(). Se questa chiamata richiede molto tempo, la visualizzazione di caricamento, specificata dal RemoteViewsFactory oggetto's getLoadingView() metodo, viene visualizzata nella posizione corrispondente della visualizzazione di raccolta fino a quando non viene restituita.

Utilizzare RemoteCollectionItems per trasmettere direttamente una raccolta

Android 12 (livello API 31) aggiunge il setRemoteAdapter(int viewId, RemoteViews.RemoteCollectionItems items) metodo, che consente all'app di trasmettere direttamente una raccolta durante il popolamento di una visualizzazione di raccolta. Se imposti l'adattatore utilizzando questo metodo, non devi implementare RemoteViewsFactory e non devi chiamare notifyAppWidgetViewDataChanged().

Oltre a semplificare il popolamento dell'adattatore, questo approccio elimina anche la latenza per il popolamento di nuovi elementi quando gli utenti scorrono l'elenco verso il basso per visualizzare un nuovo elemento. Questo approccio all'impostazione dell'adattatore è preferibile a condizione che l'insieme di elementi della raccolta sia relativamente piccolo. Tuttavia, ad esempio, questo approccio non funziona bene se la raccolta contiene numerosi Bitmaps passati a setImageViewBitmap.

Se la raccolta non utilizza un insieme costante di layout, ovvero se alcuni elementi sono presenti solo a volte, utilizza setViewTypeCount per specificare il numero massimo di layout univoci che la raccolta può contenere. In questo modo, l'adattatore può essere riutilizzato negli aggiornamenti del widget dell'app.

Di seguito è riportato un esempio di come implementare raccolte RemoteViews semplificate.

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

Nota: quando chiami setViewTypeCount(), passa il numero massimo di ID layout diversi utilizzati da RemoteViews in questa raccolta. In caso contrario, il conteggio dei tipi di visualizzazione viene dedotto dagli elementi forniti e l'adattatore viene ricreato quando viene inviato un aggiornamento che utilizza layout aggiuntivi.