วิดเจ็ตคอลเล็กชันมีความเชี่ยวชาญในการแสดงองค์ประกอบหลายอย่างประเภทเดียวกัน เช่น เป็นคอลเล็กชันรูปภาพจากแอปแกลเลอรี บทความจากแอปข่าวสาร หรือ ข้อความจากแอปการสื่อสาร วิดเจ็ตคอลเล็กชันมักจะมุ่งเน้นการใช้ 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
เช่นกัน
ตัวอย่าง:
![](https://developer.android.com/static/images/appwidgets/StackWidget.png?hl=th)
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
ที่ใช้เพื่อสร้างมุมมองคอลเล็กชันระยะไกล
โปรดทำตามขั้นตอนต่อไปนี้โดยเฉพาะ
คลาสย่อย
RemoteViewsService
RemoteViewsService
เป็นบริการผ่านทาง ซึ่งอะแดปเตอร์ระยะไกลสามารถขอRemoteViews
ได้ในคลาสย่อย
RemoteViewsService
ให้ใส่คลาสที่ใช้คลาสRemoteViewsFactory
RemoteViewsFactory
เป็นอินเทอร์เฟซสำหรับ อะแดปเตอร์ระหว่างมุมมองคอลเล็กชันระยะไกล เช่นListView
GridView
,StackView
และข้อมูลที่จำเป็นสำหรับข้อมูลพร็อพเพอร์ตี้นั้น บัญชี มีหน้าที่สร้างออบเจ็กต์RemoteViews
สำหรับแต่ละ ในชุดข้อมูล อินเทอร์เฟซนี้เป็น Wrapper ที่บางรอบๆAdapter
คุณไม่สามารถพึ่งพาบริการเพียงอินสแตนซ์เดียวหรือข้อมูลใดๆ ที่อยู่ในบริการเพื่อ
คงอยู่ อย่าเก็บข้อมูลใน RemoteViewsService
เว้นแต่จะเป็นแบบคงที่ ถ้า
คุณต้องการให้ข้อมูลวิดเจ็ตคงอยู่ วิธีที่ดีที่สุดคือใช้
ContentProvider
ที่เป็นเจ้าของข้อมูล
ยังคงอยู่หลังวงจรของกระบวนการ ตัวอย่างเช่น วิดเจ็ตร้านขายของชำสามารถ
จัดเก็บสถานะของรายการสิ่งที่ต้องซื้อแต่ละรายการในตำแหน่งถาวร เช่น
ฐานข้อมูล SQL
เนื้อหาหลักของการติดตั้งใช้งาน 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 ที่รอดำเนินการสำหรับ
มุมมองคอลเล็กชันของคุณ แล้วตั้งค่าความตั้งใจที่จะเติมข้อมูลในแต่ละรายการ
ผ่าน RemoteViewsFactory
ส่วนนี้ใช้ตัวอย่าง StackWidget
เพื่ออธิบายวิธีเพิ่มพฤติกรรมลงใน
ทีละรายการ ในตัวอย่าง StackWidget
หากผู้ใช้แตะมุมมองด้านบน
วิดเจ็ตแสดงข้อความ Toast
"มุมมองเมื่อแตะ n" โดยที่ n คือค่า
ดัชนี (ตำแหน่ง) ของมุมมองแบบแตะ วิธีการทำงานมีดังนี้:
แท็ก
StackWidgetProvider
-AppWidgetProvider
คลาสย่อย - สร้าง Intent ที่รอดำเนินการโดยมีการดำเนินการที่กำหนดเองชื่อTOAST_ACTION
เมื่อผู้ใช้แตะมุมมอง ความตั้งใจจะเริ่มทำงานและระบบจะเผยแพร่
TOAST_ACTION
ชั้นเรียน
StackWidgetProvider
ดักจับการออกอากาศครั้งนี้onReceive()
และวิดเจ็ตจะแสดงข้อความToast
สำหรับมุมมองแบบแตะ ข้อมูลสำหรับรายการคอลเล็กชันได้มาจากRemoteViewsFactory
ผ่านRemoteViewsService
ตั้งค่าเทมเพลต Intent ที่รอดำเนินการ
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
และคุณจะ
การอัปเดตทริกเกอร์:
![](https://developer.android.com/static/images/appwidgets/appwidget_collections.png?hl=th)
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() );