استخدام التطبيقات المصغّرة للمجموعات

تتخصص التطبيقات المصغّرة للمجموعات في عرض العديد من العناصر من النوع نفسه، مثل مجموعات الصور من تطبيق معرض صور أو المقالات من تطبيق أخبار أو الرسائل من تطبيق تواصل. تركّز التطبيقات المصغّرة للمجموعات عادةً على حالتَي استخدام: تصفُّح المجموعة وفتح عنصر من المجموعة لعرضه في طريقة العرض التفصيلية. يمكن الانتقال للأعلى أو للأسفل في التطبيقات المصغّرة للمجموعات.

تستخدِم التطبيقات المصغّرة هذه الرمز 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 عيّنة:

الشكل 1. أ StackWidget.

يتألّف هذا العيّنة من حزمة من عشر طرق عرض تعرض القيم من صفر إلى تسعة. يتضمّن نموذج التطبيق المصغّر السلوكيات الأساسية التالية:

• يمكن للمستخدم التمرير سريعًا للأعلى في التطبيق المصغّر لعرض المقطع التالي أو السابق. هذا سلوك مضمّن في StackView.

• بدون أي تفاعل من المستخدم، تنتقل الأداة تلقائيًا من خلال طرق العرض بالتسلسل، مثل عرض الشرائح. ويعود ذلك إلى الإعداد android:autoAdvanceViewId="@id/stack_view" في ملف res/xml/stackwidgetinfo.xml. ينطبق هذا الإعداد على معرّف العرض، والذي يكون في هذه الحالة معرّف عرض طريقة العرض المكدّسة.

• إذا لمس المستخدم العرض العلوي، تعرِض الأداة الرسالة Toast "العرض الذي تم لمسه n"، حيث يمثّل n الفهرس (الموضع) للعرض الذي تم لمسه. لمزيد من المناقشة حول كيفية تنفيذ السلوكيات، يُرجى الاطّلاع على قسم إضافة سلوك إلى عناصر individual.

استخدام التطبيقات المصغّرة مع المجموعات

لتنفيذ تطبيق مصغّر يتضمّن مجموعات، اتّبِع الإجراء الخاص بتنفيذ أي تطبيق مصغّر، ثم اتّبِع بعض الخطوات الإضافية: تعديل البيان، وإضافة عرض مجموعة إلى تنسيق التطبيق المصغّر، وتعديل الدرجة الفرعية AppWidgetProvider.

بيان التطبيقات المصغّرة التي تتضمّن مجموعات

بالإضافة إلى المتطلبات الواردة في مقالة تعريف التطبيق المصغّر في ملف البيان، عليك إتاحة ربط التطبيقات المصغّرة التي تحتوي على مجموعات بتطبيقك RemoteViewsService. يمكنك إجراء ذلك من خلال الإفصاح عن الخدمة في ملف البيان باستخدام الإذن BIND_REMOTEVIEWS. ويؤدي ذلك إلى منع التطبيقات الأخرى من الوصول بحرية إلى بيانات التطبيق المصغّر.

على سبيل المثال، عند إنشاء تطبيق مصغّر يستخدم RemoteViewsService لتعبئة ملف RemoteViewsService، قد يبدو إدخال البيان على النحو التالي:

<service android:name="MyWidgetService"
    android:permission="android.permission.BIND_REMOTEVIEWS" />

في هذا المثال، يشير android:name="MyWidgetService" إلى فئة فرعية من RemoteViewsService.

تنسيق التطبيقات المصغّرة التي تتضمّن مجموعات

الشرط الأساسي لملف XML الخاص بتنسيق التطبيق المصغّر هو أن يتضمّن أحد طرق عرض المجموعة: 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، لأنّ جميع السلع تستخدم widget_item.xml.

فئة AppWidgetProvider للتطبيقات المصغّرة التي تتضمّن مجموعات

كما هو الحال مع التطبيقات المصغّرة العادية، يتم عادةً تضمين الجزء الأكبر من الرمز البرمجي في فئة العنصر المكوّن AppWidgetProvider في ملف onUpdate(). الفرق الرئيسي في تنفيذ onUpdate() عند إنشاء أداة مصغّرة تتضمّن مجموعات هو أنّه عليك استدعاء setRemoteAdapter(). يحدّد ذلك مصدر بيانات عرض المجموعة. يمكن أن يعرض RemoteViewsService بعد ذلك عملية تنفيذ RemoteViewsFactory، ويمكن للأداة عرض البيانات المناسبة. عند استدعاء هذه الطريقة، عليك تمرير نية تشير إلى عملية تنفيذ RemoteViewsService ورقم تعريف التطبيق المصغّر الذي يحدّد التطبيق المصغّر المطلوب تعديله.

على سبيل المثال، في ما يلي كيفية تنفيذ نموذج StackWidget لطريقة callback الخاصة بـ 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 المستخدَم لتعبئة عرض المجموعة البعيدة.

ويجب تحديدًا اتّباع الخطوات التالية:

1. الفئة الفرعية RemoteViewsService. ‫RemoteViewsService هي الخدمة التي يمكن من خلالها لجهاز التحكّم عن بُعد طلب RemoteViews.

2. في الفئة الفرعية RemoteViewsService، أدرِج فئة تنفِّذ واجهة RemoteViewsFactory. RemoteViewsFactory هي واجهة لأحد المحوِّلات بين عرض مجموعة عن بُعد، مثل ListView وGridView وStackView، والبيانات الأساسية لهذا العرض. تتحمّل عملية التنفيذ مسؤولية إنشاء عنصر RemoteViews لكل عنصر في مجموعة البيانات. هذه الواجهة هي غلاف رقيق حول Adapter.

لا يمكنك الاعتماد على مثيل واحد من خدمتك أو أي بيانات يحتوي عليها للحفاظ على البيانات. لا تخزِّن البيانات في RemoteViewsService إلا إذا كانت ثابتة. إذا أردت الاحتفاظ ببيانات التطبيق المصغّر، فإنّ أفضل طريقة هي استخدام ContentProvider تبقى بياناته محفوظة بعد انتهاء دورة حياة العملية. على سبيل المثال، يمكن لأداة متجر بقالة تخزين حالة كل عنصر في قائمة البقالة في موقع دائم، مثل قاعدة بيانات SQL.

ملاحظة: اطّلِع على WeatherDataProvider.java للاطّلاع على نموذج رمز برمجي يوضّح كيفية الاحتفاظ بالبيانات الأساسية لأداة مصغّرة باستخدام ContentProvider.

إنّ المحتوى الأساسي لتنفيذ RemoteViewsService هو RemoteViewsFactory الموضّح في القسم التالي.

واجهة RemoteViewsFactory

توفّر فئة التطبيق المخصّصة التي تُنفِّذ واجهة RemoteViewsFactory للأداة المصغّرة بيانات العناصر في مجموعتها. ولإجراء ذلك، يتم دمج ملف تنسيق XML الخاص بعنصر التطبيق المصغّر مع مصدر بيانات. يمكن أن يكون مصدر البيانات هذا أيّ شيء بدءًا من قاعدة بيانات وحتى صفيف بسيط. في StackWidget العيّنة، يكون مصدر البيانات صفيفًا من WidgetItems. يعمل RemoteViewsFactory كمحوِّل للصق البيانات بعرض المجموعة البعيدة.

إنّ أهم الطريقتَين اللتين عليك تنفيذهما لفئة RemoteViewsFactory الفرعية هما onCreate() وgetViewAt().

يتصل النظام بـ onCreate() عند إنشاء المصنع لأول مرة. يمكنك هنا إعداد أيّ عمليات ربط أو مؤشرات إلى مصدر البيانات. على سبيل المثال، يستخدم StackWidget onCreate() لإعداد مصفوفة من عناصر WidgetItem. عندما يكون التطبيق المصغّر نشطًا، يصل النظام إلى هذه العناصر باستخدام موضع الفهرس في الصفيف ويعرض النص الذي يحتويه.

في ما يلي مقتطف من عملية تنفيذ RemoteViewsFactory لنموذج StackWidget الذي يعرض أجزاء من طريقة 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 المحدّد في مجموعة البيانات. في ما يلي مقتطف من عملية تنفيذ RemoteViewsFactory في عيّنة 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;
}

إضافة سلوك إلى عناصر فردية

توضِّح الأقسام السابقة كيفية ربط بياناتك بمجموعة التطبيقات المصغّرة. ولكن ماذا لو أردت إضافة سلوك ديناميكي إلى العناصر الفردية في عرض المجموعة؟

كما هو موضّح في مقالة معالجة الأحداث باستخدام فئة onUpdate()، يتم عادةً استخدام setOnClickPendingIntent() لضبط سلوك النقر على عنصر، مثل التسبب في إطلاق زرّ Activity. ولكن لا يُسمح بهذا الأسلوب لعروض البيانات الفرعية في عنصر مجموعة فردي. على سبيل المثال، يمكنك استخدام setOnClickPendingIntent() لإعداد زر عام في تطبيق Gmail المصغّر الذي يشغّل التطبيق، على سبيل المثال، ولكن ليس على عناصر القائمة الفردية.

بدلاً من ذلك، لإضافة سلوك النقرة إلى عناصر فردية في مجموعة، استخدِم setOnClickFillInIntent(). ويتطلّب ذلك إعداد نموذج نية في انتظار المراجعة لطريقة عرض مجموعتك، ثمّ ضبط نية ملء لكل عنصر في المجموعة من خلال RemoteViewsFactory.

يستخدم هذا القسم عيّنة StackWidget لوصف كيفية إضافة سلوك إلى العناصر الفردية. في نموذج StackWidget، إذا لمس المستخدم العرض العلوي، تعرض الأداة رسالة Toast "العرض الذي تم لمسه n"، حيث يكون n هو فهرس (موضع) العرض الذي تم لمسه. إليك إرشادات:

• StackWidgetProvider هي فئة فرعية من AppWidgetProvider ، وهي تنشئ نية معلّقة باستخدام إجراء مخصّص يُسمى TOAST_ACTION.

• عندما يلمس المستخدم عرضًا، يتم تشغيل النية ويتم بث TOAST_ACTION.

• يتم اعتراض هذا البث من خلال onReceive() في فئة StackWidgetProvider، ويعرض التطبيق المصغّر رسالة Toast للعرض الذي تم لمسه. يتم تقديم بيانات عناصر المجموعة من قِبل RemoteViewsFactory من خلال RemoteViewsService.

ملاحظة: يستخدم نموذج StackWidget بثًا، ولكن عادةً ما تبدأ التطبيقات المصغّرة نشاطًا في سيناريو مثل هذا.

إعداد نموذج الطلب الذي في انتظار المراجعة

يُعدّ 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 وكيفية بدء التحديثات:

الشكل 2. التفاعل مع RemoteViewsFactory أثناء التحديثات

يمكن أن تقدّم التطبيقات المصغّرة التي تستخدِم المجموعات محتوى محدّثًا للمستخدمين. على سبيل المثال، تقدّم الأداة المصغّرة لتطبيق Gmail لمحة عن البريد الوارد للمستخدمين. لكي يكون ذلك ممكنًا، فعِّل RemoteViewsFactory وعرض المجموعة لجلبها وعرض البيانات الجديدة.

لإجراء ذلك، استخدِم الرمز AppWidgetManager للاتصال بالرقم notifyAppWidgetViewDataChanged(). يؤدي هذا الطلب إلى استدعاء RemoteViewsFactory onDataSetChanged() method، ما يتيح لك جلب أي بيانات جديدة.

يمكنك تنفيذ عمليات كثيفة المعالجة بشكل متزامن ضمن callback onDataSetChanged(). نضمن لك إكمال هذا الطلب قبل جلب البيانات الوصفية أو بيانات العرض من RemoteViewsFactory. يمكنك أيضًا تنفيذ عمليات كثيفة المعالجة ضمن getViewAt() الطريقة. إذا استغرقت هذه الدعوة وقتًا طويلاً، يتم عرض طريقة loading view التي تحدّدها RemoteViewsFactorygetLoadingView() في الموضع المقابل لعرض المجموعة إلى أن يتم عرضها.

استخدام RemoteCollectionItems لنقل مجموعة مباشرةً

يضيف الإصدار 12 من نظام التشغيل Android (المستوى 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()
);

ملاحظة: عند استدعاء setViewTypeCount()، أدخِل الحد الأقصى لعدد معرّفات التنسيقات المختلفة التي يستخدمها RemoteViews في هذه المجموعة. بخلاف ذلك، يتم استنتاج عدد أنواع العرض من العناصر المقدَّمة، ويتم إعادة إنشاء المُحوِّل عند إرسال تحديث يستخدِم تنسيقات إضافية.