Widget koleksi memiliki spesialisasi dalam menampilkan banyak elemen dengan jenis yang sama, seperti koleksi gambar dari aplikasi galeri, artikel dari aplikasi berita, atau pesan dari aplikasi komunikasi. Widget koleksi biasanya berfokus pada dua kasus penggunaan: menjelajahi koleksi dan membuka elemen koleksi ke tampilan detailnya. Widget koleksi dapat di-scroll secara vertikal.
Widget ini menggunakan RemoteViewsService untuk menampilkan koleksi yang didukung oleh data jarak jauh, seperti dari penyedia konten. Widget menyajikan
data menggunakan salah satu jenis tampilan berikut, yang dikenal sebagai tampilan
koleksi:
ListView- Tampilan yang menunjukkan item dalam daftar scroll vertikal.
GridView- Tampilan yang menunjukkan item dalam petak scroll dua dimensi.
StackView- Tampilan kartu yang ditumpuk, seperti rolodex, tempat pengguna dapat menjentikkan kartu depan ke atas atau ke bawah untuk melihat kartu sebelumnya atau berikutnya.
AdapterViewFlipperViewAnimatorsederhana yang didukung adaptor yang menganimasikan antara dua tampilan atau lebih. Hanya satu turunan yang ditampilkan dalam satu waktu.
Karena tampilan koleksi ini menampilkan koleksi yang didukung oleh data jarak jauh, mereka
menggunakan Adapter untuk mengikat antarmuka
pengguna ke data mereka. Adapter mengikat masing-masing item dari kumpulan data
ke masing-masing objek View.
Selain itu, karena tampilan koleksi ini didukung oleh adaptor, framework Android
harus menyertakan arsitektur tambahan untuk mendukung penggunaannya dalam widget. Dalam konteks widget, Adapter diganti dengan RemoteViewsFactory, yang merupakan wrapper tipis di sekitar antarmuka Adapter. Saat diminta untuk
item tertentu dalam koleksi, RemoteViewsFactory akan membuat dan menampilkan
item untuk koleksi sebagai
objek RemoteViews. Untuk menyertakan tampilan koleksi di widget Anda, terapkan RemoteViewsService dan RemoteViewsFactory.
RemoteViewsService adalah layanan yang memungkinkan adaptor jarak jauh meminta
objek RemoteViews. RemoteViewsFactory adalah antarmuka untuk adaptor
antara tampilan koleksi—seperti ListView, GridView, dan
StackView—serta data yang mendasari untuk tampilan tersebut. Dalam contoh StackWidget, berikut adalah contoh kode boilerplate untuk mengimplementasikan layanan dan antarmuka ini:
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.
}
Contoh aplikasi
Cuplikan kode di bagian ini juga diambil dari contoh
StackWidget:
StackWidget.Contoh ini terdiri dari tumpukan sepuluh tampilan yang menampilkan nilai nol sampai sembilan. Widget contoh memiliki perilaku utama berikut:
Pengguna dapat melempar tampilan atas secara vertikal di widget untuk menampilkan tampilan berikutnya atau sebelumnya. Ini adalah perilaku
StackViewbawaan.Tanpa interaksi pengguna, widget akan otomatis membuka tampilannya secara berurutan, seperti slideshow. Hal ini disebabkan oleh setelan
android:autoAdvanceViewId="@id/stack_view"dalam fileres/xml/stackwidgetinfo.xml. Setelan ini berlaku untuk ID tampilan, yang dalam hal ini adalah ID tampilan dari tampilan stack.Jika pengguna menyentuh tampilan atas, widget akan menampilkan pesan
Toast"Tampilan tersentuh n", dengan n adalah indeks (posisi) tampilan tersentuh. Untuk pembahasan selengkapnya tentang cara menerapkan perilaku, lihat bagian Menambahkan perilaku ke setiap item.
Mengimplementasikan widget dengan koleksi
Untuk menerapkan widget dengan koleksi, ikuti prosedur untuk mengimplementasikan
widget, diikuti dengan beberapa langkah tambahan:
mengubah manifes, menambahkan tampilan koleksi ke tata letak widget, dan mengubah
subclass AppWidgetProvider.
Manifes untuk widget dengan koleksi
Di luar persyaratan yang tercantum dalam Mendeklarasikan widget dalam
manifes, Anda harus memungkinkan widget dengan
koleksi mengikat ke RemoteViewsService. Lakukan hal ini dengan mendeklarasikan
layanan dalam file manifes Anda dengan izin
BIND_REMOTEVIEWS.
Tindakan ini mencegah aplikasi lain mengakses data widget Anda secara bebas.
Misalnya, saat membuat widget yang menggunakan RemoteViewsService untuk mengisi tampilan koleksi, entri manifes mungkin terlihat seperti ini:
<service android:name="MyWidgetService"
android:permission="android.permission.BIND_REMOTEVIEWS" />
Dalam contoh ini, android:name="MyWidgetService" merujuk ke subclass RemoteViewsService Anda.
Tata letak untuk widget dengan koleksi
Persyaratan utama untuk file XML tata letak widget Anda adalah menyertakan salah satu
tampilan koleksi: ListView, GridView, StackView, atau
AdapterViewFlipper. Berikut adalah file widget_layout.xml untuk
contoh
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>
Perhatikan bahwa tampilan kosong harus seinduk dari tampilan koleksi yang tampilan kosongnya mewakili status kosong.
Selain file tata letak untuk seluruh widget Anda, buat file tata letak
lain yang menentukan tata letak untuk setiap item dalam koleksi—misalnya,
tata letak untuk setiap buku dalam koleksi buku. Contoh StackWidget hanya memiliki
satu file tata letak item, widget_item.xml, karena semua item menggunakan tata letak
yang sama.
Class AppWidgetProvider untuk widget dengan koleksi
Seperti widget biasa, sebagian besar kode di subclass
AppWidgetProvider
biasanya masuk
onUpdate().
Perbedaan utama dalam implementasi untuk onUpdate() saat membuat
widget dengan koleksi adalah Anda harus memanggil
setRemoteAdapter(). Atribut ini memberi tahu tampilan koleksi tempat untuk mendapatkan datanya.
Kemudian, RemoteViewsService dapat menampilkan penerapan RemoteViewsFactory Anda, dan widget dapat menyajikan data yang sesuai. Saat
memanggil metode ini, teruskan intent yang mengarah ke penerapan
RemoteViewsService dan ID widget yang menentukan widget yang akan diupdate.
Misalnya, berikut adalah cara contoh StackWidget mengimplementasikan metode callback onUpdate()
untuk menetapkan RemoteViewsService sebagai adaptor jarak jauh untuk
koleksi widget:
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);
}
Mempertahankan data
Seperti yang dijelaskan di halaman ini, subclass RemoteViewsService menyediakan
RemoteViewsFactory yang digunakan untuk mengisi tampilan koleksi jarak jauh.
Secara khusus, lakukan langkah-langkah berikut:
Subclass
RemoteViewsService.RemoteViewsServiceadalah layanan yang dapat digunakan adaptor jarak jauh untuk memintaRemoteViews.Di subclass
RemoteViewsService, sertakan class yang mengimplementasikan antarmukaRemoteViewsFactory.RemoteViewsFactoryadalah antarmuka untuk adaptor antara tampilan koleksi jarak jauh—sepertiListView,GridView,StackView—dan data yang mendasari untuk tampilan tersebut. Implementasi Anda bertanggung jawab untuk membuat objekRemoteViewsbagi setiap item dalam set data. Antarmuka ini adalah wrapper tipis di sekitarAdapter.
Anda tidak dapat mengandalkan satu instance layanan, atau data apa pun yang ada di dalamnya, untuk dipertahankan. Jangan simpan data di RemoteViewsService kecuali jika data tersebut statis. Jika
Anda ingin data widget tetap ada, pendekatan terbaik adalah menggunakan
ContentProvider yang datanya
tetap ada di luar siklus proses proses. Misalnya, widget toko bahan makanan dapat
menyimpan status setiap item daftar belanja di lokasi persisten, seperti
database SQL.
Konten utama implementasi RemoteViewsService adalah
RemoteViewsFactory, yang dijelaskan di bagian berikut.
Antarmuka RemoteViewFactory
Class kustom Anda yang menerapkan antarmuka RemoteViewsFactory menyediakan
data untuk item dalam koleksinya ke widget. Untuk melakukannya, file tata letak XML item widget Anda akan digabungkan dengan sumber data. Sumber data ini dapat berupa apa saja, mulai dari database hingga array sederhana. Pada contoh StackWidget, sumber datanya adalah array WidgetItems. RemoteViewsFactory
berfungsi sebagai adaptor untuk menempelkan data ke tampilan koleksi jarak jauh.
Dua metode terpenting yang perlu diterapkan untuk
subclass RemoteViewsFactory adalah
onCreate() dan
getViewAt().
Sistem memanggil onCreate() saat membuat factory untuk pertama kalinya.
Di sinilah Anda menyiapkan koneksi atau kursor ke sumber data Anda. Misalnya, contoh StackWidget menggunakan onCreate() untuk menginisialisasi array objek
WidgetItem. Saat widget aktif, sistem akan mengakses objek ini menggunakan posisi indeksnya dalam array dan menampilkan teks yang ada di dalamnya.
Berikut adalah kutipan dari implementasi RemoteViewsFactory sampel StackWidget
yang menunjukkan bagian dari metode 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 + "!"));
}
...
}
...
Metode RemoteViewsFactory, getViewAt(), menampilkan objek RemoteViews yang sesuai dengan data pada position yang ditentukan dalam set data. Berikut adalah
kutipan dari implementasi RemoteViewsFactory contoh 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;
}
Menambahkan perilaku ke masing-masing item
Bagian sebelumnya menunjukkan cara mengikat data ke koleksi widget Anda. Namun, bagaimana jika Anda ingin menambahkan perilaku dinamis ke masing-masing item dalam tampilan koleksi?
Seperti yang dijelaskan dalam Menangani peristiwa dengan class
onUpdate(), Anda biasanya menggunakan
setOnClickPendingIntent() untuk menetapkan perilaku klik objek—seperti untuk
menyebabkan tombol meluncurkan Activity. Namun,
pendekatan ini tidak diizinkan untuk tampilan turunan dalam masing-masing item koleksi.
Sebagai contoh, Anda dapat menggunakan setOnClickPendingIntent() untuk menyiapkan tombol global
di widget Gmail yang meluncurkan aplikasi, tetapi tidak pada
masing-masing item daftar.
Sebagai gantinya, untuk menambahkan perilaku klik ke setiap item dalam koleksi, gunakan
setOnClickFillInIntent(). Hal ini memerlukan penyiapan template intent yang tertunda untuk
tampilan koleksi, lalu menyetel intent pengganti pada setiap item dalam
koleksi melalui RemoteViewsFactory.
Bagian ini menggunakan contoh StackWidget untuk menjelaskan cara menambahkan perilaku ke setiap item. Dalam contoh StackWidget, jika pengguna menyentuh tampilan atas,
widget akan menampilkan pesan Toast "Tampilan tersentuh n", dengan n adalah
indeks (posisi) tampilan tersentuh. Begini cara kerjanya:
StackWidgetProvider—subclassAppWidgetProvider—membuat intent tertunda dengan tindakan kustom yang disebutTOAST_ACTION.Saat pengguna menyentuh tampilan, intent akan diaktifkan dan menyiarkan
TOAST_ACTION.Siaran ini dicegat oleh metode
onReceive()classStackWidgetProvider, dan widget menampilkan pesanToastuntuk tampilan tersentuh. Data untuk item koleksi disediakan olehRemoteViewsFactorymelaluiRemoteViewsService.
Menyiapkan template intent yang tertunda
StackWidgetProvider (subclass
AppWidgetProvider)
menyiapkan intent yang tertunda. Setiap item koleksi tidak dapat menyiapkan
intent tertundanya sendiri. Sebagai gantinya, koleksi secara keseluruhan menyiapkan template intent
yang tertunda, dan setiap item menetapkan intent pengganti untuk membuat perilaku
unik per item.
Class ini juga menerima siaran yang dikirim saat pengguna menyentuh
tampilan. Hal ini memproses peristiwa ini pada onReceive() metodenya. Jika tindakan intent
adalah TOAST_ACTION, widget akan menampilkan pesan Toast untuk tampilan
saat ini.
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);
}
}
Menetapkan intent pengganti
RemoteViewsFactory Anda harus menetapkan intent pengganti pada setiap item dalam koleksi. Hal ini memungkinkan untuk membedakan masing-masing tindakan klik
dari item tertentu. Intent pengganti kemudian digabungkan dengan
template PendingIntent untuk menentukan
intent akhir yang dijalankan saat item diketuk.
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;
}
...
}
Selalu perbarui data koleksi
Gambar 2 mengilustrasikan alur update di widget yang menggunakan koleksi. Contoh ini menunjukkan cara kode widget berinteraksi dengan RemoteViewsFactory dan cara Anda dapat memicu update:
RemoteViewsFactory selama update.Widget yang menggunakan koleksi dapat memberikan konten terbaru kepada pengguna. Misalnya, widget Gmail memberi pengguna ringkasan kotak masuk mereka. Agar hal ini
dapat dilakukan, picu RemoteViewsFactory dan tampilan koleksi untuk mengambil dan
menampilkan data baru.
Untuk melakukannya, gunakan
AppWidgetManager untuk memanggil
notifyAppWidgetViewDataChanged(). Panggilan ini menghasilkan callback ke metode
onDataSetChanged()
objek RemoteViewsFactory, yang memungkinkan Anda mengambil data baru.
Anda dapat menjalankan operasi pemrosesan intensif secara sinkron dalam callback onDataSetChanged(). Dipastikan bahwa panggilan ini akan selesai
sebelum metadata atau data tampilan diambil dari RemoteViewsFactory. Anda juga dapat melakukan operasi yang intensif pemrosesan dalam metode getViewAt(). Jika panggilan ini memerlukan waktu lama, tampilan pemuatan—yang ditetapkan oleh
metode getLoadingView()
objek RemoteViewsFactory—akan ditampilkan di posisi yang sesuai dengan tampilan koleksi
hingga ditampilkan.
Menggunakan RemoteCollectionItems untuk meneruskan koleksi secara langsung
Android 12 (API level 31) menambahkan metode setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items)
yang memungkinkan aplikasi meneruskan koleksi secara langsung saat mengisi
tampilan koleksi. Jika menyetel adaptor menggunakan metode ini, Anda tidak perlu
mengimplementasikan RemoteViewsFactory dan tidak perlu memanggil
notifyAppWidgetViewDataChanged().
Selain mempermudah pengisian adaptor, pendekatan ini juga
menghapus latensi untuk mengisi item baru saat pengguna men-scroll daftar ke bawah untuk
menampilkan item baru. Pendekatan untuk menyetel adaptor ini lebih disarankan selama
kumpulan item koleksi Anda relatif kecil. Namun, misalnya, pendekatan
ini tidak berfungsi dengan baik jika koleksi Anda berisi banyak Bitmaps yang
diteruskan ke setImageViewBitmap.
Jika koleksi tidak menggunakan kumpulan tata letak yang konstan—yaitu, jika beberapa
item terkadang hanya ada—gunakan setViewTypeCount untuk menentukan
jumlah maksimum tata letak unik yang dapat dimuat dalam koleksi. Hal ini memungkinkan
adaptor digunakan kembali di seluruh update untuk widget aplikasi Anda.
Berikut adalah contoh cara mengimplementasikan koleksi RemoteViews sederhana.
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()
);