Koleksiyon widget'ları, bir galeri uygulamasından resim koleksiyonları, bir haber uygulamasından makaleler veya bir iletişim uygulamasından mesajlar gibi aynı türden birçok öğeyi görüntülemede uzmanlaşır. Koleksiyon widget'ları genellikle iki kullanım alanına odaklanır: koleksiyona göz atmak ve koleksiyondaki bir öğeyi ayrıntı görünümünde açmak. Koleksiyon widget'ları dikey olarak kaydırılabilir.
Bu widget'lar, içerik sağlayıcı gibi uzak verilerle desteklenen koleksiyonları görüntülemek için RemoteViewsService
özelliğini kullanır. Widget, verileri koleksiyon görünümleri olarak bilinen aşağıdaki görünüm türlerinden birini kullanarak sunar:
ListView
- Öğeleri dikey olarak kayan bir listede gösteren görünüm.
GridView
- Öğeleri iki boyutlu kayan bir ızgarada gösteren görünüm.
StackView
- Bir çeşit rolodex gibi, kullanıcının sırasıyla önceki veya sonraki kartı görmek için ön kartı yukarı veya aşağı döndürebildiği yığın kart görünümü.
AdapterViewFlipper
- İki veya daha fazla görünüm arasında animasyon yapan
bağdaştırıcı destekli basit bir
ViewAnimator
. Tek seferde yalnızca bir çocuk gösterilir.
Bu koleksiyon görünümleri, uzak verilerle desteklenen koleksiyonları gösterdiğinden kullanıcı arayüzünü verilerine bağlamak için bir Adapter
kullanır. Adapter
, bir veri kümesinden bağımsız öğeleri bağımsız View
nesnelerine bağlar.
Bu koleksiyon görünümleri bağdaştırıcılar tarafından desteklendiğinden Android çerçevesinin widget'larda kullanımını desteklemek için ekstra mimari içermesi gerekir. Widget'lar bağlamında Adapter
öğesinin yerine, Adapter
arayüzünün etrafına ince bir sarmalayıcı olan RemoteViewsFactory
etiketi gelir. Koleksiyondaki belirli bir öğe için istekte bulunulduğunda, RemoteViewsFactory
, koleksiyonun öğesini bir RemoteViews
nesnesi olarak oluşturur ve döndürür. Widget'ınıza koleksiyon görünümü eklemek için RemoteViewsService
ve RemoteViewsFactory
öğelerini uygulayın.
RemoteViewsService
, uzak bağdaştırıcının RemoteViews
nesne isteğinde bulunmasına olanak tanıyan bir hizmettir. RemoteViewsFactory
, bir koleksiyon görünümü (ör. ListView
, GridView
ve StackView
) ile bu görünümün temel verileri arasındaki bağdaştırıcının arayüzüdür. StackWidget
örneğinden bu hizmeti ve arayüzü uygulamak için kullanılacak standart kod örneğini aşağıda bulabilirsiniz:
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. }
Örnek uygulama
Bu bölümdeki kod alıntıları da StackWidget
örneğinden alınır:
Bu örnek, sıfır ile dokuz arasındaki değerleri gösteren on görünümden oluşan bir yığından oluşur. Örnek widget'ın birincil davranışları şunlardır:
Kullanıcı, sonraki veya önceki görünümü görüntülemek için widget'ta üst görünümü dikey olarak kaydırabilir. Bu, yerleşik bir
StackView
davranışıdır.Widget, herhangi bir kullanıcı etkileşimi olmadan, bir slayt gösterisi gibi otomatik olarak sırayla kendi görünümlerinde ilerler. Bunun nedeni,
res/xml/stackwidgetinfo.xml
dosyasındakiandroid:autoAdvanceViewId="@id/stack_view"
ayarıdır. Bu ayar, görünüm kimliği için geçerlidir. Görünüm kimliği bu durumda yığın görünümünün görünüm kimliğidir.Kullanıcı üst görünüme dokunursa widget
Toast
"Dokunmalı görünüm n" mesajını görüntüler. Burada n dokunulan görünümün dizinini (konum) ifade eder. Davranışların nasıl uygulanacağı hakkında daha fazla tartışma için Bağımsız öğelere davranış ekleme bölümüne bakın.
Koleksiyonlarla widget uygulama
Koleksiyon içeren bir widget uygulamak için, herhangi bir widget'ı uygulama prosedürünü uygulayın ve ardından birkaç ek adımı uygulayın: manifest'i değiştirin, widget düzenine bir koleksiyon görünümü ekleyin ve AppWidgetProvider
alt sınıfınızı değiştirin.
Koleksiyon içeren widget'lar için manifest
Manifest'te widget bildirme bölümünde listelenen gereksinimlerin ötesinde, koleksiyon içeren widget'ların RemoteViewsService
öğenize bağlanabilmesini sağlamanız gerekir. Bunu, BIND_REMOTEVIEWS
izniyle manifest dosyanızda hizmeti belirterek yapabilirsiniz.
Bu, diğer uygulamaların widget'ınızın verilerine serbest bir şekilde erişmesini engeller.
Örneğin, bir koleksiyon görünümünü doldurmak için RemoteViewsService
kullanan bir widget oluşturduğunuzda manifest girişi aşağıdaki gibi görünebilir:
<service android:name="MyWidgetService"
android:permission="android.permission.BIND_REMOTEVIEWS" />
Bu örnekte android:name="MyWidgetService"
, RemoteViewsService
alt sınıfınızı ifade eder.
Koleksiyon içeren widget'lar için düzen
Widget düzeni XML dosyanız için temel gereksinim, koleksiyon görünümlerinden birini içermesidir: ListView
, GridView
, StackView
veya AdapterViewFlipper
. StackWidget
örneği için widget_layout.xml
dosyası aşağıdaki gibidir:
<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>
Boş görünümlerin, boş görünümün boş durumu temsil ettiği koleksiyon görünümünün kardeş öğeleri olması gerektiğini unutmayın.
Widget'ınızın tamamı için düzen dosyasına ek olarak, koleksiyondaki her öğenin düzenini tanımlayan başka bir düzen dosyası oluşturun (örneğin, bir kitap koleksiyonundaki her kitap için bir düzen). Tüm öğeler aynı düzeni kullandığından StackWidget
örneğinde yalnızca bir tane öğe düzen dosyası (widget_item.xml
) bulunur.
Koleksiyonlara sahip widget'lar için AppWidgetProvider sınıfı
Normal widget'larda olduğu gibi, AppWidgetProvider
alt sınıfınızdaki kodun büyük kısmı genellikle onUpdate()
içinde yer alır.
Koleksiyonlar içeren bir widget oluştururken onUpdate()
uygulamanızdaki en önemli fark setRemoteAdapter()
yöntemini çağırmanızdır. Bu, koleksiyon görünümüne verilerinin nereden alınacağını bildirir.
Ardından RemoteViewsService
, RemoteViewsFactory
kullanımınızı döndürür ve widget uygun verileri sunabilir. Bu yöntemi çağırırken RemoteViewsService
uygulamanıza işaret eden bir amaç ve güncellenecek widget'ı belirten widget kimliğini iletin.
Örneğin, StackWidget
örneğinin RemoteViewsService
öğesini widget koleksiyonunun uzak bağdaştırıcısı olarak ayarlamak için onUpdate()
geri çağırma yöntemini nasıl uyguladığı aşağıda açıklanmıştır:
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); }
Verileri koru
Bu sayfada açıklandığı gibi, RemoteViewsService
alt sınıfı, uzak koleksiyon görünümünü doldurmak için kullanılan RemoteViewsFactory
bilgisini sağlar.
Özellikle aşağıdaki adımları uygulayın:
RemoteViewsService
alt sınıfı.RemoteViewsService
, bir uzak bağdaştırıcınınRemoteViews
isteğinde bulunabileceği hizmettir.RemoteViewsService
alt sınıfınıza,RemoteViewsFactory
arayüzünü uygulayan bir sınıf ekleyin.RemoteViewsFactory
, uzak bir koleksiyon görünümü (ör.ListView
,GridView
,StackView
) ile söz konusu görünümün temel verileri arasındaki adaptöre ait bir arayüzdür. Uygulamanız, veri kümesindeki her öğe için birRemoteViews
nesnesi oluşturmaktan sorumludur. Bu arayüz,Adapter
çevresinde ince bir sarmalayıcıdır.
Hizmetinizin tek bir örneğine veya içerdiği tüm verilere güvenemezsiniz. RemoteViewsService
özelliği statik olmadığı sürece veri depolamayın. Widget verilerinizin kalıcı olmasını istiyorsanız en iyi yaklaşım, verileri süreç yaşam döngüsünün ötesinde de duran bir ContentProvider
kullanmaktır. Örneğin, bir market widget'ı her alışveriş listesi öğesinin durumunu SQL veritabanı gibi kalıcı bir konumda depolayabilir.
RemoteViewsService
uygulamasının birincil içeriği, aşağıdaki bölümde açıklanan RemoteViewsFactory
öğesidir.
RemoteViewsFactory arayüzü
RemoteViewsFactory
arayüzünü uygulayan özel sınıfınız, widget'a koleksiyonundaki öğelerin verilerini sağlar. Bunun için widget öğesi XML düzen dosyanızı bir veri kaynağıyla birleştirir. Bu veri kaynağı, veritabanından basit bir diziye kadar her şey olabilir. StackWidget
örneğinde, veri kaynağı WidgetItems
dizisidir. RemoteViewsFactory
, verileri uzak koleksiyon görünümüne yapıştırmak için bağdaştırıcı görevi görür.
RemoteViewsFactory
alt sınıfınız için uygulamanız gereken en önemli iki yöntem onCreate()
ve getViewAt()
'tir.
Sistem, fabrikanızı ilk kez oluştururken onCreate()
çağırır.
Veri kaynağınıza yönelik bağlantıları veya imleçleri burada ayarlarsınız. Örneğin, StackWidget
örneği, WidgetItem
nesne dizisi başlatmak için onCreate()
kullanır. Widget'ınız etkin olduğunda, sistem bu nesnelere dizideki dizin konumlarını kullanarak erişir ve içerdikleri metni görüntüler.
onCreate()
yönteminin bölümlerini gösteren StackWidget
örneğindeki RemoteViewsFactory
uygulamasından bir alıntıyı burada bulabilirsiniz:
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 + "!")); } ... } ...
RemoteViewsFactory
yöntemi getViewAt()
, veri kümesinde belirtilen position
öğesindeki verilere karşılık gelen bir RemoteViews
nesnesi döndürür. StackWidget
örneğindeki RemoteViewsFactory
uygulamasından bir alıntıyı aşağıda bulabilirsiniz:
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; }
Tek tek öğelere davranış ekleme
Yukarıdaki bölümlerde, verilerinizi widget koleksiyonunuza nasıl bağlayacağınız gösterilmektedir. Peki, koleksiyon görünümünüzdeki öğelere ayrı ayrı dinamik davranış eklemek isterseniz ne olur?
onUpdate()
sınıfıyla etkinlikleri işleme bölümünde açıklandığı gibi, normalde bir nesnenin tıklama davranışını (ör. bir düğmenin Activity
başlatmasını) ayarlamak için setOnClickPendingIntent()
kullanırsınız. Ancak tek bir koleksiyon öğesindeki alt görüntülemeler için bu yaklaşıma izin verilmez.
Örneğin, Gmail widget'ında uygulamayı başlatan genel bir düğme ayarlamak için setOnClickPendingIntent()
kullanabilirsiniz (örneğin, her bir liste öğesi için ayrı ayrı değil).
Bunun yerine, bir koleksiyondaki bağımsız öğelere tıklama davranışı eklemek için setOnClickFillInIntent()
değerini kullanın. Bu, koleksiyon görünümünüz için bir beklemedeki amaç şablonu oluşturmayı ve ardından RemoteViewsFactory
aracılığıyla koleksiyondaki her öğe için bir doldurma niyeti ayarlamayı gerektirir.
Bu bölümde, tek tek öğelere nasıl davranış ekleyeceğinizi açıklamak için StackWidget
örneğine yer verilmiştir. StackWidget
örneğinde, kullanıcı üst görünüme dokunursa widget, "Dokunulan görünüm n" Toast
mesajını görüntüler. Burada n, dokunulan görünümün dizinidir (konum). Bu şöyle işler:
Bir
AppWidgetProvider
alt sınıfı olanStackWidgetProvider
,TOAST_ACTION
adlı özel bir işlemle beklemedeki bir amaç oluşturur.Kullanıcı bir görünüme dokunduğunda amaç etkinleşir ve
TOAST_ACTION
yayını yapar.Bu yayın,
StackWidgetProvider
sınıfınınonReceive()
yöntemi tarafından kesiliyor ve widget, dokunulan görünüm içinToast
mesajını gösteriyor. Koleksiyon öğelerinin verileri,RemoteViewsFactory
aracılığıylaRemoteViewsService
aracılığıyla sağlanır.
Beklemedeki amaç şablonunu ayarlayın
StackWidgetProvider
(bir AppWidgetProvider
alt sınıfı) bekleyen bir amaç oluşturur. Bir koleksiyonun bağımsız öğeleri kendi bekleme amaçlarını ayarlayamaz. Bunun yerine, bütün olarak toplama işlemi bekleyen bir amaç şablonu oluşturur ve her bir öğe tek tek benzersiz davranışlar oluşturmak için bir doldurma niyeti belirler.
Bu sınıf, kullanıcı bir görünüme dokunduğunda gönderilen yayını da alır. Kendi onReceive()
yönteminde bu etkinliği işler. Amacın işlemi TOAST_ACTION
ise widget geçerli görünüm için bir Toast
mesajı görüntüler.
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); } }
Doldurma amacını ayarlama
RemoteViewsFactory
, koleksiyondaki her öğe için bir doldurma amacı ayarlamalıdır. Bu, belirli bir öğenin tek tek tıklama eylemini ayırt etmeyi mümkün kılar. Daha sonra doldurma amacı, öğeye dokunulduğunda yürütülen nihai niyeti belirlemek için PendingIntent
şablonuyla birleştirilir.
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; } ... }
Koleksiyon verilerini güncel tutun
Şekil 2'de koleksiyonlar kullanan bir widget'taki güncelleme akışı gösterilmektedir. Bu bölümde, widget kodunun RemoteViewsFactory
ile nasıl etkileşimde bulunduğu ve güncellemeleri nasıl tetikleyebileceğiniz gösterilmektedir:
Koleksiyonları kullanan widget'lar, kullanıcılara güncel içerik sağlayabilir. Örneğin, Gmail widget'ı kullanıcılara gelen kutularının anlık görüntüsünü sunar. Bunu mümkün kılmak için RemoteViewsFactory
ve koleksiyon görünümünüzü tetikleyerek yeni verileri getirin ve görüntüleyin.
Bunu yapmak için AppWidgetManager
kullanarak notifyAppWidgetViewDataChanged()
numaralı telefonu arayın. Bu çağrı, RemoteViewsFactory
nesnenizin onDataSetChanged()
yönteminin geri çağırmasıyla sonuçlanır. Bu yöntem, tüm yeni verileri getirmenizi sağlar.
Yoğun işlem gerektiren işlemleri onDataSetChanged()
geri çağırması içinde eşzamanlı olarak gerçekleştirebilirsiniz. Bu çağrının, meta veriler veya görünüm verileri RemoteViewsFactory
ürününden alınmadan önce tamamlandığı garanti edilir. getViewAt()
yönteminde yoğun işlem gerektiren işlemler de gerçekleştirebilirsiniz. Bu çağrı uzun sürerse RemoteViewsFactory
nesnesinin getLoadingView()
yöntemi tarafından belirtilen yükleme görünümü, geri dönene kadar koleksiyon görünümünde karşılık gelen konumda gösterilir.
Bir koleksiyonu doğrudan iletmek için RemoteCollectionItems özelliğini kullanma
Android 12'de (API düzeyi 31), koleksiyon görünümünü doldururken uygulamanızın doğrudan koleksiyon iletmesini sağlayan setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items)
yöntemini ekler. Bağdaştırıcınızı bu yöntemi kullanarak ayarlarsanız RemoteViewsFactory
uygulamanız ve notifyAppWidgetViewDataChanged()
yöntemini çağırmanız gerekmez.
Bu yaklaşım, bağdaştırıcınızı doldurmayı kolaylaştırmanın yanı sıra kullanıcılar yeni bir öğe görmek için listeyi aşağı kaydırdıklarında yeni öğelerin doldurulmasındaki gecikmeyi de ortadan kaldırır. Koleksiyon öğeleri grubunuz nispeten küçük olduğu sürece bağdaştırıcıyı ayarlamayla ilgili bu yaklaşım tercih edilir. Ancak örneğin, koleksiyonunuzda setImageViewBitmap
hizmetine aktarılan çok sayıda Bitmaps
varsa bu yaklaşım düzgün çalışmaz.
Koleksiyon sabit bir düzen grubu kullanmıyorsa (bazı öğeler yalnızca bazen mevcutsa) koleksiyonun içerebileceği maksimum benzersiz düzen sayısını belirtmek için setViewTypeCount
öğesini kullanın. Bu sayede bağdaştırıcı, uygulama widget'ınızdaki güncellemelerde yeniden kullanılabilir.
Basitleştirilmiş RemoteViews
koleksiyonlarının nasıl uygulanacağına dair bir örnek aşağıda verilmiştir.
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() );