সংগ্রহ উইজেট ব্যবহার করুন

কম্পোজ পদ্ধতিটি চেষ্টা করুন
অ্যান্ড্রয়েডের জন্য Jetpack Compose হলো প্রস্তাবিত UI টুলকিট। Compose-স্টাইলের API ব্যবহার করে কীভাবে উইজেট তৈরি করতে হয় তা শিখুন।

কালেকশন উইজেটগুলো একই ধরনের অনেকগুলো উপাদান প্রদর্শনে বিশেষায়িত, যেমন গ্যালারি অ্যাপ থেকে ছবির সংগ্রহ, নিউজ অ্যাপ থেকে আর্টিকেল, বা কমিউনিকেশন অ্যাপ থেকে মেসেজ। কালেকশন উইজেটগুলো সাধারণত দুটি ব্যবহারের ক্ষেত্রে মনোযোগ দেয়: কালেকশনটি ব্রাউজ করা এবং কালেকশনের কোনো একটি উপাদানকে তার বিস্তারিত ভিউতে খোলা। কালেকশন উইজেটগুলো উল্লম্বভাবে স্ক্রল করা যায়।

এই উইজেটগুলি রিমোট ডেটা, যেমন কোনো কন্টেন্ট প্রোভাইডার থেকে প্রাপ্ত ডেটা দ্বারা সমর্থিত কালেকশনগুলি প্রদর্শন করতে RemoteViewsService ব্যবহার করে। উইজেটটি নিম্নলিখিত ভিউ টাইপগুলির মধ্যে একটি ব্যবহার করে ডেটা উপস্থাপন করে, যেগুলি কালেকশন ভিউ নামে পরিচিত:

ListView
এমন একটি ভিউ যা আইটেমগুলোকে উল্লম্বভাবে স্ক্রলযোগ্য একটি তালিকায় প্রদর্শন করে।
GridView
একটি ভিউ যা আইটেমগুলিকে একটি দ্বি-মাত্রিক স্ক্রোলিং গ্রিডে প্রদর্শন করে।
StackView
একটি স্তূপীকৃত কার্ড ভিউ— অনেকটা রোলোডেক্সের মতো—যেখানে ব্যবহারকারী সামনের কার্ডটি উপরে বা নীচে ফ্লিক করে যথাক্রমে আগের বা পরের কার্ডটি দেখতে পারেন।
AdapterViewFlipper
একটি অ্যাডাপ্টার-সমর্থিত সরল ViewAnimator যা দুই বা ততোধিক ভিউয়ের মধ্যে অ্যানিমেট করে। একবারে কেবল একটি চাইল্ড দেখানো হয়।

যেহেতু এই কালেকশন ভিউগুলো রিমোট ডেটা দ্বারা সমর্থিত কালেকশন প্রদর্শন করে, তাই এগুলো তাদের ইউজার ইন্টারফেসকে ডেটার সাথে সংযুক্ত করতে একটি Adapter ব্যবহার করে। একটি Adapter ডেটার একটি সেট থেকে স্বতন্ত্র আইটেমগুলোকে পৃথক View অবজেক্টের সাথে সংযুক্ত করে।

এবং যেহেতু এই কালেকশন ভিউগুলো অ্যাডাপ্টার দ্বারা সমর্থিত, তাই উইজেটে এদের ব্যবহার সমর্থন করার জন্য অ্যান্ড্রয়েড ফ্রেমওয়ার্ককে অতিরিক্ত আর্কিটেকচার অন্তর্ভুক্ত করতে হয়। একটি উইজেটের প্রেক্ষাপটে, Adapter একটি RemoteViewsFactory দ্বারা প্রতিস্থাপিত হয়, যা Adapter ইন্টারফেসের একটি পাতলা র‍্যাপার। কালেকশনের কোনো নির্দিষ্ট আইটেমের জন্য অনুরোধ করা হলে, RemoteViewsFactory কালেকশনের জন্য আইটেমটি তৈরি করে এবং একটি RemoteViews অবজেক্ট হিসেবে ফেরত দেয়। আপনার উইজেটে একটি কালেকশন ভিউ অন্তর্ভুক্ত করতে, RemoteViewsService এবং RemoteViewsFactory ইমপ্লিমেন্ট করুন।

RemoteViewsService হলো এমন একটি সার্ভিস যা একটি রিমোট অ্যাডাপ্টারকে RemoteViews অবজেক্ট অনুরোধ করতে দেয়। RemoteViewsFactory হলো একটি অ্যাডাপ্টারের ইন্টারফেস, যা একটি কালেকশন ভিউ—যেমন ListView , GridView , এবং StackView এবং সেই ভিউয়ের অন্তর্নিহিত ডেটার মধ্যে সংযোগ স্থাপন করে। StackWidget স্যাম্পল থেকে, এই সার্ভিস এবং ইন্টারফেসটি ইমপ্লিমেন্ট করার জন্য বয়লারপ্লেট কোডের একটি উদাহরণ নিচে দেওয়া হলো:

কোটলিন

class StackWidgetService : RemoteViewsService() {

    override fun onGetViewFactory(intent: Intent): RemoteViewsFactory {
        return StackRemoteViewsFactory(this.applicationContext, intent)
    }
}

class StackRemoteViewsFactory(
        private val context: Context,
        intent: Intent
) : RemoteViewsService.RemoteViewsFactory {

// See the RemoteViewsFactory API reference for the full list of methods to
// implement.

}

জাভা

public class StackWidgetService extends RemoteViewsService {
    @Override
    public RemoteViewsFactory onGetViewFactory(Intent intent) {
        return new StackRemoteViewsFactory(this.getApplicationContext(), intent);
    }
}

class StackRemoteViewsFactory implements RemoteViewsService.RemoteViewsFactory {

// See the RemoteViewsFactory API reference for the full list of methods to
// implement.

}

নমুনা অ্যাপ্লিকেশন

এই অংশের কোডের অংশগুলোও StackWidget স্যাম্পল থেকে নেওয়া হয়েছে:

চিত্র ১. একটি StackWidget

এই নমুনাটিতে দশটি ভিউয়ের একটি স্ট্যাক রয়েছে যা শূন্য থেকে নয় পর্যন্ত মান প্রদর্শন করে। নমুনা উইজেটটির প্রধান আচরণগুলো হলো:

  • ব্যবহারকারী পরবর্তী বা পূর্ববর্তী ভিউ প্রদর্শন করার জন্য উইজেটের উপরের ভিউটিকে উল্লম্বভাবে সরাতে পারেন। এটি StackView -এর একটি অন্তর্নির্মিত আচরণ।

  • ব্যবহারকারীর কোনো হস্তক্ষেপ ছাড়াই, উইজেটটি একটি স্লাইডশোরের মতো স্বয়ংক্রিয়ভাবে ক্রমানুসারে এর ভিউগুলো প্রদর্শন করে। এর কারণ হলো res/xml/stackwidgetinfo.xml ফাইলে থাকা android:autoAdvanceViewId="@id/stack_view" সেটিংটি। এই সেটিংটি ভিউ আইডির ক্ষেত্রে প্রযোজ্য, যা এই ক্ষেত্রে স্ট্যাক ভিউয়ের ভিউ আইডি।

  • যদি ব্যবহারকারী টপ ভিউ স্পর্শ করেন, তাহলে উইজেটটি "Touched view n " এই Toast বার্তাটি প্রদর্শন করে, যেখানে n হলো স্পর্শ করা ভিউটির ইন্ডেক্স (অবস্থান)। কীভাবে বিভিন্ন বিহেভিয়ার প্রয়োগ করতে হয় সে সম্পর্কে আরও আলোচনার জন্য, " Add behavior to individual items" বিভাগটি দেখুন।

কালেকশন সহ উইজেট বাস্তবায়ন করুন

কালেকশন সহ একটি উইজেট ইমপ্লিমেন্ট করতে, যেকোনো উইজেট ইমপ্লিমেন্ট করার পদ্ধতি অনুসরণ করুন এবং এর সাথে কয়েকটি অতিরিক্ত ধাপ অনুসরণ করুন: ম্যানিফেস্ট পরিবর্তন করুন, উইজেট লেআউটে একটি কালেকশন ভিউ যোগ করুন এবং আপনার AppWidgetProvider সাবক্লাসটি পরিবর্তন করুন।

সংগ্রহ সহ উইজেটগুলির জন্য ম্যানিফেস্ট

"ম্যানিফেস্টে একটি উইজেট ডিক্লেয়ার করুন" অংশে তালিকাভুক্ত প্রয়োজনীয়তাগুলো ছাড়াও, আপনাকে এমন ব্যবস্থা করতে হবে যাতে কালেকশনযুক্ত উইজেটগুলো আপনার RemoteViewsService এর সাথে বাইন্ড হতে পারে। এটি করার জন্য, আপনার ম্যানিফেস্ট ফাইলে BIND_REMOTEVIEWS পারমিশনসহ সার্ভিসটি ডিক্লেয়ার করুন। এটি অন্যান্য অ্যাপ্লিকেশনকে আপনার উইজেটের ডেটা অবাধে অ্যাক্সেস করা থেকে বিরত রাখে।

উদাহরণস্বরূপ, যখন কোনো কালেকশন ভিউ পূরণ করার জন্য RemoteViewsService ব্যবহার করে এমন একটি উইজেট তৈরি করা হয়, তখন ম্যানিফেস্ট এন্ট্রিটি দেখতে এইরকম হতে পারে:

<service android:name="MyWidgetService"
    android:permission="android.permission.BIND_REMOTEVIEWS" />

এই উদাহরণে, android:name="MyWidgetService" আপনার RemoteViewsService সাবক্লাসকে নির্দেশ করে।

সংগ্রহ সহ উইজেটগুলির জন্য লেআউট

আপনার উইজেট লেআউট XML ফাইলের প্রধান শর্ত হলো, এতে ListView , GridView , StackView বা AdapterViewFlipper এর মতো যেকোনো একটি কালেকশন ভিউ অন্তর্ভুক্ত থাকতে হবে। নিচে StackWidget স্যাম্পলটির widget_layout.xml ফাইলটি দেওয়া হলো:

<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 এর ইমপ্লিমেন্টেশনকে নির্দেশ করে এবং সেই উইজেট আইডিটি পাস করুন যা আপডেট করার জন্য উইজেটটিকে নির্দিষ্ট করে।

উদাহরণস্বরূপ, উইজেট কালেকশনের জন্য RemoteViewsService কে রিমোট অ্যাডাপ্টার হিসেবে সেট করতে StackWidget স্যাম্পলটি যেভাবে onUpdate() কলব্যাক মেথডটি প্রয়োগ করে, তা এখানে দেখানো হলো:

কোটলিন

override fun onUpdate(
        context: Context,
        appWidgetManager: AppWidgetManager,
        appWidgetIds: IntArray
) {
    // Update each of the widgets with the remote adapter.
    appWidgetIds.forEach { appWidgetId ->

        // Set up the intent that starts the StackViewService, which
        // provides the views for this collection.
        val intent = Intent(context, StackWidgetService::class.java).apply {
            // Add the widget ID to the intent extras.
            putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
            data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))
        }
        // Instantiate the RemoteViews object for the widget layout.
        val views = RemoteViews(context.packageName, R.layout.widget_layout).apply {
            // Set up the RemoteViews object to use a RemoteViews adapter.
            // This adapter connects to a RemoteViewsService through the
            // specified intent.
            // This is how you populate the data.
            setRemoteAdapter(R.id.stack_view, intent)

            // The empty view is displayed when the collection has no items.
            // It must be in the same layout used to instantiate the
            // RemoteViews object.
            setEmptyView(R.id.stack_view, R.id.empty_view)
        }

        // Do additional processing specific to this widget.

        appWidgetManager.updateAppWidget(appWidgetId, views)
    }
    super.onUpdate(context, appWidgetManager, appWidgetIds)
}

জাভা

public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
    // Update each of the widgets with the remote adapter.
    for (int i = 0; i < appWidgetIds.length; ++i) {

        // Set up the intent that starts the StackViewService, which
        // provides the views for this collection.
        Intent intent = new Intent(context, StackWidgetService.class);
        // Add the widget ID to the intent extras.
        intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetIds[i]);
        intent.setData(Uri.parse(intent.toUri(Intent.URI_INTENT_SCHEME)));
        // Instantiate the RemoteViews object for the widget layout.
        RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.widget_layout);
        // Set up the RemoteViews object to use a RemoteViews adapter.
        // This adapter connects to a RemoteViewsService through the specified
        // intent.
        // This is how you populate the data.
        views.setRemoteAdapter(R.id.stack_view, intent);

        // The empty view is displayed when the collection has no items.
        // It must be in the same layout used to instantiate the RemoteViews
        // object.
        views.setEmptyView(R.id.stack_view, R.id.empty_view);

        // Do additional processing specific to this widget.

        appWidgetManager.updateAppWidget(appWidgetIds[i], views);
    }
    super.onUpdate(context, appWidgetManager, appWidgetIds);
}

ডেটা সংরক্ষণ করুন

এই পৃষ্ঠায় যেমন বর্ণনা করা হয়েছে, RemoteViewsService সাবক্লাসটি RemoteViewsFactory প্রদান করে, যা রিমোট কালেকশন ভিউকে ডেটা দিয়ে পূর্ণ করতে ব্যবহৃত হয়।

বিশেষভাবে, এই ধাপগুলো অনুসরণ করুন:

  1. RemoteViewsService সাবক্লাস করুন। RemoteViewsService হলো সেই সার্ভিস যার মাধ্যমে একটি রিমোট অ্যাডাপ্টার RemoteViews অনুরোধ করতে পারে।

  2. আপনার RemoteViewsService সাবক্লাসে, এমন একটি ক্লাস অন্তর্ভুক্ত করুন যা RemoteViewsFactory ইন্টারফেসটি ইমপ্লিমেন্ট করে। RemoteViewsFactory হলো একটি অ্যাডাপ্টারের ইন্টারফেস, যা একটি রিমোট কালেকশন ভিউ—যেমন ListView , GridView , StackView এবং সেই ভিউয়ের অন্তর্নিহিত ডেটার মধ্যে সংযোগ স্থাপন করে। আপনার ইমপ্লিমেন্টেশন ডেটাসেটের প্রতিটি আইটেমের জন্য একটি RemoteViews অবজেক্ট তৈরি করার দায়িত্বে থাকে। এই ইন্টারফেসটি Adapter এর একটি হালকা র‍্যাপার।

আপনার সার্ভিসের কোনো একটিমাত্র ইনস্ট্যান্স বা তাতে থাকা কোনো ডেটা স্থায়ীভাবে থাকবে, এমনটা নিশ্চিতভাবে বলা যায় না। আপনার RemoteViewsService এ ডেটা সংরক্ষণ করবেন না, যদি না তা স্ট্যাটিক হয়। আপনি যদি চান আপনার উইজেটের ডেটা স্থায়ীভাবে থাকুক, তবে সবচেয়ে ভালো উপায় হলো এমন একটি ContentProvider ব্যবহার করা যার ডেটা প্রসেস লাইফসাইকেলের পরেও টিকে থাকে। উদাহরণস্বরূপ, একটি গ্রোসারি স্টোর উইজেট প্রতিটি গ্রোসারি লিস্ট আইটেমের স্টেট একটি স্থায়ী স্থানে, যেমন একটি SQL ডাটাবেসে, সংরক্ষণ করতে পারে।

RemoteViewsService ইমপ্লিমেন্টেশনের মূল উপাদান হলো এর RemoteViewsFactory , যা পরবর্তী অনুচ্ছেদে বর্ণনা করা হয়েছে।

RemoteViewsFactory ইন্টারফেস

আপনার কাস্টম ক্লাস, যা RemoteViewsFactory ইন্টারফেসটি ইমপ্লিমেন্ট করে, উইজেটকে তার কালেকশনের আইটেমগুলোর জন্য ডেটা সরবরাহ করে। এটি করার জন্য, এটি আপনার উইজেট আইটেমের XML লেআউট ফাইলকে একটি ডেটা সোর্সের সাথে সংযুক্ত করে। এই ডেটা সোর্স একটি ডেটাবেস থেকে শুরু করে একটি সাধারণ অ্যারে পর্যন্ত যেকোনো কিছু হতে পারে। StackWidget স্যাম্পলটিতে, ডেটা সোর্সটি হলো WidgetItems এর একটি অ্যারে। RemoteViewsFactory একটি অ্যাডাপ্টার হিসেবে কাজ করে যা ডেটাকে রিমোট কালেকশন ভিউয়ের সাথে জুড়ে দেয়।

আপনার RemoteViewsFactory সাবক্লাসের জন্য যে দুটি সবচেয়ে গুরুত্বপূর্ণ মেথড ইমপ্লিমেন্ট করতে হবে, সেগুলো হলো onCreate() এবং getViewAt()

প্রথমবার আপনার ফ্যাক্টরি তৈরি করার সময় সিস্টেম onCreate() কল করে। এখানেই আপনি আপনার ডেটা সোর্সের সাথে যেকোনো সংযোগ বা কার্সর সেট আপ করেন। উদাহরণস্বরূপ, StackWidget স্যাম্পলটি WidgetItem অবজেক্টের একটি অ্যারে ইনিশিয়ালাইজ করতে onCreate() ব্যবহার করে। যখন আপনার উইজেটটি সক্রিয় থাকে, তখন সিস্টেম অ্যারেতে থাকা এই অবজেক্টগুলোকে তাদের ইনডেক্স পজিশন ব্যবহার করে অ্যাক্সেস করে এবং সেগুলোর মধ্যে থাকা টেক্সট প্রদর্শন করে।

এখানে StackWidget স্যাম্পলের RemoteViewsFactory ইমপ্লিমেন্টেশন থেকে onCreate() মেথডের কিছু অংশ তুলে ধরা হলো:

কোটলিন

private const val REMOTE_VIEW_COUNT: Int = 10

class StackRemoteViewsFactory(
        private val context: Context
) : RemoteViewsService.RemoteViewsFactory {

    private lateinit var widgetItems: List<WidgetItem>

    override fun onCreate() {
        // In onCreate(), set up any connections or cursors to your data
        // source. Heavy lifting, such as downloading or creating content,
        // must be deferred to onDataSetChanged() or getViewAt(). Taking
        // more than 20 seconds on this call results in an ANR.
        widgetItems = List(REMOTE_VIEW_COUNT) { index -> WidgetItem("$index!") }
        ...
    }
    ...
}

জাভা

class StackRemoteViewsFactory implements RemoteViewsService.RemoteViewsFactory {
    private static final int REMOTE_VIEW_COUNT = 10;
    private List<WidgetItem> widgetItems = new ArrayList<WidgetItem>();

    public void onCreate() {
        // In onCreate(), setup any connections or cursors to your data
        // source. Heavy lifting, such as downloading or creating content,
        // must be deferred to onDataSetChanged() or getViewAt(). Taking
        // more than 20 seconds on this call results in an ANR.
        for (int i = 0; i < REMOTE_VIEW_COUNT; i++) {
            widgetItems.add(new WidgetItem(i + "!"));
        }
        ...
    }
...

RemoteViewsFactory মেথড getViewAt() ডেটা সেটের নির্দিষ্ট position থাকা ডেটার সাথে সঙ্গতিপূর্ণ একটি RemoteViews অবজেক্ট রিটার্ন করে। নিচে StackWidget স্যাম্পলের RemoteViewsFactory ইমপ্লিমেন্টেশন থেকে একটি অংশ তুলে ধরা হলো:

কোটলিন

override fun getViewAt(position: Int): RemoteViews {
    // Construct a remote views item based on the widget item XML file
    // and set the text based on the position.
    return RemoteViews(context.packageName, R.layout.widget_item).apply {
        setTextViewText(R.id.widget_item, widgetItems[position].text)
    }
}

জাভা

public RemoteViews getViewAt(int position) {
    // Construct a remote views item based on the widget item XML file
    // and set the text based on the position.
    RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.widget_item);
    views.setTextViewText(R.id.widget_item, widgetItems.get(position).text);
    return views;
}

স্বতন্ত্র আইটেমগুলিতে আচরণ যোগ করুন

পূর্ববর্তী বিভাগগুলিতে দেখানো হয়েছে কীভাবে আপনার ডেটা উইজেট কালেকশনের সাথে যুক্ত করতে হয়। কিন্তু যদি আপনি আপনার কালেকশন ভিউয়ের প্রতিটি আইটেমে ডাইনামিক আচরণ যোগ করতে চান, তাহলে কী হবে?

onUpdate() ক্লাস দিয়ে ইভেন্ট পরিচালনা করার অংশে যেমন বর্ণনা করা হয়েছে, আপনি সাধারণত কোনো অবজেক্টের ক্লিক আচরণ নির্ধারণ করতে setOnClickPendingIntent() ব্যবহার করেন—যেমন, একটি বাটন দিয়ে কোনো Activity চালু করানো। কিন্তু একটি স্বতন্ত্র কালেকশন আইটেমের চাইল্ড ভিউগুলোর জন্য এই পদ্ধতিটি অনুমোদিত নয়। উদাহরণস্বরূপ, আপনি Gmail উইজেটে একটি গ্লোবাল বাটন সেট আপ করার জন্য setOnClickPendingIntent() ব্যবহার করতে পারেন যা অ্যাপটি চালু করে, কিন্তু স্বতন্ত্র লিস্ট আইটেমগুলোতে নয়।

এর পরিবর্তে, একটি কালেকশনের স্বতন্ত্র আইটেমগুলিতে ক্লিক আচরণ যোগ করতে, setOnClickFillInIntent() ব্যবহার করুন। এর জন্য আপনাকে আপনার কালেকশন ভিউয়ের জন্য একটি পেন্ডিং ইন্টেন্ট টেমপ্লেট সেট আপ করতে হবে এবং তারপরে আপনার RemoteViewsFactory মাধ্যমে কালেকশনের প্রতিটি আইটেমে একটি ফিল-ইন ইন্টেন্ট সেট করতে হবে।

এই বিভাগে, স্বতন্ত্র আইটেমগুলিতে কীভাবে আচরণ যোগ করতে হয় তা বর্ণনা করার জন্য StackWidget নমুনাটি ব্যবহার করা হয়েছে। StackWidget নমুনাটিতে, যদি ব্যবহারকারী উপরের ভিউটি স্পর্শ করেন, তাহলে উইজেটটি "Touched view n " Toast বার্তাটি প্রদর্শন করে, যেখানে n হলো স্পর্শ করা ভিউটির ইন্ডেক্স (অবস্থান)। এটি যেভাবে কাজ করে তা হলো:

  • StackWidgetProvider —যা AppWidgetProvider একটি সাবক্লাস— TOAST_ACTION নামক একটি কাস্টম অ্যাকশন সহ একটি পেন্ডিং ইন্টেন্ট তৈরি করে।

  • যখন ব্যবহারকারী কোনো ভিউ স্পর্শ করেন, তখন ইন্টেন্টটি সক্রিয় হয় এবং TOAST_ACTION ব্রডকাস্ট করে।

  • এই ব্রডকাস্টটি StackWidgetProvider ক্লাসের onReceive() মেথড দ্বারা গ্রহণ করা হয় এবং উইজেটটি স্পর্শ করা ভিউটির জন্য Toast মেসেজটি প্রদর্শন করে। কালেকশন আইটেমগুলোর জন্য ডেটা RemoteViewsFactory থেকে RemoteViewsService এর মাধ্যমে সরবরাহ করা হয়।

পেন্ডিং ইন্টেন্ট টেমপ্লেট সেট আপ করুন

StackWidgetProvider ( AppWidgetProvider এর একটি সাবক্লাস) একটি পেন্ডিং ইন্টেন্ট সেট আপ করে। একটি কালেকশনের স্বতন্ত্র আইটেমগুলো তাদের নিজস্ব পেন্ডিং ইন্টেন্ট সেট আপ করতে পারে না। এর পরিবর্তে, পুরো কালেকশনটি একটি পেন্ডিং ইন্টেন্ট টেমপ্লেট সেট আপ করে, এবং প্রতিটি আইটেম স্বতন্ত্র আচরণ তৈরির জন্য একটি ফিল-ইন ইন্টেন্ট সেট করে।

ব্যবহারকারী যখন কোনো ভিউ স্পর্শ করেন, তখন পাঠানো ব্রডকাস্টটিও এই ক্লাসটি গ্রহণ করে। এটি তার onReceive() মেথডে এই ইভেন্টটি প্রসেস করে। যদি ইন্টেন্টের অ্যাকশন TOAST_ACTION হয়, তাহলে উইজেটটি বর্তমান ভিউটির জন্য একটি Toast মেসেজ প্রদর্শন করে।

কোটলিন

const val TOAST_ACTION = "com.example.android.stackwidget.TOAST_ACTION"
const val EXTRA_ITEM = "com.example.android.stackwidget.EXTRA_ITEM"

class StackWidgetProvider : AppWidgetProvider() {

    ...

    // Called when the BroadcastReceiver receives an Intent broadcast.
    // Checks whether the intent's action is TOAST_ACTION. If it is, the
    // widget displays a Toast message for the current item.
    override fun onReceive(context: Context, intent: Intent) {
        val mgr: AppWidgetManager = AppWidgetManager.getInstance(context)
        if (intent.action == TOAST_ACTION) {
            val appWidgetId: Int = intent.getIntExtra(
                    AppWidgetManager.EXTRA_APPWIDGET_ID,
                    AppWidgetManager.INVALID_APPWIDGET_ID
            )
            // EXTRA_ITEM represents a custom value provided by the Intent
            // passed to the setOnClickFillInIntent() method to indicate the
            // position of the clicked item. See StackRemoteViewsFactory in
            // Set the fill-in Intent for details.
            val viewIndex: Int = intent.getIntExtra(EXTRA_ITEM, 0)
            Toast.makeText(context, "Touched view $viewIndex", Toast.LENGTH_SHORT).show()
        }
        super.onReceive(context, intent)
    }

    override fun onUpdate(
            context: Context,
            appWidgetManager: AppWidgetManager,
            appWidgetIds: IntArray
    ) {
        // Update each of the widgets with the remote adapter.
        appWidgetIds.forEach { appWidgetId ->

            // Sets up the intent that points to the StackViewService that
            // provides the views for this collection.
            val intent = Intent(context, StackWidgetService::class.java).apply {
                putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
                // When intents are compared, the extras are ignored, so embed
                // the extra sinto the data so that the extras are not ignored.
                data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))
            }
            val rv = RemoteViews(context.packageName, R.layout.widget_layout).apply {
                setRemoteAdapter(R.id.stack_view, intent)

                // The empty view is displayed when the collection has no items.
                // It must be a sibling of the collection view.
                setEmptyView(R.id.stack_view, R.id.empty_view)
            }

            // This section makes it possible for items to have individualized
            // behavior. It does this by setting up a pending intent template.
            // Individuals items of a collection can't set up their own pending
            // intents. Instead, the collection as a whole sets up a pending
            // intent template, and the individual items set a fillInIntent
            // to create unique behavior on an item-by-item basis.
            val toastPendingIntent: PendingIntent = Intent(
                    context,
                    StackWidgetProvider::class.java
            ).run {
                // Set the action for the intent.
                // When the user touches a particular view, it has the effect of
                // broadcasting TOAST_ACTION.
                action = TOAST_ACTION
                putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
                data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))

                PendingIntent.getBroadcast(context, 0, this, PendingIntent.FLAG_UPDATE_CURRENT)
            }
            rv.setPendingIntentTemplate(R.id.stack_view, toastPendingIntent)

            appWidgetManager.updateAppWidget(appWidgetId, rv)
        }
        super.onUpdate(context, appWidgetManager, appWidgetIds)
    }
}

জাভা

public class StackWidgetProvider extends AppWidgetProvider {
    public static final String TOAST_ACTION = "com.example.android.stackwidget.TOAST_ACTION";
    public static final String EXTRA_ITEM = "com.example.android.stackwidget.EXTRA_ITEM";

    ...

    // Called when the BroadcastReceiver receives an Intent broadcast.
    // Checks whether the intent's action is TOAST_ACTION. If it is, the
    // widget displays a Toast message for the current item.
    @Override
    public void onReceive(Context context, Intent intent) {
        AppWidgetManager mgr = AppWidgetManager.getInstance(context);
        if (intent.getAction().equals(TOAST_ACTION)) {
            int appWidgetId = intent.getIntExtra(AppWidgetManager.EXTRA_APPWIDGET_ID,
                AppWidgetManager.INVALID_APPWIDGET_ID);
            // EXTRA_ITEM represents a custom value provided by the Intent
            // passed to the setOnClickFillInIntent() method to indicate the
            // position of the clicked item. See StackRemoteViewsFactory in
            // Set the fill-in Intent for details.
            int viewIndex = intent.getIntExtra(EXTRA_ITEM, 0);
            Toast.makeText(context, "Touched view " + viewIndex, Toast.LENGTH_SHORT).show();
        }
        super.onReceive(context, intent);
    }

    @Override
    public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        // Update each of the widgets with the remote adapter.
        for (int i = 0; i < appWidgetIds.length; ++i) {

            // Sets up the intent that points to the StackViewService that
            // provides the views for this collection.
            Intent intent = new Intent(context, StackWidgetService.class);
            intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetIds[i]);
            // When intents are compared, the extras are ignored, so embed
            // the extras into the data so that the extras are not
            // ignored.
            intent.setData(Uri.parse(intent.toUri(Intent.URI_INTENT_SCHEME)));
            RemoteViews rv = new RemoteViews(context.getPackageName(), R.layout.widget_layout);
            rv.setRemoteAdapter(appWidgetIds[i], R.id.stack_view, intent);

            // The empty view is displayed when the collection has no items. It
            // must be a sibling of the collection view.
            rv.setEmptyView(R.id.stack_view, R.id.empty_view);

            // This section makes it possible for items to have individualized
            // behavior. It does this by setting up a pending intent template.
            // Individuals items of a collection can't set up their own pending
            // intents. Instead, the collection as a whole sets up a pending
            // intent template, and the individual items set a fillInIntent
            // to create unique behavior on an item-by-item basis.
            Intent toastIntent = new Intent(context, StackWidgetProvider.class);
            // Set the action for the intent.
            // When the user touches a particular view, it has the effect of
            // broadcasting TOAST_ACTION.
            toastIntent.setAction(StackWidgetProvider.TOAST_ACTION);
            toastIntent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetIds[i]);
            intent.setData(Uri.parse(intent.toUri(Intent.URI_INTENT_SCHEME)));
            PendingIntent toastPendingIntent = PendingIntent.getBroadcast(context, 0, toastIntent,
                PendingIntent.FLAG_UPDATE_CURRENT);
            rv.setPendingIntentTemplate(R.id.stack_view, toastPendingIntent);

            appWidgetManager.updateAppWidget(appWidgetIds[i], rv);
        }
        super.onUpdate(context, appWidgetManager, appWidgetIds);
    }
}

ফিল ইনটেন্ট সেট করুন

আপনার RemoteViewsFactory অবশ্যই কালেকশনের প্রতিটি আইটেমে একটি ফিল-ইন ইন্টেন্ট সেট করতে হবে। এর ফলে কোনো নির্দিষ্ট আইটেমের স্বতন্ত্র অন-ক্লিক অ্যাকশনকে আলাদাভাবে চিহ্নিত করা সম্ভব হয়। এরপর আইটেমটিতে ট্যাপ করা হলে কোন চূড়ান্ত ইন্টেন্টটি এক্সিকিউট হবে, তা নির্ধারণ করার জন্য এই ফিল-ইন ইন্টেন্টটিকে PendingIntent টেমপ্লেটের সাথে যুক্ত করা হয়।

কোটলিন

private const val REMOTE_VIEW_COUNT: Int = 10

class StackRemoteViewsFactory(
        private val context: Context,
        intent: Intent
) : RemoteViewsService.RemoteViewsFactory {

    private lateinit var widgetItems: List<WidgetItem>
    private val appWidgetId: Int = intent.getIntExtra(
            AppWidgetManager.EXTRA_APPWIDGET_ID,
            AppWidgetManager.INVALID_APPWIDGET_ID
    )

    override fun onCreate() {
        // In onCreate(), set up any connections or cursors to your data source.
        // Heavy lifting, such as downloading or creating content, must be
        // deferred to onDataSetChanged() or getViewAt(). Taking more than 20
        // seconds on this call results in an ANR.
        widgetItems = List(REMOTE_VIEW_COUNT) { index -> WidgetItem("$index!") }
        ...
    }
    ...

    override fun getViewAt(position: Int): RemoteViews {
        // Construct a remote views item based on the widget item XML file
        // and set the text based on the position.
        return RemoteViews(context.packageName, R.layout.widget_item).apply {
            setTextViewText(R.id.widget_item, widgetItems[position].text)

            // Set a fill-intent to fill in the pending intent template.
            // that is set on the collection view in StackWidgetProvider.
            val fillInIntent = Intent().apply {
                Bundle().also { extras ->
                    extras.putInt(EXTRA_ITEM, position)
                    putExtras(extras)
                }
            }
            // Make it possible to distinguish the individual on-click
            // action of a given item.
            setOnClickFillInIntent(R.id.widget_item, fillInIntent)
            ...
        }
    }
    ...
}

জাভা

public class StackWidgetService extends RemoteViewsService {
    @Override
    public RemoteViewsFactory onGetViewFactory(Intent intent) {
        return new StackRemoteViewsFactory(this.getApplicationContext(), intent);
    }
}

class StackRemoteViewsFactory implements RemoteViewsService.RemoteViewsFactory {
    private static final int count = 10;
    private List<WidgetItem> widgetItems = new ArrayList<WidgetItem>();
    private Context context;
    private int appWidgetId;

    public StackRemoteViewsFactory(Context context, Intent intent) {
        this.context = context;
        appWidgetId = intent.getIntExtra(AppWidgetManager.EXTRA_APPWIDGET_ID,
                AppWidgetManager.INVALID_APPWIDGET_ID);
    }

    // Initialize the data set.
    public void onCreate() {
        // In onCreate(), set up any connections or cursors to your data
        // source. Heavy lifting, such as downloading or creating
        // content, must be deferred to onDataSetChanged() or
        // getViewAt(). Taking more than 20 seconds on this call results
        // in an ANR.
        for (int i = 0; i < count; i++) {
            widgetItems.add(new WidgetItem(i + "!"));
        }
        ...
    }

    // Given the position (index) of a WidgetItem in the array, use the
    // item's text value in combination with the widget item XML file to
    // construct a RemoteViews object.
    public RemoteViews getViewAt(int position) {
        // Position always ranges from 0 to getCount() - 1.

        // Construct a RemoteViews item based on the widget item XML
        // file and set the text based on the position.
        RemoteViews rv = new RemoteViews(context.getPackageName(), R.layout.widget_item);
        rv.setTextViewText(R.id.widget_item, widgetItems.get(position).text);

        // Set a fill-intent to fill in the pending
        // intent template that is set on the collection view in
        // StackWidgetProvider.
        Bundle extras = new Bundle();
        extras.putInt(StackWidgetProvider.EXTRA_ITEM, position);
        Intent fillInIntent = new Intent();
        fillInIntent.putExtras(extras);
        // Make it possible to distinguish the individual on-click
        // action of a given item.
        rv.setOnClickFillInIntent(R.id.widget_item, fillInIntent);

        // Return the RemoteViews object.
        return rv;
    }
    ...
}

সংগ্রহের ডেটা সতেজ রাখুন

চিত্র ২-এ কালেকশন ব্যবহারকারী একটি উইজেটের আপডেট প্রবাহ দেখানো হয়েছে। এতে দেখানো হয়েছে কীভাবে উইজেট কোড RemoteViewsFactory এর সাথে কাজ করে এবং কীভাবে আপনি আপডেটগুলো ট্রিগার করতে পারেন:

চিত্র ২. আপডেট চলাকালীন RemoteViewsFactory সাথে মিথস্ক্রিয়া।

যেসব উইজেট কালেকশন ব্যবহার করে, সেগুলো ব্যবহারকারীদের হালনাগাদ কন্টেন্ট সরবরাহ করতে পারে। উদাহরণস্বরূপ, জিমেইল উইজেট ব্যবহারকারীদের তাদের ইনবক্সের একটি স্ন্যাপশট দেখায়। এটি সম্ভব করার জন্য, নতুন ডেটা ফেচ ও প্রদর্শন করতে আপনার RemoteViewsFactory এবং কালেকশন ভিউকে ট্রিগার করুন।

এটি করার জন্য, AppWidgetManager ব্যবহার করে notifyAppWidgetViewDataChanged() কল করুন। এই কলের ফলে আপনার RemoteViewsFactory অবজেক্টের onDataSetChanged() মেথডে একটি কলব্যাক যায়, যা আপনাকে যেকোনো নতুন ডেটা ফেচ করতে দেয়।

আপনি onDataSetChanged() কলব্যাকের মধ্যে প্রসেসিং-ইনটেনসিভ অপারেশনগুলো সিনক্রোনাসলি সম্পাদন করতে পারেন। এক্ষেত্রে আপনাকে নিশ্চয়তা দেওয়া হয় যে RemoteViewsFactory থেকে মেটাডেটা বা ভিউ ডেটা ফেচ করার আগেই এই কলটি সম্পন্ন হবে। আপনি getViewAt() মেথডের মধ্যেও প্রসেসিং-ইনটেনসিভ অপারেশনগুলো সম্পাদন করতে পারেন। যদি এই কলটি সম্পন্ন হতে বেশি সময় নেয়, তাহলে RemoteViewsFactory অবজেক্টের getLoadingView() মেথড দ্বারা নির্দিষ্ট করা লোডিং ভিউটি, মেথডটি রিটার্ন না করা পর্যন্ত কালেকশন ভিউয়ের সংশ্লিষ্ট অবস্থানে প্রদর্শিত হয়।

সরাসরি একটি কালেকশন পাঠাতে RemoteCollectionItems ব্যবহার করুন।

অ্যান্ড্রয়েড ১২ (এপিআই লেভেল ৩১)-এ setRemoteAdapter(int viewId, RemoteViews.RemoteCollectionItems items) মেথডটি যুক্ত করা হয়েছে, যা আপনার অ্যাপকে একটি কালেকশন ভিউ পপুলেট করার সময় সরাসরি কালেকশনটি পাস করতে দেয়। আপনি যদি এই মেথডটি ব্যবহার করে আপনার অ্যাডাপ্টার সেট করেন, তাহলে আপনার RemoteViewsFactory ইমপ্লিমেন্ট করার বা notifyAppWidgetViewDataChanged() কল করার প্রয়োজন নেই।

আপনার অ্যাডাপ্টারকে ডেটা দিয়ে পূর্ণ করা সহজ করার পাশাপাশি, এই পদ্ধতিটি ব্যবহারকারীরা যখন কোনো নতুন আইটেম দেখার জন্য তালিকাটি স্ক্রল করে নিচে নামেন, তখন নতুন আইটেমগুলো যুক্ত হওয়ার বিলম্বও দূর করে। আপনার কালেকশন আইটেমের সংখ্যা তুলনামূলকভাবে কম থাকলে অ্যাডাপ্টার সেট করার এই পদ্ধতিটিই বেশি পছন্দনীয়। তবে, উদাহরণস্বরূপ, যদি আপনার কালেকশনে setImageViewBitmap এ পাস করা অসংখ্য Bitmaps থাকে, তাহলে এই পদ্ধতিটি ভালোভাবে কাজ করে না।

যদি কালেকশনটি লেআউটের একটি নির্দিষ্ট সেট ব্যবহার না করে—অর্থাৎ, যদি কিছু আইটেম কেবল মাঝে মাঝে উপস্থিত থাকে—তবে কালেকশনটিতে সর্বাধিক কতগুলো স্বতন্ত্র লেআউট থাকতে পারে তা নির্দিষ্ট করতে setViewTypeCount ব্যবহার করুন। এর ফলে আপনার অ্যাপ উইজেটের আপডেটের পরেও অ্যাডাপ্টারটি পুনরায় ব্যবহার করা যায়।

সরলীকৃত RemoteViews কালেকশন কীভাবে বাস্তবায়ন করতে হয় তার একটি উদাহরণ এখানে দেওয়া হলো।

কোটলিন

val itemLayouts = listOf(
        R.layout.item_type_1,
        R.layout.item_type_2,
        ...
)

remoteView.setRemoteAdapter(
        R.id.list_view,
        RemoteViews.RemoteCollectionItems.Builder()
            .addItem(/* id= */ ID_1, RemoteViews(context.packageName, R.layout.item_type_1))
            .addItem(/* id= */ ID_2, RemoteViews(context.packageName, R.layout.item_type_2))
            ...
            .setViewTypeCount(itemLayouts.count())
            .build()
)

জাভা

List<Integer> itemLayouts = Arrays.asList(
    R.layout.item_type_1,
    R.layout.item_type_2,
    ...
);

remoteView.setRemoteAdapter(
    R.id.list_view,
    new RemoteViews.RemoteCollectionItems.Builder()
        .addItem(/* id= */ ID_1, new RemoteViews(context.getPackageName(), R.layout.item_type_1))
        .addItem(/* id= */ ID_2, new RemoteViews(context.getPackageName(), R.layout.item_type_2))
        ...
        .setViewTypeCount(itemLayouts.size())
        .build()
);