Widget koleksi memiliki spesialisasi dalam menampilkan banyak elemen dari jenis yang sama, seperti sebagai kumpulan gambar dari aplikasi galeri, artikel dari aplikasi berita, atau membuat pesan dari aplikasi komunikasi. Widget koleksi biasanya berfokus pada dua kegunaan kasus: menjelajahi koleksi dan membuka elemen koleksi ke tampilan detail. Widget koleksi dapat di-scroll secara vertikal.
Widget ini menggunakan
RemoteViewsService untuk ditampilkan
koleksi yang didukung oleh data jarak jauh, seperti dari konten
cloud Anda. Widget ini menyajikan
data menggunakan salah satu jenis tampilan berikut, yang dikenal sebagai koleksi
penayangan:
ListView- Tampilan yang menunjukkan item dalam daftar scroll vertikal.
GridView- Tampilan yang menunjukkan item dalam petak scroll dua dimensi.
StackView- Kartu yang ditumpuk —seperti rolodex—di mana pengguna dapat mengibaskan bagian depan ke atas atau ke bawah untuk melihat kartu sebelumnya atau berikutnya.
AdapterViewFlipper- An
sederhana yang didukung adaptor
ViewAnimatoryang membuat animasi di antara dua tampilan atau lebih. Hanya satu turunan yang ditampilkan pada satu waktu.
Karena tampilan koleksi ini menampilkan koleksi yang didukung oleh data jarak jauh, tampilan tersebut
menggunakan Adapter untuk mengikat penggunanya
antarmuka pengguna ke data mereka. Adapter mengikat item individual dari kumpulan data
ke objek View individual.
Dan karena tampilan koleksi ini didukung oleh adaptor, framework Android
harus menyertakan arsitektur tambahan untuk mendukung penggunaannya dalam widget. Dalam konteks
dari widget, Adapter diganti dengan
RemoteViewsFactory,
yang merupakan wrapper tipis di sekitar antarmuka Adapter. Jika diminta untuk
item tertentu dalam koleksi, RemoteViewsFactory akan membuat dan mengembalikan
item untuk koleksi sebagai
Objek RemoteViews. Untuk menyertakan
tampilan koleksi di widget Anda, terapkan RemoteViewsService, dan
RemoteViewsFactory.
RemoteViewsService adalah layanan yang memungkinkan permintaan adaptor jarak jauh
RemoteViews objek. RemoteViewsFactory adalah antarmuka untuk adaptor
di antara tampilan koleksi—seperti ListView, GridView, dan
StackView—dan data pokok untuk tampilan tersebut. Dari StackWidget
contoh,
berikut adalah contoh kode boilerplate untuk menerapkan layanan ini dan
antarmuka:
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 StackWidget
contoh:
StackWidget.Contoh ini terdiri dari tumpukan sepuluh tampilan yang menampilkan nilai nol hingga sembilan. Widget contoh memiliki perilaku utama berikut:
Pengguna dapat melempar tampilan atas secara vertikal dalam widget untuk menampilkan atau tampilan sebelumnya. Ini adalah perilaku
StackViewbawaan.Tanpa interaksi pengguna, widget secara otomatis melanjutkan tampilan secara berurutan, seperti {i>slideshow<i}. Hal ini karena 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 tumpukan.Jika pengguna menyentuh tampilan atas, widget akan menampilkan
Toastpesan "Tampilan tersentuh n", dengan n adalah indeks (posisi) tampilan tersentuh. Untuk diskusi lebih lanjut tentang bagaimana untuk menerapkan perilaku, lihat dokumentasi Menambahkan perilaku bagian item.
Mengimplementasikan widget dengan koleksi
Untuk menerapkan widget dengan koleksi, ikuti prosedur untuk menerapkan
, diikuti dengan beberapa langkah tambahan:
memodifikasi manifes, menambahkan tampilan koleksi ke tata letak widget, dan memodifikasi
Subclass AppWidgetProvider.
Manifes untuk widget dengan koleksi
Di luar persyaratan yang tercantum dalam Mendeklarasikan widget di
manifes, Anda harus memungkinkan widget dengan
koleksi untuk diikat ke RemoteViewsService Anda. Lakukan dengan mendeklarasikan
di 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 akan terlihat seperti ini:
<service android:name="MyWidgetService"
android:permission="android.permission.BIND_REMOTEVIEWS" />
Dalam contoh ini, android:name="MyWidgetService" merujuk ke subclass Anda dari
RemoteViewsService.
Tata letak untuk widget dengan koleksi
Persyaratan utama untuk file XML tata letak widget Anda adalah bahwa file tersebut menyertakan salah satu
tampilan koleksi: ListView, GridView, StackView, atau
AdapterViewFlipper. Berikut adalah file widget_layout.xml untuk
StackWidget
contoh:
<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 bersaudara dengan tampilan koleksi yang tampilan kosong mewakili status kosong.
Selain file tata letak untuk seluruh widget Anda, buat tata letak lain
file yang mendefinisikan tata letak untuk setiap item dalam koleksi—misalnya,
tata letak untuk setiap buku
dalam koleksi buku. Contoh StackWidget memiliki
hanya satu file tata letak item, widget_item.xml, karena semua item menggunakan
tata letak.
Class AppWidgetProvider untuk widget dengan koleksi
Seperti halnya widget biasa, sebagian besar kode di
Subclass AppWidgetProvider
biasanya masuk
onUpdate().
Perbedaan utama dalam penerapan Anda untuk onUpdate() saat membuat
dengan koleksi adalah Anda harus memanggil
setRemoteAdapter(). Tindakan ini memberi tahu tampilan koleksi tempat untuk mendapatkan datanya.
RemoteViewsService kemudian dapat menampilkan implementasi
RemoteViewsFactory, dan widget tersebut dapat menyajikan data yang sesuai. Jika Anda
memanggil metode ini, meneruskan intent yang menunjukkan implementasi
RemoteViewsService dan ID widget yang menentukan widget yang akan diupdate.
Sebagai contoh, berikut adalah cara contoh StackWidget mengimplementasikan onUpdate()
metode callback untuk menyetel 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 melalui yang dapat diminta oleh adaptor jarak jauh yang dapat memintaRemoteViews.Di subclass
RemoteViewsService, sertakan class yang mengimplementasikan class AntarmukaRemoteViewsFactory.RemoteViewsFactoryadalah antarmuka untuk adaptor di antara tampilan koleksi jarak jauh—sepertiListView,GridView,StackView—dan data pokok untuk tampilan tersebut. Nama bertanggung jawab untuk membuat objekRemoteViewsuntuk setiap item baris 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,
akan dipertahankan. Jangan simpan data di RemoteViewsService kecuali jika data itu statis. Jika
yang Anda inginkan agar 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 belanjaan di lokasi persisten, seperti
di SQL Server.
Konten utama dari implementasi RemoteViewsService adalah
RemoteViewsFactory, dijelaskan di bagian berikut.
Antarmuka RemoteViewFactory
Class kustom Anda yang mengimplementasikan antarmuka RemoteViewsFactory menyediakan
widget dengan data untuk item yang ada dalam koleksinya. Untuk melakukannya,
menggabungkan file tata letak XML item widget Anda dengan sumber data. Sumber
data dapat berupa apa saja,
mulai dari {i>database<i} hingga {i>array<i} sederhana. Di StackWidget
sumber datanya adalah array WidgetItems. RemoteViewsFactory
berfungsi sebagai adaptor untuk menggabungkan data ke tampilan koleksi jarak jauh.
Dua metode terpenting yang perlu Anda terapkan 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. Sebagai
misalnya, contoh StackWidget menggunakan onCreate() untuk menginisialisasi array
Objek WidgetItem. Saat widget Anda aktif, sistem akan mengakses
objek menggunakan posisi indeksnya dalam array dan menampilkan teks yang
untuk menampungnya.
Berikut adalah kutipan dari RemoteViewsFactory contoh StackWidget
implementasi 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
kutipan dari penerapan 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 setiap item
Bagian sebelumnya menunjukkan cara mengikat data ke koleksi widget. Tapi bagaimana jika Anda ingin menambahkan perilaku dinamis ke setiap item di tampilan koleksi?
Seperti yang dijelaskan dalam Menangani peristiwa dengan onUpdate()
, Anda biasanya menggunakan
setOnClickPendingIntent() untuk menetapkan perilaku klik objek—seperti
menyebabkan tombol meluncurkan Activity. Tapi
pendekatan ini tidak diperbolehkan untuk tampilan turunan dalam item koleksi individual.
Misalnya, Anda dapat menggunakan setOnClickPendingIntent() untuk menyiapkan tombol global
dalam widget Gmail yang meluncurkan aplikasi, misalnya, namun tidak pada
item daftar individual.
Sebagai gantinya, untuk menambahkan perilaku klik ke setiap item dalam koleksi, gunakan
setOnClickFillInIntent() Ini berarti menyiapkan {i>template<i} intent yang tertunda untuk
tampilan koleksi Anda, lalu menyetel intent pengisi pada setiap item dalam
melalui RemoteViewsFactory Anda.
Bagian ini menggunakan contoh StackWidget untuk menjelaskan cara menambahkan perilaku ke
item individual. Dalam contoh StackWidget, jika pengguna menyentuh tampilan atas,
widget menampilkan pesan Toast "Tampilan tersentuh n", dengan n adalah
indeks (posisi) tampilan tersentuh. Begini cara kerjanya:
StackWidgetProvider—AppWidgetProvidersubclass—membuat intent yang tertunda dengan tindakan kustom yang disebutTOAST_ACTION.Saat pengguna menyentuh tampilan, intent akan diaktifkan dan akan disiarkan
TOAST_ACTION.Siaran ini dicegat oleh class
StackWidgetProviderMetodeonReceive(), dan widget menampilkan pesanToastuntuk tampilan tersentuh. Data untuk item koleksi disediakan olehRemoteViewsFactorymelaluiRemoteViewsService.
Menyiapkan template intent yang tertunda
StackWidgetProvider (
subclass AppWidgetProvider)
dan menyiapkan intent yang tertunda. Masing-masing item koleksi tidak dapat disiapkan
intent yang tertunda sendiri. Sebagai gantinya, kumpulan secara keseluruhan akan menyiapkan intent yang tertunda
dalam template, dan masing-masing item menetapkan intent pengganti untuk membuat
perilaku per item.
Class ini juga menerima siaran yang dikirim saat pengguna menyentuh
{i>view<i}. Hal ini memproses peristiwa ini pada onReceive() metodenya. Jika intent
tindakannya adalah TOAST_ACTION, widget menampilkan pesan Toast untuk
{i>view<i}.
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
pengumpulan data. Hal ini memungkinkan untuk membedakan setiap tindakan klik
dari item tertentu. Intent pengganti ini kemudian dikombinasikan 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. Menunjukkan
cara kode widget berinteraksi dengan RemoteViewsFactory dan cara Anda dapat
memicu pembaruan:
RemoteViewsFactory selama update.Widget yang menggunakan koleksi dapat memberi pengguna konten terbaru. Sebagai
misalnya, widget Gmail memberikan ringkasan kotak masuk mereka kepada pengguna. Untuk membuatnya
mungkin, picu RemoteViewsFactory dan tampilan koleksi Anda untuk mengambil dan
menampilkan data baru.
Untuk melakukannya, gunakan
AppWidgetManager untuk ditelepon
notifyAppWidgetViewDataChanged(). Panggilan ini menghasilkan callback ke objek RemoteViewsFactory Anda
onDataSetChanged()
, yang memungkinkan Anda mengambil data baru.
Anda bisa melakukan operasi pemrosesan intensif secara sinkron dalam
Callback onDataSetChanged(). Dijamin bahwa panggilan ini akan diselesaikan
sebelum data tampilan atau metadata diambil dari RemoteViewsFactory. Anda
juga dapat melakukan operasi pemrosesan yang intensif dalam getViewAt()
. Jika panggilan ini memakan waktu lama, tampilan pemuatan—yang ditentukan oleh
RemoteViewsFactory objek
getLoadingView()
— ditampilkan di posisi yang sesuai dari tampilan koleksi
hingga ditampilkan.
Menggunakan RemoteCollectionItems untuk meneruskan koleksi secara langsung
Android 12 (level API 31) menambahkan setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items)
, yang memungkinkan aplikasi meneruskan koleksi secara langsung saat mengisi
tampilan koleksi. Jika Anda mengatur adaptor menggunakan metode ini, Anda tidak perlu
mengimplementasikan RemoteViewsFactory dan Anda tidak perlu memanggil
notifyAppWidgetViewDataChanged().
Selain mempermudah pengisian adaptor, pendekatan ini juga
menghilangkan latensi untuk mengisi item baru bila pengguna menggulir daftar ke bawah untuk
menampilkan item baru. Pendekatan untuk pengaturan
adaptor ini lebih disukai selama
kumpulan item koleksi Anda relatif kecil. Namun, misalnya,
pendekatan tidak akan berfungsi dengan baik jika koleksi Anda berisi banyak Bitmaps yang
diteruskan ke setImageViewBitmap.
Jika koleksi tidak menggunakan seperangkat tata letak yang konstan—yaitu, jika beberapa
item hanya terkadang ada. Gunakan setViewTypeCount untuk menentukan
jumlah maksimum tata letak unik yang dapat dimuat koleksi. Hal ini memungkinkan
adaptor dapat digunakan kembali di seluruh pembaruan pada 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()
);