Widżety kolekcji służą do wyświetlania wielu elementów tego samego typu, takich jak kolekcje zdjęć z aplikacji galerii, artykuły z aplikacji z wiadomościami czy wiadomości z aplikacji do komunikacji. Widżety kolekcji zwykle koncentrują się na 2 przypadkach użycia: przeglądaniu kolekcji i otwieraniu elementu kolekcji w widoku szczegółowym. Widżety kolekcji można przewijać w pionie.
Te widżety używają RemoteViewsService do wyświetlania kolekcji opartych na danych zdalnych, np. z mechanizmu dostarczania treści. Widżet prezentuje dane za pomocą jednego z tych typów widoków, które są nazywane widokami kolekcji:
ListView: widok, który wyświetla elementy na liście przewijanej w pionie.
GridView: widok, który wyświetla elementy w dwuwymiarowej przewijanej siatce.
StackView: widok kart ułożonych jedna na drugiej, podobny do wizytownika, w którym użytkownik może przesunąć pierwszą kartę w górę lub w dół, aby zobaczyć odpowiednio poprzednią lub następną kartę.
AdapterViewFlipper: obsługiwany przez adapter element ViewAnimator, który animuje przejścia między co najmniej 2 widokami. W danym momencie wyświetlane jest tylko jedno dziecko.
Widoki kolekcji wyświetlają kolekcje oparte na danych zdalnych, dlatego używają obiektu Adapter do powiązania interfejsu użytkownika z danymi. Adapter wiąże poszczególne elementy ze zbioru danych z poszczególnymi obiektami View.
A ponieważ te widoki kolekcji są obsługiwane przez adaptery, platforma Androida musi zawierać dodatkową architekturę, aby umożliwić ich używanie w widżetach. W kontekście widżetu element Adapter jest zastępowany przez RemoteViewsFactory, który jest cienką otoczką wokół interfejsu Adapter. Gdy zostanie wysłane żądanie dotyczące konkretnego elementu w kolekcji, RemoteViewsFactory tworzy i zwraca element kolekcji jako obiekt RemoteViews. Aby uwzględnić widok kolekcji w widżecie, zaimplementuj RemoteViewsService i RemoteViewsFactory.
RemoteViewsService to usługa, która umożliwia zdalnemu adapterowi wysyłanie żądań dotyczących obiektów RemoteViews. RemoteViewsFactory to interfejs adaptera między widokiem kolekcji, takim jak ListView, GridView i StackView, a danymi bazowymi tego widoku. Oto przykład powtarzalnego kodu z StackWidgetprzykładowej aplikacji, który implementuje tę usługę i interfejs:
class StackWidgetService : RemoteViewsService() { override fun onGetViewFactory(intent: Intent): RemoteViewsFactory = 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. }
Przykładowa aplikacja
Fragmenty kodu w tej sekcji również pochodzą z przykładowej aplikacji StackWidget:

StackWidget.Ten przykład składa się ze stosu 10 widoków, które wyświetlają wartości od 0 do 9. Przykładowy widżet ma te podstawowe zachowania:
Użytkownik może przesunąć widok z góry w widżecie w pionie, aby wyświetlić następny lub poprzedni widok. Jest to wbudowane działanie
StackView.Bez interakcji użytkownika widżet automatycznie przechodzi przez widoki w sekwencji, jak pokaz slajdów. Wynika to z ustawienia
android:autoAdvanceViewId="@id/stack_view"w plikures/xml/stackwidgetinfo.xml. To ustawienie dotyczy identyfikatora widoku, który w tym przypadku jest identyfikatorem widoku stosu.Jeśli użytkownik dotknie widoku z góry, widżet wyświetli komunikat
Toast„Dotknięto widoku n”, gdzie n to indeks (pozycja) dotkniętego widoku. Więcej informacji o implementowaniu zachowań znajdziesz w sekcji Dodawanie zachowania do poszczególnych elementów.
Wdrażanie widżetów z kolekcjami
Aby wdrożyć widżet z kolekcjami, wykonaj procedurę wdrażania dowolnego widżetu, a następnie wykonaj kilka dodatkowych czynności: zmodyfikuj plik manifestu, dodaj widok kolekcji do układu widżetu i zmodyfikuj podklasę AppWidgetProvider.
Plik manifestu widżetów z kolekcjami
Oprócz wymagań wymienionych w sekcji Deklarowanie widżetu w pliku manifestu musisz umożliwić widżetom z kolekcjami powiązanie z RemoteViewsService. Aby to zrobić, zadeklaruj usługę w pliku manifestu z uprawnieniem BIND_REMOTEVIEWS.
Zapobiega to swobodnemu dostępowi innych aplikacji do danych widżetu.
Na przykład podczas tworzenia widżetu, który używa RemoteViewsService do wypełniania widoku kolekcji, wpis w pliku manifestu może wyglądać tak:
<service android:name="MyWidgetService"
android:permission="android.permission.BIND_REMOTEVIEWS" />
W tym przykładzie android:name="MyWidgetService" odnosi się do podklasy RemoteViewsService.
Układ widżetów z kolekcjami
Głównym wymaganiem dotyczącym pliku XML układu widżetu jest to, aby zawierał on jeden z widoków kolekcji: ListView, GridView, StackView lub AdapterViewFlipper. Oto plik widget_layout.xml dla próbki 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>
Pamiętaj, że puste widoki muszą być elementami równorzędnymi widoku kolekcji, dla którego pusty widok reprezentuje pusty stan.
Oprócz pliku układu dla całego widżetu utwórz kolejny plik układu, który definiuje układ każdego elementu w kolekcji – na przykład układ każdej książki w kolekcji książek. Przykładowa aplikacja StackWidget ma tylko 1 plik układu elementu, widget_item.xml, ponieważ wszystkie elementy używają tego samego układu.
Klasa AppWidgetProvider dla widżetów z kolekcjami
Podobnie jak w przypadku zwykłych widżetów większość kodu w podklasie AppWidgetProvider zwykle trafia do onUpdate().
Główna różnica w implementacji onUpdate() podczas tworzenia widżetu z kolekcjami polega na tym, że musisz wywołać setRemoteAdapter().
Dzięki temu widok kolekcji wie, skąd ma pobierać dane.
RemoteViewsService może wtedy zwrócić Twoją implementację RemoteViewsFactory, a widżet może wyświetlać odpowiednie dane. Gdy wywołujesz tę metodę, przekaż intencję wskazującą implementację RemoteViewsService i identyfikator widżetu, który określa widżet do zaktualizowania.
Oto przykład, jak w aplikacji StackWidget zaimplementowano metodę wywołania zwrotnego onUpdate(), aby ustawić RemoteViewsService jako adapter zdalny dla kolekcji widżetów:
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) }
Utrwalanie danych
Jak opisano na tej stronie, podklasa RemoteViewsService udostępnia RemoteViewsFactory używany do wypełniania widoku kolekcji zdalnej.
W tym celu:
Podklasa
RemoteViewsService.RemoteViewsServiceto usługa, za pomocą której adapter zdalny może poprosić oRemoteViews.W podklasie
RemoteViewsServiceuwzględnij klasę, która implementuje interfejsRemoteViewsFactory.RemoteViewsFactoryto interfejs adaptera między widokiem kolekcji zdalnej (np.ListView,GridView,StackView) a danymi bazowymi tego widoku. Twoja implementacja odpowiada za utworzenie obiektuRemoteViewsdla każdego elementu w zbiorze danych. Ten interfejs jest cienką otoczką wokółAdapter.
Nie możesz polegać na pojedynczej instancji usługi ani na żadnych danych, które zawiera, aby zapewnić trwałość. Nie przechowuj danych w RemoteViewsService, chyba że są statyczne. Jeśli chcesz, aby dane widżetu były zachowywane, najlepiej użyć ContentProvider, którego dane są zachowywane po zakończeniu cyklu życia procesu. Na przykład widżet sklepu spożywczego może przechowywać stan każdego elementu listy zakupów w trwałej lokalizacji, takiej jak baza danych SQL.
Główną zawartością implementacji RemoteViewsService jest RemoteViewsFactory, który opisujemy w następnej sekcji.
Interfejs RemoteViewsFactory
Twoja klasa niestandardowa, która implementuje interfejs RemoteViewsFactory, dostarcza widżetowi dane dotyczące elementów w jego kolekcji. W tym celu łączy plik układu XML elementu widżetu ze źródłem danych. Źródłem danych może być dowolny element, od bazy danych po tablicę. W przykładowym kodzie StackWidget źródłem danych jest tablica WidgetItems. RemoteViewsFactory działa jako adapter, który łączy dane z widokiem kolekcji zdalnej.
Dwie najważniejsze metody, które musisz zaimplementować w podklasie RemoteViewsFactory, to onCreate() i getViewAt().
System wywołuje metodę onCreate() podczas tworzenia fabryki po raz pierwszy.
W tym miejscu konfigurujesz połączenia lub kursory ze źródłem danych. Na przykład w przykładzie StackWidget użyto onCreate() do zainicjowania tablicy obiektów WidgetItem. Gdy widżet jest aktywny, system uzyskuje dostęp do tych obiektów, używając ich pozycji indeksu w tablicy, i wyświetla zawarty w nich tekst.
Oto fragment implementacji RemoteViewsFactory w przykładzie StackWidget, który pokazuje części metody onCreate():
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!") } } }
Metoda RemoteViewsFactory getViewAt() zwraca obiekt RemoteViews odpowiadający danym w określonym position w zbiorze danych. Oto fragment implementacji RemoteViewsFactory w przykładzie StackWidget:
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) } }
Dodawanie zachowania do poszczególnych elementów
W poprzednich sekcjach pokazaliśmy, jak powiązać dane z kolekcją widżetów. Co jednak, jeśli chcesz dodać dynamiczne zachowanie do poszczególnych elementów w widoku kolekcji?
Zgodnie z opisem w artykule Obsługa zdarzeń za pomocą klasy onUpdate() zwykle używasz setOnClickPendingIntent(), aby ustawić zachowanie obiektu po kliknięciu, np. aby przycisk uruchamiał Activity. To podejście nie jest jednak dozwolone w przypadku widoków dziecka w poszczególnych elementach kolekcji.
Możesz na przykład użyć setOnClickPendingIntent(), aby skonfigurować przycisk globalny w widżecie Gmaila, który uruchamia aplikację, ale nie na poszczególnych elementach listy.
Aby dodać działanie po kliknięciu do poszczególnych elementów w kolekcji, użyj setOnClickFillInIntent(). Skonfiguruj szablon intencji oczekującej dla widoku kolekcji i ustaw intencję wypełnienia dla każdego elementu w kolekcji za pomocą RemoteViewsFactory.
W tej sekcji używamy przykładu StackWidget, aby opisać, jak dodać zachowanie do poszczególnych elementów. W przykładzie StackWidget, jeśli użytkownik dotknie widoku u góry, widżet wyświetli komunikat Toast „Dotknięto widoku n”, gdzie n to indeks (pozycja) dotkniętego widoku. Proces przebiega następująco:
Klasa
StackWidgetProvider, która jest podklasąAppWidgetProvider, tworzy intencję oczekującą z działaniem niestandardowym o nazwieTOAST_ACTION.Gdy użytkownik dotknie widoku, intencja zostanie uruchomiona i wyśle komunikat
TOAST_ACTION.Ta transmisja jest przechwytywana przez metodę
onReceive()klasyStackWidgetProvider, a widżet wyświetla komunikatToastdla dotkniętego widoku. Dane dotyczące elementów kolekcji są dostarczane przezRemoteViewsFactoryza pomocąRemoteViewsService.
Konfigurowanie szablonu intencji oczekującej
StackWidgetProvider (podklasa AppWidgetProvider) konfiguruje intencję oczekującą. Poszczególne elementy kolekcji nie mogą konfigurować własnych intencji oczekujących. Zamiast tego kolekcja jako całość konfiguruje szablon intencji oczekującej, a poszczególne elementy ustawiają intencję wypełnienia, aby utworzyć unikalne zachowanie dla każdego elementu.
Ta klasa odbiera też transmisję wysyłaną, gdy użytkownik dotknie widoku. Przetwarza to zdarzenie w metodzie onReceive(). Jeśli działanie intencji to TOAST_ACTION, widżet wyświetla komunikat Toast dla bieżącego widoku.
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)) // The template must be mutable, because each item fills in its // own extras through setOnClickFillInIntent(). PendingIntent.getBroadcast( context, 0, this, PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_MUTABLE ) } rv.setPendingIntentTemplate(R.id.stack_view, toastPendingIntent) appWidgetManager.updateAppWidget(appWidgetId, rv) } super.onUpdate(context, appWidgetManager, appWidgetIds) } }
Ustawianie intencji uzupełniania
Twoja aplikacja RemoteViewsFactory musi ustawić intencję wypełnienia dla każdego elementu w kolekcji. Dzięki temu można odróżnić poszczególne działania po kliknięciu danego elementu. Intencja wypełnienia jest następnie łączona z szablonem PendingIntent, aby określić ostateczną intencję, która jest wykonywana po kliknięciu elementu.
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) // ... } } // ... }
Aktualizowanie danych kolekcji
Rysunek 2 przedstawia proces aktualizacji w widżecie, który korzysta z kolekcji. Pokazuje, jak kod widżetu wchodzi w interakcję z RemoteViewsFactory i jak możesz aktywować aktualizacje:
RemoteViewsFactory podczas aktualizacji.Widżety, które korzystają z kolekcji, mogą dostarczać użytkownikom aktualne treści. Na przykład widżet Gmaila wyświetla użytkownikom podgląd skrzynki odbiorczej. Aby to umożliwić, aktywuj RemoteViewsFactory i widok kolekcji, aby pobrać i wyświetlić nowe dane.
Aby to zrobić, użyj AppWidgetManager, aby wywołać notifyAppWidgetViewDataChanged(). To wywołanie powoduje wywołanie zwrotne metody onDataSetChanged() obiektu RemoteViewsFactory, co umożliwia pobranie nowych danych.
Operacje wymagające dużej mocy obliczeniowej możesz wykonywać synchronicznie w ramach wywołania zwrotnego onDataSetChanged(). To wywołanie kończy się przed pobraniem metadanych lub danych widoku z RemoteViewsFactory. W metodzie getViewAt() możesz też wykonywać operacje wymagające dużej mocy obliczeniowej. Jeśli to wywołanie trwa długo, widok wczytywania określony przez metodę getLoadingView() obiektu RemoteViewsFactory jest wyświetlany w odpowiedniej pozycji widoku kolekcji, dopóki nie zostanie zwrócony.
Używanie RemoteCollectionItems do bezpośredniego przekazywania kolekcji
W Androidzie 12 (API na poziomie 31) dodano metodę setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items), która umożliwia aplikacji przekazywanie kolekcji bezpośrednio podczas wypełniania widoku kolekcji. Jeśli ustawisz adapter za pomocą tej metody, nie musisz implementować interfejsu RemoteViewsFactory ani wywoływać metody notifyAppWidgetViewDataChanged().
Oprócz ułatwienia wypełniania adaptera to podejście eliminuje też opóźnienia związane z wypełnianiem nowych elementów, gdy użytkownicy przewijają listę, aby wyświetlić nowy element. To podejście do ustawiania adaptera jest preferowane, o ile zbiór elementów kolekcji jest stosunkowo mały. To podejście nie sprawdza się jednak, jeśli kolekcja zawiera wiele obiektów Bitmaps przekazywanych do setImageViewBitmap.
Jeśli kolekcja nie używa stałego zestawu układów, czyli niektóre elementy są obecne tylko czasami, użyj setViewTypeCount, aby określić maksymalną liczbę unikalnych układów, które może zawierać kolekcja. Dzięki temu adapter może być używany wielokrotnie podczas aktualizacji widżetu aplikacji.
Oto przykład implementacji uproszczonych kolekcji RemoteViews.
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() )