Diese Seite wurde von der Cloud Translation API übersetzt.

Sammlungs-Widgets verwenden

Sammlungs-Widgets sind auf die Anzeige vieler Elemente desselben Typs spezialisiert, z. B. Bildersammlungen aus einer Galerie-App, Artikel aus einer Nachrichten-App oder Nachrichten aus einer Kommunikations-App. Sammlungs-Widgets konzentrieren sich in der Regel auf zwei Anwendungsfälle: das Durchsuchen der Sammlung und das Öffnen eines Elements der Sammlung in der Detailansicht. Sammlungs-Widgets können vertikal scrollen.

In diesen Widgets wird RemoteViewsService verwendet, um Sammlungen anzuzeigen, die von Remote-Daten unterstützt werden, z. B. von einem Inhaltsanbieter. Im Widget werden die Daten in einer der folgenden Ansichten dargestellt, die als Sammlungsansichten bezeichnet werden:

ListView: Eine Ansicht, in der Elemente in einer vertikal scrollbaren Liste angezeigt werden.
GridView: Eine Ansicht, in der Elemente in einem zweidimensionalen scrollbaren Raster angezeigt werden.
StackView: Eine gestapelte Kartenansicht, ähnlich wie ein Ausweisverzeichnis, bei der der Nutzer die Vorderseite der Karte nach oben oder unten wischen kann, um die vorherige oder nächste Karte aufzurufen.
AdapterViewFlipper: Ein einfacher, adaptergestützter ViewAnimator, der zwischen zwei oder mehr Ansichten animiert. Es wird jeweils nur ein Kind angezeigt.

Da diese Sammlungsansichten Sammlungen mit Remote-Daten anzeigen, wird ein Adapter verwendet, um die Benutzeroberfläche an die Daten zu binden. Ein Adapter bindet einzelne Elemente aus einem Datensatz an einzelne View-Objekte.

Da diese Sammlungsansichten von Adaptern unterstützt werden, muss das Android-Framework eine zusätzliche Architektur enthalten, um ihre Verwendung in Widgets zu unterstützen. Im Kontext eines Widgets wird Adapter durch RemoteViewsFactory ersetzt, eine dünne Ummantelung der Adapter-Schnittstelle. Wenn ein bestimmter Artikel in der Sammlung angefordert wird, erstellt und gibt RemoteViewsFactory den Artikel für die Sammlung als RemoteViews-Objekt zurück. Wenn Sie eine Sammlungsdatenansicht in Ihr Widget aufnehmen möchten, implementieren Sie RemoteViewsService und RemoteViewsFactory.

RemoteViewsService ist ein Dienst, mit dem ein Remote-Adapter RemoteViews-Objekte anfordern kann. RemoteViewsFactory ist eine Schnittstelle für einen Adapter zwischen einer Sammlungsdatenansicht wie ListView, GridView und StackView und den zugrunde liegenden Daten für diese Ansicht. Hier ein Beispiel für den Boilerplate-Code aus dem Beispiel StackWidget zum Implementieren dieses Dienstes und dieser Schnittstelle:

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.

}

Beispielanwendung

Die Codeausschnitte in diesem Abschnitt stammen ebenfalls aus dem StackWidget-Beispiel:

Dieses Beispiel besteht aus einem Stapel von zehn Ansichten, in denen die Werte 0 bis 9 angezeigt werden. Das Beispiel-Widget hat folgende primäre Verhaltensweisen:

Der Nutzer kann die Ansicht oben im Widget vertikal wischen, um die nächste oder vorherige Ansicht aufzurufen. Das ist ein integriertes StackView-Verhalten.
Ohne Nutzerinteraktion geht das Widget wie bei einer Bildschirmpräsentation automatisch der Reihe nach durch die Ansichten. Das liegt an der Einstellung android:autoAdvanceViewId="@id/stack_view" in der Datei res/xml/stackwidgetinfo.xml. Diese Einstellung gilt für die Datenansichts-ID, in diesem Fall die Datenansichts-ID der Stapelansicht.
Wenn der Nutzer die obere Ansicht berührt, wird im Widget die Meldung Toast „Angetippte Ansicht n“ angezeigt, wobei n der Index (die Position) der angetippten Ansicht ist. Weitere Informationen zur Implementierung von Verhaltensweisen finden Sie im Abschnitt Einzelnen Elementen ein Verhalten hinzufügen.

Widgets mit Sammlungen implementieren

Wenn Sie ein Widget mit Sammlungen implementieren möchten, folgen Sie der Anleitung zur Implementierung eines Widgets und führen Sie dann die folgenden zusätzlichen Schritte aus: Ändern Sie das Manifest, fügen Sie dem Widget-Layout eine Sammlungsdatenansicht hinzu und ändern Sie die AppWidgetProvider-Unterklasse.

Manifest für Widgets mit Sammlungen

Zusätzlich zu den unter Widget im Manifest deklarieren aufgeführten Anforderungen müssen Widgets mit Sammlungen an Ihre RemoteViewsService gebunden werden können. Deklarieren Sie dazu den Dienst in Ihrer Manifestdatei mit der Berechtigung BIND_REMOTEVIEWS. So wird verhindert, dass andere Apps frei auf die Daten Ihres Widgets zugreifen können.

Wenn Sie beispielsweise ein Widget erstellen, das RemoteViewsService zum Ausfüllen einer Sammlungsansicht verwendet, könnte der Manifesteintrag so aussehen:

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

In diesem Beispiel bezieht sich android:name="MyWidgetService" auf die untergeordnete Klasse von RemoteViewsService.

Layout für Widgets mit Sammlungen

Die wichtigste Anforderung an die XML-Datei des Widget-Layouts ist, dass sie eine der Sammlungsansichten enthält: ListView, GridView, StackView oder AdapterViewFlipper. Hier ist die widget_layout.xml-Datei für das Beispiel StackWidget:

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

Leere Ansichten müssen Geschwister der Sammlungsdatenansicht sein, für die die leere Ansicht den leeren Status darstellt.

Erstellen Sie zusätzlich zur Layoutdatei für das gesamte Widget eine weitere Layoutdatei, in der das Layout für jeden Artikel in der Sammlung definiert wird, z. B. ein Layout für jedes Buch in einer Buchsammlung. Das StackWidget-Beispiel enthält nur eine Artikel-Layoutdatei, widget_item.xml, da alle Artikel dasselbe Layout verwenden.

AppWidgetProvider-Klasse für Widgets mit Sammlungen

Wie bei normalen Widgets besteht der Großteil des Codes in der abgeleiteten AppWidgetProvider-Klasse normalerweise in onUpdate(). Der Hauptunterschied bei der Implementierung von onUpdate() beim Erstellen eines Widgets mit Sammlungen besteht darin, dass Sie setRemoteAdapter() aufrufen müssen. So wird der Sammlungsdatenansicht mitgeteilt, woher sie ihre Daten abrufen soll. Der RemoteViewsService kann dann Ihre Implementierung von RemoteViewsFactory zurückgeben und das Widget kann die entsprechenden Daten bereitstellen. Wenn Sie diese Methode aufrufen, übergeben Sie einen Intent, der auf Ihre Implementierung von RemoteViewsService und die Widget-ID verweist, die das zu aktualisierende Widget angibt.

Im Beispiel StackWidget wird die onUpdate()-Callback-Methode beispielsweise so implementiert, dass RemoteViewsService als Remote-Adapter für die Widget-Sammlung festgelegt wird:

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

Daten beibehalten

Wie auf dieser Seite beschrieben, stellt die RemoteViewsService-Unterklasse die RemoteViewsFactory bereit, die zum Ausfüllen der Ansicht der Remote-Sammlung verwendet wird.

Gehen Sie dazu so vor:

Abgeleitete Klasse RemoteViewsService. RemoteViewsService ist der Dienst, über den ein Remote-Adapter RemoteViews anfordern kann.
Fügen Sie in Ihrer RemoteViewsService-Unterklasse eine Klasse ein, die die Schnittstelle RemoteViewsFactory implementiert. RemoteViewsFactory ist eine Schnittstelle für einen Adapter zwischen einer Remote-Sammlungsansicht (z. B. ListView, GridView, StackView) und den zugrunde liegenden Daten für diese Ansicht. In Ihrer Implementierung müssen Sie für jedes Element im Datensatz ein RemoteViews-Objekt erstellen. Diese Schnittstelle ist ein Thin Wrapper um Adapter.

Sie können nicht davon ausgehen, dass eine einzelne Instanz Ihres Dienstes oder die darin enthaltenen Daten dauerhaft verfügbar sind. Speichern Sie nur statische Daten in RemoteViewsService. Wenn Sie möchten, dass die Daten Ihres Widgets beibehalten werden, sollten Sie eine ContentProvider verwenden, deren Daten über den Prozesslebenszyklus hinaus beibehalten werden. Ein Lebensmittelgeschäft-Widget kann beispielsweise den Status jedes Einkaufslistenelements an einem nichtflüchtigen Speicherort wie einer SQL-Datenbank speichern.

Der Hauptinhalt der RemoteViewsService-Implementierung ist RemoteViewsFactory, das im folgenden Abschnitt beschrieben wird.

RemoteViewsFactory-Schnittstelle

Ihre benutzerdefinierte Klasse, die die RemoteViewsFactory-Schnittstelle implementiert, liefert dem Widget die Daten für die Elemente in der Sammlung. Dazu wird die XML-Layoutdatei des Widgets mit einer Datenquelle kombiniert. Diese Datenquelle kann eine Datenbank oder ein einfaches Array sein. Im Beispiel StackWidget ist die Datenquelle ein Array von WidgetItems. RemoteViewsFactory fungiert als Adapter, mit dem die Daten mit der Remote-Sammlungsansicht verknüpft werden.

Die beiden wichtigsten Methoden, die Sie für Ihre RemoteViewsFactory-Unterklasse implementieren müssen, sind onCreate() und getViewAt().

Beim erstmaligen Erstellen Ihrer Factory ruft das System onCreate() auf. Hier richten Sie Verbindungen oder Cursor zu Ihrer Datenquelle ein. Im Beispiel StackWidget wird beispielsweise onCreate() verwendet, um ein Array von WidgetItem-Objekten zu initialisieren. Wenn Ihr Widget aktiv ist, greift das System über die Indexposition im Array auf diese Objekte zu und zeigt den enthaltenen Text an.

Hier ein Auszug aus der RemoteViewsFactory-Implementierung der StackWidget-Beispieldatei, der Teile der onCreate()-Methode zeigt:

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 + "!"));
        }
        ...
    }
...

Die Methode RemoteViewsFactory getViewAt() gibt ein RemoteViews-Objekt zurück, das den Daten am angegebenen position im Datensatz entspricht. Hier ein Auszug aus der RemoteViewsFactory-Implementierung der StackWidget-Beispieldatei:

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

Einzelnen Elementen ein Verhalten hinzufügen

In den vorherigen Abschnitten wurde gezeigt, wie Sie Ihre Daten an Ihre Widget-Sammlung binden. Was aber, wenn Sie den einzelnen Elementen in Ihrer Sammlungsansicht dynamisches Verhalten hinzufügen möchten?

Wie im Abschnitt Ereignisse mit der Klasse onUpdate() verarbeiten beschrieben, wird setOnClickPendingIntent() normalerweise verwendet, um das Klickverhalten eines Objekts festzulegen, z. B. um eine Schaltfläche zu aktivieren, die eine Activity startet. Dieser Ansatz ist jedoch für untergeordnete Ansichten in einem einzelnen Sammlungselement nicht zulässig. Mit setOnClickPendingIntent() können Sie beispielsweise eine globale Schaltfläche im Gmail-Widget einrichten, die die App startet, aber nicht auf den einzelnen Listenelementen.

Wenn Sie einzelnen Elementen in einer Sammlung ein Klickverhalten hinzufügen möchten, verwenden Sie stattdessen setOnClickFillInIntent(). Dazu müssen Sie eine ausstehende Intent-Vorlage für die Sammlungsansicht einrichten und dann über RemoteViewsFactory einen Fill-In-Intent für jedes Element in der Sammlung festlegen.

In diesem Abschnitt wird anhand des StackWidget-Beispiels beschrieben, wie Sie einzelnen Elementen Verhalten hinzufügen. Wenn der Nutzer im Beispiel StackWidget die Draufsicht berührt, zeigt das Widget die Toast-Meldung „Berührte Ansicht n“ an, wobei n der Index (Position) der Berührungsansicht ist. Das geht so:

Die StackWidgetProvider ist eine Unterklasse von AppWidgetProvider und erstellt einen ausstehenden Intent mit einer benutzerdefinierten Aktion namens TOAST_ACTION.
Wenn der Nutzer eine Ansicht berührt, wird die Intent ausgelöst und TOAST_ACTION gesendet.
Diese Übertragung wird von der Methode onReceive() der Klasse StackWidgetProvider abgefangen und das Widget zeigt die Toast-Nachricht für die angetippte Ansicht an. Die Daten für die Sammlungselemente werden vom RemoteViewsFactory über den RemoteViewsService bereitgestellt.

Vorlage für ausstehende Intents einrichten

StackWidgetProvider (eine abgeleitete AppWidgetProvider-Klasse) richtet einen ausstehenden Intent ein. Einzelne Elemente einer Sammlung können keine eigenen ausstehenden Intents einrichten. Stattdessen wird für die Sammlung als Ganzes eine Vorlage für ausstehende Intents eingerichtet und für die einzelnen Elemente ein Intent zum Ausfüllen festgelegt, um für jedes Element ein individuelles Verhalten zu erstellen.

Diese Klasse empfängt auch die Übertragung, die gesendet wird, wenn der Nutzer eine Ansicht berührt. Dieses Ereignis wird in der Methode onReceive() verarbeitet. Wenn die Aktion des Intents TOAST_ACTION lautet, zeigt das Widget eine Toast-Meldung für die aktuelle Ansicht an.

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

Intent für das Ausfüllen festlegen

Für jedes Element in der Sammlung muss in Ihrem RemoteViewsFactory ein Intent zum Ausfüllen festgelegt werden. So lässt sich die jeweilige Aktion nach dem Klicken auf ein bestimmtes Element unterscheiden. Der Intent zum Ausfüllen wird dann mit der PendingIntent-Vorlage kombiniert, um den endgültigen Intent zu ermitteln, der ausgeführt wird, wenn auf das Element getippt wird.

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

Daten der Sammlung auf dem neuesten Stand halten

Abbildung 2 zeigt den Aktualisierungsablauf in einem Widget, das Sammlungen verwendet. Sie zeigt, wie der Widgetcode mit dem RemoteViewsFactory interagiert und wie Sie Aktualisierungen auslösen können:

**Abbildung 2**: Interaktion mit `RemoteViewsFactory` während Updates

Widgets, die Sammlungen verwenden, können Nutzern aktuelle Inhalte bieten. Das Gmail-Widget bietet Nutzern beispielsweise einen Überblick über ihren Posteingang. Damit das möglich ist, müssen Sie Ihre RemoteViewsFactory- und Sammlungsansicht so konfigurieren, dass neue Daten abgerufen und angezeigt werden.

Verwenden Sie dazu AppWidgetManager, um notifyAppWidgetViewDataChanged() aufzurufen. Dieser Aufruf führt zu einem Rückruf an die Methode onDataSetChanged() Ihres RemoteViewsFactory-Objekts, mit der Sie neue Daten abrufen können.

Sie können verarbeitungsintensive Vorgänge synchron im onDataSetChanged()-Callback ausführen. Dieser Aufruf wird garantiert abgeschlossen, bevor die Metadaten oder Daten der Datenansicht aus der RemoteViewsFactory abgerufen werden. Sie können auch verarbeitungsintensive Vorgänge innerhalb der getViewAt()-Methode ausführen. Wenn dieser Aufruf lange dauert, wird die Ladeansicht, die durch die Methode getLoadingView() des RemoteViewsFactory-Objekts angegeben wird, an der entsprechenden Position der Sammlungsansicht angezeigt, bis die Daten zurückgegeben werden.

Mit RemoteCollectionItems eine Sammlung direkt übergeben

Mit Android 12 (API-Level 31) wird die Methode setRemoteAdapter(int viewId, RemoteViews.RemoteCollectionItems items) hinzugefügt. Damit kann Ihre App eine Sammlung direkt übergeben, wenn eine Sammlungsdatenansicht ausgefüllt wird. Wenn Sie Ihren Adapter mit dieser Methode einrichten, müssen Sie weder RemoteViewsFactory implementieren noch notifyAppWidgetViewDataChanged() aufrufen.

Dieser Ansatz erleichtert nicht nur das Ausfüllen Ihres Adapters, sondern beseitigt auch die Latenz beim Ausfüllen neuer Elemente, wenn Nutzer in der Liste nach unten scrollen, um ein neues Element zu sehen. Dieser Ansatz ist vorzuziehen, solange die Anzahl der Sammlungselemente relativ gering ist. Dieser Ansatz funktioniert jedoch beispielsweise nicht gut, wenn Ihre Sammlung zahlreiche Bitmaps enthält, die an setImageViewBitmap übergeben werden.

Wenn für die Sammlung nicht immer dieselben Layouts verwendet werden, also einige Elemente nur manchmal vorhanden sind, geben Sie mit setViewTypeCount die maximale Anzahl der eindeutigen Layouts an, die die Sammlung enthalten kann. So kann der Adapter bei Updates Ihres App-Widgets wiederverwendet werden.

Hier ein Beispiel für die Implementierung von vereinfachten RemoteViews-Sammlungen.

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