a11y: Add cursor following mode dialog

This a pure UI change that adds a new magnification cursor following
mode dialog behind a flag. The framework support will be added
separately later.

There are 3 modes as the following:
  - continuous mode
  - center mode
  - edge mode

It also renames magnification mode dialog xml file for general purpose
within accessibility.

NO_IFTTT=linter not working

Bug: b/388335935
Flag: com.android.settings.accessibility.enable_magnification_cursor_following_dialog
Test: SettingsRoboTests:com.android.settings.accessibility.ToggleScreenMagnificationPreferenceFragmentTest &&
      SettingsRoboTests:com.android.settings.accessibility.MagnificationModePreferenceControllerTest &&
      SettingsRoboTests:com.android.settings.accessibility.MagnificationCursorFollowingModePreferenceControllerTest
Change-Id: If2672186faf7443cc210d79630b1ea4f3808d7e4
This commit is contained in:
Yongshun Liu
2025-02-12 10:28:11 +00:00
parent 43e0a04580
commit 20d1a7d1b6
8 changed files with 520 additions and 4 deletions

View File

@@ -0,0 +1,200 @@
/*
* Copyright (C) 2025 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.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth.assertWithMessage;
import android.app.Dialog;
import android.content.Context;
import android.content.DialogInterface;
import android.provider.Settings;
import android.provider.Settings.Secure.AccessibilityMagnificationCursorFollowingMode;
import android.text.TextUtils;
import android.widget.AdapterView;
import android.widget.ListView;
import androidx.annotation.NonNull;
import androidx.preference.Preference;
import androidx.preference.PreferenceManager;
import androidx.preference.PreferenceScreen;
import androidx.test.core.app.ApplicationProvider;
import com.android.settings.DialogCreatable;
import com.android.settings.R;
import com.android.settings.accessibility.MagnificationCursorFollowingModePreferenceController.ModeInfo;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Spy;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
import org.robolectric.RobolectricTestRunner;
/** Tests for {@link MagnificationCursorFollowingModePreferenceController}. */
@RunWith(RobolectricTestRunner.class)
public class MagnificationCursorFollowingModePreferenceControllerTest {
private static final String PREF_KEY =
Settings.Secure.ACCESSIBILITY_MAGNIFICATION_CURSOR_FOLLOWING_MODE;
@Rule
public MockitoRule mocks = MockitoJUnit.rule();
@Spy
private TestDialogHelper mDialogHelper = new TestDialogHelper();
private PreferenceScreen mScreen;
private Context mContext;
private MagnificationCursorFollowingModePreferenceController mController;
private Preference mModePreference;
@Before
public void setUp() {
mContext = ApplicationProvider.getApplicationContext();
mContext.setTheme(androidx.appcompat.R.style.Theme_AppCompat);
final PreferenceManager preferenceManager = new PreferenceManager(mContext);
mScreen = preferenceManager.createPreferenceScreen(mContext);
mModePreference = new Preference(mContext);
mModePreference.setKey(PREF_KEY);
mScreen.addPreference(mModePreference);
mController = new MagnificationCursorFollowingModePreferenceController(mContext, PREF_KEY);
mController.setDialogHelper(mDialogHelper);
mDialogHelper.setDialogDelegate(mController);
showPreferenceOnTheScreen();
}
private void showPreferenceOnTheScreen() {
mController.displayPreference(mScreen);
}
@AccessibilityMagnificationCursorFollowingMode
private int getCheckedModeFromDialog() {
final ListView listView = mController.mModeListView;
assertThat(listView).isNotNull();
final int checkedPosition = listView.getCheckedItemPosition();
assertWithMessage("No mode is checked").that(checkedPosition)
.isNotEqualTo(AdapterView.INVALID_POSITION);
final ModeInfo modeInfo = (ModeInfo) listView.getAdapter().getItem(checkedPosition);
return modeInfo.mMode;
}
private void performItemClickWith(@AccessibilityMagnificationCursorFollowingMode int mode) {
final ListView listView = mController.mModeListView;
assertThat(listView).isNotNull();
int modeIndex = AdapterView.NO_ID;
for (int i = 0; i < listView.getAdapter().getCount(); i++) {
final ModeInfo modeInfo = (ModeInfo) listView.getAdapter().getItem(i);
if (modeInfo != null && modeInfo.mMode == mode) {
modeIndex = i;
break;
}
}
assertWithMessage("The mode could not be found").that(modeIndex)
.isNotEqualTo(AdapterView.NO_ID);
listView.performItemClick(listView.getChildAt(modeIndex), modeIndex, modeIndex);
}
@Test
public void clickPreference_defaultMode_selectionIsDefault() {
mController.handlePreferenceTreeClick(mModePreference);
assertThat(getCheckedModeFromDialog()).isEqualTo(
Settings.Secure.ACCESSIBILITY_MAGNIFICATION_CURSOR_FOLLOWING_MODE_CONTINUOUS);
}
@Test
public void clickPreference_nonDefaultMode_selectionIsExpected() {
Settings.Secure.putInt(mContext.getContentResolver(), PREF_KEY,
Settings.Secure.ACCESSIBILITY_MAGNIFICATION_CURSOR_FOLLOWING_MODE_CENTER);
mController.handlePreferenceTreeClick(mModePreference);
assertThat(getCheckedModeFromDialog()).isEqualTo(
Settings.Secure.ACCESSIBILITY_MAGNIFICATION_CURSOR_FOLLOWING_MODE_CENTER);
}
@Test
public void selectItemInDialog_selectionIsExpected() {
mController.handlePreferenceTreeClick(mModePreference);
performItemClickWith(
Settings.Secure.ACCESSIBILITY_MAGNIFICATION_CURSOR_FOLLOWING_MODE_EDGE);
assertThat(getCheckedModeFromDialog()).isEqualTo(
Settings.Secure.ACCESSIBILITY_MAGNIFICATION_CURSOR_FOLLOWING_MODE_EDGE);
}
@Test
public void selectItemInDialog_dismissWithoutSave_selectionNotPersists() {
mController.handlePreferenceTreeClick(mModePreference);
performItemClickWith(
Settings.Secure.ACCESSIBILITY_MAGNIFICATION_CURSOR_FOLLOWING_MODE_EDGE);
showPreferenceOnTheScreen();
mController.handlePreferenceTreeClick(mModePreference);
assertThat(getCheckedModeFromDialog()).isEqualTo(
Settings.Secure.ACCESSIBILITY_MAGNIFICATION_CURSOR_FOLLOWING_MODE_CONTINUOUS);
assertThat(TextUtils.equals(mController.getSummary(), mContext.getString(
R.string.accessibility_magnification_cursor_following_continuous))).isTrue();
}
@Test
public void selectItemInDialog_saveAndDismiss_selectionPersists() {
mController.handlePreferenceTreeClick(mModePreference);
performItemClickWith(
Settings.Secure.ACCESSIBILITY_MAGNIFICATION_CURSOR_FOLLOWING_MODE_EDGE);
mController.onMagnificationCursorFollowingModeDialogPositiveButtonClicked(
mDialogHelper.getDialog(), DialogInterface.BUTTON_POSITIVE);
showPreferenceOnTheScreen();
mController.handlePreferenceTreeClick(mModePreference);
assertThat(getCheckedModeFromDialog()).isEqualTo(
Settings.Secure.ACCESSIBILITY_MAGNIFICATION_CURSOR_FOLLOWING_MODE_EDGE);
assertThat(TextUtils.equals(mController.getSummary(), mContext.getString(
R.string.accessibility_magnification_cursor_following_edge))).isTrue();
}
private static class TestDialogHelper implements DialogHelper {
private DialogCreatable mDialogDelegate;
private Dialog mDialog;
@Override
public void showDialog(int dialogId) {
mDialog = mDialogDelegate.onCreateDialog(dialogId);
}
public void setDialogDelegate(@NonNull DialogCreatable delegate) {
mDialogDelegate = delegate;
}
public Dialog getDialog() {
return mDialog;
}
}
}

View File

@@ -613,6 +613,24 @@ public class ToggleScreenMagnificationPreferenceFragmentTest {
verify(dialogDelegate).getDialogMetricsCategory(dialogId);
}
@Test
@EnableFlags(com.android.settings.accessibility.Flags
.FLAG_ENABLE_MAGNIFICATION_CURSOR_FOLLOWING_DIALOG)
public void onCreateDialog_setCursorFollowingModeDialogDelegate_invokeDialogDelegate() {
ToggleScreenMagnificationPreferenceFragment fragment =
mFragController.create(
R.id.main_content, /* bundle= */ null).start().resume().get();
final DialogCreatable dialogDelegate = mock(DialogCreatable.class, RETURNS_DEEP_STUBS);
final int dialogId = DialogEnums.DIALOG_MAGNIFICATION_CURSOR_FOLLOWING_MODE;
when(dialogDelegate.getDialogMetricsCategory(anyInt())).thenReturn(dialogId);
fragment.setMagnificationCursorFollowingModeDialogDelegate(dialogDelegate);
fragment.onCreateDialog(dialogId);
fragment.getDialogMetricsCategory(dialogId);
verify(dialogDelegate).onCreateDialog(dialogId);
verify(dialogDelegate).getDialogMetricsCategory(dialogId);
}
@Test
public void getMetricsCategory_returnsCorrectCategory() {
ToggleScreenMagnificationPreferenceFragment fragment =
@@ -826,6 +844,7 @@ public class ToggleScreenMagnificationPreferenceFragmentTest {
MagnificationOneFingerPanningPreferenceController.PREF_KEY,
MagnificationAlwaysOnPreferenceController.PREF_KEY,
MagnificationJoystickPreferenceController.PREF_KEY,
MagnificationCursorFollowingModePreferenceController.PREF_KEY,
MagnificationFeedbackPreferenceController.PREF_KEY);
final List<SearchIndexableRaw> rawData = ToggleScreenMagnificationPreferenceFragment
@@ -881,7 +900,9 @@ public class ToggleScreenMagnificationPreferenceFragmentTest {
@EnableFlags({
com.android.settings.accessibility.Flags.FLAG_FIX_A11Y_SETTINGS_SEARCH,
Flags.FLAG_ENABLE_MAGNIFICATION_ONE_FINGER_PANNING_GESTURE,
Flags.FLAG_ENABLE_LOW_VISION_HATS})
Flags.FLAG_ENABLE_LOW_VISION_HATS,
com.android.settings.accessibility.Flags
.FLAG_ENABLE_MAGNIFICATION_CURSOR_FOLLOWING_DIALOG})
public void getNonIndexableKeys_hasShortcutAndAllFeaturesEnabled_allItemsSearchable() {
mShadowAccessibilityManager.setAccessibilityShortcutTargets(
TRIPLETAP, List.of(MAGNIFICATION_CONTROLLER_NAME));