添加汽车设置

“汽车设置”中的大多数页面都是以一系列 fragment 的形式实现的,其中每个 fragment 都扩展了 SettingsFragment,并且在 CarSettingActivities 中定义了各自的 activity。这些静态 activity 从 BaseCarSettingsActivity 扩展而来。除了这些设置之外,您还可将其他系统应用中的偏好设置注入“汽车设置”。

在“汽车设置”中添加新的偏好设置

如需添加新设置,请执行以下操作:

  1. 定义 XML 文件:
    1. 确保已为所有偏好设置定义 android:key。仍将键列表放于 preference_keys.xml 中。偏好设置键应独一无二。
    2. 为便于编入搜索索引,还应为偏好设置屏幕定义 android:key。仍将偏好设置屏幕键列表放于 preference_screen_keys.xml 中。偏好设置屏幕键也应独一无二。
    3. 如果偏好设置仅显示静态信息(例如,没有特殊的业务逻辑),请将偏好设置控制器设置为 com.android.car.settings.common.DefaultRestrictionsPreferenceController
    4. 如果偏好设置需要业务逻辑,请为偏好设置控制器设置一个新名称。
  2. (如有需要)在相应软件包中创建可扩展 PreferenceController 的偏好设置控制器。如有需要,请参阅 Javadoc。
  3. 使用可返回第 1 步中定义的 XML 文件的 getPreferenceScreenResId 创建 fragment。
  4. CarSettingActivities 中创建可扩展 BaseCarSettingsActivity 的 activity,然后实现 getInitialFragment(),以返回第 3 步中定义的 fragment。
  5. 更新 AndroidManifest.xml 以包含第 4 步中定义的 activity。

示例

以下内容详细说明了这一过程。

  1. 定义一个名为 demo_fragment.xml 的 XML 文件:
    <PreferenceScreen
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:settings="http://schemas.android.com/apk/res-auto"
        android:title="@string/demo_label"
        android:key="@string/psk_demo">
        <Preference
            android:icon="@drawable/ic_settings_demo_preference_1"
            android:key="@string/pk_demo_preference_1"
            android:title="@string/demo_preference_1_title"
    settings:controller="com.android.car.settings.common.DefaultRestrictionsPreferenceController">
            <intent android:targetPackage="com.android.car.settings"
    android:targetClass="com.android.car.settings.common.CarSettingActivities$DemoSetting1Activity"/>
        </Preference>
        <Preference
            android:icon="@drawable/ic_settings_demo_preference_2"
            android:key="@string/pk_demo_preference_2"
            android:title="@string/demo_preference_2_title"
    settings:controller="com.android.car.settings.example.MyCustomRestrictionsPreferenceController">
            <intent android:targetPackage="com.android.car.settings"
    android:targetClass="com.android.car.settings.common.CarSettingActivities$DemoSetting2Activity"/>
        </Preference>
    </PreferenceScreen>
    
  2. 将偏好设置键添加到 preference_keys
    <resources>
        [...]
        <string name="pk_demo_preference_1" translatable="false">demo_preference_1</string>
        <string name="pk_demo_preference_2" translatable="false">demo_preference_2</string>
    </resources>
    
  3. 将偏好设置屏幕键添加到 preference_screen_keys.xml
    <resources>
        [...]
        <string name="psk_demo" translatable="false">demo_screen</string>
    </resources>
    

    对于第一个示例偏好设置,请使用 DefaultRestrictionsPreferenceController。对于第二个偏好设置,请使用需要定义的自定义偏好设置控制器。在本例中,您可以将此偏好设置自定义为仅供管理员用户使用。 要实现这一点,请对以下自定义控制器进行定义:

    public class MyCustomRestrictionsPreferenceController extends 
        PreferenceController<Preference> {
    
        private final UserManager mUserManager;
    
        public MyCustomRestrictionsPreferenceController(Context context, String 
            preferenceKey, FragmentController fragmentController, 
            CarUxRestrictions uxRestrictions) {
            super(context, preferenceKey, fragmentController, uxRestrictions);
            mUserManager = UserManager.get(context);
        }
    
        @Override
        protected Class<Preference> getPreferenceType() {
            return Preference.class;
        }
    
        @Override
        public int getAvailabilityStatus() {
            return mUserManager.isAdminUser() ? AVAILABLE : DISABLED_FOR_USER;
        }
    }
    
  4. 要创建 fragment,请替换 getPreferenceScreenResId
  5. public class DemoFragment extends SettingsFragment {
    
        @Override
        @XmlRes
        protected int getPreferenceScreenResId() {
            return R.xml.demo_fragment;
        }
    }
    
  6. 要保存新创建的 fragment,请在 CarSettingActivities 中创建 activity:
  7. public class CarSettingActivities {
        [...]
        public static class DemoActivity extends BaseCarSettingsActivity {
            @Nullable
            @Override
            protected Fragment getInitialFragment() {
                return new DemoFragment();
            }
        }
    }
    
  8. 更新清单文件以添加新 activity:
  9. <application
        [...]
        <activity
            android:name=".common.CarSettingActivities$DemoActivity"
            android:exported="true">
            <meta-data android:name="distractionOptimized" android:value="true"/>
        </activity>
        [...]
    </application>
    

    在“汽车设置”中添加外部 intent 偏好设置

    除了注入偏好设置这种方法,还可将具有指向其他应用的 intent 的偏好设置直接插入到“汽车设置”中。为此,只需将具有可解析到外部应用的 intent 操作的偏好设置添加到偏好设置屏幕中。与“汽车设置”中的其他偏好设置一样,这些偏好设置也具有相同的 XML 属性。

    <Preference
        android:key="@string/pk_demo_preference"
        android:title="@string/demo_preference_title"
        android:summary="@string/demo_preference_summary"
    settings:controller="com.android.car.settings.common.DefaultRestrictionsPreferenceController">
            <intent android:action="android.intent.action.DEMO_ACTION"/>
    </Preference>
    

    添加注入的偏好设置

    注入的偏好设置包含指向外部或内部 activity 的 intent。例如,“设置”首页上的“Google”设置项就是一种注入偏好设置。在以下任一情况下,注入偏好设置尤其有用。设置:

    • 未在“汽车设置”应用中直接实现(例如,注入由 OEM 实现的设置)。
    • 应显示在“汽车设置”应用中。

    如需将 activity 配置为注入设置,请执行以下操作:

    1. 要将 activity 标记为注入的设置,请向该 activity 添加 intent 过滤器。
    2. 将其所属的类别告诉“汽车设置”应用。类别是在 CategoryKey 中定义的常量,用于指明注入设置应在“汽车设置”的哪个级别显示。我们在 CategoryKey 中提供了一组类别,不过原始设备制造商可以视情况定义自己的类别。
    3. (可选)在设置显示时,添加摘要文字:
      <activity android:name="Settings$DemoSettingsActivity"
          <!-- Mark the activity as an injected setting -->
          <intent-filter>
              <action android:name="com.android.settings.action.EXTRA_SETTINGS"/>
          </intent-filter>
          <!-- Tell CarSettings app which category it belongs to -->
          <meta-data android:name="com.android.settings.category"
                     android:value="com.android.settings.category.demo_category"/>
          <!-- Tell CarSettings the what the preference title should be -->
          <meta-data android:name="com.android.settings.title"
                     android:value="@string/app_name" />
          <!-- Optional: specify the icon to show with the preference -->
          <meta-data android:name="com.android.settings.icon"
                     android:resource="@drawable/ic_demo"
                     android:value="true"/>
          <!-- Optional: Add a summary text when the string is displayed -->
          <meta-data android:name="com.android.settings.summary"
                     android:resource="@string/demo_summary"/>
      </activity>
      

    要让注入的设置在“汽车设置”应用中特定页面上显示,请在 XML 中添加以下示例代码,以便在适当情况下修改变量:

    <com.android.car.settings.common.LogicalPreferenceGroup
        <!-- Replace key string -->
        android:key="@string/pk_system_extra_settings"
        <!-- Indicates the preferences in the group should be injected in.
             ExtraSettingsPreferenceController contains the logic to pull in injected
             preferences. -->
    settings:controller="com.android.settings.common.ExtraSettingsPreferenceController">
        <!-- Tells the controller what activities should be pulled into this preference
             group. -->
        <intent android:action="com.android.settings.action.EXTRA_SETTINGS">
            <!-- Name and value should match the metadata in your activity -->
            <extra android:name="com.android.settings.category"
                   android:value="com.android.settings.category.demo_category"/>
        </intent>
    </com.android.car.settings.common.LogicalPreferenceGroup>