Виджеты-коллекции предназначены для показа множества элементов одного типа, например фотографий из галереи, статей из новостного приложения или сообщений из мессенджера. Обычно такие виджеты используются для просмотра коллекции и открытия ее элементов в подробном представлении. Виджеты коллекций можно прокручивать по вертикали.
Эти виджеты используют RemoteViewsService для показа коллекций, которые поддерживаются удаленными данными, например от поставщика контента. Виджет представляет данные, используя один из следующих типов представлений, которые называются представлениями коллекций:
ListView – представление, в котором элементы показаны в виде вертикального списка с прокруткой.
GridView – представление, в котором элементы показаны в виде двумерной сетки с прокруткой.
StackView – карточки, расположенные друг за другом. Чтобы посмотреть предыдущую или следующую карточку, нужно провести по экрану вверх или вниз.
AdapterViewFlipper – поддерживаемый адаптером элемент ViewAnimator, который анимирует переходы между двумя или более представлениями. Одновременно показывается только один ребенок.
Поскольку эти представления отображают коллекции, подкрепленные удаленными данными, они используют Adapter для привязки своего пользовательского интерфейса к своим данным. Adapter связывает отдельные элементы из набора данных с отдельными объектами View.
Поскольку эти представления коллекций поддерживаются адаптерами, фреймворк Android должен включать дополнительную архитектуру для поддержки их использования в виджетах. В контексте виджета Adapter заменяется на RemoteViewsFactory, который является тонкой оболочкой для интерфейса Adapter. Когда запрашивается определенный элемент коллекции, RemoteViewsFactory создает и возвращает его в виде объекта RemoteViews. Чтобы добавить в виджет представление коллекции, реализуйте RemoteViewsService и RemoteViewsFactory.
RemoteViewsService – это сервис, который позволяет удаленному адаптеру запрашивать объекты RemoteViews. RemoteViewsFactory – это интерфейс для адаптера между представлением коллекции, например ListView, GridView и StackView, и базовыми данными для этого представления. Ниже приведен пример шаблонного кода из StackWidget
примера, который реализует этот сервис и интерфейс.
class StackWidgetService : RemoteViewsService() { override fun onGetViewFactory(intent: Intent): RemoteViewsFactory = StackRemoteViewsFactory(this.applicationContext, intent) } class StackRemoteViewsFactory( private val context: Context, intent: Intent ) : RemoteViewsService.RemoteViewsFactory { // See the RemoteViewsFactory API reference for the full list of methods to implement. }
Пример приложения
Фрагменты кода в этом разделе также взяты из примера StackWidget.
StackWidget.Этот пример состоит из стека из десяти представлений, которые отображают значения от нуля до девяти. Пример виджета имеет следующие основные варианты поведения:
Пользователь может прокрутить верхнее представление в виджете по вертикали, чтобы перейти к следующему или предыдущему представлению. Это встроенная функция
StackView.Без какого-либо взаимодействия с пользователем виджет автоматически продвигается по своим представлениям последовательно, как слайд-шоу. Это связано с настройкой
android:autoAdvanceViewId="@id/stack_view"в файлеres/xml/stackwidgetinfo.xml. Эта настройка применяется к идентификатору представления, который в данном случае является идентификатором представления стека.Если пользователь нажмет на верхний элемент, виджет покажет сообщение
Toast"Нажат элемент n", где n – индекс (позиция) нажатого элемента. Подробнее о том, как реализовать поведение, рассказывается в разделе Добавление поведения к отдельным элементам.
Как реализовать виджеты с подборками
Чтобы реализовать виджет с коллекциями, следуйте процедуре реализации любого виджета, а затем выполните несколько дополнительных шагов: измените манифест, добавьте представление коллекции в макет виджета и измените подкласс AppWidgetProvider.
Манифест для виджетов с коллекциями
Помимо требований, перечисленных в разделе Объявление виджета в манифесте, вам необходимо сделать так, чтобы виджеты с коллекциями могли связываться с вашим RemoteViewsService. Для этого объявите сервис в файле манифеста с разрешением BIND_REMOTEVIEWS.
Это не позволит другим приложениям свободно получать доступ к данным виджета.
Например, при создании виджета, который использует RemoteViewsService для заполнения представления коллекции, запись манифеста может выглядеть следующим образом:
<service android:name="MyWidgetService"
android:permission="android.permission.BIND_REMOTEVIEWS" />
В этом примере android:name="MyWidgetService" – это подкласс RemoteViewsService.
Макет для виджетов с подборками
Основное требование к XML-файлу макета виджета – он должен включать одно из представлений коллекции: ListView, GridView, StackView или AdapterViewFlipper. Ниже приведен файл widget_layout.xml для примера 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>
Обратите внимание, что пустые представления должны быть дочерними элементами того же уровня, что и представление коллекции, для которого они представляют пустое состояние.
Помимо файла макета для всего виджета, создайте ещё один файл макета, который определяет макет для каждого элемента в коллекции, например макет для каждой книги в коллекции книг. В примере StackWidget есть только один файл макета элемента – widget_item.xml, поскольку все элементы используют один и тот же макет.
Класс AppWidgetProvider для виджетов с коллекциями
Как и в случае с обычными виджетами, основная часть кода в подклассе AppWidgetProvider обычно находится в onUpdate().
Основное отличие в реализации onUpdate() при создании виджета с коллекциями заключается в том, что необходимо вызвать setRemoteAdapter().
Это указывает представлению коллекции, откуда брать данные.
Затем RemoteViewsService может вернуть вашу реализацию RemoteViewsFactory, а виджет – предоставить нужные данные. При вызове этого метода передайте намерение, указывающее на вашу реализацию RemoteViewsService, и идентификатор виджета, который нужно обновить.
Например, в примере StackWidget метод обратного вызова onUpdate() используется для того, чтобы задать RemoteViewsService в качестве удаленного адаптера для коллекции виджетов:
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) }
Сохранение данных
Как описано на этой странице, подкласс RemoteViewsService предоставляет RemoteViewsFactory, используемый для заполнения удаленного представления коллекции.
Выполните следующие действия:
Подкласс
RemoteViewsService.RemoteViewsService– это сервис, через который удаленный адаптер может запрашиватьRemoteViews.В подкласс
RemoteViewsServiceвключите класс, реализующий интерфейсRemoteViewsFactory.RemoteViewsFactory– это интерфейс для адаптера между удаленным представлением коллекции (например,ListView,GridView,StackView) и базовыми данными для этого представления. Ваша реализация должна создавать объектRemoteViewsдля каждого элемента в наборе данных. Этот интерфейс представляет собой тонкую оболочку вокругAdapter.
Нельзя полагаться на то, что один экземпляр сервиса или содержащиеся в нем данные будут храниться постоянно. Не храните в RemoteViewsService динамические данные. Если вы хотите, чтобы данные виджета сохранялись, лучше всего использовать ContentProvider, данные которого сохраняются после завершения жизненного цикла процесса. Например, виджет продуктового магазина может хранить состояние каждого элемента списка покупок в постоянном месте, например в базе данных SQL.
Основным компонентом реализации RemoteViewsService является RemoteViewsFactory, описанный в следующем разделе.
Интерфейс RemoteViewsFactory
Ваш пользовательский класс, реализующий интерфейс RemoteViewsFactory, предоставляет виджету данные для элементов в его коллекции. Для этого он объединяет XML-файл макета элемента виджета с источником данных. Этим источником данных может быть что угодно, от базы данных до массива. В примере StackWidget источником данных является массив WidgetItems. RemoteViewsFactory работает как адаптер, который связывает данные с удаленным представлением коллекции.
Два наиболее важных метода, которые необходимо реализовать для подкласса RemoteViewsFactory, – это onCreate() и getViewAt().
Система вызывает onCreate() при первом создании фабрики.
Здесь вы настраиваете подключения или курсоры к источнику данных. Например, в примере StackWidget используется onCreate() для инициализации массива объектов WidgetItem. Когда виджет активен, система обращается к этим объектам, используя их индекс в массиве, и показывает содержащийся в них текст.
Ниже приведен фрагмент реализации RemoteViewsFactory из примера StackWidget, в котором показаны части метода onCreate():
private const val REMOTE_VIEW_COUNT: Int = 10 class StackRemoteViewsFactory( private val context: Context ) : RemoteViewsService.RemoteViewsFactory { private lateinit var widgetItems: List<WidgetItem> override fun onCreate() { // In onCreate(), set up any connections or cursors to your data // source. Heavy lifting, such as downloading or creating content, // must be deferred to onDataSetChanged() or getViewAt(). Taking // more than 20 seconds on this call results in an ANR. widgetItems = List(REMOTE_VIEW_COUNT) { index -> WidgetItem("$index!") } } }
Метод getViewAt() класса RemoteViewsFactory возвращает объект RemoteViews, соответствующий данным в указанной строке position набора данных. Ниже приведен фрагмент реализации RemoteViewsFactory из примера StackWidget.
override fun getViewAt(position: Int): RemoteViews { // Construct a remote views item based on the widget item XML file // and set the text based on the position. return RemoteViews(context.packageName, R.layout.widget_item).apply { setTextViewText(R.id.widget_item, widgetItems[position].text) } }
Как добавить поведение для отдельных элементов
В предыдущих разделах показано, как связать данные с коллекцией виджетов. Но что, если вы хотите добавить динамическое поведение к отдельным элементам в представлении коллекции?
Как описано в разделе Обработка событий с помощью класса onUpdate(), обычно для настройки поведения объекта при нажатии используется setOnClickPendingIntent(). Например, можно сделать так, чтобы при нажатии кнопки запускался объект Activity. Но этот подход не разрешен для дочерних представлений в отдельном элементе коллекции.
Например, с помощью setOnClickPendingIntent() можно настроить глобальную кнопку в виджете Gmail, которая запускает приложение, но не отдельные элементы списка.
Чтобы добавить поведение при нажатии для отдельных элементов в коллекции, используйте setOnClickFillInIntent(). Настройте шаблон отложенного интента для представления коллекции и задайте интент заполнения для каждого элемента в коллекции с помощью RemoteViewsFactory.
В этом разделе на примере StackWidget описывается, как добавить поведение к отдельным элементам. В примере StackWidget, если пользователь касается верхнего представления, виджет отображает сообщение Toast "Коснулся представления n", где n – индекс (позиция) затронутого представления. Вот как это работает.
StackWidgetProvider– подклассAppWidgetProvider– создает отложенный интент с настраиваемым действиемTOAST_ACTION.Когда пользователь касается представления, запускается намерение и транслируется
TOAST_ACTION.Эта трансляция перехватывается методом
onReceive()классаStackWidgetProvider, и виджет показывает сообщениеToastдля затронутого представления. Данные для элементов коллекции предоставляютсяRemoteViewsFactoryчерезRemoteViewsService.
Как настроить шаблон отложенного интента
StackWidgetProvider (подкласс AppWidgetProvider) настраивает отложенный интент. Отдельные элементы коллекции не могут настраивать собственные отложенные интенты. Вместо этого коллекция в целом настраивает шаблон отложенного намерения, а отдельные элементы устанавливают намерение заполнения, чтобы создать уникальное поведение для каждого элемента.
Этот класс также получает широковещательное сообщение, которое отправляется, когда пользователь касается представления. и обрабатывает его в методе onReceive(). Если действие намерения – TOAST_ACTION, виджет показывает сообщение Toast для текущего представления.
const val TOAST_ACTION = "com.example.android.stackwidget.TOAST_ACTION" const val EXTRA_ITEM = "com.example.android.stackwidget.EXTRA_ITEM" class StackWidgetProvider : AppWidgetProvider() { // ... // Called when the BroadcastReceiver receives an Intent broadcast. // Checks whether the intent's action is TOAST_ACTION. If it is, the // widget displays a Toast message for the current item. override fun onReceive(context: Context, intent: Intent) { val mgr: AppWidgetManager = AppWidgetManager.getInstance(context) if (intent.action == TOAST_ACTION) { val appWidgetId: Int = intent.getIntExtra( AppWidgetManager.EXTRA_APPWIDGET_ID, AppWidgetManager.INVALID_APPWIDGET_ID ) // EXTRA_ITEM represents a custom value provided by the Intent // passed to the setOnClickFillInIntent() method to indicate the // position of the clicked item. See StackRemoteViewsFactory in // Set the fill-in Intent for details. val viewIndex: Int = intent.getIntExtra(EXTRA_ITEM, 0) Toast.makeText(context, "Touched view $viewIndex", Toast.LENGTH_SHORT).show() } super.onReceive(context, intent) } override fun onUpdate( context: Context, appWidgetManager: AppWidgetManager, appWidgetIds: IntArray ) { // Update each of the widgets with the remote adapter. appWidgetIds.forEach { appWidgetId -> // Sets up the intent that points to the StackViewService that // provides the views for this collection. val intent = Intent(context, StackWidgetService::class.java).apply { putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId) // When intents are compared, the extras are ignored, so embed // the extra sinto the data so that the extras are not ignored. data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME)) } val rv = RemoteViews(context.packageName, R.layout.widget_layout).apply { setRemoteAdapter(R.id.stack_view, intent) // The empty view is displayed when the collection has no items. // It must be a sibling of the collection view. setEmptyView(R.id.stack_view, R.id.empty_view) } // This section makes it possible for items to have individualized // behavior. It does this by setting up a pending intent template. // Individuals items of a collection can't set up their own pending // intents. Instead, the collection as a whole sets up a pending // intent template, and the individual items set a fillInIntent // to create unique behavior on an item-by-item basis. val toastPendingIntent: PendingIntent = Intent( context, StackWidgetProvider::class.java ).run { // Set the action for the intent. // When the user touches a particular view, it has the effect of // broadcasting TOAST_ACTION. action = TOAST_ACTION putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId) data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME)) // The template must be mutable, because each item fills in its // own extras through setOnClickFillInIntent(). PendingIntent.getBroadcast( context, 0, this, PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_MUTABLE ) } rv.setPendingIntentTemplate(R.id.stack_view, toastPendingIntent) appWidgetManager.updateAppWidget(appWidgetId, rv) } super.onUpdate(context, appWidgetManager, appWidgetIds) } }
Установите намерение заполнения
Ваш RemoteViewsFactory должен задавать намерение заполнения для каждого элемента в коллекции. Это позволяет различать действия по клику для отдельных элементов. Затем намерение заполнения объединяется с шаблоном PendingIntent, чтобы определить окончательное намерение, которое выполняется при нажатии на элемент.
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) // ... } } // ... }
Поддерживайте актуальность данных в подборках
На рисунке 2 показан процесс обновления виджета, использующего коллекции. На ней показано, как код виджета взаимодействует с RemoteViewsFactory и как можно инициировать обновления.
RemoteViewsFactory во время обновлений.Виджеты, использующие коллекции, могут предоставлять пользователям актуальный контент. Например, виджет Gmail позволяет пользователям быстро просматривать входящие письма. Для этого настройте триггер RemoteViewsFactory и представление коллекции, чтобы получать и показывать новые данные.
Для этого используйте AppWidgetManager, чтобы вызвать notifyAppWidgetViewDataChanged(). Этот вызов приводит к обратному вызову метода onDataSetChanged() объекта RemoteViewsFactory, что позволяет получить новые данные.
Вы можете выполнять ресурсоемкие операции синхронно в обратном вызове onDataSetChanged(). Этот вызов завершается до того, как метаданные или данные представления будут получены из RemoteViewsFactory. В методе getViewAt() также можно выполнять ресурсоемкие операции. Если вызов занимает много времени, в соответствующей позиции представления коллекции будет показываться представление загрузки, заданное методом getLoadingView() объекта RemoteViewsFactory.
Используйте RemoteCollectionItems, чтобы передать коллекцию напрямую.
В Android 12 (уровень API 31) добавлен метод setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items), который позволяет приложению передавать коллекцию напрямую при заполнении представления коллекции. Если вы настроите адаптер таким образом, вам не нужно будет реализовывать RemoteViewsFactory и вызывать notifyAppWidgetViewDataChanged().
Это не только упрощает заполнение адаптера, но и устраняет задержку при заполнении новых элементов, когда пользователи прокручивают список. Этот подход к настройке адаптера предпочтителен, если набор элементов коллекции относительно невелик. Однако этот подход не работает, если коллекция содержит множество объектов Bitmaps, передаваемых в setImageViewBitmap.
Если в коллекции не используется постоянный набор макетов (то есть некоторые элементы присутствуют только иногда), используйте setViewTypeCount, чтобы указать максимальное количество уникальных макетов, которые может содержать коллекция. Это позволяет повторно использовать адаптер при обновлении виджета приложения.
Ниже приведен пример реализации упрощенных коллекций RemoteViews.
val itemLayouts = listOf( R.layout.item_type_1, R.layout.item_type_2, // ... ) remoteView.setRemoteAdapter( R.id.list_view, RemoteViews.RemoteCollectionItems.Builder() .addItem(/* id= */ ID_1, RemoteViews(context.packageName, R.layout.item_type_1)) .addItem(/* id= */ ID_2, RemoteViews(context.packageName, R.layout.item_type_2)) // ... .setViewTypeCount(itemLayouts.count()) .build() )