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

ווידג'טים של אפליקציות הם תצוגות מוקטנות של אפליקציות שאפשר להטמיע באפליקציות אחרות – כמו מסך הבית – ולקבל עדכונים תקופתיים. התצוגות האלה נקראות ווידג'טים בממשק המשתמש, ואפשר לפרסם אחת מהן באמצעות ספק ווידג'טים של אפליקציה (או ספק ווידג'טים). רכיב אפליקציה שמכיל ווידג'טים אחרים נקרא מארח ווידג'טים של אפליקציה (או מארח ווידג'טים). באיור 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()

הפונקציה הזו נקראת בפעם הראשונה שממקמים את הווידג'ט, ובכל פעם שמגדילים או מקטינים את הווידג'ט. אפשר להשתמש בקריאה החוזרת (callback) הזו כדי להציג או להסתיר תוכן בהתאם לטווחי הגודל של הווידג'ט. כדי לקבל את טווחי הגדלים – ומ-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()‎

הקריאה החוזרת החשובה ביותר של 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 מגדיר רק את ה-method 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" />