diff --git a/src/com/android/settings/accessibility/AccessibilityQuickSettingsPrimarySwitchPreferenceController.java b/src/com/android/settings/accessibility/AccessibilityQuickSettingsPrimarySwitchPreferenceController.java new file mode 100644 index 00000000000..33b6deb82b9 --- /dev/null +++ b/src/com/android/settings/accessibility/AccessibilityQuickSettingsPrimarySwitchPreferenceController.java @@ -0,0 +1,124 @@ +/* + * Copyright (C) 2022 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.ComponentName; +import android.content.Context; +import android.os.Bundle; +import android.os.Handler; + +import androidx.preference.PreferenceScreen; + +import com.android.settings.R; +import com.android.settings.core.TogglePreferenceController; +import com.android.settingslib.PrimarySwitchPreference; +import com.android.settingslib.core.lifecycle.LifecycleObserver; +import com.android.settingslib.core.lifecycle.events.OnCreate; +import com.android.settingslib.core.lifecycle.events.OnSaveInstanceState; + +/** PrimarySwitchPreferenceController that shows quick settings tooltip on first use. */ +public abstract class AccessibilityQuickSettingsPrimarySwitchPreferenceController + extends TogglePreferenceController + implements LifecycleObserver, OnCreate, OnSaveInstanceState { + private static final String KEY_SAVED_QS_TOOLTIP_RESHOW = "qs_tooltip_reshow"; + private final Handler mHandler; + private PrimarySwitchPreference mPreference; + private AccessibilityQuickSettingsTooltipWindow mTooltipWindow; + private boolean mNeedsQSTooltipReshow = false; + + /** Returns the accessibility tile component name. */ + abstract ComponentName getTileComponentName(); + + /** Returns the accessibility tile tooltip content. */ + abstract CharSequence getTileTooltipContent(); + + public AccessibilityQuickSettingsPrimarySwitchPreferenceController(Context context, + String preferenceKey) { + super(context, preferenceKey); + mHandler = new Handler(context.getMainLooper()); + } + + @Override + public void onCreate(Bundle savedInstanceState) { + // Restore the tooltip. + if (savedInstanceState != null) { + if (savedInstanceState.containsKey(KEY_SAVED_QS_TOOLTIP_RESHOW)) { + mNeedsQSTooltipReshow = savedInstanceState.getBoolean(KEY_SAVED_QS_TOOLTIP_RESHOW); + } + } + } + + @Override + public void onSaveInstanceState(Bundle outState) { + if (mTooltipWindow != null) { + outState.putBoolean(KEY_SAVED_QS_TOOLTIP_RESHOW, mTooltipWindow.isShowing()); + } + } + + @Override + public void displayPreference(PreferenceScreen screen) { + super.displayPreference(screen); + mPreference = screen.findPreference(getPreferenceKey()); + if (mNeedsQSTooltipReshow) { + mHandler.post(this::showQuickSettingsTooltipIfNeeded); + } + } + + @Override + public boolean setChecked(boolean isChecked) { + if (isChecked) { + showQuickSettingsTooltipIfNeeded(); + } + return isChecked; + } + + @Override + public boolean isChecked() { + return false; + } + + @Override + public int getAvailabilityStatus() { + return AVAILABLE; + } + + @Override + public int getSliceHighlightMenuRes() { + return R.string.menu_key_accessibility; + } + + private void showQuickSettingsTooltipIfNeeded() { + final ComponentName tileComponentName = getTileComponentName(); + if (tileComponentName == null) { + // Returns if no tile service assigned. + return; + } + + if (!mNeedsQSTooltipReshow && AccessibilityQuickSettingUtils.hasValueInSharedPreferences( + mContext, tileComponentName)) { + // Returns if quick settings tooltip only show once. + return; + } + + mTooltipWindow = new AccessibilityQuickSettingsTooltipWindow(mContext); + mTooltipWindow.setup(getTileTooltipContent(), + R.drawable.accessibility_auto_added_qs_tooltips_illustration); + mTooltipWindow.showAtTopCenter(mPreference.getSwitch()); + AccessibilityQuickSettingUtils.optInValueToSharedPreferences(mContext, tileComponentName); + mNeedsQSTooltipReshow = false; + } +} diff --git a/src/com/android/settings/accessibility/ReduceBrightColorsPreferenceController.java b/src/com/android/settings/accessibility/ReduceBrightColorsPreferenceController.java index 2018e059693..7b40024ca54 100644 --- a/src/com/android/settings/accessibility/ReduceBrightColorsPreferenceController.java +++ b/src/com/android/settings/accessibility/ReduceBrightColorsPreferenceController.java @@ -16,6 +16,9 @@ package com.android.settings.accessibility; +import static com.android.internal.accessibility.AccessibilityShortcutController.REDUCE_BRIGHT_COLORS_TILE_SERVICE_COMPONENT_NAME; + +import android.content.ComponentName; import android.content.Context; import android.database.ContentObserver; import android.hardware.display.ColorDisplayManager; @@ -30,14 +33,14 @@ import androidx.preference.Preference; import androidx.preference.PreferenceScreen; import com.android.settings.R; -import com.android.settings.core.TogglePreferenceController; import com.android.settingslib.PrimarySwitchPreference; import com.android.settingslib.core.lifecycle.LifecycleObserver; import com.android.settingslib.core.lifecycle.events.OnStart; import com.android.settingslib.core.lifecycle.events.OnStop; /** PreferenceController that shows the Reduce Bright Colors summary */ -public class ReduceBrightColorsPreferenceController extends TogglePreferenceController +public class ReduceBrightColorsPreferenceController + extends AccessibilityQuickSettingsPrimarySwitchPreferenceController implements LifecycleObserver, OnStart, OnStop { private ContentObserver mSettingsContentObserver; private PrimarySwitchPreference mPreference; @@ -67,6 +70,7 @@ public class ReduceBrightColorsPreferenceController extends TogglePreferenceCont @Override public boolean setChecked(boolean isChecked) { + super.setChecked(isChecked); return mColorDisplayManager.setReduceBrightColorsActivated(isChecked); } @@ -105,8 +109,20 @@ public class ReduceBrightColorsPreferenceController extends TogglePreferenceCont Settings.Secure.REDUCE_BRIGHT_COLORS_ACTIVATED), false, mSettingsContentObserver, UserHandle.USER_CURRENT); } + @Override public void onStop() { mContext.getContentResolver().unregisterContentObserver(mSettingsContentObserver); } + + @Override + protected ComponentName getTileComponentName() { + return REDUCE_BRIGHT_COLORS_TILE_SERVICE_COMPONENT_NAME; + } + + @Override + CharSequence getTileTooltipContent() { + return mContext.getText( + R.string.accessibility_reduce_bright_colors_auto_added_qs_tooltip_content); + } } diff --git a/tests/robotests/src/com/android/settings/accessibility/AccessibilityQuickSettingsPrimarySwitchPreferenceControllerTest.java b/tests/robotests/src/com/android/settings/accessibility/AccessibilityQuickSettingsPrimarySwitchPreferenceControllerTest.java new file mode 100644 index 00000000000..89c91209ffd --- /dev/null +++ b/tests/robotests/src/com/android/settings/accessibility/AccessibilityQuickSettingsPrimarySwitchPreferenceControllerTest.java @@ -0,0 +1,186 @@ +/* + * Copyright (C) 2022 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.ToggleFeaturePreferenceFragment.KEY_SAVED_QS_TOOLTIP_RESHOW; + +import static com.google.common.truth.Truth.assertThat; + +import static org.mockito.Mockito.doReturn; +import static org.mockito.Mockito.spy; +import static org.mockito.Mockito.when; + +import android.content.ComponentName; +import android.content.Context; +import android.os.Bundle; +import android.view.LayoutInflater; +import android.widget.LinearLayout; +import android.widget.PopupWindow; + +import androidx.preference.PreferenceManager; +import androidx.preference.PreferenceScreen; +import androidx.preference.PreferenceViewHolder; +import androidx.test.core.app.ApplicationProvider; + +import com.android.settings.R; +import com.android.settings.SettingsPreferenceFragment; +import com.android.settings.testutils.shadow.ShadowFragment; +import com.android.settingslib.PrimarySwitchPreference; + +import org.junit.Before; +import org.junit.Rule; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Answers; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.mockito.Spy; +import org.mockito.junit.MockitoJUnit; +import org.mockito.junit.MockitoRule; +import org.robolectric.RobolectricTestRunner; +import org.robolectric.annotation.Config; +import org.robolectric.shadow.api.Shadow; +import org.robolectric.shadows.ShadowApplication; + +/** + * Tests for {@link AccessibilityQuickSettingsPrimarySwitchPreferenceController}. + */ +@RunWith(RobolectricTestRunner.class) +public class AccessibilityQuickSettingsPrimarySwitchPreferenceControllerTest { + + private static final String PLACEHOLDER_PACKAGE_NAME = "com.placeholder.example"; + private static final String PLACEHOLDER_TILE_CLASS_NAME = + PLACEHOLDER_PACKAGE_NAME + "tile.placeholder"; + private static final ComponentName PLACEHOLDER_TILE_COMPONENT_NAME = new ComponentName( + PLACEHOLDER_PACKAGE_NAME, PLACEHOLDER_TILE_CLASS_NAME); + private static final CharSequence PLACEHOLDER_TILE_CONTENT = + PLACEHOLDER_TILE_CLASS_NAME + ".tile.content"; + private static final String TEST_KEY = "test_pref_key"; + private static final String TEST_TITLE = "test_title"; + + @Rule + public final MockitoRule mockito = MockitoJUnit.rule(); + + @Spy + private final Context mContext = ApplicationProvider.getApplicationContext(); + + private TestAccessibilityQuickSettingsPrimarySwitchPreferenceController mController; + private PrimarySwitchPreference mPreference; + private TestFragment mFragment; + private PreferenceScreen mScreen; + private PreferenceViewHolder mHolder; + @Mock(answer = Answers.RETURNS_DEEP_STUBS) + private PreferenceManager mPreferenceManager; + + private static PopupWindow getLatestPopupWindow() { + final ShadowApplication shadowApplication = + Shadow.extract(ApplicationProvider.getApplicationContext()); + return shadowApplication.getLatestPopupWindow(); + } + + @Before + public void setUp() { + MockitoAnnotations.initMocks(this); + + mContext.setTheme(R.style.Theme_AppCompat); + mFragment = spy(new TestFragment()); + when(mFragment.getPreferenceManager()).thenReturn(mPreferenceManager); + when(mFragment.getPreferenceManager().getContext()).thenReturn(mContext); + when(mFragment.getContext()).thenReturn(mContext); + mScreen = spy(new PreferenceScreen(mContext, /* attrs= */ null)); + when(mScreen.getPreferenceManager()).thenReturn(mPreferenceManager); + doReturn(mScreen).when(mFragment).getPreferenceScreen(); + + mPreference = new PrimarySwitchPreference(mContext); + mPreference.setKey(TEST_KEY); + mPreference.setTitle(TEST_TITLE); + LayoutInflater inflater = LayoutInflater.from(mContext); + mHolder = PreferenceViewHolder.createInstanceForTests(inflater.inflate( + com.android.settingslib.R.layout.preference_two_target, null)); + LinearLayout mWidgetView = mHolder.itemView.findViewById(android.R.id.widget_frame); + inflater.inflate(R.layout.preference_widget_primary_switch, mWidgetView, true); + mPreference.onBindViewHolder(mHolder); + + mController = new TestAccessibilityQuickSettingsPrimarySwitchPreferenceController(mContext, + TEST_KEY); + when(mScreen.findPreference(mController.getPreferenceKey())).thenReturn(mPreference); + mController.displayPreference(mScreen); + } + + @Test + public void setChecked_showTooltipView() { + mController.setChecked(true); + + assertThat(getLatestPopupWindow().isShowing()).isTrue(); + } + + @Test + public void setChecked_tooltipViewShown_notShowTooltipView() { + mController.setChecked(true); + getLatestPopupWindow().dismiss(); + mController.setChecked(false); + + mController.setChecked(true); + + assertThat(getLatestPopupWindow().isShowing()).isFalse(); + } + + @Test + @Config(shadows = ShadowFragment.class) + public void restoreValueFromSavedInstanceState_showTooltipView() { + mController.setChecked(true); + final Bundle savedInstanceState = new Bundle(); + savedInstanceState.putBoolean(KEY_SAVED_QS_TOOLTIP_RESHOW, /* value= */ true); + + mFragment.onCreate(savedInstanceState); + mController.displayPreference(mScreen); + + assertThat(getLatestPopupWindow().isShowing()).isTrue(); + } + + public static class TestAccessibilityQuickSettingsPrimarySwitchPreferenceController + extends AccessibilityQuickSettingsPrimarySwitchPreferenceController { + + public TestAccessibilityQuickSettingsPrimarySwitchPreferenceController(Context context, + String preferenceKey) { + super(context, preferenceKey); + } + + @Override + ComponentName getTileComponentName() { + return PLACEHOLDER_TILE_COMPONENT_NAME; + } + + @Override + CharSequence getTileTooltipContent() { + return PLACEHOLDER_TILE_CONTENT; + } + } + + private static class TestFragment extends SettingsPreferenceFragment { + + @Override + protected boolean shouldSkipForInitialSUW() { + return false; + } + + @Override + public int getMetricsCategory() { + return 0; + } + } +}