Preferências de legendas

Na maioria das vezes, adicionar resumos de preferências é relativamente simples, porque envolve apenas adicionar o atributo android:summary à respectiva preferência com o recurso de string adequado. No entanto, se as legendas precisarem ser atualizadas dinamicamente, um controlador de preferências personalizado pode ser necessário.

Legendas estáticas

Para adicionar uma legenda estática a uma preferência:

1. Adicione o atributo android:summary à preferência. Por exemplo, para adicionar um resumo à preferência de configurações de exibição L0, adicione algo como o seguinte aos atributos de preferência:

   android:summary="@string/display_settings_summary"
   

   Por exemplo, considere este exemplo de código de preferência completo:

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

Legendas dinâmicas

As legendas especificadas com o atributo android:summary são estáticas e, portanto, não podem ser atualizadas com base em determinadas condições. Para legendas dinâmicas, é necessário modificar o controlador de preferência. O exemplo a seguir modifica a preferência de local L0 para ter um subtítulo que especifica se a localização está ativada ou desativada e, se estiver ativada, informa quantos apps têm acesso à localização.

1. Defina as novas strings:

   <!-- 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. Crie um novo PreferenceController, LocationEntryPreferenceController, para definir e mudar dinamicamente o texto de resumo da preferência de local:

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

   Para este exemplo de controlador:

   • Se o local estiver desativado, o texto do resumo será definido como a string location_settings_summary_location_off.
   • Se a localização estiver ativada, o número de apps que têm permissão de localização será adicionado. Enquanto ele está sendo carregado, a string location_settings_loading_app_permission_stats é mostrada. Quando os dados são carregados, o controlador define o resumo como a string location_settings_summary_location_on com o número de apps com acesso especificado.
   • Quando o controlador de preferência é iniciado, ele registra um receptor e atualiza o estado da preferência quando o estado do local muda.
3. Modifique o arquivo XML do fragmento para anexar o novo controlador à preferência relevante:

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