Widżety kolekcji specjalizują się w wyświetlaniu wielu elementów tego samego typu, takich jak kolekcje zdjęć z galerii, artykuły z aplikacji z wiadomościami czy wiadomości z aplikacji do komunikacji. Widżety kolekcji koncentrują się zwykle na dwóch przypadkach: przeglądanie kolekcji i otwarciu elementu kolekcji w widoku szczegółowym. Widżety kolekcji można przewijać w pionie.
Te widżety używają narzędzia RemoteViewsService do wyświetlania kolekcji opartych na danych zdalnych, np. pochodzących od dostawcy treści. Widżet prezentuje dane za pomocą jednego z tych typów widoków, znanych jako widoki kolekcji:
ListView- Widok, który przedstawia elementy na liście przewijanej w pionie.
GridView- Widok, który pokazuje elementy w dwuwymiarowej siatce przewijania.
StackView- Widok skumulowany kart podobny do rolodexu, w którym użytkownik może przesuwać przednią kartę w górę lub w dół, aby zobaczyć poprzednią lub następną kartę.
AdapterViewFlipper- Oparty na adaptacjach prosty element
ViewAnimator, który pojawia się między co najmniej 2 wyświetleniami. W danym momencie pokazywane jest tylko 1 dziecko.
W tych widokach kolekcji wyświetlane są zbiory oparte na danych zdalnych, dlatego do powiązania interfejsu użytkownika z danymi używają Adapter. Element Adapter wiąże poszczególne elementy ze zbioru danych z poszczególnymi obiektami View.
Widoki kolekcji są obsługiwane przez adaptery, więc platforma Androida musi zawierać dodatkową architekturę, aby można było ich używać w widżetach. W kontekście widżetu element Adapter jest zastępowany elementem RemoteViewsFactory, który jest cienką otoką wokół interfejsu Adapter. Po przesłaniu żądania dotyczącego określonego elementu w kolekcji RemoteViewsFactory tworzy i zwraca element kolekcji jako obiekt RemoteViews. Aby uwzględnić w widżecie widok kolekcji, zaimplementuj RemoteViewsService i RemoteViewsFactory.
RemoteViewsService to usługa, która umożliwia adapterowi zdalnemu żądania obiektów RemoteViews. RemoteViewsFactory to interfejs adaptera między widokiem kolekcji, np. ListView, GridView i StackView, a danymi bazowymi tego widoku. Na podstawie przykładowego kodu StackWidget przedstawiamy gotowy kod do wdrożenia 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 są również zaczerpnięte z przykładowego pliku StackWidget:
StackWidget.Ten przykład składa się ze stosu 10 widoków, w których wyświetlane są wartości od 0 do 9. Przykładowy widżet działa w następujący sposób:
Użytkownik może przechylić górny widok w pionie w widżecie, aby wyświetlić następny lub poprzedni widok. To jest wbudowane zachowanie
StackView.Bez interakcji użytkownika widżet automatycznie przewija widok w sekwencji, jak w pokazie slajdów. Wynika to z ustawienia
android:autoAdvanceViewId="@id/stack_view"w plikures/xml/stackwidgetinfo.xml. To ustawienie odnosi się do identyfikatora widoku, w tym przypadku do identyfikatora widoku stosu.Jeśli użytkownik dotknie widoku u góry, w widżecie pojawi się komunikat
Toast„Widok dotknięty n”, gdzie n to indeks (pozycja) widoku dotkniętego. Więcej o implementowaniu zachowań dowiesz się 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ę implementacji dowolnego widżetu oraz wykonaj kilka dodatkowych czynności: zmień 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 manifeście musisz umożliwić widżetom z kolekcjami powiązanie z Twoim zasobem RemoteViewsService. Aby to zrobić, zadeklaruj usługę w pliku manifestu z uprawnieniem BIND_REMOTEVIEWS.
Uniemożliwia to innym aplikacjom swobodny dostęp do danych widżetu.
Gdy na przykład tworzysz widżet, który wykorzystuje 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 pliku XML układu widżetu jest to, aby zawierał jeden z widoków kolekcji: ListView, GridView, StackView lub AdapterViewFlipper. Oto plik widget_layout.xml przykładowego wpisu 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 wobec widoku kolekcji, w przypadku którego pusty widok oznacza pusty.
Oprócz pliku układu dla całego widżetu utwórz kolejny plik układu, który określa układ poszczególnych elementów w kolekcji – na przykład układ każdej książki w kolekcji książek. Przykład StackWidget zawiera tylko 1 plik układu elementu (widget_item.xml), ponieważ wszystkie elementy mają ten sam układ.
Klasa AppWidgetProvider dla widżetów z kolekcjami
Tak jak w przypadku zwykłych widżetów, większość kodu w podklasie AppWidgetProvider jest zazwyczaj umieszczana w elemencie onUpdate().
Główna różnica w implementacji funkcji onUpdate() w przypadku tworzenia widżetu z kolekcjami polega na tym, że musisz wywołać setRemoteAdapter(). Informuje on widok kolekcji, skąd pobierać jego dane.
Następnie RemoteViewsService może zwrócić Twoją implementację RemoteViewsFactory i widżet może wyświetlić odpowiednie dane. Wywołując tę metodę, przekaż intencję wskazującą Twoją implementację RemoteViewsService oraz identyfikator widżetu, który określa widżet do aktualizacji.
Oto jak przykład StackWidget implementuje metodę wywołania zwrotnego onUpdate() w celu ustawienia RemoteViewsService jako adaptera zdalnego dla kolekcji 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);
}
Utrwal dane
Jak opisano na tej stronie, podklasa RemoteViewsService udostępnia klasę RemoteViewsFactory używaną do wypełniania widoku zbioru zdalnego.
W tym celu wykonaj te czynności:
Podklasa
RemoteViewsService.RemoteViewsServiceto usługa, za pomocą której adapter zdalny może zażądaćRemoteViews.W podklasie
RemoteViewsServicedodaj klasę, która implementuje interfejsRemoteViewsFactory.RemoteViewsFactoryto interfejs łączący widok zbioru zdalnego, np.ListView,GridViewiStackView, a danymi bazowymi tego widoku. Implementacja odpowiada za utworzenie obiektuRemoteViewsdla każdego elementu w zbiorze danych. Ten interfejs jest cienką otoką wokółAdapter.
Nie możesz polegać na trwałości pojedynczej instancji usługi ani zawartych w niej danych. Nie przechowuj danych w elemencie RemoteViewsService, chyba że jest on statyczny. Jeśli chcesz, aby dane widżetu pozostawały zachowane, najlepszym sposobem jest użycie ContentProvider, którego dane są dostępne poza cyklem życia procesu. Na przykład widżet sklepu spożywczego może przechowywać stan każdej pozycji z listy zakupów w stałej lokalizacji, takiej jak baza danych SQL.
Główna zawartość implementacji RemoteViewsService to RemoteViewsFactory. Opisaliśmy to w sekcji poniżej.
Interfejs RemoteViewsFactory
Klasa niestandardowa, która implementuje interfejs RemoteViewsFactory, udostępnia widżetowi dane dotyczące elementów w kolekcji. W tym celu łączy plik układu XML elementu widżetu ze źródłem danych. Może to być wszystko, od bazy danych po prostą tablicę. W przykładzie StackWidget źródłem danych jest tablica WidgetItems. RemoteViewsFactory działa jak adapter do łączenia danych z widokiem zbioru zdalnego.
Dwie najważniejsze metody, które musisz wdrożyć w podklasie RemoteViewsFactory, to onCreate() i getViewAt().
Podczas tworzenia fabryki po raz pierwszy system wywołuje onCreate().
W tym miejscu konfigurujesz wszelkie połączenia lub kursory prowadzące do Twojego źródła danych. Na przykład w przykładzie StackWidget użyto pola onCreate() do zainicjowania tablicy obiektów WidgetItem. Gdy widżet jest aktywny, system uzyskuje dostęp do tych obiektów za pomocą pozycji indeksu w tablicy i wyświetla zawarty w nich tekst.
Oto fragment kodu z przykładu StackWidget RemoteViewsFactory, 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 position zbiorze danych. Oto fragment implementacji RemoteViewsFactory w przykładzie 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;
}
Dodaj zachowanie do poszczególnych elementów
W poprzednich sekcjach opisano, jak powiązać dane z kolekcją widżetów. A co, jeśli chcesz dodać zachowanie dynamiczne do poszczególnych elementów w widoku kolekcji?
Jak opisano w sekcji Obsługa zdarzeń za pomocą klasy onUpdate(), zwykle do ustawiania zachowania obiektu przy kliknięciu, na przykład do uruchamiania przycisku Activity, używasz zwykle metody setOnClickPendingIntent(). Takie podejście nie jest jednak dozwolone w przypadku wyświetleń poszczególnych elementów kolekcji.
Za pomocą setOnClickPendingIntent() możesz na przykład skonfigurować przycisk globalny w widżecie Gmaila, który uruchamia aplikację, ale nie na poszczególnych elementach listy.
Aby dodać zachowanie dotyczące kliknięć do poszczególnych elementów w kolekcji, użyj właściwości setOnClickFillInIntent(). Obejmuje to skonfigurowanie oczekującego szablonu intencji dla widoku kolekcji, a następnie ustawienie intencji wypełnienia dla każdego elementu w kolekcji za pomocą RemoteViewsFactory.
W tej sekcji do opisania sposobu dodawania zachowania do poszczególnych elementów używamy przykładu StackWidget. Jeśli w przykładzie StackWidget użytkownik dotknie widoku u góry, widżet wyświetli komunikat Toast „Widok dotknięty n”, gdzie n to indeks (pozycja) widoku dotkniętego. Proces przebiega następująco:
Podklasa
StackWidgetProvider(podklasaAppWidgetProvider) tworzy oczekującą intencję z działaniem niestandardowymTOAST_ACTION.Gdy użytkownik dotyka widoku, intencja uruchamia się i przesyła
TOAST_ACTION.Ta transmisja jest przechwytywana przez metodę
onReceive()klasyStackWidgetProvideri widżet wyświetla komunikatToastdla widoku dotkniętego. Dane dotyczące elementów kolekcji są dostarczane przezRemoteViewsFactoryza pomocąRemoteViewsService.
Konfigurowanie oczekującego szablonu intencji
StackWidgetProvider (podklasa AppWidgetProvider) konfiguruje intencję oczekującą. Pojedyncze elementy kolekcji nie mogą konfigurować własnych oczekujących intencji. Zamiast tego cała kolekcja konfiguruje się w oczekującym szablonie intencji, a poszczególne elementy ustawiają intencję wypełniania tak, by każda z nich generowała unikalne zachowanie.
Te zajęcia otrzymują też komunikat wysyłany, gdy użytkownik dotknie widoku. Przetwarza to zdarzenie za pomocą swojej metody onReceive(). Jeśli działaniem intencji jest TOAST_ACTION, widżet wyświetla komunikat Toast dla bieżącego widoku danych.
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);
}
}
Ustawianie intencji wypełnienia
RemoteViewsFactory musi skonfigurować intencję wypełnienia w przypadku każdego elementu w kolekcji. Dzięki temu można rozróżnić
działania wykonywane przez kliknięcie danego elementu. Intencja wypełnienia jest następnie łączona z szablonem PendingIntent, aby określić ostateczną intencję wykonywaną 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;
}
...
}
Dbaj o aktualność danych kolekcji
Rysunek 2 przedstawia przepływ aktualizacji w widżecie używającym kolekcji. Pokazuje on, jak kod widżetu wchodzi w interakcję z RemoteViewsFactory i jak możesz wywoływać aktualizacje:
RemoteViewsFactory podczas aktualizacji.Widżety, które wykorzystują kolekcje, mogą dostarczać użytkownikom aktualną zawartość. Widżet Gmaila zawiera na przykład podsumowanie skrzynki odbiorczej. Aby to umożliwić, aktywuj widok RemoteViewsFactory i widok kolekcji w celu pobrania i wyświetlenia nowych danych.
Aby to zrobić, użyj AppWidgetManager w celu wywołania notifyAppWidgetViewDataChanged(). Powoduje ono wywołanie zwrotne metody onDataSetChanged() obiektu RemoteViewsFactory, która umożliwia pobranie nowych danych.
Operacje wymagające dużej mocy obliczeniowej możesz wykonywać synchronicznie w ramach wywołania zwrotnego onDataSetChanged(). Masz pewność, że to wywołanie zostanie wykonane przed pobraniem metadanych lub danych widoku z RemoteViewsFactory. Możesz też wykonywać operacje wymagające dużych nakładów pracy w ramach metody getViewAt(). Jeśli to wywołanie trwa długo, widok wczytywania – określony przez metodę getLoadingView() obiektu RemoteViewsFactory – jest wyświetlany w odpowiednim położeniu widoku kolekcji, dopóki nie zostanie zwrócony.
Użycie elementu RemoteCollectionItems bezpośrednio w kolekcji
Android 12 (poziom interfejsu API 31) dodaje metodę setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items), która umożliwia aplikacji przekazywanie kolekcji bezpośrednio podczas wypełniania widoku kolekcji. Jeśli skonfigurujesz adapter za pomocą tej metody, nie musisz implementować interfejsu RemoteViewsFactory i nie musisz wywoływać metody notifyAppWidgetViewDataChanged().
Nie tylko ułatwia ono wypełnianie adaptera, ale także eliminuje opóźnienie związane z wypełnianiem nowych elementów, gdy użytkownicy przewijają listę w dół w celu wyświetlenia nowego elementu. Ta metoda ustawiania adaptera jest preferowana, jeśli zbiór elementów kolekcji jest stosunkowo mały. Ta metoda nie działa jednak np. wtedy, gdy kolekcja zawiera wiele elementów Bitmaps przekazywanych do setImageViewBitmap.
Jeśli w kolekcji nie jest stosowany stały zestaw układów – czyli gdy niektóre 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 można używać adaptera w przypadku 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()
);