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

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

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

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

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

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

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

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

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

• يتم اعتراض هذا البث من خلال فئة StackWidgetProvider onReceive()، وستعرِض الأداة رسالة 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() تؤدي هذه المكالمة إلى معاودة الاتصال بجهاز RemoteViewsFactory الخاص بك. onDataSetChanged() ، مما يتيح لك استرجاع أي بيانات جديدة.

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

استخدِم 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 في هذه المجموعة بخلاف ذلك، يتم استنتاج عدد أنواع المشاهدات من العناصر المقدَّمة، وستتم إعادة إنشاء المحوّل عند إرسال تحديث تستخدم تنسيقات إضافية.