कलेक्शन विजेट, एक ही तरह के कई एलिमेंट दिखाने में माहिर होते हैं. जैसे, गैलरी ऐप्लिकेशन से मिली तस्वीरों का कलेक्शन, खबरों के ऐप्लिकेशन से मिले लेख या कम्यूनिकेशन ऐप्लिकेशन से मिले मैसेज. कलेक्शन विजेट, आम तौर पर दो तरह के इस्तेमाल पर फ़ोकस करते हैं: कलेक्शन को ब्राउज़ करना और कलेक्शन के किसी एलिमेंट को उसके ज़्यादा जानकारी वाले व्यू में खोलना. कलेक्शन विजेट को वर्टिकल तौर पर स्क्रोल किया जा सकता है.
ये विजेट, RemoteViewsService का इस्तेमाल करके ऐसे कलेक्शन दिखाते हैं जिनका डेटा रिमोट से मिलता है. जैसे, कॉन्टेंट उपलब्ध कराने वाली कंपनी से मिला डेटा. विजेट, इनमें से किसी एक व्यू टाइप का इस्तेमाल करके डेटा दिखाता है. इन्हें कलेक्शन व्यू कहा जाता है:
ListView- ऐसा व्यू जिसमें आइटम, वर्टिकल तौर पर स्क्रोल होने वाली सूची में दिखते हैं.
GridView- यह एक ऐसा व्यू है जिसमें आइटम, दो डाइमेंशन वाले स्क्रोलिंग ग्रिड में दिखते हैं.
StackView- स्टैक किए गए कार्ड का व्यू, जो रोलोडेक्स की तरह होता है. इसमें उपयोगकर्ता, पिछले या अगले कार्ड को देखने के लिए, सामने मौजूद कार्ड को ऊपर या नीचे फ़्लिक कर सकता है.
AdapterViewFlipper- ऐडैप्टर के साथ काम करने वाला आसान
ViewAnimator, जो दो या उससे ज़्यादा व्यू के बीच ऐनिमेशन करता है. एक बार में सिर्फ़ एक बच्चे की जानकारी दिखती है.
ये कलेक्शन व्यू, रिमोट डेटा के आधार पर कलेक्शन दिखाते हैं. इसलिए, ये अपने यूज़र इंटरफ़ेस को डेटा से जोड़ने के लिए, Adapter का इस्तेमाल करते हैं. Adapter, डेटा के सेट के अलग-अलग आइटम को अलग-अलग View ऑब्जेक्ट से जोड़ता है.
साथ ही, इन कलेक्शन व्यू को अडैप्टर की मदद से दिखाया जाता है. इसलिए, विजेट में इनका इस्तेमाल करने के लिए, Android फ़्रेमवर्क में अतिरिक्त आर्किटेक्चर शामिल करना ज़रूरी है. विजेट के संदर्भ में, Adapter को RemoteViewsFactory से बदल दिया जाता है. यह Adapter इंटरफ़ेस के चारों ओर एक पतला रैपर होता है. जब कलेक्शन में किसी खास आइटम का अनुरोध किया जाता है, तो RemoteViewsFactory उस आइटम को RemoteViews ऑब्जेक्ट के तौर पर बनाता है और दिखाता है. अपने विजेट में कलेक्शन व्यू शामिल करने के लिए, RemoteViewsService और RemoteViewsFactory लागू करें.
RemoteViewsService एक ऐसी सेवा है जिसकी मदद से रिमोट अडैप्टर, RemoteViews ऑब्जेक्ट का अनुरोध कर सकता है. RemoteViewsFactory, कलेक्शन व्यू और उस व्यू के डेटा के बीच के अडैप्टर के लिए इंटरफ़ेस है. जैसे, ListView, GridView, और StackView. StackWidget के सैंपल से, इस सेवा और इंटरफ़ेस को लागू करने के लिए, यहां बॉयलरप्लेट कोड का उदाहरण दिया गया है:
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.
}
सैंपल ऐप्लिकेशन
इस सेक्शन में दिए गए कोड के कुछ हिस्से भी StackWidget
सैंपल से लिए गए हैं:
StackWidget.इस सैंपल में 10 व्यू का स्टैक है, जो शून्य से लेकर नौ तक की वैल्यू दिखाता है. सैंपल विजेट के ये मुख्य व्यवहार हैं:
अगला या पिछला व्यू देखने के लिए, उपयोगकर्ता विजेट में सबसे ऊपर मौजूद व्यू को वर्टिकल तौर पर फ़्लिंग कर सकता है. यह
StackViewका पहले से मौजूद व्यवहार है.उपयोगकर्ता के इंटरैक्शन के बिना, विजेट अपने-आप अपने व्यू के क्रम में आगे बढ़ता है, जैसे कि स्लाइड शो. ऐसा,
res/xml/stackwidgetinfo.xmlफ़ाइल में मौजूदandroid:autoAdvanceViewId="@id/stack_view"सेटिंग की वजह से होता है. यह सेटिंग व्यू आईडी पर लागू होती है. इस मामले में, यह स्टैक व्यू का व्यू आईडी है.अगर उपयोगकर्ता सबसे ऊपर मौजूद व्यू को छूता है, तो विजेट पर
Toastमैसेज "छुआ गया व्यू n" दिखता है. यहां n, छूए गए व्यू का इंडेक्स (पोज़िशन) है. व्यवहार लागू करने के तरीके के बारे में ज़्यादा जानने के लिए, अलग-अलग आइटम में व्यवहार जोड़ना सेक्शन देखें.
कलेक्शन के साथ विजेट लागू करना
कलेक्शन के साथ विजेट लागू करने के लिए, किसी भी विजेट को लागू करने का तरीका अपनाएं. इसके बाद, कुछ और चरण पूरे करें: मेनिफ़ेस्ट में बदलाव करें, विजेट लेआउट में कलेक्शन व्यू जोड़ें, और अपने AppWidgetProvider सबक्लास में बदलाव करें.
कलेक्शन वाले विजेट के लिए मेनिफ़ेस्ट
मेनिफ़ेस्ट में विजेट का एलान करें में बताई गई ज़रूरी शर्तों के अलावा, आपको यह भी पक्का करना होगा कि कलेक्शन वाले विजेट, आपके RemoteViewsService से बंधे हों. ऐसा करने के लिए, अपनी मेनिफ़ेस्ट फ़ाइल में अनुमति BIND_REMOTEVIEWS के साथ सेवा का एलान करें.
इससे दूसरे ऐप्लिकेशन, आपके विजेट का डेटा आसानी से ऐक्सेस नहीं कर पाते.
उदाहरण के लिए, ऐसा विजेट बनाते समय जो कलेक्शन व्यू को भरने के लिए RemoteViewsService का इस्तेमाल करता है, तो मेनिफ़ेस्ट एंट्री इस तरह दिख सकती है:
<service android:name="MyWidgetService"
android:permission="android.permission.BIND_REMOTEVIEWS" />
इस उदाहरण में, android:name="MyWidgetService" का मतलब RemoteViewsService के सबसेट से है.
कलेक्शन वाले विजेट के लिए लेआउट
विजेट लेआउट की एक्सएमएल फ़ाइल के लिए मुख्य ज़रूरी शर्त यह है कि इसमें इनमें से कोई एक कलेक्शन व्यू शामिल हो: ListView, GridView, StackView या
AdapterViewFlipper. यहां StackWidget
सैंपल के लिए widget_layout.xml फ़ाइल दी गई है:
<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() को विजेट कलेक्शन के लिए रिमोट अडैप्टर के तौर पर सेट करने के लिए, onUpdate() कॉलबैक का तरीका कैसे लागू करता है:RemoteViewsService
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);
}
डेटा को सेव करना
इस पेज पर बताया गया है कि RemoteViewsService सबक्लास, RemoteViewsFactory उपलब्ध कराता है. इसका इस्तेमाल, रिमोट कलेक्शन व्यू को पॉप्युलेट करने के लिए किया जाता है.
खास तौर पर, यह तरीका अपनाएं:
सब-क्लास
RemoteViewsService.RemoteViewsServiceवह सेवा है जिसकी मदद से रिमोट अडैप्टर,RemoteViewsका अनुरोध कर सकता है.अपनी
RemoteViewsServiceसबक्लास में, ऐसी क्लास शामिल करें जोRemoteViewsFactoryइंटरफ़ेस को लागू करती हो.RemoteViewsFactory, रिमोट कलेक्शन व्यू और उस व्यू के डेटा के बीच अडैप्टर के लिए इंटरफ़ेस है. जैसे,ListView,GridView,StackView. डेटासेट में मौजूद हर आइटम के लिए,RemoteViewsऑब्जेक्ट बनाने की ज़िम्मेदारी आपके पास होती है. यह इंटरफ़ेस,Adapterके आस-पास एक पतला रैपर है.
अपनी सेवा के किसी एक इंस्टेंस या उसमें मौजूद किसी डेटा पर भरोसा करके, उसे बनाए रखने की कोशिश नहीं की जा सकती. RemoteViewsService में डेटा तब तक सेव न करें, जब तक वह स्टैटिक न हो. अगर आपको अपने विजेट का डेटा सेव रखना है, तो सबसे अच्छा तरीका यह है कि आप ऐसे ContentProvider का इस्तेमाल करें जिसका डेटा प्रोसेस के लाइफ़साइकल के बाद भी सेव रहता है. उदाहरण के लिए, किराने की दुकान का विजेट, किराने की सूची के हर आइटम की स्थिति को हमेशा मौजूद रहने वाली जगह पर स्टोर कर सकता है. जैसे, SQL डेटाबेस.
RemoteViewsService लागू करने का मुख्य कॉन्टेंट, उसका
RemoteViewsFactory है. इसके बारे में नीचे दिए गए सेक्शन में बताया गया है.
RemoteViewsFactory इंटरफ़ेस
RemoteViewsFactory इंटरफ़ेस को लागू करने वाली आपकी कस्टम क्लास, विजेट को अपने कलेक्शन में मौजूद आइटम का डेटा उपलब्ध कराती है. ऐसा करने के लिए, यह आपके विजेट आइटम की एक्सएमएल लेआउट फ़ाइल को डेटा के सोर्स के साथ जोड़ता है. डेटा का यह सोर्स, डेटाबेस से लेकर किसी साधारण कलेक्शन तक कुछ भी हो सकता है. StackWidget
सैंपल में, डेटा सोर्स WidgetItems का ऐरे है. RemoteViewsFactory, डेटा को रिमोट कलेक्शन व्यू में जोड़ने के लिए अडैप्टर के तौर पर काम करता है.
अपने RemoteViewsFactory सबक्लास के लिए, आपको ये दो सबसे ज़रूरी तरीके लागू करने होंगे: onCreate() और getViewAt().
पहली बार फ़ैक्ट्री बनाते समय, सिस्टम onCreate() को कॉल करता है.
यहां अपने डेटा सोर्स के लिए, कोई कनेक्शन या कर्सर सेट अप किया जाता है. उदाहरण के लिए, StackWidget सैंपल, WidgetItem ऑब्जेक्ट के कलेक्शन को शुरू करने के लिए onCreate() का इस्तेमाल करता है. जब आपका विजेट चालू होता है, तो सिस्टम इन ऑब्जेक्ट को ऐरे में मौजूद उनकी इंडेक्स पोज़िशन का इस्तेमाल करके ऐक्सेस करता है और उनमें मौजूद टेक्स्ट दिखाता है.
यहां StackWidget सैंपल के RemoteViewsFactory लागू करने के तरीके का एक हिस्सा दिया गया है, जिसमें 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 + "!"));
}
...
}
...
RemoteViewsFactory का getViewAt() तरीका, डेटा सेट में बताए गए position पर मौजूद डेटा से जुड़ा RemoteViews ऑब्जेक्ट दिखाता है. यहां StackWidget सैंपल के RemoteViewsFactory लागू करने का एक उदाहरण दिया गया है:
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;
}
अलग-अलग आइटम के लिए व्यवहार जोड़ना
पिछले सेक्शन में, अपने डेटा को विजेट कलेक्शन से जोड़ने का तरीका बताया गया है. अगर आपको अपने कलेक्शन व्यू में अलग-अलग आइटम के लिए डाइनैमिक व्यवहार जोड़ना है, तो क्या करें?
onUpdate() क्लास की मदद से इवेंट मैनेज करना में बताया गया है कि आम तौर पर, किसी ऑब्जेक्ट के क्लिक व्यवहार को सेट करने के लिए setOnClickPendingIntent() का इस्तेमाल किया जाता है. जैसे, किसी बटन से Activity लॉन्च करना. हालांकि, किसी कलेक्शन आइटम में चाइल्ड व्यू के लिए, इस तरीके का इस्तेमाल नहीं किया जा सकता.
उदाहरण के लिए, Gmail विजेट में ग्लोबल बटन सेट अप करने के लिए setOnClickPendingIntent() का इस्तेमाल किया जा सकता है. यह बटन, ऐप्लिकेशन को लॉन्च करता है. हालांकि, इसे सूची के अलग-अलग आइटम पर नहीं सेट अप किया जा सकता.
इसके बजाय, किसी कलेक्शन में मौजूद अलग-अलग आइटम के लिए क्लिक व्यवहार जोड़ने के लिए, setOnClickFillInIntent() का इस्तेमाल करें. इसके लिए, आपको अपने कलेक्शन व्यू के लिए, पेंडिंग इंटेंट टेंप्लेट सेट अप करना होगा. इसके बाद, RemoteViewsFactory की मदद से कलेक्शन के हर आइटम पर, 'अपने-आप भरने वाला इंटेंट' सेट करना होगा.
इस सेक्शन में, StackWidget सैंपल का इस्तेमाल करके, अलग-अलग आइटम में व्यवहार जोड़ने का तरीका बताया गया है. StackWidget सैंपल में, अगर उपयोगकर्ता सबसे ऊपर मौजूद व्यू को छूता है, तो विजेट Toast मैसेज "छुआ गया व्यू n" दिखाता है. यहां n, छूए गए व्यू का इंडेक्स (पोज़िशन) है. आइए जानते हैं कि ऐसा कैसे करें:
StackWidgetProvider,AppWidgetProviderके सबसेट के तौर पर काम करता है. यहTOAST_ACTIONनाम के कस्टम ऐक्शन के साथ, पेंडिंग इंटेंट बनाता है.जब उपयोगकर्ता किसी व्यू को छूता है, तो इंटेंट ट्रिगर होता है और वह
TOAST_ACTIONब्रॉडकास्ट करता है.इस ब्रॉडकास्ट को
StackWidgetProviderक्लास केonReceive()तरीके से इंटरसेप्ट किया जाता है. साथ ही, टच किए गए व्यू के लिए विजेट,Toastमैसेज दिखाता है. कलेक्शन आइटम का डेटा,RemoteViewsServiceके ज़रिएRemoteViewsFactoryसे मिलता है.
पेंडिंग इंटेंट टेंप्लेट सेट अप करना
StackWidgetProvider (AppWidgetProvider सबक्लास), PendingIntent सेट अप करता है. किसी कलेक्शन के अलग-अलग आइटम, अपने अधूरे इंटेंट को सेट अप नहीं कर सकते. इसके बजाय, पूरा कलेक्शन एक ऐसा टेंप्लेट सेट अप करता है जिसमें कार्रवाई पूरी नहीं हुई है. साथ ही, हर आइटम के लिए, अलग-अलग व्यवहार बनाने के लिए, आइटम में जानकारी भरने की सुविधा सेट अप की जाती है.
इस क्लास को वह ब्रॉडकास्ट भी मिलता है जो उपयोगकर्ता के किसी व्यू को छूने पर भेजा जाता है. यह इस इवेंट को अपने onReceive() मेथड में प्रोसेस करता है. अगर इंटेंट की कार्रवाई TOAST_ACTION है, तो विजेट मौजूदा व्यू के लिए Toast मैसेज दिखाता है.
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);
}
}
भरने का इंटेंट सेट करना
आपके RemoteViewsFactory को कलेक्शन के हर आइटम पर, अपने-आप जानकारी भरने का इंटेंट सेट करना होगा. इससे, किसी आइटम पर क्लिक करने पर होने वाली अलग-अलग कार्रवाइयों को अलग-अलग दिखाया जा सकता है. इसके बाद, आइटम पर टैप करने पर होने वाली कार्रवाई तय करने के लिए, भरने के इंटेंट को PendingIntent टेंप्लेट के साथ जोड़ दिया जाता है.
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;
}
...
}
कलेक्शन का डेटा अप-टू-डेट रखना
दूसरे चित्र में, कलेक्शन का इस्तेमाल करने वाले विजेट में अपडेट फ़्लो दिखाया गया है. इससे पता चलता है कि विजेट कोड, RemoteViewsFactory के साथ कैसे इंटरैक्ट करता है और अपडेट को कैसे ट्रिगर किया जा सकता है:
RemoteViewsFactory के साथ इंटरैक्शन.कलेक्शन का इस्तेमाल करने वाले विजेट, उपयोगकर्ताओं को अप-टू-डेट कॉन्टेंट दिखा सकते हैं. उदाहरण के लिए, Gmail विजेट से उपयोगकर्ताओं को अपने इनबॉक्स का स्नैपशॉट मिलता है. ऐसा करने के लिए, नया डेटा फ़ेच और दिखाने के लिए, अपने RemoteViewsFactory और कलेक्शन व्यू को ट्रिगर करें.
ऐसा करने के लिए, notifyAppWidgetViewDataChanged() को कॉल करने के लिए, AppWidgetManager का इस्तेमाल करें. इस कॉल की वजह से, आपके RemoteViewsFactory ऑब्जेक्ट के onDataSetChanged() तरीके को कॉलबैक मिलता है. इससे, आपको नया डेटा फ़ेच करने में मदद मिलती है.
onDataSetChanged() कॉलबैक में, प्रोसेसिंग के ज़्यादा समय लेने वाले ऑपरेशन एक साथ किए जा सकते हैं. आपको यह गारंटी दी जाती है कि RemoteViewsFactory से मेटाडेटा या व्यू का डेटा फ़ेच करने से पहले, यह कॉल पूरा हो जाएगा. getViewAt() के तरीके में, प्रोसेसिंग के लिए ज़्यादा समय लगने वाले ऑपरेशन भी किए जा सकते हैं. अगर इस कॉल में ज़्यादा समय लगता है, तो RemoteViewsFactory ऑब्जेक्ट के getLoadingView() तरीके से तय किए गए लोडिंग व्यू को, कलेक्शन व्यू की उसी जगह पर तब तक दिखाया जाता है, जब तक वह नतीजे नहीं दिखाता.
सीधे किसी कलेक्शन को पास करने के लिए, RemoteCollectionItems का इस्तेमाल करना
Android 12 (एपीआई लेवल 31) में setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items) तरीका जोड़ा गया है. इसकी मदद से, आपका ऐप्लिकेशन कलेक्शन व्यू को पॉप्युलेट करते समय, सीधे तौर पर कलेक्शन को पास कर सकता है. अगर आपने इस तरीके का इस्तेमाल करके अडैप्टर सेट किया है, तो आपको RemoteViewsFactory लागू करने की ज़रूरत नहीं है. साथ ही, आपको notifyAppWidgetViewDataChanged() को कॉल करने की ज़रूरत भी नहीं है.
इस तरीके से, अडैप्टर को आसानी से पॉप्युलेट किया जा सकता है. साथ ही, जब उपयोगकर्ता सूची में नीचे की ओर स्क्रोल करके कोई नया आइटम देखना चाहते हैं, तो नए आइटम को पॉप्युलेट होने में लगने वाला समय भी कम हो जाता है. अडैप्टर सेट करने के लिए, इस तरीके का इस्तेमाल तब तक किया जा सकता है, जब तक आपके कलेक्शन आइटम का सेट अपेक्षाकृत छोटा हो. हालांकि, उदाहरण के लिए, अगर आपके कलेक्शन में Bitmaps को setImageViewBitmap में पास किए जाने वाले कई Bitmaps हैं, तो यह तरीका ठीक से काम नहीं करता.
अगर कलेक्शन में लेआउट के एक तय सेट का इस्तेमाल नहीं किया जाता है, यानी कुछ आइटम कभी-कभी ही मौजूद होते हैं, तो setViewTypeCount का इस्तेमाल करके बताएं कि कलेक्शन में ज़्यादा से ज़्यादा कितने यूनीक लेआउट हो सकते हैं. इससे आपके ऐप्लिकेशन विजेट के अपडेट में, अडैप्टर का फिर से इस्तेमाल किया जा सकता है.
यहां आसान बनाए गए RemoteViews कलेक्शन को लागू करने का उदाहरण दिया गया है.
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()
);