Sous-titres de préférence

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Dans la plupart des cas, l'ajout de résumés de préférences est relativement simple car il s'agit simplement d'ajouter l'attribut android:summary à la préférence respective avec la ressource de chaîne appropriée. Cependant, si les sous-titres doivent être mis à jour dynamiquement, un contrôleur de préférences personnalisé peut être 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 résumé à la préférence des paramètres d'affichage L0, ajoutez quelque chose comme ce qui suit aux attributs de préférence :
    android:summary="@string/display_settings_summary"
    

    Par exemple, considérez cet exemple de code de préférence complet :

    <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 être mis à jour en fonction de certaines conditions. Pour les sous-titres dynamiques, vous devez modifier le contrôleur de préférence pour la préférence. L'exemple suivant modifie la préférence d'emplacement L0 pour avoir un sous-titre qui spécifie si l'emplacement est activé ou désactivé et, s'il est activé, indique combien d'applications ont actuellement accès à l'emplacement.

  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 nouveau PreferenceController, LocationEntryPreferenceController , pour définir et modifier dynamiquement 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 l'emplacement est désactivé, le texte récapitulatif est défini sur la chaîne location_settings_summary_location_off .
    • Si la localisation est activée, le nombre d'applications disposant d'une autorisation de localisation est ajouté. Pendant le chargement, la chaîne location_settings_loading_app_permission_stats s'affiche. Lorsque les données sont chargées, le contrôleur définit le résumé sur la chaîne location_settings_summary_location_on avec le nombre d'applications avec accès spécifié.
    • Lorsque le contrôleur de préférence est démarré, le contrôleur enregistre un récepteur et rafraîchit l'état de préférence lorsque l'état d'emplacement change.
  3. Modifiez le fichier XML de fragment pour attacher le nouveau contrôleur à la préférence pertinente :
    <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"/>