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

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

وتستخدم هذه التطبيقات المصغّرة 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، إليك مثالاً على الرمز النموذجي لتنفيذ هذه الخدمة والواجهة:

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 إلى فهرس (موضع) طريقة العرض التي تم لمسها. لمزيد من المناقشة حول كيفية تنفيذ السلوكيات، راجِع قسم إضافة سلوك إلى عناصر فردية.

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

لتنفيذ تطبيق مصغّر يضم مجموعات، يمكنك اتّباع الإجراء الخاص بتنفيذ أي أداة، مع اتّباع بضع خطوات إضافية: تعديل البيان، وإضافة عرض مجموعة إلى تنسيق الأداة، وتعديل الفئة الفرعية 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 كمحوّل بعيد لمجموعة الأدوات:

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، كما هو موضّح في القسم التالي.

واجهة RemoteViewsFavorite

إنّ فئتك المخصّصة التي تستخدم واجهة 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(). يستلزم هذا إعداد نموذج intent في انتظار المراجعة لعرض المجموعة، ثم إعداد هدف تعبئة لكل عنصر في المجموعة من خلال RemoteViewsFactory.

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

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

• عندما يلمس المستخدم إحدى المشاهدات، يتم تنشيط الهدف ويتم بث TOAST_ACTION.

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

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

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

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

وتتلقّى هذه الفئة أيضًا البث الذي يتم إرساله عندما يلمس المستخدم إحدى المشاهدة. تعالج هذه السياسة هذا الحدث في طريقة 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(). ينتج عن هذا الاستدعاء استدعاء طريقة onDataSetChanged() الخاصة بكائن RemoteViewsFactory، ما يتيح لك استرجاع أي بيانات جديدة.

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

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

يضيف 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()
);

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