कलेक्शन विजेट एक ही तरह के कई एलिमेंट दिखाने में माहिर होते हैं, जैसे तस्वीरों के संग्रह के तौर पर, गैलरी ऐप्लिकेशन से लेख या समाचार ऐप्लिकेशन से मैसेज भी मिलते हैं. कलेक्शन विजेट आम तौर पर दो चीज़ों पर फ़ोकस करते हैं केस: कलेक्शन को ब्राउज़ करना और कलेक्शन के किसी एलिमेंट को ज़्यादा जानकारी वाला व्यू. कलेक्शन विजेट, वर्टिकल तौर पर स्क्रोल कर सकते हैं.
ये विजेट Google
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.इस नमूने में दस व्यू का स्टैक शामिल है, जिसमें शून्य वैल्यू दिखती हैं नौ से नौ. नमूना विजेट में ये प्राथमिक व्यवहार होते हैं:
उपयोगकर्ता अगले पेज पर जाने के लिए, विजेट में सबसे ऊपर वाले व्यू को वर्टिकल तरीके से फ़्लिंग कर सकता है या पिछला व्यू. यह एक पहले से मौजूद
StackViewव्यवहार है.किसी भी उपयोगकर्ता इंटरैक्शन के बिना, विजेट अपने-आप क्रम में देख सकते हैं, जैसे कि स्लाइड शो. ऐसा सेटिंग की वजह से होता है
android:autoAdvanceViewId="@id/stack_view"res/xml/stackwidgetinfo.xmlफ़ाइल. यह सेटिंग व्यू आईडी पर लागू होती है, जो इस मामले में स्टैक व्यू का व्यू आईडी है.अगर उपयोगकर्ता टॉप व्यू को छूता है, तो बैज
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. यहां दी गई फ़ाइल के लिए widget_layout.xml फ़ाइल है:
StackWidget
सैंपल:
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent">
<StackView
android:id="@+id/stack_view"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="center"
android:loopViews="true" />
<TextView
android:id="@+id/empty_view"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="center"
android:background="@drawable/widget_item_background"
android:textColor="#ffffff"
android:textStyle="bold"
android:text="@string/empty_view_text"
android:textSize="20sp" />
</FrameLayout>
ध्यान दें कि खाली व्यू, उस कलेक्शन व्यू के सिबलिंग होने चाहिए जिसके लिए खाली व्यू, खाली स्थिति दिखाता है.
अपने पूरे विजेट के लिए लेआउट फ़ाइल के अलावा, कोई दूसरा लेआउट बनाएं
ऐसी फ़ाइल जिसमें कलेक्शन के हर आइटम के लेआउट के बारे में बताया जाता है—उदाहरण के लिए,
किताबों के कलेक्शन में हर किताब के लिए लेआउट. StackWidget सैंपल में ये शामिल हैं
सिर्फ़ एक आइटम लेआउट फ़ाइल, widget_item.xml, क्योंकि सभी आइटम एक ही का इस्तेमाल करते हैं
लेआउट.
संग्रह वाले विजेट के लिए AppWidgetProvider क्लास
नियमित विजेट की तरह, आपके कोड में बड़ी संख्या में
AppWidgetProvider सब-क्लास
आम तौर पर,
onUpdate().
नई रिपोर्ट बनाते समय onUpdate() को लागू करने की प्रक्रिया में बड़ा अंतर
कलेक्शन वाला विजेट है, तो आपको कॉल
setRemoteAdapter(). यह कलेक्शन व्यू को बताता है कि उसे डेटा कहां मिलेगा.
इसके बाद, RemoteViewsService आपकी लागू की गई प्रोसेस को दिखा सकता है
RemoteViewsFactory, और विजेट सही डेटा दिखा सकता है. आसानी से अपने कैलेंडर में जोड़ें.
इस तरीके को कॉल करें, एक ऐसा इंटेंट पास करें जो आपको
RemoteViewsService और वह विजेट आईडी जो अपडेट किए जाने वाले विजेट के बारे में बताता है.
उदाहरण के लिए, यहां बताया गया है कि StackWidget सैंपल, onUpdate() को कैसे लागू करता है
कॉलबैक का तरीका चुनकर RemoteViewsService को रिमोट अडैप्टर के रूप में सेट करें
विजेट मेमोरी:
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 जिसका डेटा
प्रोसेस लाइफ़साइकल के बाद भी बनी रहती है. उदाहरण के लिए, किराने की दुकान का विजेट
किराने की सूची के हर आइटम की स्थिति को एक स्थायी जगह पर सेव रखता है, जैसे कि
एसक्यूएल डेटाबेस.
RemoteViewsService को लागू करने का मुख्य कॉन्टेंट यह है
RemoteViewsFactory की जानकारी नीचे दिए गए सेक्शन में दी गई है.
RemoteViewsफ़ैक्ट्री इंटरफ़ेस
आपकी कस्टम क्लास, जो RemoteViewsFactory इंटरफ़ेस को लागू करती है
इसके संग्रह में मौजूद आइटम के डेटा वाला विजेट. ऐसा करने के लिए,
यह आपके विजेट आइटम की एक्सएमएल लेआउट फ़ाइल को डेटा के सोर्स के साथ जोड़ता है. इसका सोर्स
डेटा, डेटाबेस से लेकर आसान कलेक्शन तक कुछ भी हो सकता है. StackWidget में
सैंपल के तौर पर, डेटा सोर्स WidgetItems का कलेक्शन है. RemoteViewsFactory
रिमोट कलेक्शन व्यू में डेटा को चिपकाने के लिए अडैप्टर के रूप में काम करता है.
अपने विज्ञापनों के लिए,
RemoteViewsFactory सब-क्लास ये हैं
onCreate() और
getViewAt().
पहली बार फ़ैक्ट्री बनाते समय, सिस्टम onCreate() को कॉल करता है.
यहां पर अपने डेटा सोर्स के लिए कनेक्शन या कर्सर सेट अप किए जाते हैं. इसके लिए
उदाहरण के लिए, StackWidget सैंपल onCreate() का इस्तेमाल करके,
WidgetItem ऑब्जेक्ट. विजेट के चालू होने पर, सिस्टम इन्हें ऐक्सेस करता है
अरे में अपने इंडेक्स पोज़िशन का इस्तेमाल करके, ऑब्जेक्ट और टेक्स्ट दिखाता है
शामिल हैं.
यहां 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(), RemoteViews ऑब्जेक्ट दिखाता है
डेटा सेट में बताए गए position पर मौजूद डेटा से मेल खाता हो. यहां है
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 को लॉन्च करने के लिए बटन दबाएँ. लेकिन
किसी कलेक्शन आइटम में चाइल्ड व्यू के लिए इस तरीके की अनुमति नहीं है.
उदाहरण के लिए, ग्लोबल बटन सेट अप करने के लिए, setOnClickPendingIntent() का इस्तेमाल किया जा सकता है
उदाहरण के लिए, ऐप्लिकेशन को लॉन्च करने वाले Gmail विजेट में, लेकिन
अलग-अलग सूची आइटम.
इसके बजाय, किसी कलेक्शन के अलग-अलग आइटम पर क्लिक करने की प्रोसेस जोड़ने के लिए,
setOnClickFillInIntent(). इसके लिए, इंटेंट टेंप्लेट को सेट अप करना होगा
और फिर इसमें हर आइटम के लिए एक फ़िल-इन इंटेंट सेट करें
आपके RemoteViewsFactory के ज़रिए संग्रह.
इस सेक्शन में, StackWidget सैंपल का इस्तेमाल करके यह बताया जाता है कि व्यवहार को कैसे जोड़ा जाए
अलग-अलग आइटम. StackWidget सैंपल में, अगर उपयोगकर्ता सबसे ऊपर वाले व्यू को छूता है, तो
विजेट पर, Toast मैसेज "टच किया गया व्यू n" दिखता है. जहां n है
स्पर्श किए गए दृश्य का इंडेक्स (स्थिति). यह इस तरह काम करता है:
StackWidgetProvider—एकAppWidgetProviderसब-क्लास—एक कस्टम कार्रवाई के साथ एक लंबित इंटेंट बनाता हैTOAST_ACTION.जब उपयोगकर्ता किसी व्यू को छूता है, तो इंटेंट ट्रिगर हो जाता है और ब्रॉडकास्ट होता है
TOAST_ACTION.इस ब्रॉडकास्ट को
StackWidgetProviderक्लासonReceive()तरीका और विजेटToastमैसेज दिखाता है स्पर्श करें. कलेक्शन आइटम का डेटा यहां दी जाती है:RemoteViewsServiceसेRemoteViewsFactory.
जिन इंटेंट टेंप्लेट को मंज़ूरी मिलना बाकी है उन्हें सेट अप करें
StackWidgetProvider (एक
AppWidgetProvider सब-क्लास)
लंबित इंटेंट सेट अप करता है. संग्रह के अलग-अलग आइटम उनका सेट अप नहीं कर सकते
लंबित इंटेंट मौजूद हैं. इसके बजाय, इकट्ठा किए जाने वाले डेटा की वजह से ऐसा इंटेंट सेट अप हो जाता है जिसे मंज़ूरी मिलना बाकी है
टेम्प्लेट का इस्तेमाल कर सकते हैं और अलग-अलग आइटम के लिए 'फ़िल-इन इंटेंट' सेट कर सकते हैं, ताकि
अलग-अलग आइटम के हिसाब से.
इस कक्षा को वह प्रसारण भी प्राप्त होता है जिसे उपयोगकर्ता के किसी
व्यू. यह इस इवेंट को उसके 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;
}
...
}
कलेक्शन का डेटा अप-टू-डेट रखें
इमेज 2 में, कलेक्शन का इस्तेमाल करने वाले विजेट में अपडेट फ़्लो दिखाया गया है. यह दिखाता है
विजेट कोड, RemoteViewsFactory के साथ कैसे इंटरैक्ट करता है और यह कैसे किया जा सकता है
अपडेट ट्रिगर करें:
RemoteViewsFactory के साथ इंटरैक्शन.कलेक्शन का इस्तेमाल करने वाले विजेट से लोगों को अप-टू-डेट कॉन्टेंट मिल सकता है. इसके लिए
उदाहरण के लिए, Gmail विजेट से उपयोगकर्ताओं को उनके इनबॉक्स का स्नैपशॉट मिलता है. इसे बनाने के लिए
तो अपने RemoteViewsFactory और कलेक्शन व्यू को फ़ेच करने के लिए ट्रिगर करें और
नया डेटा दिखाएं.
ऐसा करने के लिए,
कॉल करने के लिए AppWidgetManager
notifyAppWidgetViewDataChanged(). इस कॉल के नतीजे में आपके RemoteViewsFactory ऑब्जेक्ट के
onDataSetChanged()
तरीका है, जिसकी मदद से किसी भी तरह का नया डेटा फ़ेच किया जा सकता है.
आप
onDataSetChanged() कॉलबैक. आपको गारंटी है कि यह कॉल पूरा हो जाएगा
RemoteViewsFactory से मेटाडेटा या व्यू डेटा फ़ेच करने से पहले. आपने लोगों तक पहुंचाया मुफ़्त में
getViewAt() में प्रोसेसिंग-इंटेंसिव ऑपरेशन भी कर सकता है
तरीका. अगर इस कॉल में ज़्यादा समय लगता है, तो लोडिंग व्यू—
RemoteViewsFactory ऑब्जेक्ट
getLoadingView()
तरीका—इसे कलेक्शन व्यू के हिसाब से दिखाया जाता है
इसके वापस आने तक.
किसी कलेक्शन को सीधे पास करने के लिए, RemoteCollectionItem का इस्तेमाल करें
Android 12 (एपीआई लेवल 31) ने setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items) को जोड़ा
तरीका, जिससे आपका ऐप्लिकेशन किसी
कलेक्शन व्यू. अगर आपने अडैप्टर को इस तरीके से सेट किया है, तो आपको ये काम करने की ज़रूरत नहीं है
RemoteViewsFactory लागू करें. आपको कॉल करने की ज़रूरत नहीं है
notifyAppWidgetViewDataChanged().
आपके अडैप्टर को पॉप्युलेट करना आसान बनाने के अलावा, इस तरीके को
इससे उपयोगकर्ताओं को सूची में नीचे की ओर स्क्रोल करने पर, नए आइटम अपने-आप भरने में लगने वाला समय कम हो जाता है
नया आइटम दिखाने के लिए. अडैप्टर को सेट करने का यह तरीका तब तक इस्तेमाल किया जाता है, जब तक
आपके कलेक्शन आइटम का सेट बाकी है. हालांकि, उदाहरण के लिए,
अगर आपके कलेक्शन में बहुत सारे Bitmaps हैं, तो यह तरीका कारगर नहीं है
setImageViewBitmap को पास किया गया.
अगर कलेक्शन में लेआउट के कॉन्स्टेंट सेट का इस्तेमाल नहीं किया गया है, तो इसका मतलब है कि
आइटम कभी-कभी ही मौजूद होते हैं—यह बताने के लिए 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()
);