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

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

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

ListView

طريقة عرض تعرض العناصر في قائمة يتم تمريرها عموديًا

GridView

طريقة عرض تعرض العناصر في شبكة تمرير ثنائية الأبعاد

StackView

طريقة عرض بطاقة مجمّعة، تشبه بطاقة rolodex، حيث يمكن للمستخدم النقر على البطاقة الأمامية للأعلى أو للأسفل لرؤية البطاقة السابقة أو التالية على التوالي

AdapterViewFlipper

نموذج ViewAnimator بسيط ومستند إلى المحوّل ويتحرك بين مشاهدتين أو أكثر. يتم عرض طفل واحد فقط في كل مرة.

وبما أنّ طرق عرض المجموعات هذه تعرض المجموعات المستندة إلى بيانات عن بُعد، فإنّها تستخدم Adapter لربط واجهة المستخدم الخاصة بها بالبيانات. يربط Adapter عناصر فردية من مجموعة من البيانات بكائنات View فردية.

ولأنّ طرق عرض المجموعة هذه مدعومة بمحوّلات، يجب أن يتضمّن إطار عمل Android بنية إضافية لإتاحة استخدامها في التطبيقات المصغّرة. في سياق التطبيق المصغّر، يتم استبدال Adapter بـ RemoteViewsFactory، وهي عبارة عن برنامج تضمين رفيع حول واجهة Adapter. عند طلب عنصر محدّد في المجموعة، ينشئ RemoteViewsFactory العنصر للمجموعة ويعرضه على أنّه كائن RemoteViews. لتضمين عرض مجموعة في التطبيق المصغّر، نفِّذ RemoteViewsService وRemoteViewsFactory.

RemoteViewsService هي خدمة تتيح لمحوّل عن بُعد طلب عناصر RemoteViews. RemoteViewsFactory عبارة عن واجهة لمحوّل بين عرض المجموعة، مثل ListView وGridView وStackView، والبيانات الأساسية لهذا الملف الشخصي. من نموذج StackWidget، إليك مثال على الرمز البرمجي لتنفيذ هذه الخدمة والواجهة:

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.

}

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:

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

• يمكن للمستخدم تحريك العرض العلوي عموديًا في الأداة لعرض العرض التالي أو السابق. هذا سلوك ميزة 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.

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

يتمثل الشرط الرئيسي لملف 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، لأن جميع العناصر تستخدم نفس التنسيق.

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

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

على سبيل المثال، في ما يلي طريقة تنفيذ نموذج StackWidget لطريقة معاودة الاتصال onUpdate() لضبط RemoteViewsService كمحوّل عن بُعد لمجموعة التطبيقات المصغّرة:

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)
}

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.

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

واجهة RemoteViews أسعار

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

أهم طريقتَين يجب تطبيقهما على فئة RemoteViewsFactory الفرعية هما onCreate() و getViewAt().

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

في ما يلي مقتطف من تنفيذ RemoteViewsFactory لنموذج StackWidget الذي يعرض أجزاءً من طريقة onCreate():

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!") }
        ...
    }
    ...
}

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:

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)
    }
}

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.

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

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

يتلقى هذا الفصل أيضًا البث الذي يتم إرساله عندما يلمس المستخدم طريقة العرض. تعالج هذه البيانات هذا الحدث بطريقة onReceive(). إذا كان إجراء الغرض هو TOAST_ACTION، ستعرض الأداة رسالة Toast لطريقة العرض الحالية.

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)
    }
}

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 لتحديد الغرض النهائي الذي يتم تنفيذه عند النقر على العنصر.

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)
            ...
        }
    }
    ...
}

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

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

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

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

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

يضيف نظام التشغيل Android 12 (المستوى 31 من واجهة برمجة التطبيقات) طريقة setRemoteAdapter(int viewId, RemoteViews.RemoteCollectionItems items) التي تتيح لتطبيقك نقل مجموعة مباشرةً عند تعبئة عرض المجموعة. إذا ضبطت المحوّل باستخدام هذه الطريقة، لن تحتاج إلى تنفيذ RemoteViewsFactory ولن تحتاج إلى الاتصال بـ notifyAppWidgetViewDataChanged().

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

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

في ما يلي مثال على كيفية تنفيذ مجموعات RemoteViews مبسّطة.

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()
)

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()
);