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

Commit 04955b96 authored by jasonwshsu's avatar jasonwshsu
Browse files

Add the preference controller to control accessibility button size preference

Bug: 173940869
Test: atest FloatingMenuSizePreferenceControllerTest
Change-Id: Ic206a940abde90641442df37a634c8cb3a345597
parent 12346442
Loading
Loading
Loading
Loading
+2 −1
Original line number Diff line number Diff line
@@ -34,7 +34,8 @@
        android:key="accessibility_button_size"
        android:title="@string/accessibility_button_size_title"
        android:summary="%s"
        android:persistent="false"/>
        android:persistent="false"
        settings:controller="com.android.settings.accessibility.FloatingMenuSizePreferenceController"/>

    <SwitchPreference
        android:key="accessibility_button_fade"
+8 −0
Original line number Diff line number Diff line
@@ -16,6 +16,7 @@

package com.android.settings.accessibility;

import static android.provider.Settings.Secure.ACCESSIBILITY_BUTTON_MODE_FLOATING_MENU;
import static android.view.WindowManagerPolicyConstants.NAV_BAR_MODE_GESTURAL;

import android.accessibilityservice.AccessibilityServiceInfo;
@@ -143,6 +144,13 @@ final class AccessibilityUtil {
                == NAV_BAR_MODE_GESTURAL;
    }

    /** Determines if a accessibility floating menu is being used. */
    public static boolean isFloatingMenuEnabled(Context context) {
        return Settings.Secure.getInt(context.getContentResolver(),
                Settings.Secure.ACCESSIBILITY_BUTTON_MODE, /* def= */ -1)
                == ACCESSIBILITY_BUTTON_MODE_FLOATING_MENU;
    }

    /** Determines if a touch explore is being used. */
    public static boolean isTouchExploreEnabled(Context context) {
        final AccessibilityManager am = context.getSystemService(AccessibilityManager.class);
+199 −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 android.content.ContentResolver;
import android.content.Context;
import android.database.ContentObserver;
import android.os.Handler;
import android.os.Looper;
import android.provider.Settings;
import android.util.ArrayMap;

import androidx.annotation.IntDef;
import androidx.annotation.VisibleForTesting;
import androidx.preference.ListPreference;
import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;

import com.android.settings.R;
import com.android.settings.core.BasePreferenceController;
import com.android.settingslib.core.lifecycle.LifecycleObserver;
import com.android.settingslib.core.lifecycle.events.OnPause;
import com.android.settingslib.core.lifecycle.events.OnResume;

import com.google.common.primitives.Ints;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/** Preference controller that controls the preferred size in accessibility button page. */
public class FloatingMenuSizePreferenceController extends BasePreferenceController
        implements Preference.OnPreferenceChangeListener, LifecycleObserver, OnResume, OnPause {

    private final ContentResolver mContentResolver;
    @VisibleForTesting
    final ContentObserver mContentObserver;

    @VisibleForTesting
    ListPreference mPreference;

    private final ArrayMap<String, String> mValueTitleMap = new ArrayMap<>();
    private int mDefaultSize;

    @Retention(RetentionPolicy.SOURCE)
    @IntDef({
            Size.SMALL,
            Size.LARGE,
            Size.EDGE
    })
    @VisibleForTesting
    @interface Size {
        int SMALL = 0;
        int LARGE = 1;
        int EDGE = 2;
    }

    @Retention(RetentionPolicy.SOURCE)
    @IntDef({
            EdgeMode.FULL_CIRCLE,
            EdgeMode.HALF_CIRCLE,
    })
    @VisibleForTesting
    @interface EdgeMode {
        int FULL_CIRCLE = 0;
        int HALF_CIRCLE = 1;
    }

    public FloatingMenuSizePreferenceController(Context context, String preferenceKey) {
        super(context, preferenceKey);
        mContentResolver = context.getContentResolver();
        mContentObserver = new ContentObserver(new Handler(Looper.getMainLooper())) {
            @Override
            public void onChange(boolean selfChange) {
                updateAvailabilityStatus();
            }
        };

        initValueTitleMap();
    }

    @Override
    public int getAvailabilityStatus() {
        return AccessibilityUtil.isFloatingMenuEnabled(mContext)
                ? AVAILABLE : DISABLED_DEPENDENT_SETTING;
    }

    @Override
    public void displayPreference(PreferenceScreen screen) {
        super.displayPreference(screen);

        mPreference = screen.findPreference(getPreferenceKey());
    }

    @Override
    public boolean onPreferenceChange(Preference preference, Object newValue) {
        final ListPreference listPreference = (ListPreference) preference;
        final Integer value = Ints.tryParse((String) newValue);
        if (value != null) {
            writeToFloatingMenuSettings(value);
            updateState(listPreference);
        }
        return true;
    }

    @Override
    public void updateState(Preference preference) {
        super.updateState(preference);
        final ListPreference listPreference = (ListPreference) preference;

        listPreference.setValue(getCurrentAccessibilityButtonSize());
    }

    @Override
    public void onResume() {
        mContentResolver.registerContentObserver(
                Settings.Secure.getUriFor(
                        Settings.Secure.ACCESSIBILITY_BUTTON_MODE), /* notifyForDescendants= */
                false, mContentObserver);

    }

    @Override
    public void onPause() {
        mContentResolver.unregisterContentObserver(mContentObserver);
    }

    private void updateAvailabilityStatus() {
        mPreference.setEnabled(AccessibilityUtil.isFloatingMenuEnabled(mContext));
    }

    private void initValueTitleMap() {
        if (mValueTitleMap.size() == 0) {
            final String[] values = mContext.getResources().getStringArray(
                    R.array.accessibility_button_size_selector_values);
            final String[] titles = mContext.getResources().getStringArray(
                    R.array.accessibility_button_size_selector_titles);
            final int mapSize = values.length;

            mDefaultSize = Integer.parseInt(values[0]);
            for (int i = 0; i < mapSize; i++) {
                mValueTitleMap.put(values[i], titles[i]);
            }
        }
    }

    private void writeToFloatingMenuSettings(@Size int sizeValue) {
        if (sizeValue == Size.EDGE) {
            putAccessibilityFloatingMenuSize(Size.SMALL);
            putAccessibilityFloatingMenuIconType(EdgeMode.HALF_CIRCLE);
        } else {
            putAccessibilityFloatingMenuSize(sizeValue);
            putAccessibilityFloatingMenuIconType(EdgeMode.FULL_CIRCLE);
        }
    }

    private String getCurrentAccessibilityButtonSize() {
        final @EdgeMode int iconType = getAccessibilityFloatingMenuIconType(EdgeMode.FULL_CIRCLE);
        final @Size int btnSize = getAccessibilityFloatingMenuSize(mDefaultSize);

        return (iconType == EdgeMode.HALF_CIRCLE)
                ? String.valueOf(Size.EDGE) : String.valueOf(btnSize);
    }

    @Size
    private int getAccessibilityFloatingMenuSize(@Size int defaultValue) {
        return Settings.Secure.getInt(mContentResolver,
                Settings.Secure.ACCESSIBILITY_FLOATING_MENU_SIZE, defaultValue);
    }

    private void putAccessibilityFloatingMenuSize(@Size int value) {
        Settings.Secure.putInt(mContentResolver,
                Settings.Secure.ACCESSIBILITY_FLOATING_MENU_SIZE, value);
    }

    @EdgeMode
    private int getAccessibilityFloatingMenuIconType(@EdgeMode int defaultValue) {
        return Settings.Secure.getInt(mContentResolver,
                Settings.Secure.ACCESSIBILITY_FLOATING_MENU_ICON_TYPE, defaultValue);
    }

    private void putAccessibilityFloatingMenuIconType(@EdgeMode int value) {
        Settings.Secure.putInt(mContentResolver,
                Settings.Secure.ACCESSIBILITY_FLOATING_MENU_ICON_TYPE, value);
    }
}
+145 −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 android.provider.Settings.Secure.ACCESSIBILITY_BUTTON_MODE_FLOATING_MENU;
import static android.provider.Settings.Secure.ACCESSIBILITY_BUTTON_MODE_NAVIGATION_BAR;

import static com.android.settings.core.BasePreferenceController.AVAILABLE;
import static com.android.settings.core.BasePreferenceController.DISABLED_DEPENDENT_SETTING;

import static com.google.common.truth.Truth.assertThat;

import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

import android.content.ContentResolver;
import android.content.Context;
import android.provider.Settings;

import androidx.preference.ListPreference;
import androidx.test.core.app.ApplicationProvider;

import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Spy;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
import org.robolectric.RobolectricTestRunner;

/** Tests for {@link FloatingMenuSizePreferenceController}. */
@RunWith(RobolectricTestRunner.class)
public class FloatingMenuSizePreferenceControllerTest {

    @Rule
    public MockitoRule mocks = MockitoJUnit.rule();

    @Spy
    private final Context mContext = ApplicationProvider.getApplicationContext();
    @Mock
    private ContentResolver mContentResolver;
    private final ListPreference mListPreference = new ListPreference(mContext);
    private FloatingMenuSizePreferenceController mController;

    @Before
    public void setUp() {
        when(mContext.getContentResolver()).thenReturn(mContentResolver);
        mController = new FloatingMenuSizePreferenceController(mContext, "test_key");
    }

    @Test
    public void getAvailabilityStatus_a11yBtnModeFloatingMenu_returnAvailable() {
        Settings.Secure.putInt(mContentResolver, Settings.Secure.ACCESSIBILITY_BUTTON_MODE,
                ACCESSIBILITY_BUTTON_MODE_FLOATING_MENU);

        assertThat(mController.getAvailabilityStatus()).isEqualTo(AVAILABLE);
    }

    @Test
    public void getAvailabilityStatus_a11yBtnModeNavigationBar_returnDisabledDependentSetting() {
        Settings.Secure.putInt(mContentResolver, Settings.Secure.ACCESSIBILITY_BUTTON_MODE,
                ACCESSIBILITY_BUTTON_MODE_NAVIGATION_BAR);

        assertThat(mController.getAvailabilityStatus()).isEqualTo(DISABLED_DEPENDENT_SETTING);
    }

    @Test
    public void updateState_floatingMenuLargeSizeAndFullCircle_largeSizeValue() {
        Settings.Secure.putInt(mContentResolver, Settings.Secure.ACCESSIBILITY_FLOATING_MENU_SIZE,
                FloatingMenuSizePreferenceController.Size.LARGE);
        Settings.Secure.putInt(mContentResolver,
                Settings.Secure.ACCESSIBILITY_FLOATING_MENU_ICON_TYPE,
                FloatingMenuSizePreferenceController.EdgeMode.FULL_CIRCLE);

        mController.updateState(mListPreference);

        final String largeSize = String.valueOf(FloatingMenuSizePreferenceController.Size.LARGE);
        assertThat(mListPreference.getValue()).isEqualTo(largeSize);
    }

    @Test
    public void updateState_floatingMenuHalfCircle_edgeSizeValue() {
        Settings.Secure.putInt(mContentResolver,
                Settings.Secure.ACCESSIBILITY_FLOATING_MENU_ICON_TYPE,
                FloatingMenuSizePreferenceController.EdgeMode.HALF_CIRCLE);

        mController.updateState(mListPreference);

        final String edgeSize = String.valueOf(FloatingMenuSizePreferenceController.Size.EDGE);
        assertThat(mListPreference.getValue()).isEqualTo(edgeSize);
    }

    @Test
    public void onPreferenceChange_floatingMenuEdgeSize_edgeSizeValue() {
        final String edgeSize = String.valueOf(
                FloatingMenuSizePreferenceController.Size.EDGE);

        mController.onPreferenceChange(mListPreference, edgeSize);

        assertThat(mListPreference.getValue()).isEqualTo(edgeSize);
    }

    @Test
    public void onChange_a11yBtnModeChangeToNavigationBar_preferenceDisabled() {
        mController.mPreference = mListPreference;
        Settings.Secure.putInt(mContentResolver, Settings.Secure.ACCESSIBILITY_BUTTON_MODE,
                ACCESSIBILITY_BUTTON_MODE_NAVIGATION_BAR);

        mController.mContentObserver.onChange(false);

        assertThat(mController.mPreference.isEnabled()).isFalse();
    }

    @Test
    public void onResume_registerSpecificContentObserver() {
        mController.onResume();

        verify(mContentResolver).registerContentObserver(
                Settings.Secure.getUriFor(Settings.Secure.ACCESSIBILITY_BUTTON_MODE), false,
                mController.mContentObserver);
    }

    @Test
    public void onPause_unregisterContentObserver() {
        mController.onPause();

        verify(mContentResolver).unregisterContentObserver(mController.mContentObserver);
    }
}