Widżety kolekcji specjalizują się w wyświetlaniu wielu elementów tego samego typu, takich jak jako kolekcje zdjęć z galerii, artykuły z aplikacji z wiadomościami; z aplikacji do komunikacji. Widżety kolekcji zazwyczaj koncentrują się na 2 sposobie użycia przypadki: przeglądanie kolekcji i otwieranie jej elementu szczegółowy widok danych. Widżety kolekcji można przewijać w pionie.
Wykorzystują one
RemoteViewsService
do wyświetlenia
kolekcje oparte na danych zdalnych, takich jak zawartość
usługodawcy. Widżet przedstawia
danych za pomocą jednego z tych typów widoków, które nazywamy kolekcją
widoki danych:
ListView
- Widok, w którym elementy są w przewijaną w pionie.
GridView
- Widok, w którym elementy są w dwuwymiarową siatkę przewijania.
StackView
- Ułożenie karty Widok – jak rolodex – który użytkownik może obrócić przód aby wyświetlić odpowiednio poprzednią lub następną kartę.
AdapterViewFlipper
- An
prosty oparty na przejściu
Animowane rozszerzenie
ViewAnimator
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
wiąże poszczególne elementy ze zbioru danych
do poszczególnych obiektów View
.
A 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, sekcja Adapter
jest zastępowana
RemoteViewsFactory
,
czyli cienkiej otoczce interfejsu Adapter
. W przypadku prośby o
określony element w kolekcji, RemoteViewsFactory
tworzy i zwraca
jako element kolekcji
RemoteViews
. Aby dodać parametr
w widżecie, zaimplementuj RemoteViewsService
i
RemoteViewsFactory
RemoteViewsService
to usługa, która umożliwia zdalne żądanie adaptera
RemoteViews
obiektów. RemoteViewsFactory
to interfejs adaptera
między widokiem kolekcji, takim jak ListView
, GridView
czy
StackView
– oraz dane bazowe dla tego widoku. Źródło: StackWidget
przykład,
Oto przykładowy kod stały służący do implementacji tej usługi
interfejs:
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ż pobierane z StackWidget
przykład:
Ta próbka składa się ze stosu 10 wyświetleń, w których pojawiają się wartości zerowe. do dziewiątej. Przykładowy widżet ma te główne zachowania:
Użytkownik może przesunąć w pionie widok z góry, aby wyświetlić następny lub w poprzednim widoku. 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:res/xml/stackwidgetinfo.xml
. To ustawienie dotyczy identyfikatora widoku, W tym przypadku jest to identyfikator widoku stosu.Jeśli użytkownik dotknie widoku z góry, widżet wyświetli
Toast
wiadomość „Widok dotknięty n”, gdzie n to indeks (pozycja) widoku, który jest kliknięty. Więcej dyskusji na temat tego, na temat wdrażania określonych zachowań, zapoznaj się z sekcją Dodawanie zachowania do poszczególnych użytkowników elementów.
Wdrażanie widżetów z kolekcjami
Aby zaimplementować widżet z kolekcjami, wykonaj procedurę implementacji dowolnych
i wykonaj kilka dodatkowych czynności:
zmodyfikować plik manifestu, dodać widok kolekcji do układu widżetu i zmodyfikować
Podklasa: AppWidgetProvider
.
Plik manifestu widżetów z kolekcjami
Oprócz wymagań wymienionych w sekcji Zadeklarowanie widżetu w
pliku manifestu, musisz zezwolić na widżety z
kolekcji, które chcesz powiązać z RemoteViewsService
. Aby to zrobić, zadeklaruj parametr
usługa z uprawnieniami w pliku manifestu
BIND_REMOTEVIEWS
Uniemożliwi to innym aplikacjom swobodny dostęp 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 pliku XML układu widżetu jest to, aby zawierał on jeden
widoki 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 inny układ
określający układ każdego elementu w kolekcji – na przykład
układ dla każdej książki w kolekcji. Przykład z StackWidget
zawiera
tylko jeden plik układu elementu, widget_item.xml
, ponieważ wszystkie elementy używają tego samego
układ.
Klasa AppWidgetProvider dla widżetów z kolekcjami
Podobnie jak w przypadku zwykłych widżetów, duża część kodu w kodzie
Podklasa AppWidgetProvider
zwykle przechodzi do
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.
Interfejs RemoteViewsService
może wtedy zwrócić Twoją implementację
RemoteViewsFactory
, a widżet będzie wyświetlać odpowiednie dane. Gdy
i wywołaj tę metodę, przekaż intencję wskazującą implementację
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 zdalny 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); }
Utrwalaj dane
Jak opisano na tej stronie, podklasa RemoteViewsService
zapewnia
RemoteViewsFactory
służy do wypełniania zdalnego widoku kolekcji.
W szczególności wykonaj te czynności:
Podklasa
RemoteViewsService
.RemoteViewsService
jest usługą za pośrednictwem do których adapter zdalny może zażądać parametruRemoteViews
.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. Jest to cienka otoka wokół elementuAdapter
.
Nie możesz polegać na pojedynczym wystąpieniu usługi ani na żadnych zawartych w niej danych
i utrwalać się. Nie przechowuj danych w elemencie RemoteViewsService
, chyba że jest on statyczny. Jeśli
jeśli chcesz, aby dane widżetu były zachowane, najlepszym sposobem jest użycie
ContentProvider
, którego dane
nawet po zakończeniu cyklu życia tego procesu. Na przykład widżet sklepu spożywczego może
zapisywać stan każdej pozycji na liście zakupów w stałej lokalizacji, takiej jak
w bazie 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. To źródło
może to być wszystko, od bazy danych po prostą tablicę. W: StackWidget
źródłem danych jest tablica WidgetItems
. RemoteViewsFactory
pełni funkcję adaptera do klejenia danych do zdalnego widoku kolekcji.
Dwie najważniejsze metody wdrażania tej funkcji
RemoteViewsFactory
podklasa nie kwalifikuje się
onCreate()
i
getViewAt()
Podczas tworzenia fabryki system po raz pierwszy wywołuje metodę onCreate()
.
Tutaj możesz skonfigurować połączenia lub kursory ze źródłem danych. Dla:
przykładu przykładu StackWidget
używa funkcji onCreate()
do zainicjowania tablicy
WidgetItem
obiektów. Gdy widżet jest aktywny, system uzyskuje dostęp do tych
za pomocą pozycji indeksu w tablicy i wyświetla tekst,
zawierają.
Oto fragment książki RemoteViewsFactory
z fragment: StackWidget
implementacja, która 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ące 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; }
Dodaj zachowanie do poszczególnych elementów
W poprzednich sekcjach dowiesz się, jak powiązać dane ze 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
. Ale
ta metoda jest niedozwolona w przypadku wyświetleń podrzędnych poszczególnych elementów kolekcji.
Możesz na przykład użyć polecenia setOnClickPendingIntent()
, aby skonfigurować przycisk globalny
np. w widżecie Gmaila, który uruchamia aplikację, ale nie w
poszczególnych elementów listy.
Zamiast tego, aby dodać zachowanie związane z kliknięciami do poszczególnych elementów w kolekcji, użyj funkcji
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 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 z góry,
widżet wyświetla komunikat Toast
„Widok dotknięty n”, gdzie n to
pozycji wskazywanej przez kliknięcie. Proces przebiega następująco:
StackWidgetProvider
–AppWidgetProvider
podklasa – tworzy oczekującą intencję z działaniem niestandardowym o nazwieTOAST_ACTION
.Gdy użytkownik dotyka obejrzenia, uruchamia się intencja, która zostaje rozpowszechniona.
TOAST_ACTION
Ta transmisja jest przechwycona przez klasę
StackWidgetProvider
onReceive()
, a w widżecie wyświetli się komunikatToast
po kliknięciu. Dane elementów kolekcji są dostarczane przezRemoteViewsFactory
przezRemoteViewsService
.
Konfigurowanie oczekującego szablonu 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 cała kolekcja konfiguruje intencję oczekującą.
a poszczególne elementy ustawiają intencję wypełnienia, tworząc unikalne
zachowanie produktu dla każdego produktu.
Zajęcia te otrzymują też komunikat, który jest wysyłany, gdy użytkownik dotknie
widok. Przetwarza to zdarzenie za pomocą metody onReceive()
. Jeśli intencja
akcja to TOAST_ACTION
, widżet wyświetla komunikat Toast
dotyczący bieżącej wartości
widok.
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. Pozwala to odróżnić poszczególne działania
danego elementu. Intencja uzupełniania jest następnie łączona z
PendingIntent
do określenia.
czyli końcowa intencja, która jest wykonywana 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 proces aktualizacji w widżecie, który korzysta z kolekcji. Pokazuje
jak kod widżetu współdziała z RemoteViewsFactory
i jak możesz
aktualizacje wyzwalacza:
Widżety korzystające z kolekcji mogą udostępniać użytkownikom aktualne treści. Dla:
na przykład widżet Gmaila wyświetla użytkownikom podsumowanie ich skrzynki odbiorczej. Aby zrobić to
należy uruchomić widok RemoteViewsFactory
i kolekcji, aby pobrać
wyświetlać nowe dane.
W tym celu użyj
AppWidgetManager
, aby zadzwonić
notifyAppWidgetViewDataChanged()
Powoduje to wywołanie zwrotne do obiektu RemoteViewsFactory
onDataSetChanged()
.
która pozwala pobrać nowe dane.
Operacje wymagające dużej mocy obliczeniowej można wykonywać synchronicznie w
onDataSetChanged()
oddzwonienie. 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 setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items)
która pozwala aplikacji przekazać kolekcję bezpośrednio przy wypełnianiu pola
w widoku kolekcji. Jeśli ustawisz przejściówkę za pomocą tej metody, nie musisz
zaimplementuj RemoteViewsFactory
i nie musisz wywoływać
notifyAppWidgetViewDataChanged()
Podejście to nie tylko ułatwia zapełnianie przejściówki,
pozwala uniknąć opóźnień w zapełnianiu nowych elementów, gdy użytkownicy przewiną listę w dół,
pokazać nowy element. Ten sposób ustawiania adaptera jest preferowany, jeśli
Twój zestaw elementów kolekcji jest stosunkowo mały. Jednak na przykład to
nie będzie dobrze działać, jeśli Twoja kolekcja zawiera wiele elementów Bitmaps
przekazano do: 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 funkcja
adaptera można używać wielokrotnie w różnych aktualizacjach widżetu aplikacji.
Oto przykład wdrożenia 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() );