Widżety kolekcji specjalizują się w wyświetlaniu wielu elementów tego samego typu, np. kolekcji zdjęć z aplikacji galerii, artykułów z aplikacji z wiadomościami czy wiadomości z aplikacji do komunikacji. Widżety kolekcji zazwyczaj 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.
Widżety RemoteViewsService służą do wyświetlania kolekcji opartych na zdalnych danych, np. od dostawcy treści. Widżet przedstawia dane za pomocą jednego z tych typów widoków danych, czyli widoków kolekcji:
ListView- Widok, w którym elementy są przewijane w pionie.
GridView- Widok, w którym elementy są wyświetlane w dwuwymiarowej przewijanej siatce.
StackView- Widok skumulowanych kart – jak rolodex – w którym użytkownik może przesunąć przednią kartę w górę lub w dół, aby zobaczyć poprzednią lub następną kartę.
AdapterViewFlipper- Uparty na adaptacji prosty element
ViewAnimator, który wyświetla się między 2 lub większą liczbą wyświetleń. Wyświetlane jest tylko jedno dziecko naraz.
Te widoki kolekcji wyświetlają kolekcje oparte na danych zdalnych, dlatego używają do powiązania swojego interfejsu użytkownika z danymi za pomocą obiektu Adapter. Element Adapter wiąże poszczególne elementy ze zbioru danych z poszczególnymi obiektami View.
Ponieważ widoki kolekcji są oparte na przejściach, platforma Androida musi zawierać dodatkową architekturę, która obsługuje ich użycie w widżetach. W kontekście widżetu obiekt Adapter jest zastępowany obiektem RemoteViewsFactory, który jest cienkim otoczeniem wokół interfejsu Adapter. Na żądanie określonego elementu kolekcji RemoteViewsFactory tworzy i zwraca ten 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 zdalne żądanie obiektów RemoteViews przez adapter zdalny. RemoteViewsFactory to interfejs służący do adaptera między widokiem kolekcji (np. ListView, GridView i StackView) a danymi bazowymi dla tego widoku. W przykładzie StackWidget znajdziesz przykładowy kod stały służący 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ą również z przykładu 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 ma te główne zachowania:
Użytkownik może przesunąć w pionie widok z góry, aby wyświetlić następny lub poprzedni widok. Jest to wbudowane działanie
StackView.Bez interakcji ze strony użytkownika widżet automatycznie przechodzi po kolejnych wyświetleniach, 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, który w tym przypadku jest identyfikatorem widoku stosu.Jeśli użytkownik dotknie widoku z góry, widżet wyświetli komunikat
Toast„Widok dotknięty n”, gdzie n oznacza indeks (pozycję) klikniętego widoku. Więcej informacji o wdrażaniu zachowań znajdziesz w sekcji Dodawanie zachowania do poszczególnych elementów.
Wdrażanie widżetów z kolekcjami
Aby zaimplementować widżet z kolekcjami, wykonaj procedurę implementacji 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 Zadeklarowanie widżetu w manifeście musisz umożliwić widżetom z kolekcjami powiązanie z elementem RemoteViewsService. Aby to zrobić, zadeklaruj usługę w pliku manifestu z uprawnieniem BIND_REMOTEVIEWS.
Uniemożliwi to innym aplikacjom swobodny dostęp do danych widżetu.
Gdy na przykład utworzysz widżet, który zapełnia widok kolekcji za pomocą parametru RemoteViewsService, 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 w przypadku 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 dotyczący StackWidget przykładu:
<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, w którym pusty widok reprezentuje stan pusty.
Oprócz pliku układu całego widżetu utwórz też kolejny plik układu, który definiuje układ dla każdego elementu w kolekcji – na przykład układ każdej książki w kolekcji. Przykład StackWidget zawiera tylko 1 plik układu elementów, widget_item.xml, ponieważ wszystkie elementy mają ten sam układ.
Klasa AppWidgetProvider dla widżetów z kolekcjami
Podobnie jak w przypadku zwykłych widżetów, spora część kodu w podklasie AppWidgetProvider zwykle znajduje się w onUpdate().
Główna różnica w implementacji elementu onUpdate() podczas tworzenia widżetu z kolekcjami polega na tym, że musisz wywołać setRemoteAdapter(). Informuje on widok kolekcji, skąd może pobrać dane.
RemoteViewsService może następnie zwrócić Twoją implementację tagu RemoteViewsFactory, a widżet może wyświetlać odpowiednie dane. Gdy wywołujesz tę metodę, przekaż intencję wskazującą Twoją implementację obiektu RemoteViewsService oraz identyfikator widżetu, który określa widżet do zaktualizowania.
Tak na przykład StackWidget implementuje metodę wywołania zwrotnego onUpdate(), która ustawia RemoteViewsService jako zdalny adapter zbioru 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 udostępnia funkcję RemoteViewsFactory służącą do wypełniania zdalnego widoku kolekcji.
W szczególności 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 zdalny widok kolekcji (np.ListView,GridView,StackView) a danymi bazowymi dla tego widoku. Implementacja odpowiada za utworzenie obiektuRemoteViewsna potrzeby 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. Nie przechowuj danych w elemencie RemoteViewsService, chyba że jest on statyczny. Jeśli chcesz, aby dane widżetu pozostały zachowywane, najlepszym rozwiązaniem jest użycie obiektu ContentProvider, którego dane pozostaną dostępne poza cyklem życia procesu. Na przykład widżet sklepu spożywczego może przechowywać stan każdej pozycji na liście zakupów w stałej lokalizacji, takiej jak baza danych SQL.
Podstawową zawartością implementacji RemoteViewsService jest jej RemoteViewsFactory, która została opisana w następnej sekcji.
Interfejs RemoteViewsFactory
Klasa niestandardowa, która implementuje interfejs RemoteViewsFactory, udostępnia widżet z danymi o elementach w kolekcji. W tym celu łączy plik układu XML elementu widżetu ze źródłem danych. Źródłem danych może być wszystko, od bazy danych po prostą tablicę. W przykładzie StackWidget źródłem danych jest tablica WidgetItems. Obiekt RemoteViewsFactory pełni funkcję adaptera do wklejania danych do zdalnego widoku kolekcji.
Dwie najważniejsze metody, które musisz wdrożyć w podklasie RemoteViewsFactory, to 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. Na przykład w przykładzie StackWidget użyto metody 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 zawarte w nich teksty.
Oto fragment kodu StackWidget z implementacji 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 o określonym position w zbiorze danych. Oto fragment kodu StackWidget z implementacji RemoteViewsFactory:
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. A jeśli chcesz dodać dynamiczne zachowanie poszczególnych elementów w widoku kolekcji?
Jak opisano w sekcji Obsługiwanie zdarzeń za pomocą klasy onUpdate(), zwykle używasz setOnClickPendingIntent() do ustawiania zachowania obiektu po kliknięciu, na przykład do wywoływania przycisku uruchamiającego Activity. Takie podejście nie jest jednak dozwolone w przypadku wyświetleń podrzędnych w pojedynczym elemencie kolekcji.
Za pomocą setOnClickPendingIntent() możesz np. skonfigurować w widżecie Gmaila przycisk globalny, który uruchamia aplikację, ale nie w poszczególnych elementach listy.
Aby dodać zachowanie związane z kliknięciami do poszczególnych elementów w kolekcji, użyj właściwości setOnClickFillInIntent(). Wymaga to skonfigurowania oczekującego szablonu intencji w widoku kolekcji, a następnie ustawienia intencji wypełnienia dla każdego elementu w kolekcji za pomocą obiektu RemoteViewsFactory.
W tej sekcji wykorzystano przykład StackWidget, aby opisać, jak dodać zachowanie do poszczególnych elementów. W przykładzie StackWidget, gdy użytkownik dotknie widoku z góry, widżet wyświetli komunikat Toast „Widok dotknięty n”, gdzie n oznacza indeks (pozycję) widoku klikniętego. Proces przebiega następująco:
StackWidgetProvider– podklasaAppWidgetProvider– tworzy intencję oczekującą z działaniem niestandardowymTOAST_ACTION.Gdy użytkownik dotyka wyświetlenia, uruchamiana jest intencja, która przesyła komunikat
TOAST_ACTION.Ta transmisja jest przechwytywana przez metodę
onReceive()klasyStackWidgetProvider. Widżet wyświetla komunikatToastw widoku, który został dotknięty. Dane dotyczące elementów kolekcji są dostarczane przezRemoteViewsFactorydoRemoteViewsService.
Konfigurowanie oczekującego szablonu intencji
StackWidgetProvider (podklasa AppWidgetProvider) konfiguruje intencję oczekującą. Pojedyncze elementy kolekcji nie mogą konfigurować własnych intencji oczekujących. Zamiast tego cała kolekcja konfiguruje oczekujący szablon intencji, a poszczególne elementy ustawiają intencję wypełnienia, aby uzyskać unikalne zachowanie dla każdego elementu.
Ta klasa odbiera też komunikat, który jest wysyłany, gdy użytkownik dotknie widoku. Przetwarza to zdarzenie za pomocą metody onReceive(). Jeśli działanie intencji to TOAST_ACTION, widżet wyświetla komunikat 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
Element RemoteViewsFactory musi mieć ustawioną intencję wypełnienia w przypadku każdego elementu w kolekcji. Pozwala to odróżnić poszczególne działania
wywołane kliknięciem danego elementu. Intencja uzupełniania jest następnie łączona z szablonem PendingIntent w celu określenia końcowej intencji wykonywanej 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 on, jak kod widżetu współdziała z RemoteViewsFactory i jak można wywoływać aktualizacje:
RemoteViewsFactory podczas aktualizacji.Widżety korzystające z kolekcji mogą udostępniać użytkownikom aktualne treści. Widżet Gmaila wyświetla na przykład podsumowanie zawartości skrzynki odbiorczej. Aby to umożliwić, aktywuj widok danych RemoteViewsFactory i kolekcji, aby pobierać i wyświetlać nowe dane.
W tym celu użyj funkcji AppWidgetManager do wywołania notifyAppWidgetViewDataChanged(). Powoduje to wywołanie zwrotne do 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 wywołanie zostanie ukończone, zanim z RemoteViewsFactory zostaną pobrane metadane lub dane widoku. W metodzie getViewAt() możesz też wykonywać operacje intensywnie przetwarzające. Jeśli to wywołanie trwa długo, widok wczytywania – określony przez metodę getLoadingView() obiektu RemoteViewsFactory – jest wyświetlany na odpowiednim położeniu widoku kolekcji, dopóki nie zostanie zwrócony.
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 umożliwia aplikacji przekazywanie kolekcji bezpośrednio podczas wypełniania widoku kolekcji. Jeśli ustawisz adapter za pomocą tej metody, nie musisz implementować RemoteViewsFactory ani wywoływać metody notifyAppWidgetViewDataChanged().
Nie tylko ułatwia to wypełnianie adaptera, eliminuje też czas oczekiwania na wypełnienie 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 względnie mały. Jednak na przykład ta metoda nie będzie działać dobrze, jeśli Twoja kolekcja zawiera wiele elementów Bitmaps przekazywanych do setImageViewBitmap.
Jeśli kolekcja nie korzysta ze stałego zestawu układów (czyli gdy niektóre elementy występują tylko czasami), użyj parametru setViewTypeCount, aby określić maksymalną liczbę unikalnych układów, które może zawierać kolekcja. Umożliwi to ponowne wykorzystanie adaptera w 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()
);