Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e771cbb1 authored by menghanli's avatar menghanli
Browse files

Add AccessibilityShortcutPreferenceFragment to share non-accesibility tools to add shortcut 

Bug: 190022774
Test: make RunSettingsRoboTests -j52 ROBOTEST_FILTER=AccessibilityShortcutPreferenceFragmentTest
Change-Id: I1cae8fbed059ba7c309126e2dff46adfb48cffd8
parent 78c093b0

src/com/android/settings/accessibility/AccessibilityShortcutPreferenceFragment.java

0 → 100644
+366 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2021 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.accessibility;



import static com.android.settings.accessibility.AccessibilityDialogUtils.DialogEnums;



import android.app.Dialog;

import android.app.settings.SettingsEnums;

import android.content.ComponentName;

import android.content.Context;

import android.content.DialogInterface;

import android.icu.text.CaseMap;

import android.net.Uri;

import android.os.Bundle;

import android.os.Handler;

import android.provider.Settings;

import android.view.LayoutInflater;

import android.view.View;

import android.view.ViewGroup;

import android.view.accessibility.AccessibilityManager;

import android.widget.CheckBox;



import androidx.annotation.VisibleForTesting;

import androidx.preference.PreferenceScreen;



import com.android.settings.R;

import com.android.settings.SettingsPreferenceFragment;

import com.android.settings.utils.LocaleUtils;



import com.google.android.setupcompat.util.WizardManagerHelper;



import java.util.ArrayList;

import java.util.List;

import java.util.Locale;



/**

 * Base class for accessibility fragments shortcut functions and dialog management.

 */

public abstract class AccessibilityShortcutPreferenceFragment extends SettingsPreferenceFragment

        implements ShortcutPreference.OnClickCallback {

    private static final String KEY_SHORTCUT_PREFERENCE = "shortcut_preference";

    protected static final String KEY_SAVED_USER_SHORTCUT_TYPE = "shortcut_type";

    protected static final int NOT_SET = -1;

    // Save user's shortcutType value when savedInstance has value (e.g. device rotated).

    protected int mSavedCheckBoxValue = NOT_SET;



    protected ShortcutPreference mShortcutPreference;

    private AccessibilityManager.TouchExplorationStateChangeListener

            mTouchExplorationStateChangeListener;

    private SettingsContentObserver mSettingsContentObserver;

    private CheckBox mSoftwareTypeCheckBox;

    private CheckBox mHardwareTypeCheckBox;



    /** Returns the accessibility component name. */

    protected abstract ComponentName getComponentName();



    /** Returns the accessibility feature name. */

    protected abstract CharSequence getLabelName();



    @Override

    public void onCreate(Bundle savedInstanceState) {

        super.onCreate(savedInstanceState);



        // Restore the user shortcut type.

        if (savedInstanceState != null && savedInstanceState.containsKey(

                KEY_SAVED_USER_SHORTCUT_TYPE)) {

            mSavedCheckBoxValue = savedInstanceState.getInt(KEY_SAVED_USER_SHORTCUT_TYPE, NOT_SET);

        }



        final int resId = getPreferenceScreenResId();

        if (resId <= 0) {

            final PreferenceScreen preferenceScreen = getPreferenceManager().createPreferenceScreen(

                    getPrefContext());

            setPreferenceScreen(preferenceScreen);

        }



        final List<String> shortcutFeatureKeys = new ArrayList<>();

        shortcutFeatureKeys.add(Settings.Secure.ACCESSIBILITY_BUTTON_TARGETS);

        shortcutFeatureKeys.add(Settings.Secure.ACCESSIBILITY_SHORTCUT_TARGET_SERVICE);

        mSettingsContentObserver = new SettingsContentObserver(new Handler(), shortcutFeatureKeys) {

            @Override

            public void onChange(boolean selfChange, Uri uri) {

                updateShortcutPreferenceData();

                updateShortcutPreference();

            }

        };

    }



    @Override

    public View onCreateView(LayoutInflater inflater, ViewGroup container,

            Bundle savedInstanceState) {

        mShortcutPreference = new ShortcutPreference(getPrefContext(), /* attrs= */ null);

        mShortcutPreference.setPersistent(false);

        mShortcutPreference.setKey(getShortcutPreferenceKey());

        mShortcutPreference.setOnClickCallback(this);



        final CharSequence title = getString(R.string.accessibility_shortcut_title, getLabelName());

        mShortcutPreference.setTitle(title);

        getPreferenceScreen().addPreference(mShortcutPreference);



        mTouchExplorationStateChangeListener = isTouchExplorationEnabled -> {

            removeDialog(DialogEnums.EDIT_SHORTCUT);

            mShortcutPreference.setSummary(getShortcutTypeSummary(getPrefContext()));

        };



        return super.onCreateView(inflater, container, savedInstanceState);

    }



    @Override

    public void onResume() {

        super.onResume();

        final AccessibilityManager am = getPrefContext().getSystemService(

                AccessibilityManager.class);

        am.addTouchExplorationStateChangeListener(mTouchExplorationStateChangeListener);

        mSettingsContentObserver.register(getContentResolver());

        updateShortcutPreferenceData();

        updateShortcutPreference();

    }



    @Override

    public void onPause() {

        final AccessibilityManager am = getPrefContext().getSystemService(

                AccessibilityManager.class);

        am.removeTouchExplorationStateChangeListener(mTouchExplorationStateChangeListener);

        mSettingsContentObserver.unregister(getContentResolver());

        super.onPause();

    }



    @Override

    public void onSaveInstanceState(Bundle outState) {

        final int value = getShortcutTypeCheckBoxValue();

        if (value != NOT_SET) {

            outState.putInt(KEY_SAVED_USER_SHORTCUT_TYPE, value);

        }

        super.onSaveInstanceState(outState);

    }



    @Override

    public Dialog onCreateDialog(int dialogId) {

        switch (dialogId) {

            case DialogEnums.EDIT_SHORTCUT:

                final CharSequence dialogTitle = getPrefContext().getString(

                        R.string.accessibility_shortcut_title, getLabelName());

                final int dialogType = WizardManagerHelper.isAnySetupWizard(getIntent())

                        ? AccessibilityDialogUtils.DialogType.EDIT_SHORTCUT_GENERIC_SUW :

                        AccessibilityDialogUtils.DialogType.EDIT_SHORTCUT_GENERIC;

                final Dialog dialog = AccessibilityDialogUtils.showEditShortcutDialog(

                        getPrefContext(), dialogType, dialogTitle,

                        this::callOnAlertDialogCheckboxClicked);

                setupEditShortcutDialog(dialog);

                return dialog;

            default:

                throw new IllegalArgumentException("Unsupported dialogId " + dialogId);

        }

    }



    @Override

    public int getDialogMetricsCategory(int dialogId) {

        switch (dialogId) {

            case DialogEnums.EDIT_SHORTCUT:

                return SettingsEnums.DIALOG_ACCESSIBILITY_SERVICE_EDIT_SHORTCUT;

            default:

                return SettingsEnums.ACTION_UNKNOWN;

        }

    }



    @Override

    public void onSettingsClicked(ShortcutPreference preference) {

        showDialog(DialogEnums.EDIT_SHORTCUT);

    }



    @Override

    public void onToggleClicked(ShortcutPreference preference) {

        if (getComponentName() == null) {

            return;

        }



        final int shortcutTypes = PreferredShortcuts.retrieveUserShortcutType(getPrefContext(),

                getComponentName().flattenToString(), AccessibilityUtil.UserShortcutType.SOFTWARE);

        if (preference.isChecked()) {

            AccessibilityUtil.optInAllValuesToSettings(getPrefContext(), shortcutTypes,

                    getComponentName());

            showDialog(DialogEnums.LAUNCH_ACCESSIBILITY_TUTORIAL);

        } else {

            AccessibilityUtil.optOutAllValuesFromSettings(getPrefContext(), shortcutTypes,

                    getComponentName());

        }

        mShortcutPreference.setSummary(getShortcutTypeSummary(getPrefContext()));

    }



    protected String getShortcutPreferenceKey() {

        return KEY_SHORTCUT_PREFERENCE;

    }



    @VisibleForTesting

    void setupEditShortcutDialog(Dialog dialog) {

        final View dialogSoftwareView = dialog.findViewById(R.id.software_shortcut);

        mSoftwareTypeCheckBox = dialogSoftwareView.findViewById(R.id.checkbox);

        setDialogTextAreaClickListener(dialogSoftwareView, mSoftwareTypeCheckBox);



        final View dialogHardwareView = dialog.findViewById(R.id.hardware_shortcut);

        mHardwareTypeCheckBox = dialogHardwareView.findViewById(R.id.checkbox);

        setDialogTextAreaClickListener(dialogHardwareView, mHardwareTypeCheckBox);



        updateEditShortcutDialogCheckBox();

    }



    /**

     * Returns accumulated {@link AccessibilityUtil.UserShortcutType} checkbox value or

     * {@code NOT_SET} if checkboxes did not exist.

     */

    protected int getShortcutTypeCheckBoxValue() {

        if (mSoftwareTypeCheckBox == null || mHardwareTypeCheckBox == null) {

            return NOT_SET;

        }



        int value = AccessibilityUtil.UserShortcutType.EMPTY;

        if (mSoftwareTypeCheckBox.isChecked()) {

            value |= AccessibilityUtil.UserShortcutType.SOFTWARE;

        }

        if (mHardwareTypeCheckBox.isChecked()) {

            value |= AccessibilityUtil.UserShortcutType.HARDWARE;

        }

        return value;

    }





    /**

     * This method will be invoked when a button in the edit shortcut dialog is clicked.

     *

     * @param dialog The dialog that received the click

     * @param which  The button that was clicked

     */

    protected void callOnAlertDialogCheckboxClicked(DialogInterface dialog, int which) {

        if (getComponentName() == null) {

            return;

        }



        final int value = getShortcutTypeCheckBoxValue();



        saveNonEmptyUserShortcutType(value);

        AccessibilityUtil.optInAllValuesToSettings(getPrefContext(), value, getComponentName());

        AccessibilityUtil.optOutAllValuesFromSettings(getPrefContext(), ~value, getComponentName());

        mShortcutPreference.setChecked(value != AccessibilityUtil.UserShortcutType.EMPTY);

        mShortcutPreference.setSummary(getShortcutTypeSummary(getPrefContext()));

    }



    @VisibleForTesting

    void saveNonEmptyUserShortcutType(int type) {

        if (type == AccessibilityUtil.UserShortcutType.EMPTY) {

            return;

        }



        final PreferredShortcut shortcut = new PreferredShortcut(

                getComponentName().flattenToString(), type);

        PreferredShortcuts.saveUserShortcutType(getPrefContext(), shortcut);

    }



    private void setDialogTextAreaClickListener(View dialogView, CheckBox checkBox) {

        final View dialogTextArea = dialogView.findViewById(R.id.container);

        dialogTextArea.setOnClickListener(v -> checkBox.toggle());

    }



    protected CharSequence getShortcutTypeSummary(Context context) {

        if (!mShortcutPreference.isSettingsEditable()) {

            return context.getText(R.string.accessibility_shortcut_edit_dialog_title_hardware);

        }



        if (!mShortcutPreference.isChecked()) {

            return context.getText(R.string.switch_off_text);

        }



        final int shortcutTypes = PreferredShortcuts.retrieveUserShortcutType(context,

                getComponentName().flattenToString(), AccessibilityUtil.UserShortcutType.SOFTWARE);



        final List<CharSequence> list = new ArrayList<>();

        final CharSequence softwareTitle = context.getText(

                R.string.accessibility_shortcut_edit_summary_software);



        if (hasShortcutType(shortcutTypes, AccessibilityUtil.UserShortcutType.SOFTWARE)) {

            list.add(softwareTitle);

        }

        if (hasShortcutType(shortcutTypes, AccessibilityUtil.UserShortcutType.HARDWARE)) {

            final CharSequence hardwareTitle = context.getText(

                    R.string.accessibility_shortcut_hardware_keyword);

            list.add(hardwareTitle);

        }



        // Show software shortcut if first time to use.

        if (list.isEmpty()) {

            list.add(softwareTitle);

        }



        return CaseMap.toTitle().wholeString().noLowercase().apply(Locale.getDefault(), /* iter= */

                null, LocaleUtils.getConcatenatedString(list));

    }



    private void updateEditShortcutDialogCheckBox() {

        // If it is during onConfigChanged process then restore the value, or get the saved value

        // when shortcutPreference is checked.

        int value = restoreOnConfigChangedValue();

        if (value == NOT_SET) {

            final int lastNonEmptyUserShortcutType = PreferredShortcuts.retrieveUserShortcutType(

                    getPrefContext(), getComponentName().flattenToString(),

                    AccessibilityUtil.UserShortcutType.SOFTWARE);

            value = mShortcutPreference.isChecked() ? lastNonEmptyUserShortcutType

                    : AccessibilityUtil.UserShortcutType.EMPTY;

        }



        mSoftwareTypeCheckBox.setChecked(

                hasShortcutType(value, AccessibilityUtil.UserShortcutType.SOFTWARE));

        mHardwareTypeCheckBox.setChecked(

                hasShortcutType(value, AccessibilityUtil.UserShortcutType.HARDWARE));

    }



    private int restoreOnConfigChangedValue() {

        final int savedValue = mSavedCheckBoxValue;

        mSavedCheckBoxValue = NOT_SET;

        return savedValue;

    }



    private boolean hasShortcutType(int value, @AccessibilityUtil.UserShortcutType int type) {

        return (value & type) == type;

    }



    protected void updateShortcutPreferenceData() {

        if (getComponentName() == null) {

            return;

        }



        final int shortcutTypes = AccessibilityUtil.getUserShortcutTypesFromSettings(

                getPrefContext(), getComponentName());

        if (shortcutTypes != AccessibilityUtil.UserShortcutType.EMPTY) {

            final PreferredShortcut shortcut = new PreferredShortcut(

                    getComponentName().flattenToString(), shortcutTypes);

            PreferredShortcuts.saveUserShortcutType(getPrefContext(), shortcut);

        }

    }



    protected void updateShortcutPreference() {

        if (getComponentName() == null) {

            return;

        }



        final int shortcutTypes = PreferredShortcuts.retrieveUserShortcutType(getPrefContext(),

                getComponentName().flattenToString(), AccessibilityUtil.UserShortcutType.SOFTWARE);

        mShortcutPreference.setChecked(

                AccessibilityUtil.hasValuesInSettings(getPrefContext(), shortcutTypes,

                        getComponentName()));

        mShortcutPreference.setSummary(getShortcutTypeSummary(getPrefContext()));

    }

}

src/com/android/settings/accessibility/ToggleFeaturePreferenceFragment.java

+1 −1
Original line number Diff line number Diff line
@@ -136,7 +136,7 @@ public abstract class ToggleFeaturePreferenceFragment extends SettingsPreference 
        setupDefaultShortcutIfNecessary(getPrefContext());

        final int resId = getPreferenceScreenResId();

        if (resId <= 0) {

            PreferenceScreen preferenceScreen = getPreferenceManager().createPreferenceScreen(

            final PreferenceScreen preferenceScreen = getPreferenceManager().createPreferenceScreen(

                    getPrefContext());

            setPreferenceScreen(preferenceScreen);

        }

tests/robotests/src/com/android/settings/accessibility/AccessibilityShortcutPreferenceFragmentTest.java

0 → 100644
+222 −0

File added.

Preview size limit exceeded, changes collapsed.

tests/robotests/src/com/android/settings/accessibility/ToggleFeaturePreferenceFragmentTest.java

+1 −1
Original line number Diff line number Diff line
@@ -118,9 +118,9 @@ public class ToggleFeaturePreferenceFragmentTest { 
    @Test

    public void updateShortcutPreferenceData_hasValueInSettings_assignToVariable() {

        mFragment.mComponentName = PLACEHOLDER_COMPONENT_NAME;



        putStringIntoSettings(SOFTWARE_SHORTCUT_KEY, PLACEHOLDER_COMPONENT_NAME.flattenToString());

        putStringIntoSettings(HARDWARE_SHORTCUT_KEY, PLACEHOLDER_COMPONENT_NAME.flattenToString());



        mFragment.updateShortcutPreferenceData();



        final int expectedType = PreferredShortcuts.retrieveUserShortcutType(mContext,

tests/robotests/src/com/android/settings/accessibility/ToggleScreenMagnificationPreferenceFragmentTest.java

+1 −0
Original line number Diff line number Diff line
@@ -186,6 +186,7 @@ public class ToggleScreenMagnificationPreferenceFragmentTest { 
    public void updateShortcutPreferenceData_hasValueInSettings_assignToVariable() {

        putStringIntoSettings(SOFTWARE_SHORTCUT_KEY, MAGNIFICATION_CONTROLLER_NAME);

        setMagnificationTripleTapEnabled(/* enabled= */ true);



        mFragment.updateShortcutPreferenceData();



        final int expectedType = PreferredShortcuts.retrieveUserShortcutType(mContext,