Add "Work profile" section to Languages and input settings

This CL adds "Work profile" section to Languages and input settings.

The new section is visible when and only when work profile is enabled.
Hence there should be no user-visible behavior difference when work
profile is not enabled.

If per-profile IME [1] is also enabled, the following 3 preferences
will be shown in the new section.

 * Virtual keyboard for work
 * Spell checker for work
 * Personal dictionary for work

 [1]: Ied99664d3dc61b97c919b220c601f90b29761b96
      a878b9500e6b89dce9738179edc27bcd0d736b7e

Fix: 120748696
Test: Manually verified as follows.
  1. Build and flash an AOSP build
  2. adb root
  3. adb shell setprop persist.debug.per_profile_ime 1
  4. adb reboot
  5. Install Test DPC
  6. Enable managed profile with Test DPC
  7. tapas SoftKeyboard && make -j
  8. adb install -r --user 0 $OUT/system/app/SoftKeyboard/SoftKeyboard.apk
  9. tapas SampleSpellCheckerService && make -j
 10. adb install -r --user 0 \
     $OUT/system/app/SampleSpellCheckerService/SampleSpellCheckerService.apk
 11. Open Settings -> System -> Languages & input
 12. Virtual Keyboard -> Manage keyboards:
     Make sure both "Android Keyboard" and "Sample Soft Keyboard" are shown.
 13. Spell checker -> Default spell checker
     Make sure "Android Spell Checker" and "Sample correction" are shown.
 14. Advanced -> Virtual Keyboard for Work -> Manage keyboards
     Make sure that only "Android Keyboard" is shown.
 15. Advanced -> Spell checker -> Default spell checker
     Make sure that only "Android Spell Checker" is shown.
Change-Id: Id88928318ab1cd92963d652ae39ca772222ea4ac

res/values/strings.xml

@@ -4456,6 +4456,10 @@
     <string name="keyboard_shortcuts_helper">Keyboard shortcuts helper</string>
     <!-- Summary text for the 'keyboard shortcuts helper' dialog. [CHAR LIMIT=100] -->
     <string name="keyboard_shortcuts_helper_summary">Display available shortcuts</string>
+    <!-- Title for the 'Work profile' preference category inside Languages and inputs'. [CHAR LIMIT=45] -->
+    <string name="language_and_input_for_work_category_title">Work profile</string>
+    <!-- Title for the 'Virtual keyboards for work' preference. [CHAR LIMIT=45] -->
+    <string name="virtual_keyboards_for_work_title">Virtual keyboard for work</string>
 
     <!-- Summary text for keyboards when no layout has been selected. [CHAR LIMIT=35] -->
     <string name="default_keyboard_layout">Default</string>
@@ -4487,6 +4491,8 @@
     <!-- User dictionary settings --><skip />
     <!-- User dictionary settings. The title of the list item to go into the Personal dictionary settings screen. [CHAR LIMIT=35] -->
     <string name="user_dict_settings_title">Personal dictionary</string>
+    <!-- Title for the 'Spell checker for work' preference. [CHAR LIMIT=45] -->
+    <string name="user_dict_settings_for_work_title">Personal dictionary for work</string>
     <!-- User dictionary settings.  The summary of the list item to go into the Personal dictionary settings screen. -->
     <string name="user_dict_settings_summary">""</string>
     <!-- User dictionary settings. The title of the menu item to add a new word to the user dictionary. -->
@@ -6380,6 +6386,8 @@
 
     <!--  Title for spell checker settings -->
     <string name="spellcheckers_settings_title">Spell checker</string>
+    <!--  Title for spell checker settings for work [CHAR LIMIT=45]-->
+    <string name="spellcheckers_settings_for_work_title">Spell checker for work</string>
 
     <!-- Prompt for the user to enter their current full-backup password -->
     <string name="current_backup_pw_prompt">Type your current full backup password here</string>

res/xml/language_and_input.xml

@@ -92,4 +92,27 @@
         android:summary="@string/vibrate_input_devices_summary"
         settings:controller="com.android.settings.inputmethod.GameControllerPreferenceController" />
 
+    <com.android.settings.widget.WorkOnlyCategory
+        android:key="language_and_input_for_work_category"
+        android:title="@string/language_and_input_for_work_category_title">
+
+        <Preference
+            android:key="virtual_keyboards_for_work_pref"
+            android:title="@string/virtual_keyboards_for_work_title"
+            android:fragment="com.android.settings.inputmethod.VirtualKeyboardFragment"
+            settings:controller="com.android.settings.inputmethod.VirtualKeyboardForWorkPreferenceController" />
+
+        <Preference
+            android:key="spellcheckers_settings_for_work_pref"
+            android:title="@string/spellcheckers_settings_for_work_title"
+            android:fragment="com.android.settings.inputmethod.SpellCheckersSettings"
+            settings:controller="com.android.settings.language.UserDictionaryForWorkPreferenceController" />
+
+        <Preference
+            android:key="user_dictionary_settings_for_work_pref"
+            android:title="@string/user_dict_settings_for_work_title"
+            android:fragment="com.android.settings.inputmethod.UserDictionaryList"
+            settings:controller="com.android.settings.inputmethod.SpellCheckerForWorkPreferenceController" />
+    </com.android.settings.widget.WorkOnlyCategory>
+
 </PreferenceScreen>

src/com/android/settings/core/WorkProfilePreferenceController.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright (C) 2019 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the
+ * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package com.android.settings.core;
+
+import android.content.Context;
+import android.os.UserHandle;
+import android.os.UserManager;
+import android.text.TextUtils;
+
+import androidx.annotation.Nullable;
+import androidx.preference.Preference;
+
+import com.android.settings.Utils;
+
+/**
+ * Abstract class to provide additional logic to deal with optional {@link Preference} entries that
+ * are used only when work profile is enabled.
+ *
+ * <p>TODO(b/123376083): Consider merging this into {@link BasePreferenceController}.</p>
+ */
+public abstract class WorkProfilePreferenceController extends BasePreferenceController {
+    @Nullable
+    private final UserHandle mWorkProfileUser;
+
+    /**
+     * Constructor of {@link WorkProfilePreferenceController}. Called by
+     * {@link BasePreferenceController#createInstance(Context, String)} through reflection.
+     *
+     * @param context {@link Context} to instantiate this controller.
+     * @param preferenceKey Preference key to be associated with the {@link Preference}.
+     */
+    public WorkProfilePreferenceController(Context context, String preferenceKey) {
+        super(context, preferenceKey);
+        mWorkProfileUser = Utils.getManagedProfile(UserManager.get(context));
+    }
+
+    /**
+     * @return Non-{@code null} {@link UserHandle} when a work profile is enabled.
+     *         Otherwise {@code null}.
+     */
+    @Nullable
+    protected UserHandle getWorkProfileUser() {
+        return mWorkProfileUser;
+    }
+
+    /**
+     * Called back from {@link #handlePreferenceTreeClick(Preference)} to associate source metrics
+     * category.
+     *
+     * @return One of {@link android.app.settings.SettingsEnums}.
+     */
+    protected abstract int getSourceMetricsCategory();
+
+    /**
+     * {@inheritDoc}
+     *
+     * <p>When you override this method, do not forget to check {@link #getWorkProfileUser()} to
+     * see if work profile user actually exists or not.</p>
+     */
+    @AvailabilityStatus
+    @Override
+    public int getAvailabilityStatus() {
+        return mWorkProfileUser != null ? AVAILABLE : DISABLED_FOR_USER;
+    }
+
+    /**
+     * Launches the specified fragment for the work profile user if the associated
+     * {@link Preference} is clicked.  Otherwise just forward it to the super class.
+     *
+     * @param preference the preference being clicked.
+     * @return {@code true} if handled.
+     */
+    public boolean handlePreferenceTreeClick(Preference preference) {
+        if (!TextUtils.equals(preference.getKey(), getPreferenceKey())) {
+            return super.handlePreferenceTreeClick(preference);
+        }
+        new SubSettingLauncher(preference.getContext())
+                .setDestination(preference.getFragment())
+                .setSourceMetricsCategory(getSourceMetricsCategory())
+                .setArguments(preference.getExtras())
+                .setUserHandle(mWorkProfileUser)
+                .launch();
+        return true;
+    }
+}

src/com/android/settings/inputmethod/SpellCheckerForWorkPreferenceController.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2019 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings.inputmethod;
+
+import android.app.settings.SettingsEnums;
+import android.content.Context;
+import android.view.inputmethod.InputMethodSystemProperty;
+
+import com.android.settings.R;
+import com.android.settings.core.WorkProfilePreferenceController;
+
+/**
+ * Preference controller for "Spell checker for work".
+ *
+ * @see SpellCheckerPreferenceController
+ */
+public final class SpellCheckerForWorkPreferenceController extends WorkProfilePreferenceController {
+
+    public SpellCheckerForWorkPreferenceController(Context context, String preferenceKey) {
+        super(context, preferenceKey);
+    }
+
+    @Override
+    protected int getSourceMetricsCategory() {
+        return SettingsEnums.SETTINGS_LANGUAGE_CATEGORY;
+    }
+
+    @AvailabilityStatus
+    @Override
+    public int getAvailabilityStatus() {
+        if (!mContext.getResources().getBoolean(R.bool.config_show_spellcheckers_settings)
+                || !InputMethodSystemProperty.PER_PROFILE_IME_ENABLED) {
+            return UNSUPPORTED_ON_DEVICE;
+        }
+        return super.getAvailabilityStatus();
+    }
+}

src/com/android/settings/inputmethod/VirtualKeyboardForWorkPreferenceController.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (C) 2019 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings.inputmethod;
+
+import android.app.settings.SettingsEnums;
+import android.content.Context;
+import android.view.inputmethod.InputMethodSystemProperty;
+
+import com.android.settings.R;
+import com.android.settings.core.WorkProfilePreferenceController;
+
+public final class VirtualKeyboardForWorkPreferenceController
+        extends WorkProfilePreferenceController {
+
+    public VirtualKeyboardForWorkPreferenceController(Context context,
+            String preferenceKey) {
+        super(context, preferenceKey);
+    }
+
+    @Override
+    protected int getSourceMetricsCategory() {
+        return SettingsEnums.SETTINGS_LANGUAGE_CATEGORY;
+    }
+
+    @AvailabilityStatus
+    @Override
+    public int getAvailabilityStatus() {
+        if (!mContext.getResources().getBoolean(R.bool.config_show_virtual_keyboard_pref)
+                || !InputMethodSystemProperty.PER_PROFILE_IME_ENABLED) {
+            return UNSUPPORTED_ON_DEVICE;
+        }
+        return super.getAvailabilityStatus();
+    }
+}

src/com/android/settings/language/UserDictionaryForWorkPreferenceController.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2019 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.settings.language;
+
+import android.app.settings.SettingsEnums;
+import android.content.Context;
+import android.view.inputmethod.InputMethodSystemProperty;
+
+import com.android.settings.R;
+import com.android.settings.core.WorkProfilePreferenceController;
+
+/**
+ * Preference controller for "UserDictionary for work".
+ *
+ * @see UserDictionaryPreferenceController
+ */
+public final class UserDictionaryForWorkPreferenceController
+        extends WorkProfilePreferenceController {
+
+    public UserDictionaryForWorkPreferenceController(Context context, String preferenceKey) {
+        super(context, preferenceKey);
+    }
+
+    @Override
+    protected int getSourceMetricsCategory() {
+        return SettingsEnums.SETTINGS_LANGUAGE_CATEGORY;
+    }
+
+    @AvailabilityStatus
+    @Override
+    public int getAvailabilityStatus() {
+        if (!InputMethodSystemProperty.PER_PROFILE_IME_ENABLED) {
+            return UNSUPPORTED_ON_DEVICE;
+        }
+        return super.getAvailabilityStatus();
+    }
+}