ใช้วิดเจ็ตคอลเล็กชัน

วิดเจ็ตคอลเล็กชันมีความเชี่ยวชาญในการแสดงองค์ประกอบหลายรายการประเภทเดียวกัน เช่น คอลเล็กชันรูปภาพจากแอปแกลเลอรี บทความจากแอปข่าว หรือข้อความจากแอปการสื่อสาร โดยปกติแล้ววิดเจ็ตคอลเล็กชันจะมุ่งเน้นที่กรณีการใช้งาน 2 กรณี ได้แก่ การเรียกดูคอลเล็กชันและการเปิดองค์ประกอบของคอลเล็กชันไปยังมุมมองแบบละเอียด วิดเจ็ตคอลเล็กชันจะเลื่อนในแนวตั้งได้

วิดเจ็ตเหล่านี้ใช้ RemoteViewsService เพื่อแสดงคอลเล็กชันที่มีข้อมูลระยะไกล เช่น จากผู้ให้บริการเนื้อหา วิดเจ็ตจะแสดงข้อมูลโดยใช้มุมมองประเภทใดประเภทหนึ่งต่อไปนี้ ซึ่งเรียกว่ามุมมองคอลเล็กชัน

ListView
มุมมองที่แสดงรายการในรายการที่เลื่อนขึ้นลงแนวตั้ง
GridView
มุมมองที่แสดงรายการในตารางกริดแบบเลื่อน 2 มิติ
StackView
มุมมองการ์ดที่ซ้อนกัน ซึ่งคล้ายกับโรลเดกซ์ที่ผู้ใช้สามารถปัดการ์ดหน้าขึ้นหรือลงเพื่อดูการ์ดก่อนหน้าหรือการ์ดถัดไปตามลำดับ
AdapterViewFlipper
ViewAnimator แบบง่ายที่รองรับอะแดปเตอร์ซึ่งแสดงภาพเคลื่อนไหวระหว่างมุมมอง 2 มุมมองขึ้นไป แสดงผู้เผยแพร่โฆษณาย่อยทีละคนเท่านั้น

เนื่องจากมุมมองคอลเล็กชันเหล่านี้แสดงคอลเล็กชันที่สนับสนุนโดยข้อมูลระยะไกล ใช้ Adapter เพื่อผูกผู้ใช้ เข้ากับข้อมูลของตน Adapter จะเชื่อมโยงแต่ละรายการจากชุดข้อมูลกับออบเจ็กต์ View แต่ละรายการ

และเนื่องจากมุมมองคอลเล็กชันเหล่านี้สนับสนุนโดยอะแดปเตอร์ เฟรมเวิร์กของ Android ต้องมีสถาปัตยกรรมเพิ่มเติมเพื่อรองรับการใช้งานในวิดเจ็ต ในบริบท ของวิดเจ็ต Adapter จะแทนที่ด้วย RemoteViewsFactory, ซึ่งเป็น Wrapper ที่บางอยู่รอบๆ อินเทอร์เฟซ 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

ตัวอย่างนี้ประกอบด้วยมุมมอง 10 แบบซ้อนกันที่แสดงค่าเป็น 0 ถึง 9 วิดเจ็ตตัวอย่างมีลักษณะการทำงานหลักดังต่อไปนี้

  • ผู้ใช้สามารถเลื่อนมุมมองด้านบนในแนวตั้ง เพื่อแสดงวิดเจ็ตถัดไป หรือมุมมองก่อนหน้า นี่คือลักษณะการทำงานในตัวของ StackView

  • โดยไม่ต้องมีการโต้ตอบใดๆ จากผู้ใช้ วิดเจ็ตจะเคลื่อนผ่าน ดูตามลำดับ เช่น ภาพสไลด์ ปัญหานี้เกิดจากการตั้งค่า android:autoAdvanceViewId="@id/stack_view" ในไฟล์ res/xml/stackwidgetinfo.xml การตั้งค่านี้จะมีผลกับรหัสมุมมอง ซึ่งในกรณีนี้คือรหัสมุมมองของมุมมองกอง

  • หากผู้ใช้แตะมุมมองด้านบน วิดเจ็ตจะแสดงข้อความ Toast "มุมมองที่สัมผัส n" โดยที่ n คือดัชนี (ตําแหน่ง) ของมุมมองที่สัมผัส หากต้องการการสนทนาเพิ่มเติมเกี่ยวกับวิธี ในการนำพฤติกรรมไปใช้ โปรดดูส่วน เพิ่มพฤติกรรมให้กับ items

ใช้วิดเจ็ตกับคอลเล็กชัน

หากต้องการใช้วิดเจ็ตกับคอลเล็กชัน ให้ทําตามขั้นตอนเพื่อใช้วิดเจ็ต แล้วทําตามขั้นตอนเพิ่มเติมอีก 2-3 ขั้นตอน ได้แก่ แก้ไขไฟล์ Manifest, เพิ่มมุมมองคอลเล็กชันลงในเลย์เอาต์วิดเจ็ต และแก้ไขAppWidgetProvider ซับคลาส

ไฟล์ Manifest สําหรับวิดเจ็ตที่มีคอลเล็กชัน

นอกจากข้อกำหนดที่ระบุไว้ในประกาศวิดเจ็ตในไฟล์ Manifest แล้ว คุณต้องทำให้วิดเจ็ตที่มีคอลเล็กชันสามารถเชื่อมโยงกับ RemoteViewsService ได้ ซึ่งทำได้โดยการประกาศ บริการในไฟล์ Manifest ของคุณที่มีสิทธิ์ BIND_REMOTEVIEWS ซึ่งจะป้องกันไม่ให้แอปพลิเคชันอื่นๆ เข้าถึงข้อมูลวิดเจ็ตของคุณได้อย่างอิสระ

ตัวอย่างเช่น เมื่อสร้างวิดเจ็ตที่ใช้ RemoteViewsService เพื่อป้อนข้อมูลในมุมมองคอลเล็กชัน รายการไฟล์ Manifest อาจมีลักษณะดังนี้

<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 และวิดเจ็ตจะแสดงข้อมูลที่ถูกต้อง เมื่อเรียกใช้เมธอดนี้ ให้ส่ง Intent ที่ชี้ไปยังการติดตั้งใช้งาน RemoteViewsService และรหัสวิดเจ็ตที่ระบุวิดเจ็ตที่จะอัปเดต

ตัวอย่างเช่น ตัวอย่าง StackWidget ในการนำ onUpdate() ไปใช้มีดังนี้ Callback Method เพื่อตั้งค่า 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 สำหรับแต่ละ ในชุดข้อมูล อินเทอร์เฟซนี้เป็น Wrapper ที่บางรอบๆ Adapter

คุณไม่สามารถพึ่งพาบริการเพียงอินสแตนซ์เดียวหรือข้อมูลใดๆ ที่อยู่ในบริการเพื่อ คงอยู่ อย่าเก็บข้อมูลใน RemoteViewsService เว้นแต่จะเป็นแบบคงที่ หากต้องการให้ข้อมูลของวิดเจ็ตคงอยู่ วิธีที่ดีที่สุดคือใช้ ContentProvider ที่มีข้อมูลที่คงอยู่หลังจากวงจรของกระบวนการ ตัวอย่างเช่น วิดเจ็ตของร้านขายของใช้ทั่วไปสามารถเก็บสถานะของรายการในรายการซื้อของใช้ทั่วไปแต่ละรายการไว้ในตำแหน่งถาวร เช่น ฐานข้อมูล SQL

ที่ WeatherDataProvider.java

เนื้อหาหลักของการติดตั้งใช้งาน RemoteViewsService คือ RemoteViewsFactory, อธิบายในส่วนต่อไปนี้

อินเทอร์เฟซ RemoteViewsFactory

คลาสที่กําหนดเองซึ่งใช้อินเทอร์เฟซ RemoteViewsFactory จะระบุข้อมูลของรายการในคอลเล็กชันให้กับวิดเจ็ต โดยรวมไฟล์เลย์เอาต์ XML ของรายการวิดเจ็ตเข้ากับแหล่งข้อมูล แหล่งที่มาของ ข้อมูลสามารถเป็นอะไรก็ได้ ตั้งแต่ฐานข้อมูลไปจนถึงอาร์เรย์แบบง่าย ในStackWidgetตัวอย่างแหล่งข้อมูลคืออาร์เรย์ของ WidgetItems RemoteViewsFactory จะทําหน้าที่เป็นอะแดปเตอร์เพื่อผสานข้อมูลเข้ากับมุมมองคอลเล็กชันระยะไกล

วิธีการที่สำคัญที่สุด 2 วิธีที่คุณจำเป็นต้องใช้สำหรับ คลาสย่อย 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 + "!"));
        }
        ...
    }
...

เมธอด getViewAt() ของ RemoteViewsFactory แสดงผลออบเจ็กต์ 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 ที่รอดําเนินการสําหรับมุมมองคอลเล็กชัน จากนั้นตั้งค่า Intent แบบกรอกข้อมูลในรายการแต่ละรายการในคอลเล็กชันผ่าน RemoteViewsFactory

ส่วนนี้ใช้ตัวอย่าง StackWidget เพื่ออธิบายวิธีเพิ่มลักษณะการทํางานให้กับรายการแต่ละรายการ ในตัวอย่าง StackWidget หากผู้ใช้แตะมุมมองด้านบน วิดเจ็ตจะแสดงข้อความ Toast "มุมมองที่สัมผัส n" โดยที่ n คือดัชนี (ตําแหน่ง) ของมุมมองที่สัมผัส โดยมีวิธีการดังนี้

  • แท็ก StackWidgetProvider - AppWidgetProvider คลาสย่อย - สร้าง Intent ที่รอดำเนินการโดยมีการดำเนินการที่กำหนดเองชื่อ TOAST_ACTION

  • เมื่อผู้ใช้แตะมุมมอง อินเทนต์จะทริกเกอร์และออกอากาศ TOAST_ACTION

  • การออกอากาศนี้ถูกขัดจังหวะโดยเมธอด onReceive() ของคลาส StackWidgetProvider และวิดเจ็ตจะแสดงข้อความ Toast สำหรับมุมมองที่สัมผัส ข้อมูลสำหรับรายการคอลเล็กชันได้มาจาก RemoteViewsFactory ผ่าน RemoteViewsService

ตั้งค่าเทมเพลตความตั้งใจที่รอดําเนินการ

StackWidgetProvider ( คลาสย่อย AppWidgetProvider) ตั้งค่า Intent ที่รอดำเนินการ รายการแต่ละรายการของคอลเล็กชันไม่สามารถตั้งค่า Intent ที่รอดำเนินการของตนเองได้ แต่คอลเล็กชันโดยรวมจะสร้าง Intent ที่รอดำเนินการ เทมเพลต และแต่ละรายการจะกำหนดความตั้งใจที่จะกรอกเพื่อสร้าง ที่แตกต่างกันไปตามรายการ

ชั้นเรียนนี้จะรับการบรอดแคสต์ข้อความที่ส่งเมื่อผู้ใช้แตะ โดยจะประมวลผลเหตุการณ์นี้ในเมธอด onReceive() หากการดำเนินการของ Intent คือ 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 ของคุณต้องตั้งค่า Intent ที่จะเติมข้อมูลในแต่ละรายการใน คอลเล็กชัน วิธีนี้จะช่วยให้แยกความแตกต่างระหว่างการทำงานเมื่อคลิกแต่ละรายการได้ จากรายการที่กำหนด จากนั้น ระบบจะรวมเข้ากับ 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() ซึ่งช่วยให้คุณดึงข้อมูลใหม่ๆ ได้

คุณดำเนินการที่ต้องใช้การประมวลผลอย่างหนักแบบซิงค์ภายในการเรียกกลับ onDataSetChanged() ได้ คุณรับประกันว่าการโทรนี้จะเสร็จสมบูรณ์ ก่อนที่ระบบจะดึงข้อมูลข้อมูลเมตาหรือข้อมูลพร็อพเพอร์ตี้จาก RemoteViewsFactory คุณ ยังสามารถดำเนินการประมวลผลแบบหนักภายใน getViewAt() หากการเรียกใช้นี้ใช้เวลานาน มุมมองการโหลดที่ระบุโดยเมธอดของRemoteViewsFactoryออบเจ็กต์getLoadingView()จะแสดงในตำแหน่งที่สอดคล้องกันของมุมมองคอลเล็กชันจนกว่าการเรียกใช้จะเสร็จสมบูรณ์

ใช้ RemoteCollectionItems เพื่อส่งต่อคอลเล็กชันโดยตรง

Android 12 (API ระดับ 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()
);