Widżety kolekcji specjalizują się w wyświetlaniu wielu elementów tego samego typu, takich jak kolekcje zdjęć z aplikacji galerii, artykuły z aplikacji z wiadomości czy wiadomości z aplikacji do komunikacji. Widżety kolekcji zwykle skupiają się na 2 użyciach: przeglądaniu kolekcji i otwieraniu elementu kolekcji w widoku szczegółowym. Widżety kolekcji można przewijać w pionie.
Wykorzystują one
RemoteViewsService
do wyświetlenia
kolekcje oparte na danych zdalnych, takich jak zawartość
usługodawcy. Widget przedstawia dane za pomocą jednego z tych typów widoku, które są nazywane widokami kolekcji:
ListView
- Widok, w którym elementy są w przewijaną w pionie.
GridView
- Widok, w którym elementy są w dwuwymiarową siatkę przewijania.
StackView
- Widok ułożonych kart, podobny do kartelokardu, w którym użytkownik może przesuwać kartę w górę lub w dół, aby wyświetlić poprzednią lub następną kartę.
AdapterViewFlipper
- Prosty adapter
ViewAnimator
, który animuje przejście między co najmniej 2 widokami. Wyświetlane jest tylko jedno dziecko naraz.
Te widoki kolekcji wyświetlają kolekcje oparte na danych zdalnych,
używają Adapter
do powiązania użytkownika,
do swoich danych. Element Adapter
łączy poszczególne elementy z zestawu danych z poszczególnymi obiektami View
.
Ponieważ te widoki kolekcji są oparte na adapterach, platforma Androida
muszą uwzględniać dodatkową architekturę, która obsługuje ich użycie w widżetach. W kontekście widżetu element Adapter
jest zastępowany przez element RemoteViewsFactory
, który jest cienką osłonką interfejsu Adapter
. W przypadku prośby o
określony element w kolekcji, RemoteViewsFactory
tworzy i zwraca
jako element kolekcji
RemoteViews
. Aby uwzględnić widok kolekcji w widżecie, zastosuj elementy RemoteViewsService
i RemoteViewsFactory
.
RemoteViewsService
to usługa, która umożliwia zdałemu adapterowi żądanie obiektów RemoteViews
. RemoteViewsFactory
to interfejs adaptera
między widokiem kolekcji, takim jak ListView
, GridView
czy
StackView
– oraz dane bazowe dla tego widoku. Oto przykładowy kod z pliku StackWidget
, który służy do implementacji tej usługi i interfejsu:
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. }
Przykładowa aplikacja
Fragmenty kodu w tej sekcji pochodzą też z przykładu StackWidget
:
Ten przykład składa się z 10 widoków, które wyświetlają wartości od 0 do 9. Przykładowy widżet ma te podstawowe funkcje:
Użytkownik może przesunąć widok w górnej części widżetu w pionie, aby wyświetlić następny lub poprzedni widok. Jest to wbudowane działanie
StackView
.Bez interakcji ze strony użytkownika widżet automatycznie przechodzi wyświetlane w sekwencji, tak jak w przypadku pokazu slajdów. Wynika to z ustawienia
android:autoAdvanceViewId="@id/stack_view"
w plikures/xml/stackwidgetinfo.xml
. To ustawienie dotyczy identyfikatora widoku, którym w tym przypadku jest identyfikator widoku widoku stosu.Jeśli użytkownik dotknie górnego widoku, widżet wyświetli komunikat
Toast
„Dotknięty widok n”, gdzie n to indeks (pozycja) dotkniętego widoku. Więcej informacji o wdrażaniu zachowań znajdziesz w sekcji Dodawanie zachowań do poszczególnych elementów.
Implementowanie widżetów z kolekcjami
Aby wdrożyć widżet z kolekcjami, wykonaj procedurę wdrażania dowolnego widżetu, a potem 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 deklaracji widżetu w pliku manifestu musisz umożliwić wiązanie widżetów z kolekcjami z Twoim RemoteViewsService
. Aby to zrobić, zadeklaruj parametr
usługa z uprawnieniami w pliku manifestu
BIND_REMOTEVIEWS
Dzięki temu inne aplikacje nie będą miały swobodnego dostępu do danych widżetu.
Jeśli na przykład tworzysz widżet, który korzysta z funkcji RemoteViewsService
do wypełniania
kolekcja, 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 jedną z opcji widoku kolekcji: ListView
, GridView
, StackView
lub AdapterViewFlipper
. Oto plik widget_layout.xml
dla
StackWidget
przykład:
<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ć równorzędne z widokiem kolekcji, dla którego pusty widok oznacza pusty stan.
Oprócz pliku układu dla całego widżetu utwórz jeszcze jeden plik układu, który definiuje układ każdego elementu w kolekcji, np. układ każdej książki w kolekcji książek. Plik StackWidget
zawiera tylko jeden 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
znajduje się zazwyczaj w pliku onUpdate()
.
Główna różnica w implementacji elementu onUpdate()
, gdy tworzysz
widżet z kolekcjami jest taki, że musisz wywołać
setRemoteAdapter()
Informuje on widok kolekcji, skąd może pobrać dane.
RemoteViewsService
może wtedy zwrócić implementację funkcji RemoteViewsFactory
, a widżet może wyświetlić odpowiednie dane. Podczas wywoływania tej metody prześlij intencję wskazującą implementację funkcji RemoteViewsService
oraz identyfikator widżetu określający widżet do zaktualizowania.
Tak na przykład oto, jak w przykładzie StackWidget
implementuje się onUpdate()
wywołania zwrotnego, by ustawić RemoteViewsService
jako zdalną adapter dla
kolekcja widżetów:
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); }
Zapisz dane
Jak opisano na tej stronie, podklasa RemoteViewsService
udostępnia RemoteViewsFactory
używane do wypełniania widoku zdalnej kolekcji.
W szczególności wykonaj te czynności:
Podklasa
RemoteViewsService
.RemoteViewsService
to usługa, za pomocą której adapter zdalny może wysyłać żądaniaRemoteViews
.W podklasie
RemoteViewsService
dodaj klasę, która implementuje funkcję interfejsuRemoteViewsFactory
.RemoteViewsFactory
to interfejs dla między zdalnym widokiem kolekcji, takim jakListView
,GridView
,StackView
oraz dane bazowe dla tego widoku. Twoje implementacja odpowiada za utworzenie obiektuRemoteViews
dla każdego elementu w zbiorze danych. Ten interfejs jest cienką osłonką dlaAdapter
.
Nie możesz polegać na pojedynczym wystąpieniu usługi ani na żadnych zawartych w niej danych
i utrwalać się. Nie przechowuj danych w RemoteViewsService
, chyba że są one statyczne. Jeśli chcesz, aby dane widżetu były przechowywane, najlepiej użyć ContentProvider
, którego dane są przechowywane dłużej niż przez czas trwania procesu. Na przykład widżet sklepu spożywczego może przechowywać stan każdego elementu listy zakupów w trwałym miejscu, takim jak baza danych SQL.
Podstawową treścią implementacji RemoteViewsService
jest
RemoteViewsFactory
. Jak opisano w następnej sekcji.
Interfejs RemoteViewsFactory
Twoja niestandardowa klasa implementująca interfejs RemoteViewsFactory
zapewnia
widżet z danymi elementów w kolekcji. W tym celu
łączy plik układu XML elementu widżetu ze źródłem danych. Może to być dowolne źródło danych: od bazy danych po prosty tablicowy. W przypadku StackWidget
źródło danych to tablica WidgetItems
. RemoteViewsFactory
pełni funkcję adaptera do klejenia danych do zdalnego widoku kolekcji.
Dwie najważniejsze metody, które musisz zaimplementować w podklasie RemoteViewsFactory
, to:
onCreate()
i getViewAt()
.
System wywołuje funkcję onCreate()
podczas tworzenia fabryki po raz pierwszy.
Tutaj możesz skonfigurować połączenia lub kursory ze źródłem danych. Na przykład przykład StackWidget
używa funkcji onCreate()
do zainicjowania tablicy obiektów WidgetItem
. Gdy widżet jest aktywny, system uzyskuje dostęp do tych
za pomocą pozycji indeksu w tablicy i wyświetla tekst,
zawierają.
Oto fragment implementacji StackWidget
(RemoteViewsFactory
) w pliku StackWidget
, który pokazuje fragmenty metody 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 + "!")); } ... } ...
Metoda RemoteViewsFactory
getViewAt()
zwraca obiekt RemoteViews
odpowiadający danym w określonym miejscu position
w zbiorze danych. Oto
fragment z implementacji RemoteViewsFactory
w 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; }
Dodawanie zachowania do poszczególnych elementów
W poprzednich sekcjach pokazaliśmy, jak powiązać dane z kolekcją widżetów. Ale Co zrobić, jeśli chcesz dodać dynamiczne zachowanie poszczególnych elementów w widoku kolekcji?
Jak opisano w sekcji Obsługiwanie zdarzeń za pomocą tagu onUpdate()
class, której zwykle używasz
setOnClickPendingIntent()
, aby określić zachowanie po kliknięciu obiektu, takie jak
powoduje uruchomienie przycisku Activity
. Takie podejście jest jednak niedozwolone w przypadku widoków podrzędnych w poszczególnych elementach kolekcji.
Możesz na przykład użyć setOnClickPendingIntent()
, aby skonfigurować globalny przycisk w widżecie Gmaila, który uruchamia aplikację, ale nie w przypadku poszczególnych elementów listy.
Aby zamiast tego dodać zachowanie kliknięcia do poszczególnych elementów w kolekcji, użyj elementu setOnClickFillInIntent()
. Wiąże się to ze skonfigurowaniu oczekującego szablonu intencji dla
w widoku kolekcji, a potem ustaw intencję wypełniania dla każdego elementu
kolekcja na RemoteViewsFactory
.
W tej sekcji na przykładzie StackWidget
opisujemy, jak dodawać zachowanie do poszczególnych elementów. W przykładzie StackWidget
, jeśli użytkownik dotknie górnego widoku, widget wyświetli wiadomość Toast
„Dotknięty widok n”, gdzie n to indeks (pozycja) dotkniętego widoku. Proces przebiega następująco:
StackWidgetProvider
–AppWidgetProvider
podklasa – tworzy oczekującą intencję z działaniem niestandardowym o nazwieTOAST_ACTION
.Gdy użytkownik dotknie widoku, zamiar zostanie wywołany i przesłany.
TOAST_ACTION
Ta transmisja jest przechwycona przez klasę
StackWidgetProvider
onReceive()
, a w widżecie wyświetli się komunikatToast
po kliknięciu. Dane dotyczące elementów kolekcji są dostarczane przezRemoteViewsFactory
za pomocąRemoteViewsService
.
Konfigurowanie szablonu oczekującej intencji
StackWidgetProvider
(an
podklasa AppWidgetProvider
)
skonfigurować intencję oczekującą. Na poszczególnych elementach kolekcji nie można skonfigurować
własne oczekujące intencje. Zamiast tego kolekcja jako całość tworzy szablon oczekującej intencji, a poszczególne elementy określają intencja uzupełniania, aby tworzyć unikalne zachowanie w przypadku każdego elementu.
Ta klasa otrzymuje też transmisję, która jest wysyłana, gdy użytkownik dotknie widoku. Przetwarza to zdarzenie za pomocą metody onReceive()
. Jeśli działanie związane z zamierzeniem to TOAST_ACTION
, widżet wyświetla wiadomość Toast
w bieżącym widoku.
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); } }
Ustaw intencję wypełnienia
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. Następnie zamiar uzupełnienia jest łączony z szablonem PendingIntent
, aby określić ostateczny zamiar, który zostanie wykonany po kliknięciu elementu.
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; } ... }
Aktualizowanie danych kolekcji
Rysunek 2 przedstawia proces aktualizacji w widżecie, który korzysta z kolekcji. Pokazuje on, jak kod widżetu współpracuje z elementem RemoteViewsFactory
i jak można wywoływać aktualizacje:
Widgety, które korzystają z kolekcji, mogą dostarczać użytkownikom aktualne treści. Dla:
na przykład widżet Gmaila wyświetla użytkownikom podsumowanie ich skrzynki odbiorczej. Aby to zrobić, uruchom widok RemoteViewsFactory
i widok kolekcji, aby pobrać i wyświetlić nowe dane.
W tym celu użyj
AppWidgetManager
, aby zadzwonić
notifyAppWidgetViewDataChanged()
Wywołanie to powoduje wywołanie metody RemoteViewsFactory
obiektu onDataSetChanged()
, która umożliwia pobranie nowych danych.
W ramach wywołania zwrotnego onDataSetChanged()
możesz wykonywać operacje wymagające intensywnego przetwarzania w sposób synchroniczny. Masz pewność, że rozmowa zostanie zakończona
przed pobraniem z RemoteViewsFactory
metadanych lub widoku danych. Ty
może też wykonywać operacje intensywnie przetwarzające w getViewAt()
. Jeśli to wywołanie trwa długo, zostanie wyświetlony widok wczytywania określony przez funkcję
RemoteViewsFactory
obiektu
getLoadingView()
metoda – jest wyświetlana w odpowiedniej pozycji widoku kolekcji
.
Używaj elementu RemoteCollectionItems do bezpośredniego przekazywania kolekcji.
Android 12 (poziom interfejsu API 31) dodaje metodę setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items)
, która pozwala aplikacji przekazywać kolekcję bezpośrednio podczas wypełniania widoku kolekcji. Jeśli skonfigurujesz adapter za pomocą tej metody, nie musisz implementować funkcji RemoteViewsFactory
ani wywoływać funkcji notifyAppWidgetViewDataChanged()
.
Dzięki temu nie tylko ułatwisz wypełnianie adaptera, ale też skrócisz czas potrzebny na wypełnianie nowych elementów, gdy użytkownicy przewijają listę w dół, aby wyświetlić nowy element. Takie podejście do konfigurowania adaptera jest preferowane, o ile zestaw elementów kolekcji jest stosunkowo mały. Takie podejście nie sprawdza się jednak, gdy kolekcja zawiera wiele elementów Bitmaps
przekazywanych do elementu setImageViewBitmap
.
Jeśli w kolekcji nie używa się stałego zestawu układów, czyli
Elementy występują 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żna ponownie wykorzystać w ramach aktualizacji widżetu aplikacji.
Oto przykład implementacji uproszczonych kolekcji RemoteViews
.
Kotlin
val itemLayouts = listOf( R.layout.item_type_1, R.layout.item_type_2, ... ) remoteView.setRemoteAdapter( R.id.list_view, RemoteViews.RemoteCollectionItems.Builder() .addItem(/* id= */ ID_1, RemoteViews(context.packageName, R.layout.item_type_1)) .addItem(/* id= */ ID_2, RemoteViews(context.packageName, R.layout.item_type_2)) ... .setViewTypeCount(itemLayouts.count()) .build() )
Java
List<Integer> itemLayouts = Arrays.asList( R.layout.item_type_1, R.layout.item_type_2, ... ); remoteView.setRemoteAdapter( R.id.list_view, new RemoteViews.RemoteCollectionItems.Builder() .addItem(/* id= */ ID_1, new RemoteViews(context.getPackageName(), R.layout.item_type_1)) .addItem(/* id= */ ID_2, new RemoteViews(context.getPackageName(), R.layout.item_type_2)) ... .setViewTypeCount(itemLayouts.size()) .build() );