Sous-titres des préférences

Dans la plupart des cas, l'ajout de résumés des préférences est relativement simple, car il consiste simplement à ajouter l'attribut android:summary à la préférence correspondante avec la ressource de chaîne appropriée. Toutefois, si les sous-titres doivent se mettre à jour de façon dynamique un contrôleur de préférences personnalisées peut s'avérer nécessaire.

Sous-titres statiques

Pour ajouter un sous-titre statique à une préférence:

1. Ajoutez l'attribut android:summary à la préférence. Par exemple, pour ajouter un à la préférence de paramètres d'affichage L0, ajoutez un élément semblable à celui-ci attributs de préférence:

   android:summary="@string/display_settings_summary"
   

   Prenons l'exemple complet de code de préférence suivant:

   <Preference
           android:fragment="com.android.car.settings.display.DisplaySettingsFragment"
           android:icon="@drawable/ic_settings_display"
           android:key="@string/pk_display_settings_entry"
           android:title="@string/display_settings"
           android:summary="@string/display_settings_summary"
           settings:controller="com.android.car.settings.common.DefaultRestrictionsPreferenceController"/>
   

Sous-titres dynamiques

Les sous-titres spécifiés avec l'attribut android:summary sont statiques et ne peuvent donc pas se mettent à jour en fonction de certaines conditions. Pour les sous-titres dynamiques, vous devez modifier la préférence le contrôleur de préférence. L'exemple suivant modifie la préférence de localisation L0 en comporter un sous-titre spécifiant si la localisation est activée ou désactivée et, si elle est activée, indiquer le nombre d'applications ont actuellement accès à leur position.

1. Définissez les nouvelles chaînes:

   <!-- Summary for Location settings when location is off [CHAR LIMIT=NONE] -->
       <string name="location_settings_summary_location_off">Off</string>
       <!-- Summary for Location settings when location is on, explaining how many apps have location permission [CHAR LIMIT=NONE]-->
       <plurals name="location_settings_summary_location_on">
           <item quantity="one">On - <xliff:g id="count">%1$d</xliff:g> app has access to location</item>
           <item quantity="other">On - <xliff:g id="count">%1$d</xliff:g> apps have access to location</item>
       </plurals>
       <!-- Location settings, loading the number of apps which have location permission [CHAR LIMIT=30] -->
       <string name="location_settings_loading_app_permission_stats">Loading\u2026</string>
   

2. Créez un PreferenceController, LocationEntryPreferenceController, pour définir dynamiquement et modifier le texte récapitulatif des préférences d'emplacement:

   public class LocationEntryPreferenceController extends PreferenceController<Preference> {
   
       private static final Logger LOG = new Logger(LocationEntryPreferenceController.class);
       private static final IntentFilter INTENT_FILTER_LOCATION_MODE_CHANGED =
               new IntentFilter(LocationManager.MODE_CHANGED_ACTION);
   
       private final Context mContext;
       private final LocationManager mLocationManager;
       /** Total number of apps that have location permissions. */
       private int mNumTotal = -1;
       private int mNumTotalLoading = 0;
       private AtomicInteger mLoadingInProgress = new AtomicInteger(0);
   
       private final BroadcastReceiver mReceiver = new BroadcastReceiver() {
           @Override
           public void onReceive(Context context, Intent intent) {
               refreshUi();
           }
       };
   
       public LocationEntryPreferenceController(Context context, String preferenceKey,
               FragmentController fragmentController, CarUxRestrictions uxRestrictions) {
           super(context, preferenceKey, fragmentController, uxRestrictions);
           mContext = context;
           mLocationManager = (LocationManager) getContext().getSystemService(
                   Service.LOCATION_SERVICE);
       }
   
       @Override
       protected Class<Preference> getPreferenceType() {
           return Preference.class;
       }
   
       @Override
       protected void onStartInternal() {
           getContext().registerReceiver(mReceiver, INTENT_FILTER_LOCATION_MODE_CHANGED);
       }
   
       @Override
       protected void onStopInternal() {
           getContext().unregisterReceiver(mReceiver);
       }
   
       @Override
       protected void updateState(Preference preference) {
           super.updateState(preference);
           updateSummary(preference);
           if (!mLocationManager.isLocationEnabled() || mLoadingInProgress.get() != 0) {
               return;
           }
           mNumTotalLoading = 0;
           // Retrieve a list of users inside the current user profile group.
           List<UserHandle> users = mContext.getSystemService(
                   UserManager.class).getUserProfiles();
           mLoadingInProgress.set(users.size());
           for (UserHandle user : users) {
               Context userContext = createPackageContextAsUser(mContext, user.getIdentifier());
               if (userContext == null) {
                   if (mLoadingInProgress.decrementAndGet() == 0) {
                       setLocationAppCount(preference, mNumTotalLoading);
                   }
                   continue;
               }
               PermissionControllerManager permController =
                       userContext.getSystemService(PermissionControllerManager.class);
               permController.countPermissionApps(
                       Arrays.asList(ACCESS_FINE_LOCATION, ACCESS_COARSE_LOCATION),
                       PermissionControllerManager.COUNT_ONLY_WHEN_GRANTED,
                       (numApps) -> {
                           mNumTotalLoading += numApps;
                           if (mLoadingInProgress.decrementAndGet() == 0) {
                               setLocationAppCount(preference, mNumTotalLoading);
                           }
                       }, null);
           }
       }
   
       @VisibleForTesting
       void setLocationAppCount(Preference preference, int numApps) {
           mNumTotal = numApps;
           updateSummary(preference);
       }
   
       private void updateSummary(Preference preference) {
           String summary = "";
           if (mLocationManager.isLocationEnabled()) {
               if (mNumTotal == -1) {
                   summary = mContext.getString(R.string.location_settings_loading_app_permission_stats);
               } else {
                   summary = mContext.getResources().getQuantityString(
                           R.plurals.location_settings_summary_location_on,
                           mNumTotal, mNumTotal);
               }
           } else {
               summary = mContext.getString(R.string.location_settings_summary_location_off);
           }
           preference.setSummary(summary);
       }
   
       private Context createPackageContextAsUser(Context context, int userId) {
           try {
               return context.createPackageContextAsUser(
                       context.getPackageName(), 0 /* flags */, UserHandle.of(userId));
           } catch (PackageManager.NameNotFoundException e) {
               LOG.e("Failed to create user context", e);
           }
           return null;
       }
   }
   

   Pour cet exemple de contrôleur:

   • Si la localisation est désactivée, le texte de résumé est défini sur Chaîne location_settings_summary_location_off.
   • Si la localisation est activée, le nombre d'applications qui ont l'autorisation d'accéder à la position est ajouté. Alors que en cours de chargement, la chaîne location_settings_loading_app_permission_stats est affichés. Une fois les données chargées, le contrôleur définit le résumé sur Chaîne location_settings_summary_location_on indiquant le nombre d'applications avec l'accès spécifié.
   • Lorsque le contrôleur de préférences est démarré, il enregistre un récepteur actualise l'état des préférences lorsque celui de l'établissement change.
3. Modifiez le fichier XML du fragment pour associer le nouveau contrôleur à la préférence appropriée:

   <Preference
           android:fragment="com.android.car.settings.location.LocationSettingsFragment"
           android:icon="@drawable/ic_settings_location"
           android:key="@string/pk_location_settings_entry"
           android:title="@string/location_settings_title"
           settings:controller="com.android.car.settings.location.LocationEntryPreferenceController"/>