Cette page a été traduite par l'API Cloud Translation.

Architecture de l’information

Android 8.0 a introduit une nouvelle architecture de l'information pour l'application Paramètres afin de simplifier l'organisation des paramètres et permettre aux utilisateurs trouver rapidement les paramètres pour personnaliser leurs appareils Android. Android 9 a introduit quelques améliorations afin de fournir plus Fonctionnalité de paramètres et implémentation simplifiée.

Exemples et source

Actuellement, la plupart des pages des paramètres sont implémentées à l'aide du nouveau framework. Un bon par exemple DisplaySettings, packages/apps/Settings/src/com/android/settings/DisplaySettings.java

Les chemins d'accès aux fichiers des composants importants sont indiqués ci-dessous:

CategoryKey: packages/SettingsLib/src/com/android/settingslib/drawer/CategoryKey.java
DashboardFragmentRegistry : packages/apps/Settings/src/com/android/settings/dashboard/DashboardFragmentRegistry.java
DashboardFragment: packages/apps/Settings/src/com/android/settings/dashboard/DashboardFragment.java
AbstractPreferenceController : frameworks/base/packages/SettingsLib/src/com/android/settingslib/core/AbstractPreferenceController.java
BasePreferenceController (introduit dans Android 9): packages/apps/Settings/src/com/android/settings/core/BasePreferenceController.java

Implémentation

Les fabricants d'appareils sont invités à adapter l'architecture des informations de paramètres existante et à insérer des pages de paramètres supplémentaires si nécessaire pour prendre en charge les fonctionnalités propres aux partenaires. Le transfert des préférences d'une ancienne page (implémentée en tant que SettingsPreferencePage) vers une nouvelle page (implémentée à l'aide de DashboardFragment) peut s'avérer complexe. La préférence de l'ancienne page n'est probablement pas implémentée avec un PreferenceController.

Par conséquent, lorsque vous déplacez des préférences d'une ancienne page vers une nouvelle page, vous devez créer un PreferenceController et déplacer le code dans le contrôleur avant de l'instancier dans le nouveau DashboardFragment. Les API requises par PreferenceController sont décrites dans leur nom et documentées dans Javadoc.

Nous vous recommandons vivement d'ajouter un test unitaire pour chaque PreferenceController. Si la modification est envoyée à AOSP, un test unitaire est requis. Pour en savoir plus sur l'écriture de tests basés sur Robolectric, consultez le fichier de documentation packages/apps/Settings/tests/robotests/README.md.

Architecture de l'information de type plug-in

Chaque élément de paramètres est implémenté en tant que préférence. Une préférence peut facilement être déplacées d'une page à une autre.

Pour faciliter le déplacement de plusieurs paramètres, Android 8.0 a introduit un fragment d'hôte de type plug-in contenant des éléments de paramètres. Les éléments de paramètres sont modélisés en tant que contrôleurs de type plug-in. Par conséquent, une page de paramètres est construite à partir d'un seul fragment d'hôte et de plusieurs contrôleurs de paramètres.

DashboardFragment

DashboardFragment est l'hôte des contrôleurs de préférences de type plug-in. Le fragment hérite de PreferenceFragment et dispose de crochets pour développer et mettre à jour à la fois les listes de préférences statiques et les listes de préférences dynamiques.

Préférences statiques

Une liste de préférences statique est définie au format XML à l'aide de la balise <Preference>. A L'implémentation de DashboardFragment utilise le getPreferenceScreenResId() pour définir quel fichier XML contient la liste statique de préférences à afficher.

Préférences dynamiques

Un élément dynamique représente une carte avec intention, ce qui conduit à une communication externe ou interne Activité. En règle générale, l'intent mène à une autre page de paramètres. Par exemple, l'élément de paramètre "Google" de la page d'accueil des paramètres est un élément dynamique. Les éléments dynamiques sont définis dans AndroidManifest (décrit ci-dessous) et chargés via un FeatureProvider (défini comme DashboardFeatureProvider).

Les paramètres dynamiques sont plus lourds que les paramètres configurés de manière statique. Par conséquent, les développeurs doivent normalement implémenter le paramètre en tant que paramètre statique. Toutefois, le paramètre dynamique peut être utile dans les cas suivants :

Le paramètre n'est pas implémenté directement dans l'application Paramètres (par exemple, en injectant un paramètre implémenté par les applications OEM/opérateur).
Le paramètre devrait apparaître sur la page d'accueil des paramètres.
Vous disposez déjà d'une activité pour le paramètre et vous ne souhaitez pas implémenter la configuration statique supplémentaire.

Pour configurer une activité en tant que paramètre dynamique, procédez comme suit :

Marquez l'activité comme paramètre dynamique en ajoutant un filtre d'intent à l'activité.
Indiquez à l'application Paramètres à quelle catégorie elle appartient. La catégorie est une constante, définie dans CategoryKey.
Facultatif: Ajoutez un texte récapitulatif lorsque le paramètre est affiché.

Voici un exemple issu de l'application Paramètres pour DisplaySettings.

<activity android:name="Settings$DisplaySettingsActivity"
                   android:label="@string/display_settings"
                   android:icon="@drawable/ic_settings_display">
             <!-- Mark the activity as a dynamic setting -->
              <intent-filter>
                     <action android:name="com.android.settings.action.IA_SETTINGS" />
              </intent-filter>
             <!-- Tell Settings app which category it belongs to -->
              <meta-data android:name="com.android.settings.category"
                     android:value="com.android.settings.category.ia.homepage" />
             <!-- Add a summary text when the setting is displayed -->
              <meta-data android:name="com.android.settings.summary"
                     android:resource="@string/display_dashboard_summary"/>
             </activity>

Au moment du rendu, le fragment demande une liste de préférences à partir des fichiers XML statiques et des paramètres dynamiques définis dans AndroidManifest. Que les PreferenceController soient définis en code Java ou en XML, DashboardFragment gère la logique de gestion de chaque paramètre via PreferenceController (voir ci-dessous). Ils sont ensuite affichés dans l'UI sous la forme d'une liste mixte.

PreferenceController

Il existe des différences entre l'implémentation de PreferenceController sous Android 9 et Android 8.x, comme décrit dans cette .

PreferenceController dans la version Android 9

Un PreferenceController contient toute la logique permettant d'interagir avec la préférence, y compris l'affichage, la mise à jour, l'indexation de recherche, etc.

L'interface de PreferenceController est définie comme BasePreferenceController. Par exemple, reportez-vous au code packages/apps/Settings/src/com/android/settings/core/ BasePreferenceController.java

Il existe plusieurs sous-classes de BasePreferenceController, chacune mappé à un style d'interface utilisateur spécifique pris en charge par défaut par l'application Paramètres. Pour Par exemple, TogglePreferenceController dispose d'une API qui mappe directement à la façon dont l'utilisateur doit interagir avec une UI de préférence basée sur le bouton d'activation.

BasePreferenceController dispose d'API telles que getAvailabilityStatus(), displayPreference(), handlePreferenceTreeClicked(),, etc. La documentation détaillée de chaque API se trouve dans la classe d'interface.

Une restriction sur l'implémentation de BasePreferenceController (et ses sous-classes telles que TogglePreferenceController) est que la signature du constructeur doit correspondre à l'un des éléments suivants:

public MyController(Context context, String key) {}
public MyController(Context context) {}

Lors de l'installation d'une préférence dans le fragment, le tableau de bord fournit une méthode permettant d'associer un PreferenceController avant l'heure d'affichage. Au moment de l'installation, le contrôleur est câblé au fragment afin que tous les événements pertinents futurs soient envoyés au contrôleur.

DashboardFragment conserve une liste de PreferenceController sur l'écran. Au niveau du fragment onCreate(), tous les contrôleurs sont appelés getAvailabilityStatus(). Si elle renvoie la valeur "true", displayPreference() est appelé pour traiter la logique d'affichage. getAvailabilityStatus() est également important pour indiquer aux paramètres déterminer quels éléments sont disponibles lors de la recherche.

PreferenceController dans les versions Android 8.x

Un PreferenceController contient toute la logique permettant d'interagir avec la préférence, y compris l'affichage, la mise à jour, l'indexation de recherche, etc.

En fonction des interactions de préférences, l'interface de PreferenceController contient les API isAvailable(), displayPreference(), handlePreferenceTreeClicked(), etc. Vous trouverez une documentation détaillée sur chaque API dans la classe d'interface.

Lors de l'installation d'une préférence pour le fragment, le tableau de bord fournit une méthode pour associer un PreferenceController avant l'heure d'affichage. Au moment de l'installation, le contrôleur est câblé au fragment afin que tous les événements pertinents futurs soient envoyés au contrôleur.

DashboardFragment conserve une liste de PreferenceControllers à l'écran. Au niveau de l'élément onCreate() du fragment, contrôleurs sont appelés pour la méthode isAvailable(), et si elle renvoie "true", displayPreference() est appelé pour traiter l'affichage logique.

Utiliser DashboardFragment

Déplacer une préférence de la page A vers la page B

Si la préférence est répertoriée de manière statique dans le fichier XML des préférences de la page d'origine suivez la procédure de déplacement statique pour votre version ci-dessous. Sinon, suivez la procédure de déplacement dynamique. pour votre version d'Android.

Déplacement statique sous Android 9

Recherchez les fichiers XML de préférences pour la page d'origine et la page de destination. Vous trouverez ces informations dans la méthode getPreferenceScreenResId() de la page.
Supprimez la préférence du fichier XML de la page d'origine.
Ajoutez la préférence au fichier XML de la page de destination.
Supprimez le PreferenceController de cette préférence l'implémentation Java de sa page d'origine. Généralement, c'est dans createPreferenceControllers() Le contrôleur peut être déclaré directement en XML.
Remarque: Il est possible que la préférence ne comporte pas PreferenceController
Instanciez PreferenceController dans le composant createPreferenceControllers() Si le PreferenceController étant défini en XML dans l'ancienne page, définissez-le en XML pour la nouvelle page.

Déplacement dynamique sous Android 9

Identifiez la catégorie hébergée par la page d'origine et la page de destination. Vous pouvez vous trouverez ces informations dans DashboardFragmentRegistry.
Ouvrez le fichier AndroidManifest.xml contenant le paramètre que vous devez déplacer, puis recherchez l'entrée "Activity" (Activité) qui le représente.
Définissez la valeur des métadonnées de l'activité pour com.android.settings.category à la clé de catégorie de la nouvelle page.

Déplacement statique dans les versions d'Android 8.x

Recherchez les fichiers XML de préférences pour la page d'origine et la page de destination.

getPreferenceScreenResId()

Supprimez la préférence dans le fichier XML de la page d'origine.
Ajoutez la préférence au fichier XML de la page de destination.
Supprimez le PreferenceController de cette préférence dans l'implémentation Java de sa page d'origine. Il se trouve généralement dans getPreferenceControllers().

Remarque:Il est possible que la préférence n'ait pas de PreferenceController

Instanciez PreferenceController dans le composant getPreferenceControllers()

Déplacement dynamique dans les versions Android 8.x

Identifiez la catégorie hébergée par la page d'origine et la page de destination. Vous trouverez ces informations dans DashboardFragmentRegistry.
Ouvrez le fichier AndroidManifest.xml contenant le paramètre que vous il vous suffit de vous déplacer et de trouver l'entrée "Activity" (Activité) qui représente ce paramètre.
Modifiez la valeur des métadonnées de l'activité pour com.android.settings.category. définissez le point de valeur sur la clé de catégorie de la nouvelle page.

Créer une préférence dans une page

Si la préférence est listée de manière statique dans le fichier XML de préférences de la page d'origine, suivez la procédure statique ci-dessous. Sinon, suivez la procédure dynamique.

Créer une préférence statique

Recherchez les fichiers XML de préférences pour la page. Vous trouverez ces informations de la méthode getPreferenceScreenResId() de la page.
Ajoutez un élément "Preference" (Préférence) dans le fichier XML. Assurez-vous qu'il possède un android:key unique.
Définissez un PreferenceController pour cette préférence dans les getPreferenceControllers().
- Dans Android 8.x et éventuellement dans Android 9, instanciez un PreferenceController pour cette préférence dans la méthode createPreferenceControllers() de la page.
  Si cette préférence existait déjà à d'autres endroits, il est possible que est déjà un PreferenceController. Vous pouvez réutiliser PreferenceController sans en créer d'autre.
- À partir d'Android 9, vous pouvez choisir de déclarer PreferenceController en XML à côté de la préférence. Exemple :
```
<Preference
        android:key="reset_dashboard"
        android:title="@string/reset_dashboard_title"
        settings:controller="com.android.settings.system.ResetPreferenceController"/>
```

Créer une préférence dynamique

Identifiez la catégorie qui héberge la page d'origine et la page de destination. Vous trouverez ces informations dans DashboardFragmentRegistry.
Créer une activité dans AndroidManifest
Ajoutez les métadonnées nécessaires à la nouvelle activité pour définir le paramètre. Définissez le paramètre valeur de métadonnées de com.android.settings.category sur la même valeur définies à l'étape 1.

Créer une page

Créez un fragment héritant de DashboardFragment.
Définissez sa catégorie dans DashboardFragmentRegistry.
Remarque:Cette étape est facultative. Si vous n'avez pas besoin de préférences dynamiques sur cette page, vous n'avez pas besoin de fournir de clé de catégorie.
Suivez les étapes pour ajouter les paramètres requis pour cette page. Pour en savoir plus, consultez la section Implémentation.

Validation

Exécutez les tests Robolectric dans "Paramètres". Tous les tests existants et nouveaux doivent réussir.
Créez et installez les paramètres, puis ouvrez manuellement la page en cours de modification. La page devrait se mettre à jour immédiatement.