Merge "[Physical Keyboard] Add main page for Repeat keys" into main

This commit is contained in:
Shaowei Shen
2024-10-14 15:32:38 +00:00
committed by Android (Google) Code Review
10 changed files with 546 additions and 12 deletions

View File

@@ -4705,9 +4705,13 @@
<!-- Summary for the button to trigger the 'Physical keyboard accessibility' page. [CHAR LIMIT=NONE] -->
<string name="keyboard_a11y_settings_summary">Sticky keys, Bounce keys, Mouse keys</string>
<!-- Title for the keyboard repeat key option. [CHAR LIMIT=60] -->
<string name="keyboard_repeat_key_title">Repeat Keys</string>
<string name="keyboard_repeat_keys_title">Repeat Keys</string>
<!-- Title for the keyboard repeat key timeout option. [CHAR LIMIT=60] -->
<string name="keyboard_repeat_keys_timeout_title">Delay before repeat</string>
<!-- Title for the keyboard repeat key delay option. [CHAR LIMIT=60] -->
<string name="keyboard_repeat_keys_delay_title">Repeat Rate</string>
<!-- Summary for the keyboard repeat key option. [CHAR LIMIT=NONE] -->
<string name="keyboard_repeat_key_summary">Hold down a key to repeat its character until the key is released</string>
<string name="keyboard_repeat_keys_summary">Hold down a key to repeat its character until the key is released</string>
<!-- Title text for per IME subtype keyboard layout. [CHAR LIMIT=35] -->
<string name="ime_label_title"><xliff:g id="ime_label" example="Gboard">%s</xliff:g> layout</string>

View File

@@ -33,11 +33,12 @@
android:summary="@string/modifier_keys_settings_summary"
android:fragment="com.android.settings.inputmethod.ModifierKeysSettings" />
<SwitchPreferenceCompat
android:key="physical_keyboard_repeat_key"
android:title="@string/keyboard_repeat_key_title"
android:summary="@string/keyboard_repeat_key_summary"
<com.android.settingslib.PrimarySwitchPreference
android:key="physical_keyboard_repeat_keys"
android:title="@string/keyboard_repeat_keys_title"
android:summary="@string/keyboard_repeat_keys_summary"
android:defaultValue="false"
android:fragment="com.android.settings.inputmethod.KeyboardRepeatKeysMainFragment"
settings:controller="com.android.settings.inputmethod.KeyboardRepeatKeysController" />
<Preference

View File

@@ -0,0 +1,42 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
~ Copyright 2024 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.
-->
<PreferenceScreen
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:settings="http://schemas.android.com/apk/res-auto"
android:title="@string/keyboard_repeat_keys_title"
android:key="repeat_keys_main_page">
<com.android.settingslib.widget.MainSwitchPreference
android:key="repeat_keys_main_switch"
android:title="@string/keyboard_repeat_keys_title"
settings:controller="com.android.settings.inputmethod.KeyboardRepeatKeysController"/>
<com.android.settings.widget.LabeledSeekBarPreference
android:key="repeat_keys_timeout_preference"
android:title="@string/keyboard_repeat_keys_timeout_title"
android:min="0"
android:max="6"
settings:seekBarIncrement="1"
settings:controller= "com.android.settings.inputmethod.KeyboardRepeatKeysTimeOutPreferenceController" />
<com.android.settings.widget.LabeledSeekBarPreference
android:key="repeat_keys_delay_preference"
android:title="@string/keyboard_repeat_keys_delay_title"
android:min="0"
android:max="8"
settings:seekBarIncrement="1"
settings:controller= "com.android.settings.inputmethod.KeyboardRepeatKeysDelayPreferenceController" />
</PreferenceScreen>

View File

@@ -25,14 +25,20 @@ import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.lifecycle.LifecycleObserver;
import androidx.preference.PreferenceScreen;
import androidx.preference.SwitchPreferenceCompat;
import com.android.settingslib.PrimarySwitchPreference;
import com.android.settingslib.widget.MainSwitchPreference;
public class KeyboardRepeatKeysController extends
InputSettingPreferenceController implements
LifecycleObserver {
private static final String KEY_REPEAT_KEY = "physical_keyboard_repeat_keys";
private static final String KEY_REPEAT_KEY_MAIN_PAGE = "repeat_key_main_switch";
@Nullable
private SwitchPreferenceCompat mSwitchPreferenceCompat;
private PrimarySwitchPreference mPrimarySwitchPreference;
@Nullable
private MainSwitchPreference mMainSwitchPreference;
public KeyboardRepeatKeysController(@NonNull Context context,
@NonNull String key) {
@@ -42,7 +48,11 @@ public class KeyboardRepeatKeysController extends
@Override
public void displayPreference(@NonNull PreferenceScreen screen) {
super.displayPreference(screen);
mSwitchPreferenceCompat = screen.findPreference(getPreferenceKey());
if (KEY_REPEAT_KEY.equals(getPreferenceKey())) {
mPrimarySwitchPreference = screen.findPreference(getPreferenceKey());
} else if (KEY_REPEAT_KEY_MAIN_PAGE.equals(getPreferenceKey())) {
mMainSwitchPreference = screen.findPreference(getPreferenceKey());
}
}
@Override
@@ -63,8 +73,10 @@ public class KeyboardRepeatKeysController extends
@Override
protected void onInputSettingUpdated() {
if (mSwitchPreferenceCompat != null) {
mSwitchPreferenceCompat.setChecked(InputSettings.isRepeatKeysEnabled(mContext));
if (mPrimarySwitchPreference != null) {
mPrimarySwitchPreference.setChecked(InputSettings.isRepeatKeysEnabled(mContext));
} else if (mMainSwitchPreference != null) {
mMainSwitchPreference.setChecked(InputSettings.isRepeatKeysEnabled(mContext));
}
}

View File

@@ -0,0 +1,65 @@
/*
* Copyright 2024 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.content.Context;
import android.hardware.input.InputSettings;
import androidx.annotation.NonNull;
import com.android.internal.annotations.VisibleForTesting;
import com.android.settings.core.SliderPreferenceController;
import com.google.common.collect.ImmutableList;
public class KeyboardRepeatKeysDelayPreferenceController extends SliderPreferenceController {
@VisibleForTesting
static final ImmutableList<Integer> REPEAT_KEY_DELAY_VALUE_LIST = ImmutableList.of(2000, 1000,
500, 300, 200, 100, 50, 30, 20);
public KeyboardRepeatKeysDelayPreferenceController(@NonNull Context context,
@NonNull String preferenceKey) {
super(context, preferenceKey);
}
@Override
public int getSliderPosition() {
return REPEAT_KEY_DELAY_VALUE_LIST.indexOf(InputSettings.getRepeatKeysDelay(mContext));
}
@Override
public boolean setSliderPosition(int position) {
InputSettings.setRepeatKeysDelay(mContext, REPEAT_KEY_DELAY_VALUE_LIST.get(position));
return true;
}
@Override
public int getMax() {
return REPEAT_KEY_DELAY_VALUE_LIST.size() - 1;
}
@Override
public int getMin() {
return 0;
}
@Override
public int getAvailabilityStatus() {
return InputSettings.isRepeatKeysFeatureFlagEnabled()
? AVAILABLE : UNSUPPORTED_ON_DEVICE;
}
}

View File

@@ -0,0 +1,170 @@
/*
* Copyright 2024 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 static com.android.settings.inputmethod.PhysicalKeyboardFragment.getHardKeyboards;
import android.app.settings.SettingsEnums;
import android.content.ContentResolver;
import android.content.Context;
import android.database.ContentObserver;
import android.hardware.input.InputManager;
import android.hardware.input.InputSettings;
import android.net.Uri;
import android.os.Bundle;
import android.os.Handler;
import android.os.UserHandle;
import android.provider.Settings;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import com.android.internal.util.Preconditions;
import com.android.settings.R;
import com.android.settings.dashboard.DashboardFragment;
import com.android.settings.keyboard.Flags;
import com.android.settings.search.BaseSearchIndexProvider;
import com.android.settings.widget.LabeledSeekBarPreference;
import com.android.settingslib.utils.ThreadUtils;
import java.util.List;
public class KeyboardRepeatKeysMainFragment extends DashboardFragment
implements InputManager.InputDeviceListener {
private static final String TAG = "RepeatKeysMainFragment";
private static final String TIME_OUT_KEY = "repeat_keys_timeout_preference";
private static final String DELAY_KEY = "repeat_keys_delay_preference";
private final Uri mRepeatKeyUri = Settings.Secure.getUriFor(
Settings.Secure.KEY_REPEAT_ENABLED);
private final ContentObserver mContentObserver = new ContentObserver(new Handler(true)) {
@Override
public void onChange(boolean selfChange, Uri uri) {
if (mRepeatKeyUri.equals(uri)) {
updatePreferencesState();
}
}
};
private InputManager mInputManager;
private ContentResolver mContentResolver;
@Nullable
private LabeledSeekBarPreference mRepeatTimeoutPreference;
@Nullable
private LabeledSeekBarPreference mRepeatDelayPreference;
@Override
public int getMetricsCategory() {
return SettingsEnums.PHYSICAL_KEYBOARD_A11Y;
}
@Override
public void onAttach(@NonNull Context context) {
super.onAttach(context);
mInputManager = Preconditions.checkNotNull(getActivity()
.getSystemService(InputManager.class));
mContentResolver = context.getContentResolver();
}
@Override
public void onCreatePreferences(Bundle bundle, String s) {
super.onCreatePreferences(bundle, s);
mRepeatTimeoutPreference = findPreference(TIME_OUT_KEY);
mRepeatDelayPreference = findPreference(DELAY_KEY);
updatePreferencesState();
}
@Override
public void onResume() {
super.onResume();
finishEarlyIfNeeded();
mInputManager.registerInputDeviceListener(this, null);
registerSettingsObserver();
}
@Override
public void onPause() {
super.onPause();
mInputManager.unregisterInputDeviceListener(this);
unregisterSettingsObserver();
}
@Override
protected String getLogTag() {
return TAG;
}
@Override
protected int getPreferenceScreenResId() {
return R.xml.repeat_key_main_page;
}
private void updatePreferencesState() {
boolean isRepeatKeyEnabled = InputSettings.isRepeatKeysEnabled(getContext());
if (mRepeatTimeoutPreference != null && mRepeatDelayPreference != null) {
mRepeatTimeoutPreference.setEnabled(isRepeatKeyEnabled);
mRepeatDelayPreference.setEnabled(isRepeatKeyEnabled);
}
}
private void registerSettingsObserver() {
unregisterSettingsObserver();
mContentResolver.registerContentObserver(
mRepeatKeyUri,
false,
mContentObserver,
UserHandle.myUserId());
}
private void unregisterSettingsObserver() {
mContentResolver.unregisterContentObserver(mContentObserver);
}
@Override
public void onInputDeviceAdded(int deviceId) {
finishEarlyIfNeeded();
}
@Override
public void onInputDeviceRemoved(int deviceId) {
finishEarlyIfNeeded();
}
@Override
public void onInputDeviceChanged(int deviceId) {
finishEarlyIfNeeded();
}
private void finishEarlyIfNeeded() {
final Context context = getContext();
ThreadUtils.postOnBackgroundThread(() -> {
final List<PhysicalKeyboardFragment.HardKeyboardDeviceInfo> newHardKeyboards =
getHardKeyboards(context);
if (newHardKeyboards.isEmpty()) {
getActivity().finish();
}
});
}
public static final BaseSearchIndexProvider SEARCH_INDEX_DATA_PROVIDER =
new BaseSearchIndexProvider(R.xml.repeat_key_main_page) {
@Override
protected boolean isPageSearchEnabled(Context context) {
return Flags.keyboardAndTouchpadA11yNewPageEnabled()
&& !getHardKeyboards(context).isEmpty();
}
};
}

View File

@@ -0,0 +1,66 @@
/*
* Copyright 2024 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.content.Context;
import android.hardware.input.InputSettings;
import androidx.annotation.NonNull;
import com.android.internal.annotations.VisibleForTesting;
import com.android.settings.core.SliderPreferenceController;
import com.google.common.collect.ImmutableList;
public class KeyboardRepeatKeysTimeOutPreferenceController extends SliderPreferenceController {
@VisibleForTesting
static final ImmutableList<Integer> REPEAT_KEY_TIMEOUT_VALUE_LIST = ImmutableList.of(2000, 1500,
1000, 400, 300, 200, 150);
public KeyboardRepeatKeysTimeOutPreferenceController(
@NonNull Context context,
@NonNull String preferenceKey) {
super(context, preferenceKey);
}
@Override
public int getSliderPosition() {
return REPEAT_KEY_TIMEOUT_VALUE_LIST.indexOf(InputSettings.getRepeatKeysTimeout(mContext));
}
@Override
public boolean setSliderPosition(int position) {
InputSettings.setRepeatKeysTimeout(mContext, REPEAT_KEY_TIMEOUT_VALUE_LIST.get(position));
return true;
}
@Override
public int getMax() {
return REPEAT_KEY_TIMEOUT_VALUE_LIST.size() - 1;
}
@Override
public int getMin() {
return 0;
}
@Override
public int getAvailabilityStatus() {
return InputSettings.isRepeatKeysFeatureFlagEnabled()
? AVAILABLE : UNSUPPORTED_ON_DEVICE;
}
}

View File

@@ -51,7 +51,7 @@ public class KeyboardRepeatKeysControllerTest {
public void setUp() {
mContext = RuntimeEnvironment.application;
mKeyboardRepeatKeysController = new KeyboardRepeatKeysController(mContext,
"physical_keyboard_repeat_key");
"physical_keyboard_repeat_keys");
}
@Test

View File

@@ -0,0 +1,86 @@
/*
* Copyright 2024 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 static com.android.input.flags.Flags.FLAG_KEYBOARD_REPEAT_KEYS;
import static com.google.common.truth.Truth.assertThat;
import android.content.Context;
import android.hardware.input.InputSettings;
import android.platform.test.annotations.DisableFlags;
import android.platform.test.annotations.EnableFlags;
import android.platform.test.flag.junit.SetFlagsRule;
import com.android.settings.core.BasePreferenceController;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
@RunWith(RobolectricTestRunner.class)
@Config(shadows = {
com.android.settings.testutils.shadow.ShadowFragment.class,
})
public class KeyboardRepeatKeysDelayPreferenceControllerTest {
@Rule
public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();
private Context mContext;
private KeyboardRepeatKeysDelayPreferenceController mRepeatKeysDelayPreferenceController;
@Before
public void setUp() {
mContext = RuntimeEnvironment.application;
mRepeatKeysDelayPreferenceController = new KeyboardRepeatKeysDelayPreferenceController(
mContext, "repeat_keys_delay_preference");
}
@Test
@EnableFlags(FLAG_KEYBOARD_REPEAT_KEYS)
public void getAvailabilityStatus_flagIsEnabled_isAvailable() {
assertThat(mRepeatKeysDelayPreferenceController.getAvailabilityStatus())
.isEqualTo(BasePreferenceController.AVAILABLE);
}
@Test
@DisableFlags(FLAG_KEYBOARD_REPEAT_KEYS)
public void getAvailabilityStatus_flagIsDisabled_notSupport() {
assertThat(mRepeatKeysDelayPreferenceController.getAvailabilityStatus())
.isEqualTo(BasePreferenceController.UNSUPPORTED_ON_DEVICE);
}
@Test
public void setSliderPosition_updatesInputSettingValue() {
int sliderPosition = 1;
mRepeatKeysDelayPreferenceController.setSliderPosition(sliderPosition);
assertThat(InputSettings.getRepeatKeysDelay(mContext)).isEqualTo(
KeyboardRepeatKeysDelayPreferenceController.REPEAT_KEY_DELAY_VALUE_LIST.get(
sliderPosition));
}
@Test
public void getSliderPosition_matchesWithDelayValue() {
int timeout = InputSettings.getRepeatKeysDelay(mContext);
assertThat(mRepeatKeysDelayPreferenceController.getSliderPosition()).isEqualTo(
KeyboardRepeatKeysDelayPreferenceController.REPEAT_KEY_DELAY_VALUE_LIST.indexOf(
timeout));
}
}

View File

@@ -0,0 +1,88 @@
/*
* Copyright 2024 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 static com.android.input.flags.Flags.FLAG_KEYBOARD_REPEAT_KEYS;
import static com.google.common.truth.Truth.assertThat;
import android.content.Context;
import android.hardware.input.InputSettings;
import android.platform.test.annotations.DisableFlags;
import android.platform.test.annotations.EnableFlags;
import android.platform.test.flag.junit.SetFlagsRule;
import com.android.settings.core.BasePreferenceController;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.robolectric.RobolectricTestRunner;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.Config;
@RunWith(RobolectricTestRunner.class)
@Config(shadows = {
com.android.settings.testutils.shadow.ShadowFragment.class,
})
public class KeyboardRepeatKeysTimeOutPreferenceControllerTest {
@Rule
public final SetFlagsRule mSetFlagsRule = new SetFlagsRule();
private Context mContext;
private KeyboardRepeatKeysTimeOutPreferenceController
mKeyboardRepeatKeysTimeOutPreferenceController;
@Before
public void setUp() {
mContext = RuntimeEnvironment.application;
mKeyboardRepeatKeysTimeOutPreferenceController =
new KeyboardRepeatKeysTimeOutPreferenceController(mContext,
"repeat_keys_timeout_preference");
}
@Test
@EnableFlags(FLAG_KEYBOARD_REPEAT_KEYS)
public void getAvailabilityStatus_flagIsEnabled_isAvailable() {
assertThat(mKeyboardRepeatKeysTimeOutPreferenceController.getAvailabilityStatus())
.isEqualTo(BasePreferenceController.AVAILABLE);
}
@Test
@DisableFlags(FLAG_KEYBOARD_REPEAT_KEYS)
public void getAvailabilityStatus_flagIsDisabled_notSupport() {
assertThat(mKeyboardRepeatKeysTimeOutPreferenceController.getAvailabilityStatus())
.isEqualTo(BasePreferenceController.UNSUPPORTED_ON_DEVICE);
}
@Test
public void setSliderPosition_updatesInputSettingValue() {
int sliderPosition = 1;
mKeyboardRepeatKeysTimeOutPreferenceController.setSliderPosition(sliderPosition);
assertThat(InputSettings.getRepeatKeysTimeout(mContext)).isEqualTo(
KeyboardRepeatKeysTimeOutPreferenceController.REPEAT_KEY_TIMEOUT_VALUE_LIST.get(
sliderPosition));
}
@Test
public void getSliderPosition_matchesWithTimeoutValue() {
int timeout = InputSettings.getRepeatKeysTimeout(mContext);
assertThat(mKeyboardRepeatKeysTimeOutPreferenceController.getSliderPosition()).isEqualTo(
KeyboardRepeatKeysTimeOutPreferenceController.REPEAT_KEY_TIMEOUT_VALUE_LIST.indexOf(
timeout));
}
}