Créer un widget simple

Les widgets d'application sont des vues d'application miniatures que vous pouvez intégrer à d'autres applications (comme l'écran d'accueil) et recevoir des mises à jour périodiques. Ces vues sont appelées widgets dans l'interface utilisateur. Vous pouvez en publier une avec un fournisseur de widgets d'application (ou fournisseur de widgets). Un composant d'application qui contient d'autres widgets est appelé hôte de widget d'application (ou hôte de widget). La figure 1 montre un exemple de widget de musique:

Ce document explique comment publier un widget à l'aide d'un fournisseur de widgets. Pour en savoir plus sur la création de votre propre AppWidgetHost pour héberger des widgets d'application, consultez Créer un hôte de widget.

Pour savoir comment concevoir votre widget, consultez la section Présentation des widgets d'application.

Composants du widget

Pour créer un widget, vous avez besoin des composants de base suivants:

Objet AppWidgetProviderInfo

Décrit les métadonnées d'un widget, telles que la mise en page, la fréquence de mise à jour et la classe AppWidgetProvider du widget. AppWidgetProviderInfo est défini en XML, comme décrit dans ce document.

Classe AppWidgetProvider

Définit les méthodes de base qui vous permettent d'interagir de manière programmatique avec le widget. Vous recevez ainsi des diffusions lorsque le widget est mis à jour, activé, désactivé ou supprimé. Vous déclarez AppWidgetProvider dans le fichier manifeste, puis vous l'implémentez, comme décrit dans ce document.

Afficher la mise en page

Définit la mise en page initiale du widget. La mise en page est définie en XML, comme décrit dans ce document.

La figure 2 montre comment ces composants s'intègrent au flux de traitement global des widgets d'application.

Si votre widget nécessite une configuration utilisateur, implémentez l'activité de configuration du widget d'application. Cette activité permet aux utilisateurs de modifier les paramètres des widgets, par exemple le fuseau horaire d'un widget d'horloge.

• À partir d'Android 12 (niveau d'API 31), vous pouvez fournir une configuration par défaut et permettre aux utilisateurs de reconfigurer le widget ultérieurement. Pour en savoir plus, consultez les pages Utiliser la configuration par défaut du widget et Permettre aux utilisateurs de reconfigurer les widgets placés.
• Sous Android 11 (niveau d'API 30) ou version antérieure, cette activité est lancée chaque fois que l'utilisateur ajoute le widget à son écran d'accueil.

Nous vous recommandons également d'utiliser les améliorations suivantes: mises en page flexibles des widgets, améliorations diverses, widgets avancés, widgets de collection et création d'un hôte de widgets.

Déclarer le fichier XML AppWidgetProviderInfo

L'objet AppWidgetProviderInfo définit les qualités essentielles d'un widget. Définissez l'objet AppWidgetProviderInfo dans un fichier de ressources XML à l'aide d'un seul élément <appwidget-provider>, puis enregistrez-le dans le dossier res/xml/ du projet.

Ce processus est illustré dans l'exemple suivant :

<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>

Attributs de dimensionnement des widgets

L'écran d'accueil par défaut positionne les widgets dans sa fenêtre en fonction d'une grille de cellules dont la hauteur et la largeur sont définies. La plupart des écrans d'accueil ne permettent aux widgets de prendre que des tailles multiples entières des cellules de la grille (par exemple, deux cellules horizontalement sur trois cellules verticalement).

Les attributs de dimensionnement des widgets vous permettent de spécifier une taille par défaut pour votre widget et de définir des limites inférieure et supérieure à sa taille. Dans ce contexte, la taille par défaut d'un widget est celle qu'il prend lorsqu'il est ajouté pour la première fois à l'écran d'accueil.

Le tableau suivant décrit les attributs <appwidget-provider> liés à la mise à l'échelle des widgets:

Exemple

Pour illustrer l'impact des attributs du tableau précédent sur la taille des widgets, supposons les spécifications suivantes:

• Une cellule de grille mesure 30 dp de large et 50 dp de haut.
• La spécification d'attribut suivante est fournie:

<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" />

À partir d'Android 12:

Utilisez les attributs targetCellWidth et targetCellHeight comme taille par défaut du widget.

La taille du widget est de 2 x 2 par défaut. Vous pouvez redimensionner le widget jusqu'à 2x1 ou jusqu'à 4x3.

Android 11 et versions antérieures:

Utilisez les attributs minWidth et minHeight pour calculer la taille par défaut du widget.

Largeur par défaut = Math.ceil(80 / 30) = 3

Hauteur par défaut = Math.ceil(80 / 50) = 2

La taille du widget est de 3 x 2 par défaut. Le widget peut être redimensionné jusqu'à 2 x 1 ou en plein écran.

Attributs de widget supplémentaires

Le tableau suivant décrit les attributs <appwidget-provider> concernant d'autres qualités que la taille des widgets.

Utiliser la classe AppWidgetProvider pour gérer les diffusions de widgets

La classe AppWidgetProvider gère les diffusions de widgets et met à jour le widget en réponse aux événements de cycle de vie du widget. Les sections suivantes expliquent comment déclarer AppWidgetProvider dans le fichier manifeste, puis l'implémenter.

Déclarer un widget dans le fichier manifeste

Tout d'abord, déclarez la classe AppWidgetProvider dans le fichier AndroidManifest.xml de votre application, comme indiqué dans l'exemple suivant:

<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>

L'élément <receiver> nécessite l'attribut android:name, qui spécifie le AppWidgetProvider utilisé par le widget. Le composant ne doit pas être exporté, sauf si un processus distinct doit diffuser des données sur votre AppWidgetProvider, ce qui n'est généralement pas le cas.

L'élément <intent-filter> doit inclure un élément <action> avec l'attribut android:name. Cet attribut spécifie que AppWidgetProvider accepte la diffusion ACTION_APPWIDGET_UPDATE. Il s'agit de la seule diffusion que vous devez déclarer explicitement. AppWidgetManager envoie automatiquement toutes les autres diffusions de widgets au AppWidgetProvider si nécessaire.

L'élément <meta-data> spécifie la ressource AppWidgetProviderInfo et nécessite les attributs suivants:

• android:name: spécifie le nom des métadonnées. Utilisez android.appwidget.provider pour identifier les données en tant que descripteur AppWidgetProviderInfo.
• android:resource: spécifie l'emplacement de la ressource AppWidgetProviderInfo.

Implémenter la classe AppWidgetProvider

La classe AppWidgetProvider étend BroadcastReceiver en tant que classe pratique pour gérer les diffusions de widgets. Il ne reçoit que les diffusions d'événements pertinentes pour le widget, par exemple lorsqu'il est mis à jour, supprimé, activé ou désactivé. Lorsque ces événements de diffusion se produisent, les méthodes AppWidgetProvider suivantes sont appelées:

onUpdate()

Cette méthode est appelée pour mettre à jour le widget à des intervalles définis par l'attribut updatePeriodMillis dans AppWidgetProviderInfo. Pour en savoir plus, consultez le tableau décrivant les attributs de widget supplémentaires sur cette page.

Cette méthode est également appelée lorsque l'utilisateur ajoute le widget. Elle effectue donc la configuration essentielle, comme la définition de gestionnaires d'événements pour les objets View ou le démarrage de tâches pour charger les données à afficher dans le widget. Toutefois, si vous déclarez une activité de configuration sans l'indicateur configuration_optional, cette méthode n'est pas appelée lorsque l'utilisateur ajoute le widget, mais elle est appelée pour les mises à jour ultérieures. L'activité de configuration est chargée d'effectuer la première mise à jour une fois la configuration terminée. Pour en savoir plus, consultez Permettre aux utilisateurs de configurer les widgets d'application.

Le rappel le plus important est onUpdate(). Pour en savoir plus, consultez la section Gérer les événements avec la classe onUpdate() de cette page.

onAppWidgetOptionsChanged()

Cette méthode est appelée lorsque le widget est placé pour la première fois et chaque fois qu'il est redimensionné. Utilisez ce rappel pour afficher ou masquer le contenu en fonction des plages de taille du widget. Obtenez les plages de tailles (et, à partir d'Android 12, la liste des tailles possibles d'une instance de widget) en appelant getAppWidgetOptions(), qui renvoie un Bundle qui inclut les éléments suivants:

• OPTION_APPWIDGET_MIN_WIDTH : contient la limite inférieure de la largeur, en unités dp, d'une instance de widget.
• OPTION_APPWIDGET_MIN_HEIGHT : contient la limite inférieure de la hauteur, en unités dp, d'une instance de widget.
• OPTION_APPWIDGET_MAX_WIDTH : contient la limite supérieure de la largeur, en unités dp, d'une instance de widget.
• OPTION_APPWIDGET_MAX_HEIGHT : contient la limite supérieure de la hauteur, en unités dp, d'une instance de widget.
• OPTION_APPWIDGET_SIZES : contient la liste des tailles possibles (List<SizeF>), en unités dp, qu'une instance de widget peut prendre. Introduit dans Android 12.

onDeleted(Context, int[])

Cette méthode est appelée chaque fois qu'un widget est supprimé de l'hôte de widget.

onEnabled(Context)

Cette méthode est appelée lorsqu'une instance du widget est créée pour la première fois. Par exemple, si l'utilisateur ajoute deux instances de votre widget, il n'est appelé que la première fois. Si vous devez ouvrir une nouvelle base de données ou effectuer une autre configuration qui ne doit avoir lieu qu'une seule fois pour toutes les instances de widget, c'est un bon endroit pour le faire.

onDisabled(Context)

Cette méthode est appelée lorsque la dernière instance de votre widget est supprimée de l'hôte de widget. C'est ici que vous nettoyez tout travail effectué dans onEnabled(Context), comme la suppression d'une base de données temporaire.

onReceive(Context, Intent)

Cette méthode est appelée pour chaque diffusion et avant chacune des méthodes de rappel précédentes. Vous n'avez généralement pas besoin d'implémenter cette méthode, car l'implémentation par défaut de AppWidgetProvider filtre toutes les diffusions de widgets et appelle les méthodes précédentes selon les besoins.

Vous devez déclarer l'implémentation de votre classe AppWidgetProvider en tant que broadcast receiver à l'aide de l'élément <receiver> dans le AndroidManifest. Pour en savoir plus, consultez la section Déclarer un widget dans le fichier manifeste de cette page.

Gérer les événements avec la classe onUpdate()

Le rappel AppWidgetProvider le plus important est onUpdate(), car il est appelé lorsque chaque widget est ajouté à un hôte, sauf si vous utilisez une activité de configuration sans l'indicateur configuration_optional. Si votre widget accepte des événements d'interaction utilisateur, enregistrez les gestionnaires d'événements dans ce rappel. Si votre widget ne crée pas de fichiers ou de bases de données temporaires, ni n'effectue d'autres tâches nécessitant un nettoyage, onUpdate() peut être la seule méthode de rappel que vous devez définir.

Par exemple, si vous souhaitez un widget avec un bouton qui lance une activité lorsqu'il est enfoncé, vous pouvez utiliser l'implémentation suivante de 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);
        }
    }
}

Ce AppWidgetProvider ne définit que la méthode onUpdate(), qui permet de créer un PendingIntent qui lance un Activity et l'associe au bouton du widget à l'aide de setOnClickPendingIntent(int, PendingIntent). Il inclut une boucle qui itère chaque entrée dans appWidgetIds, qui est un tableau d'ID qui identifie chaque widget créé par ce fournisseur. Si l'utilisateur crée plusieurs instances du widget, elles sont toutes mises à jour simultanément. Toutefois, une seule planification updatePeriodMillis est gérée pour toutes les instances du widget. Par exemple, si la planification des mises à jour est définie toutes les deux heures et qu'une deuxième instance du widget est ajoutée une heure après la première, elles sont toutes les deux mises à jour sur la période définie par la première, et la deuxième période de mise à jour est ignorée. Ils sont tous les deux mis à jour toutes les deux heures, et non toutes les heures.

Pour en savoir plus, consultez l'exemple de classe ExampleAppWidgetProvider.java.

Recevoir des intents de diffusion de widget

AppWidgetProvider est une classe pratique. Si vous souhaitez recevoir directement les diffusions du widget, vous pouvez implémenter votre propre BroadcastReceiver ou remplacer le rappel onReceive(Context,Intent). Les intents dont vous devez tenir compte sont les suivants:

• ACTION_APPWIDGET_UPDATE
• ACTION_APPWIDGET_DELETED
• ACTION_APPWIDGET_ENABLED
• ACTION_APPWIDGET_DISABLED
• ACTION_APPWIDGET_OPTIONS_CHANGED

Créer la mise en page du widget

Vous devez définir une mise en page initiale pour votre widget au format XML et l'enregistrer dans le répertoire res/layout/ du projet. Pour en savoir plus, consultez les Consignes de conception.

La création de la mise en page du widget est simple si vous connaissez les mises en page. Toutefois, sachez que les mises en page de widgets sont basées sur RemoteViews, qui n'est pas compatible avec tous les types de mise en page ou de widget de vue. Vous ne pouvez pas utiliser de vues personnalisées ni de sous-classes des vues compatibles avec RemoteViews.

RemoteViews est également compatible avec ViewStub, qui est une View invisible de taille nulle que vous pouvez utiliser pour gonfler, de manière différée, des ressources de mise en page lors de l'exécution.

Prise en charge du comportement avec état

Android 12 prend en charge le comportement avec état à l'aide des composants existants suivants:

• CheckBox

• Switch

• RadioButton

Le widget est toujours sans état. Votre application doit stocker l'état et s'inscrire pour les événements de changement d'état.

L'exemple de code suivant montre comment implémenter ces composants.

// 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));

Fournissez deux mises en page: l'une ciblant les appareils équipés d'Android 12 ou version ultérieure dans res/layout-v31, et l'autre ciblant les versions précédentes d'Android 11 ou version antérieure dans le dossier res/layout par défaut.

Implémenter des coins arrondis

Android 12 introduit les paramètres système suivants pour définir les rayons des coins arrondis de votre widget:

• system_app_widget_background_radius : rayon des coins de l'arrière-plan du widget, qui ne dépasse jamais 28 dp.

• system_app_widget_inner_radius : rayon des coins de n'importe quelle vue dans le widget. Il s'agit exactement de 8 dp de moins que le rayon de l'arrière-plan, pour s'aligner correctement lorsque vous utilisez une marge de 8 dp.

L'exemple suivant montre un widget qui utilise system_app_widget_background_radius pour le coin du widget et system_app_widget_inner_radius pour les vues dans le widget.

1 Coin du widget.

2 Coin d'une vue dans le widget.

Remarques importantes concernant les coins arrondis

• Les lanceurs tiers et les fabricants d'appareils peuvent remplacer le paramètre system_app_widget_background_radius pour qu'il soit inférieur à 28 dp. Le paramètre system_app_widget_inner_radius est toujours inférieur de 8 dp à la valeur de system_app_widget_background_radius.
• Si votre widget n'utilise pas @android:id/background ou ne définit pas d'arrière-plan qui découpe son contenu en fonction du contour (avec android:clipToOutline défini sur true), le lanceur identifie automatiquement l'arrière-plan et découpe le widget à l'aide d'un rectangle aux coins arrondis d'une taille maximale de 16 dp. Consultez Assurer la compatibilité de votre widget avec Android 12.

Pour assurer la compatibilité des widgets avec les versions précédentes d'Android, nous vous recommandons de définir des attributs personnalisés et d'utiliser un thème personnalisé pour les remplacer sur Android 12, comme illustré dans les exemples de fichiers XML suivants:

<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" />