יצירת ווידג'ט פשוט

ווידג'טים של אפליקציות הם תצוגות מוקטנות של אפליקציות שאפשר להטמיע באפליקציות אחרות, כמו מסך הבית, ולקבל עדכונים תקופתיים. התצוגות האלה נקראות ווידג'טים בממשק המשתמש, ואפשר לפרסם אחת מהן באמצעות ספק ווידג'טים של אפליקציה (או ספק ווידג'טים). רכיב אפליקציה שמכיל ווידג'טים אחרים נקרא מארח ווידג'טים של אפליקציה (או מארח ווידג'טים). באיור 1 מוצג ווידג'ט מוזיקה לדוגמה:

במסמך הזה מוסבר איך לפרסם ווידג'ט באמצעות ספק ווידג'טים. במאמר יצירת מארח ווידג'טים מוסבר איך יוצרים AppWidgetHost משלכם כדי לארח ווידג'טים של אפליקציות.

בסקירה הכללית על ווידג'טים של אפליקציות מוסבר איך מעצבים ווידג'טים.

רכיבי ווידג'טים

כדי ליצור ווידג'ט, צריך את הרכיבים הבסיסיים הבאים:

אובייקט AppWidgetProviderInfo

תיאור המטא-נתונים של ווידג'ט, כמו הפריסה של הווידג'ט, תדירות העדכון והקלאס AppWidgetProvider. AppWidgetProviderInfo מוגדר ב-XML, כפי שמתואר במסמך הזה.

הכיתה AppWidgetProvider

מגדיר את השיטות הבסיסיות שמאפשרות ליצור ממשק עם הווידג'ט באופן פרוגרמטי. דרך האירוע הזה תקבלו עדכונים כשהווידג'ט מתעדכן, מופעל, מושבת או נמחק. מגדירים את AppWidgetProvider במניפסט ואז מטמיעים אותו, כפי שמתואר במסמך הזה.

הצגת הפריסה

הגדרת הפריסה הראשונית של הווידג'ט. הפריסה מוגדרת ב-XML, כפי שמתואר במסמך הזה.

באיור 2 מוצג איך הרכיבים האלה משתלבים בתהליך העיבוד הכולל של ווידג'טים של אפליקציות.

אם הווידג'ט צריך הגדרות משתמש, מטמיעים את הפעילות של הגדרת הווידג'ט של האפליקציה. הפעילות הזו מאפשרת למשתמשים לשנות את הגדרות הווידג'טים – לדוגמה, את אזור הזמן של ווידג'ט השעון.

• החל מ-Android 12 (רמת API 31), אפשר לספק הגדרת ברירת מחדל ולאפשר למשתמשים להגדיר מחדש את הווידג'ט מאוחר יותר. פרטים נוספים זמינים במאמרים שימוש בהגדרות ברירת המחדל של הווידג'ט ואיך מאפשרים למשתמשים לשנות את ההגדרות של ווידג'טים שהוגדרו.
• ב-Android 11 (רמת API 30) ואילך, הפעילות הזו מופעלת בכל פעם שהמשתמש מוסיף את הווידג'ט למסך הבית.

מומלץ גם להשתמש בשיפורים הבאים: פריסות גמישות של ווידג'טים, שיפורים שונים, ווידג'טים מתקדמים, ווידג'טים של אוספים ויצירת מארח ווידג'טים.

הצהרה על קובץ ה-XML של AppWidgetProviderInfo

האובייקט AppWidgetProviderInfo מגדיר את המאפיינים החיוניים של ווידג'ט. מגדירים את האובייקט AppWidgetProviderInfo בקובץ משאב XML באמצעות רכיב <appwidget-provider> יחיד ושומרים אותו בתיקייה res/xml/ של הפרויקט.

הדוגמה הבאה ממחישה זאת:

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="40dp"
    android:minHeight="40dp"
    android:targetCellWidth="1"
    android:targetCellHeight="1"
    android:maxResizeWidth="250dp"
    android:maxResizeHeight="120dp"
    android:updatePeriodMillis="86400000"
    android:description="@string/example_appwidget_description"
    android:previewLayout="@layout/example_appwidget_preview"
    android:initialLayout="@layout/example_loading_appwidget"
    android:configure="com.example.android.ExampleAppWidgetConfigurationActivity"
    android:resizeMode="horizontal|vertical"
    android:widgetCategory="home_screen"
    android:widgetFeatures="reconfigurable|configuration_optional">
</appwidget-provider>

מאפייני התאמת הגודל של ווידג'טים

במסך הבית שמוגדר כברירת מחדל, הווידג'טים ממוקמים בחלון על סמך רשת של תאים עם גובה ורוחב מוגדרים. ברוב מסכי הבית, הווידג'טים יכולים להיות רק בגדלים שהם מכפילים שלמים של תאי הרשת – לדוגמה, שני תאים אופקיים על שלושה תאים אנכיים.

מאפייני הגודל של הווידג'ט מאפשרים לכם לציין גודל ברירת מחדל לווידג'ט ולקבוע גבולות עליון ותחתון לגודל שלו. בהקשר הזה, גודל ברירת המחדל של הווידג'ט הוא הגודל שהוא מקבל כשמוסיפים אותו בפעם הראשונה למסך הבית.

בטבלה הבאה מתוארים המאפיינים של <appwidget-provider> שקשורים לגודל הווידג'ט:

דוגמה

כדי להמחיש איך המאפיינים בטבלה הקודמת משפיעים על גודל הווידג'ט, נניח את המפרטים הבאים:

• תא רשת הוא ברוחב 30dp ובגובה 50dp.
• המפרט הבא של המאפיין מסופק:

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="80dp"
    android:minHeight="80dp"
    android:targetCellWidth="2"
    android:targetCellHeight="2"
    android:minResizeWidth="40dp"
    android:minResizeHeight="40dp"
    android:maxResizeWidth="120dp"
    android:maxResizeHeight="120dp"
    android:resizeMode="horizontal|vertical" />

החל מגרסה Android 12:

משתמשים במאפיינים targetCellWidth ו-targetCellHeight כגודל ברירת המחדל של הווידג'ט.

גודל הווידג'ט הוא 2x2 כברירת מחדל. אפשר לשנות את הגודל של הווידג'ט ל-2x1 או ל-4x3.

Android מגרסה 11 ומטה:

משתמשים במאפיינים minWidth ו-minHeight כדי לחשב את גודל ברירת המחדל של הווידג'ט.

רוחב ברירת המחדל = Math.ceil(80 / 30) = 3

גובה ברירת המחדל = Math.ceil(80 / 50) = 2

גודל הווידג'ט הוא 3x2 כברירת מחדל. אפשר לשנות את הגודל של הווידג'ט ל-2x1 או למסך מלא.

מאפיינים נוספים של ווידג'טים

בטבלה הבאה מתוארים המאפיינים של <appwidget-provider> שקשורים למאפיינים אחרים מלבד הגודל של הווידג'ט.

שימוש בכיתה AppWidgetProvider לטיפול בשידורים של ווידג'טים

הכיתה AppWidgetProvider מטפלת בשידורים של ווידג'טים ומעדכנת את הווידג'ט בתגובה לאירועים במחזור החיים של הווידג'ט. בקטעים הבאים מוסבר איך להצהיר על AppWidgetProvider במניפסט ואז להטמיע אותו.

הצהרה על ווידג'ט במניפסט

קודם כול, מגדירים את הכיתה AppWidgetProvider בקובץ AndroidManifest.xml של האפליקציה, כפי שמתואר בדוגמה הבאה:

<receiver android:name="ExampleAppWidgetProvider"
                 android:exported="false">
    <intent-filter>
        <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
    </intent-filter>
    <meta-data android:name="android.appwidget.provider"
               android:resource="@xml/example_appwidget_info" />
</receiver>

אלמנט <receiver> מחייב את המאפיין android:name, שמציין את AppWidgetProvider שבו משתמש הווידג'ט. אין לייצא את הרכיב אלא אם תהליך נפרד צריך לשדר ל-AppWidgetProvider, וזה בדרך כלל לא המצב.

האלמנט <intent-filter> חייב לכלול אלמנט <action> עם המאפיין android:name. המאפיין הזה מציין שה-AppWidgetProvider מקבל את השידור של ACTION_APPWIDGET_UPDATE. זו השידור היחיד שצריך להצהיר עליו במפורש. AppWidgetManager שולח באופן אוטומטי את כל שידורי הווידג'טים האחרים אל AppWidgetProvider לפי הצורך.

האלמנט <meta-data> מציין את המשאב AppWidgetProviderInfo, והוא מחייב את המאפיינים הבאים:

• android:name: מציינים את שם המטא-נתונים. משתמשים ב-android.appwidget.provider כדי לזהות את הנתונים בתור מתאר AppWidgetProviderInfo.
• android:resource: מציין את המיקום של המשאב AppWidgetProviderInfo.

הטמעת המחלקה AppWidgetProvider

הכיתה AppWidgetProvider היא תת-כיתה של BroadcastReceiver, ומיועדת לטיפול בשידורים של ווידג'טים. הוא מקבל רק את שידורי האירועים הרלוונטיים לווידג'ט, למשל כשהווידג'ט מתעדכן, נמחק, מופעל או מושבת. כשאירועי השידור האלה מתרחשים, מתבצעת קריאה לשיטות AppWidgetProvider הבאות:

onUpdate()

הקריאה הזו מתבצעת כדי לעדכן את הווידג'ט במרווחי זמן שמוגדרים על ידי המאפיין updatePeriodMillis בקובץ AppWidgetProviderInfo. מידע נוסף זמין בטבלה שמתארת מאפיינים נוספים של ווידג'טים שבדף הזה.

השיטה הזו נקראת גם כשהמשתמש מוסיף את הווידג'ט, כדי לבצע את ההגדרות החיוניות, כמו הגדרת פונקציות טיפול באירועים עבור אובייקטים מסוג View או הפעלת משימות לטעינת נתונים להצגה בווידג'ט. עם זאת, אם מגדירים פעילות תצורה בלי הדגל configuration_optional, השיטה הזו לא נקראת כשהמשתמש מוסיף את הווידג'ט, אבל היא כן נקראת בעדכונים הבאים. אחרי שההגדרה תושלם, פעילות ההגדרה אחראית לבצע את העדכון הראשון. מידע נוסף זמין במאמר איך מאפשרים למשתמשים להגדיר ווידג'טים של אפליקציות.

הקריאה החוזרת החשובה ביותר היא onUpdate(). מידע נוסף זמין בקטע טיפול באירועים באמצעות הכיתה onUpdate() שבדף הזה.

onAppWidgetOptionsChanged()

הפונקציה הזו נקראת בפעם הראשונה שממקמים את הווידג'ט, ובכל פעם שמגדילים או מקטינים את הווידג'ט. אפשר להשתמש בקריאה החוזרת הזו כדי להציג או להסתיר תוכן על סמך טווחי הגדלים של הווידג'ט. כדי לקבל את טווחי הגדלים – ומ-Android 12 ואילך, את רשימת הגדלים האפשריים של מופע הווידג'ט – צריך להפעיל את getAppWidgetOptions(). הפונקציה מחזירה את הערך Bundle שכולל את הפרטים הבאים:

• OPTION_APPWIDGET_MIN_WIDTH: מכיל את הגבול התחתון של הרוחב, ביחידות dp, של מופע של ווידג'ט.
• OPTION_APPWIDGET_MIN_HEIGHT: מכיל את הגבול התחתון של הגובה, ביחידות dp, של מופע של ווידג'ט.
• OPTION_APPWIDGET_MAX_WIDTH: מכיל את הגבול העליון של הרוחב, ביחידות dp, של מופע של ווידג'ט.
• OPTION_APPWIDGET_MAX_HEIGHT: מכיל את הגבול העליון של הגובה, ביחידות dp, של מופע של ווידג'ט.
• OPTION_APPWIDGET_SIZES: מכיל את רשימת הגדלים האפשריים (List<SizeF>), ביחידות dp, שיכולים להיות למכונה של הווידג'ט. הופיעה לראשונה ב-Android 12.

onDeleted(Context, int[])

הפונקציה הזו נקראת בכל פעם שווידג'ט נמחק ממארח הווידג'טים.

onEnabled(Context)

השיטה הזו נקראת כשמכונה של הווידג'ט נוצרת בפעם הראשונה. לדוגמה, אם המשתמש מוסיף שני מופעים של הווידג'ט, הפונקציה הזו תופעל רק בפעם הראשונה. אם אתם צריכים לפתוח מסד נתונים חדש או לבצע הגדרה אחרת שצריך לבצע רק פעם אחת לכל המופעים של הווידג'ט, זה המקום המתאים לעשות זאת.

onDisabled(Context)

האירוע הזה נקרא כשהמכונה האחרונה של הווידג'ט נמחקת ממארח הווידג'טים. כאן מנקים את כל העבודה שבוצעה ב-onEnabled(Context), למשל מחיקת מסד נתונים זמני.

onReceive(Context, Intent)

השיטה הזו נקראת בכל שידור וקודם לכל אחת מהשיטות הקודמות של קריאה חוזרת. בדרך כלל אין צורך להטמיע את השיטה הזו, כי הטמעת ברירת המחדל של AppWidgetProvider מסננת את כל השידורים של הווידג'ט ומפעילה את השיטות הקודמות בהתאם.

צריך להצהיר על ההטמעה של הכיתה AppWidgetProvider כמקלט שידור באמצעות הרכיב <receiver> בקובץ AndroidManifest. מידע נוסף זמין בקטע הצהרה על ווידג'ט במניפסט בדף הזה.

טיפול באירועים באמצעות הכיתה onUpdate()‎

פונקציית ה-callback החשובה ביותר של AppWidgetProvider היא onUpdate(), כי היא נקראת כשכל ווידג'ט מתווסף למארח, אלא אם משתמשים בפעילות הגדרה ללא הדגל configuration_optional. אם הווידג'ט מקבל אירועי אינטראקציה של משתמשים, צריך לרשום את פונקציות הטיפול באירועים בקריאה החוזרת הזו. אם הווידג'ט לא יוצר קבצים זמניים או מסדי נתונים, או מבצע משימות אחרות שדורשות ניקוי, יכול להיות ש-onUpdate() היא שיטת ה-callback היחידה שצריך להגדיר.

לדוגמה, אם רוצים ליצור ווידג'ט עם לחצן שמפעיל פעילות כשלוחצים עליו, אפשר להשתמש בהטמעה הבאה של AppWidgetProvider:

class ExampleAppWidgetProvider : AppWidgetProvider() {

    override fun onUpdate(
            context: Context,
            appWidgetManager: AppWidgetManager,
            appWidgetIds: IntArray
    ) {
        // Perform this loop procedure for each widget that belongs to this
        // provider.
        appWidgetIds.forEach { appWidgetId ->
            // Create an Intent to launch ExampleActivity.
            val pendingIntent: PendingIntent = PendingIntent.getActivity(
                    /* context = */ context,
                    /* requestCode = */  0,
                    /* intent = */ Intent(context, ExampleActivity::class.java),
                    /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
            )

            // Get the layout for the widget and attach an onClick listener to
            // the button.
            val views: RemoteViews = RemoteViews(
                    context.packageName,
                    R.layout.appwidget_provider_layout
            ).apply {
                setOnClickPendingIntent(R.id.button, pendingIntent)
            }

            // Tell the AppWidgetManager to perform an update on the current
            // widget.
            appWidgetManager.updateAppWidget(appWidgetId, views)
        }
    }
}

public class ExampleAppWidgetProvider extends AppWidgetProvider {

    public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        // Perform this loop procedure for each widget that belongs to this
        // provider.
        for (int i=0; i < appWidgetIds.length; i++) {
            int appWidgetId = appWidgetIds[i];
            // Create an Intent to launch ExampleActivity
            Intent intent = new Intent(context, ExampleActivity.class);
            PendingIntent pendingIntent = PendingIntent.getActivity(
                /* context = */ context,
                /* requestCode = */ 0,
                /* intent = */ intent,
                /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE
            );

            // Get the layout for the widget and attach an onClick listener to
            // the button.
            RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.example_appwidget_layout);
            views.setOnClickPendingIntent(R.id.button, pendingIntent);

            // Tell the AppWidgetManager to perform an update on the current app
            // widget.
            appWidgetManager.updateAppWidget(appWidgetId, views);
        }
    }
}

AppWidgetProvider הזה מגדיר רק את השיטה onUpdate(), ומשתמש בה כדי ליצור PendingIntent שמפעיל Activity ומצרף אותו ללחצן של הווידג'ט באמצעות setOnClickPendingIntent(int, PendingIntent). הוא כולל לולאה שמריצה את כל הרשומות ב-appWidgetIds, שהוא מערך של מזהים שמזהים כל ווידג'ט שנוצר על ידי הספק הזה. אם המשתמש יוצר יותר ממופעים אחדים של הווידג'ט, כולם יעודכנו בו-זמנית. עם זאת, לכל המופעים של הווידג'ט מנוהל רק לוח זמנים אחד של updatePeriodMillis. לדוגמה, אם לוח הזמנים של העדכונים מוגדר לכל שעתיים, ומודעה שנייה של הווידג'ט נוספת שעה אחרי הראשונה, שתיהן יעודכנו במסגרת התקופה שהוגדרה למודעה הראשונה, ותקופת העדכון השנייה תתעלם. שניהם מתעדכנים כל שעתיים, ולא כל שעה.

פרטים נוספים זמינים בכיתה לדוגמה ExampleAppWidgetProvider.java.

קבלת כוונות שידור של ווידג'טים

AppWidgetProvider היא מחלקת נוחות. אם אתם רוצים לקבל את השידור של הווידג'ט ישירות, תוכלו להטמיע BroadcastReceiver משלכם או לשנות את הפונקציה הלא חוזרת onReceive(Context,Intent). אלה כוונות החיפוש שחשוב להכיר:

• ACTION_APPWIDGET_UPDATE
• ACTION_APPWIDGET_DELETED
• ACTION_APPWIDGET_ENABLED
• ACTION_APPWIDGET_DISABLED
• ACTION_APPWIDGET_OPTIONS_CHANGED

יצירת הפריסה של הווידג'ט

צריך להגדיר פריסה ראשונית של הווידג'ט ב-XML ולשמור אותה בספרייה res/layout/ של הפרויקט. פרטים נוספים זמינים בהנחיות לעיצוב.

אם אתם מכירים פריסות, קל ליצור את הפריסה של הווידג'ט. עם זאת, חשוב לזכור שהפריסות של הווידג'טים מבוססות על RemoteViews, שלא תומך בכל סוגי הפריסות או תצוגות הווידג'טים. אי אפשר להשתמש בתצוגות בהתאמה אישית או בתת-כיתות של התצוגות שנתמכות על ידי RemoteViews.

RemoteViews תומך גם ב-ViewStub, שהוא View בלתי נראה בגודל אפס שאפשר להשתמש בו כדי לנפח בזמנם משאבים של פריסה בזמן הריצה.

תמיכה בהתנהגות עם מצב

ב-Android 12 נוספה תמיכה בהתנהגות עם מצב באמצעות הרכיבים הקיימים הבאים:

• CheckBox

• Switch

• RadioButton

הווידג'ט עדיין ללא מצב. האפליקציה צריכה לאחסן את המצב ולהירשם לאירועים של שינוי מצב.

בדוגמת הקוד הבאה מוסבר איך מטמיעים את הרכיבים האלה.

// Check the view.
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true)

// Check a radio group.
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2)

// Listen for check changes. The intent has an extra with the key
// EXTRA_CHECKED that specifies the current checked state of the view.
remoteView.setOnCheckedChangeResponse(
        R.id.my_checkbox,
        RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent)
)

// Check the view.
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true);

// Check a radio group.
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2);

// Listen for check changes. The intent has an extra with the key
// EXTRA_CHECKED that specifies the current checked state of the view.
remoteView.setOnCheckedChangeResponse(
    R.id.my_checkbox,
    RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent));

יש לספק שני פריסות: אחת שמטרגטת מכשירים עם Android מגרסה 12 ואילך ב-res/layout-v31, והשנייה שמטרגטת מכשירים עם Android מגרסה 11 ומטה בתיקיית ברירת המחדל res/layout.

הטמעת פינות מעוגלות

ב-Android 12 נוספו הפרמטרים הבאים למערכת כדי להגדיר את הרדיוס של הפינות המעוגלות של הווידג'ט:

• system_app_widget_background_radius: רדיוס הפינה של הרקע של הווידג'ט, שלא יכול להיות גדול מ-28dp.

• system_app_widget_inner_radius: רדיוס הפינה של כל תצוגה בתוך הווידג'ט. הערך הזה קטן ב-8dp בדיוק מרדיוס הרקע, כדי שהתמונה תתאים כשמשתמשים ב-8dp של ריווח.

בדוגמה הבאה מוצג ווידג'ט שמשתמש ב-system_app_widget_background_radius בפינה של הווידג'ט וב-system_app_widget_inner_radius בתצוגות בתוך הווידג'ט.

1 פינה של הווידג'ט.

2 פינה של תצוגה בתוך הווידג'ט.

שיקולים חשובים לגבי פינות מעוגלות

• יצרני מכשירים ומרכזי אפליקציות של צד שלישי יכולים לשנות את הפרמטר system_app_widget_background_radius כך שיהיה קטן מ-28dp. הפרמטר system_app_widget_inner_radius תמיד קטן ב-8dp מהערך של system_app_widget_background_radius.
• אם בווידג'ט לא נעשה שימוש ב-@android:id/background או לא מוגדר לו רקע שמחתוך את התוכן שלו על סמך המתאר – כשהערך של android:clipToOutline מוגדר כ-true – מרכז האפליקציות מזהה את הרקע באופן אוטומטי וחותוך את הווידג'ט באמצעות מלבן עם פינות מעוגלות בגודל של עד 16dp. איך מוודאים שהווידג'ט תואם ל-Android 12

כדי שהווידג'ט יתאים לגרסאות קודמות של Android, מומלץ להגדיר מאפיינים מותאמים אישית ולהשתמש בנושא מותאם אישית כדי לשנות אותם ב-Android 12, כפי שמוצג בקובצי ה-XML לדוגמה הבאים:

<resources>
  <attr name="backgroundRadius" format="dimension" />
</resources>

<resources>
  <style name="MyWidgetTheme">
    <item name="backgroundRadius">@dimen/my_background_radius_dimen</item>
  </style>
</resources>

<resources>
  <style name="MyWidgetTheme" parent="@android:style/Theme.DeviceDefault.DayNight">
    <item name="backgroundRadius">@android:dimen/system_app_widget_background_radius</item>
  </style>
</resources>

<shape xmlns:android="http://schemas.android.com/apk/res/android"
  android:shape="rectangle">
  <corners android:radius="?attr/backgroundRadius" />
  ...
</shape>

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
  ...
  android:background="@drawable/my_widget_background" />