Используйте виджеты коллекций

Виджеты коллекций специализируются на отображении множества элементов одного типа, например коллекций изображений из приложения-галереи, статей из новостного приложения или сообщений из коммуникационного приложения. Виджеты коллекций обычно ориентированы на два варианта использования: просмотр коллекции и открытие элемента коллекции для его подробного просмотра. Виджеты коллекций могут прокручиваться вертикально.

Эти виджеты используют 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 {
        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.

}

Ява

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.

}

Образец заявления

Выдержки кода в этом разделе также взяты из примера StackWidget :

Рисунок 1. StackWidget .

Этот образец состоит из десяти представлений, отображающих значения от нуля до девяти. Пример виджета имеет следующие основные функции:

• Пользователь может вертикально перевернуть вид сверху в виджете, чтобы отобразить следующий или предыдущий вид. Это встроенное поведение StackView .

• Без какого-либо взаимодействия с пользователем виджет автоматически последовательно перемещается по своим представлениям, как слайд-шоу. Это связано с настройкой android:autoAdvanceViewId="@id/stack_view" в файле res/xml/stackwidgetinfo.xml . Этот параметр применяется к идентификатору представления, который в данном случае является идентификатором представления стека.

• Если пользователь касается вида сверху, виджет отображает Toast сообщение «Touched view 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)
}

Ява

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);
}

Сохранение данных

Как описано на этой странице, подкласс RemoteViewsService предоставляет RemoteViewsFactory используемый для заполнения представления удаленной коллекции.

В частности, выполните следующие действия:

1. Подкласс RemoteViewsService . RemoteViewsService — это служба, посредством которой удаленный адаптер может запрашивать RemoteViews .

2. В подкласс RemoteViewsService включите класс, реализующий интерфейс RemoteViewsFactory . RemoteViewsFactory — это интерфейс адаптера между представлением удаленной коллекции, например ListView , GridView , StackView , и базовыми данными для этого представления. Ваша реализация отвечает за создание объекта RemoteViews для каждого элемента набора данных. Этот интерфейс представляет собой тонкую оболочку Adapter .

Вы не можете полагаться на сохранение единственного экземпляра вашего сервиса или любых содержащихся в нем данных. Не храните данные в RemoteViewsService , если они не являются статическими. Если вы хотите, чтобы данные вашего виджета сохранялись, лучший подход — использовать ContentProvider , данные которого сохраняются после жизненного цикла процесса. Например, виджет продуктового магазина может хранить состояние каждого элемента списка продуктов в постоянном месте, например в базе данных SQL.

Примечание. См. пример кода WeatherDataProvider.java , демонстрирующий, как сохранить базовые данные виджета с помощью ContentProvider .

Основным содержимым реализации 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!") }
        ...
    }
    ...
}

Ява

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 + "!"));
        }
        ...
    }
...

Метод RemoteViewsFactory getViewAt() возвращает объект 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)
    }
}

Ява

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;
}

Добавить поведение к отдельным элементам

В предыдущих разделах показано, как привязать ваши данные к коллекции виджетов. Но что, если вы хотите добавить динамическое поведение к отдельным элементам в представлении коллекции?

Как описано в разделе «Обработка событий с помощью класса onUpdate() , вы обычно используете setOnClickPendingIntent() для установки поведения щелчка объекта — например, чтобы кнопка запускала Activity . Но этот подход недопустим для дочерних представлений в отдельном элементе коллекции. Например, вы можете использовать setOnClickPendingIntent() чтобы настроить глобальную кнопку в виджете Gmail, например, запускающую приложение, но не для отдельных элементов списка.

Вместо этого, чтобы добавить поведение щелчка к отдельным элементам коллекции, используйте setOnClickFillInIntent() . Это влечет за собой настройку ожидающего шаблона намерения для вашего представления коллекции, а затем установку намерения заполнения для каждого элемента в коллекции через RemoteViewsFactory .

В этом разделе используется образец StackWidget , чтобы описать, как добавить поведение к отдельным элементам. В примере StackWidget , если пользователь прикасается к виду сверху, виджет отображает Toast сообщение «Touched view n », где n — индекс (позиция) сенсорного представления. Вот как это работает:

• StackWidgetProvider — подкласс AppWidgetProvider — создает ожидающее намерение с помощью настраиваемого действия TOAST_ACTION .

• Когда пользователь касается представления, срабатывает намерение и передается TOAST_ACTION .

• Эта трансляция перехватывается методом onReceive() класса StackWidgetProvider , и виджет отображает Toast -сообщение для сенсорного представления. Данные для элементов коллекции предоставляются RemoteViewsFactory через RemoteViewsService .

Примечание. В примере StackWidget используется широковещательная рассылка, но обычно виджет запускает действие в таком сценарии.

Настройка шаблона ожидающего намерения

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))

                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)
    }
}

Ява

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);
    }
}

Установите намерение заполнения

Ваш 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)
            ...
        }
    }
    ...
}

Ява

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;
    }
    ...
}

Сохраняйте актуальность данных коллекции

На рис. 2 показан процесс обновления виджета, использующего коллекции. Он показывает, как код виджета взаимодействует с RemoteViewsFactory и как вы можете запускать обновления:

Рисунок 2. Взаимодействие с 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()
)

Ява

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()
);

Примечание. При вызове setViewTypeCount() передайте максимальное количество различных идентификаторов макета, которые используются RemoteViews в этой коллекции. В противном случае количество типов представлений выводится из предоставленных элементов, а адаптер создается заново при отправке обновления, использующего дополнительные макеты.