Add a done button to vision setting pages in setup flow

Root cause: User feels confused because the particular screen doesn't have a back button but at that moment of the setup flow the regular UI gestures didn't even work.
Solution: Add a done button to the vision settings pages for clearer navigation.

Bug: 262995569
Test: make RunSettingsRoboTests ROBOTEST_FILTER=FragmentForSetupWizardTest
Change-Id: Id3a0d78389e0e6c11b5b5cf016b37673fde7f286

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

@@ -16,6 +16,8 @@
 
 package com.android.settings.accessibility;
 
+import static android.app.Activity.RESULT_CANCELED;
+
 import static com.android.settings.Utils.getAdaptiveIcon;
 import static com.android.settingslib.widget.TwoTargetPreference.ICON_SIZE_MEDIUM;
 
@@ -41,6 +43,7 @@ import com.android.settings.R;
 import com.android.settings.dashboard.DashboardFragment;
 import com.android.settingslib.RestrictedPreference;
 
+import com.google.android.setupcompat.template.FooterBarMixin;
 import com.google.android.setupdesign.GlifPreferenceLayout;
 
 import java.util.List;
@@ -90,6 +93,12 @@ public class AccessibilitySettingsForSetupWizard extends DashboardFragment
         final Drawable icon = getContext().getDrawable(R.drawable.ic_accessibility_visibility);
         AccessibilitySetupWizardUtils.updateGlifPreferenceLayout(getContext(), layout, title,
                 description, icon);
+
+        final FooterBarMixin mixin = layout.getMixin(FooterBarMixin.class);
+        AccessibilitySetupWizardUtils.setPrimaryButton(getContext(), mixin, R.string.done, () -> {
+            setResult(RESULT_CANCELED);
+            finish();
+        });
     }
 
     @Override

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

@@ -19,8 +19,13 @@ import android.content.Context;
 import android.graphics.drawable.Drawable;
 import android.widget.LinearLayout;
 
+import androidx.annotation.StringRes;
+
 import com.android.settings.R;
 
+import com.google.android.setupcompat.template.FooterBarMixin;
+import com.google.android.setupcompat.template.FooterButton;
+import com.google.android.setupcompat.template.Mixin;
 import com.google.android.setupdesign.GlifPreferenceLayout;
 import com.google.android.setupdesign.util.ThemeHelper;
 
@@ -30,7 +35,7 @@ class AccessibilitySetupWizardUtils {
     private AccessibilitySetupWizardUtils(){}
 
     /**
-     * Update the {@link GlifPreferenceLayout} attributes if they have previously been initialized.
+     * Updates the {@link GlifPreferenceLayout} attributes if they have previously been initialized.
      * When the SetupWizard supports the extended partner configs, it means the material layout
      * would be applied. It should set a different padding/margin in views to align Settings style
      * for accessibility feature pages.
@@ -55,4 +60,46 @@ class AccessibilitySetupWizardUtils {
             }
         }
     }
+
+    /**
+     * Sets primary button for footer of the {@link GlifPreferenceLayout}.
+     *
+     * <p> This will be the initial by given material theme style.
+     *
+     * @param context A {@link Context}
+     * @param mixin A {@link Mixin} for managing buttons.
+     * @param text The {@code text} by resource.
+     * @param runnable The {@link Runnable} to run.
+     */
+    public static void setPrimaryButton(Context context, FooterBarMixin mixin, @StringRes int text,
+            Runnable runnable) {
+        mixin.setPrimaryButton(
+                new FooterButton.Builder(context)
+                        .setText(text)
+                        .setListener(l -> runnable.run())
+                        .setButtonType(FooterButton.ButtonType.DONE)
+                        .setTheme(R.style.SudGlifButton_Primary)
+                        .build());
+    }
+
+    /**
+     * Sets secondary button for the footer of the {@link GlifPreferenceLayout}.
+     *
+     * <p> This will be the initial by given material theme style.
+     *
+     * @param context A {@link Context}
+     * @param mixin A {@link Mixin} for managing buttons.
+     * @param text The {@code text} by resource.
+     * @param runnable The {@link Runnable} to run.
+     */
+    public static void setSecondaryButton(Context context, FooterBarMixin mixin,
+            @StringRes int text, Runnable runnable) {
+        mixin.setSecondaryButton(
+                new FooterButton.Builder(context)
+                        .setText(text)
+                        .setListener(l -> runnable.run())
+                        .setButtonType(FooterButton.ButtonType.CLEAR)
+                        .setTheme(R.style.SudGlifButton_Secondary)
+                        .build());
+    }
 }

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

@@ -33,7 +33,6 @@ import com.android.settings.R;
 import com.android.settingslib.Utils;
 
 import com.google.android.setupcompat.template.FooterBarMixin;
-import com.google.android.setupcompat.template.FooterButton;
 import com.google.android.setupdesign.GlifPreferenceLayout;
 
 /**
@@ -55,26 +54,14 @@ public class TextReadingPreferenceFragmentForSetupWizard extends TextReadingPref
                 /* description= */ null, icon);
 
         final FooterBarMixin mixin = layout.getMixin(FooterBarMixin.class);
-        mixin.setSecondaryButton(
+        AccessibilitySetupWizardUtils.setPrimaryButton(getContext(), mixin, R.string.done, () -> {
-                new FooterButton.Builder(getContext())
+            setResult(RESULT_CANCELED);
-                        .setText(R.string.accessibility_text_reading_reset_button_title)
+            finish();
-                        .setListener(l -> showDialog(DIALOG_RESET_SETTINGS))
+        });
-                        .setButtonType(FooterButton.ButtonType.CLEAR)
+        AccessibilitySetupWizardUtils.setSecondaryButton(getContext(), mixin,
-                        .setTheme(R.style.SudGlifButton_Secondary)
+                R.string.accessibility_text_reading_reset_button_title,
-                        .build());
+                () -> showDialog(DIALOG_RESET_SETTINGS)
-
+        );
-        if (isCallingFromAnythingElseEntryPoint()) {
-            mixin.setPrimaryButton(
-                    new FooterButton.Builder(getContext())
-                            .setText(R.string.done)
-                            .setListener(l -> {
-                                setResult(RESULT_CANCELED);
-                                finish();
-                            })
-                            .setButtonType(FooterButton.ButtonType.DONE)
-                            .setTheme(R.style.SudGlifButton_Primary)
-                            .build());
-        }
     }
 
     @Override

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

@@ -16,6 +16,8 @@
 
 package com.android.settings.accessibility;
 
+import static android.app.Activity.RESULT_CANCELED;
+
 import android.app.settings.SettingsEnums;
 import android.graphics.drawable.Drawable;
 import android.os.Bundle;
@@ -27,6 +29,7 @@ import androidx.recyclerview.widget.RecyclerView;
 
 import com.android.settings.R;
 
+import com.google.android.setupcompat.template.FooterBarMixin;
 import com.google.android.setupdesign.GlifPreferenceLayout;
 
 public class ToggleScreenMagnificationPreferenceFragmentForSetupWizard
@@ -44,6 +47,13 @@ public class ToggleScreenMagnificationPreferenceFragmentForSetupWizard
         final Drawable icon = getContext().getDrawable(R.drawable.ic_accessibility_visibility);
         AccessibilitySetupWizardUtils.updateGlifPreferenceLayout(getContext(), layout, title,
                 description, icon);
+
+        final FooterBarMixin mixin = layout.getMixin(FooterBarMixin.class);
+        AccessibilitySetupWizardUtils.setPrimaryButton(getContext(), mixin, R.string.done, () -> {
+            setResult(RESULT_CANCELED);
+            finish();
+        });
+
         hidePreferenceSettingComponents();
     }
 

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

@@ -16,6 +16,8 @@
 
 package com.android.settings.accessibility;
 
+import static android.app.Activity.RESULT_CANCELED;
+
 import android.app.settings.SettingsEnums;
 import android.graphics.drawable.Drawable;
 import android.os.Bundle;
@@ -27,6 +29,7 @@ import androidx.recyclerview.widget.RecyclerView;
 
 import com.android.settings.R;
 
+import com.google.android.setupcompat.template.FooterBarMixin;
 import com.google.android.setupdesign.GlifPreferenceLayout;
 
 public class ToggleScreenReaderPreferenceFragmentForSetupWizard
@@ -45,6 +48,12 @@ public class ToggleScreenReaderPreferenceFragmentForSetupWizard
         AccessibilitySetupWizardUtils.updateGlifPreferenceLayout(getContext(), layout, title,
                 description, icon);
 
+        final FooterBarMixin mixin = layout.getMixin(FooterBarMixin.class);
+        AccessibilitySetupWizardUtils.setPrimaryButton(getContext(), mixin, R.string.done, () -> {
+            setResult(RESULT_CANCELED);
+            finish();
+        });
+
         mToggleSwitchWasInitiallyChecked = mToggleServiceSwitchPreference.isChecked();
         if (mTopIntroPreference != null) {
             mTopIntroPreference.setVisible(false);

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

@@ -16,6 +16,8 @@
 
 package com.android.settings.accessibility;
 
+import static android.app.Activity.RESULT_CANCELED;
+
 import android.app.settings.SettingsEnums;
 import android.graphics.drawable.Drawable;
 import android.os.Bundle;
@@ -27,6 +29,7 @@ import androidx.recyclerview.widget.RecyclerView;
 
 import com.android.settings.R;
 
+import com.google.android.setupcompat.template.FooterBarMixin;
 import com.google.android.setupdesign.GlifPreferenceLayout;
 
 public class ToggleSelectToSpeakPreferenceFragmentForSetupWizard
@@ -45,6 +48,12 @@ public class ToggleSelectToSpeakPreferenceFragmentForSetupWizard
         AccessibilitySetupWizardUtils.updateGlifPreferenceLayout(getContext(), layout, title,
                 description, icon);
 
+        final FooterBarMixin mixin = layout.getMixin(FooterBarMixin.class);
+        AccessibilitySetupWizardUtils.setPrimaryButton(getContext(), mixin, R.string.done, () -> {
+            setResult(RESULT_CANCELED);
+            finish();
+        });
+
         mToggleSwitchWasInitiallyChecked = mToggleServiceSwitchPreference.isChecked();
         if (mTopIntroPreference != null) {
             mTopIntroPreference.setVisible(false);

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

@@ -23,6 +23,7 @@ import static com.android.settings.accessibility.AccessibilitySettingsForSetupWi
 
 import static com.google.common.truth.Truth.assertThat;
 
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.spy;
@@ -45,6 +46,7 @@ import androidx.test.core.app.ApplicationProvider;
 import com.android.settings.R;
 import com.android.settingslib.RestrictedPreference;
 
+import com.google.android.setupcompat.template.FooterBarMixin;
 import com.google.android.setupdesign.GlifPreferenceLayout;
 
 import org.junit.Before;
@@ -79,6 +81,8 @@ public class AccessibilitySettingsForSetupWizardTest {
     private FragmentActivity mActivity;
     @Mock
     private GlifPreferenceLayout mGlifLayoutView;
+    @Mock
+    private FooterBarMixin mFooterBarMixin;
     private AccessibilitySettingsForSetupWizard mFragment;
 
     @Before
@@ -89,6 +93,7 @@ public class AccessibilitySettingsForSetupWizardTest {
         when(mAccessibilityManager.getInstalledAccessibilityServiceList()).thenReturn(
                 mAccessibilityServices);
         doReturn(mActivity).when(mFragment).getActivity();
+        doReturn(mFooterBarMixin).when(mGlifLayoutView).getMixin(FooterBarMixin.class);
     }
 
     @Test
@@ -99,6 +104,7 @@ public class AccessibilitySettingsForSetupWizardTest {
                 mContext.getString(R.string.vision_settings_title));
         verify(mGlifLayoutView).setDescriptionText(
                 mContext.getString(R.string.vision_settings_description));
+        verify(mFooterBarMixin).setPrimaryButton(any());
     }
 
     @Test

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

@@ -100,19 +100,10 @@ public class TextReadingPreferenceFragmentForSetupWizardTest {
     }
 
     @Test
-    public void onViewCreated_verifySetSecondaryButton() {
+    public void onViewCreated_verifyAction() {
-        mFragment.onViewCreated(mGlifLayoutView, null);
-
-        verify(mFooterBarMixin).setSecondaryButton(any());
-    }
-
-    @Test
-    public void onViewCreated_verifySetPrimaryButton() {
-        doReturn(mActivity).when(mFragment).getActivity();
-        doReturn("setupwizard").when(mActivity).getCallingPackage();
-
         mFragment.onViewCreated(mGlifLayoutView, null);
 
         verify(mFooterBarMixin).setPrimaryButton(any());
+        verify(mFooterBarMixin).setSecondaryButton(any());
     }
 }

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

@@ -18,6 +18,7 @@ package com.android.settings.accessibility;
 
 import static com.google.common.truth.Truth.assertThat;
 
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.verify;
@@ -38,6 +39,7 @@ import com.android.settings.testutils.shadow.ShadowSettingsPreferenceFragment;
 import com.android.settings.widget.SettingsMainSwitchBar;
 import com.android.settingslib.widget.TopIntroPreference;
 
+import com.google.android.setupcompat.template.FooterBarMixin;
 import com.google.android.setupdesign.GlifPreferenceLayout;
 
 import org.junit.Before;
@@ -64,6 +66,8 @@ public class ToggleScreenMagnificationPreferenceFragmentForSetupWizardTest {
     private GlifPreferenceLayout mGlifLayoutView;
     @Mock
     private SettingsMainSwitchBar mSwitchBar;
+    @Mock
+    private FooterBarMixin mFooterBarMixin;
     private ToggleScreenMagnificationPreferenceFragmentForSetupWizard mFragment;
 
     @Before
@@ -72,6 +76,7 @@ public class ToggleScreenMagnificationPreferenceFragmentForSetupWizardTest {
                 spy(new TestToggleScreenMagnificationPreferenceFragmentForSetupWizard(mContext));
         doReturn(mActivity).when(mFragment).getActivity();
         when(mActivity.getSwitchBar()).thenReturn(mSwitchBar);
+        doReturn(mFooterBarMixin).when(mGlifLayoutView).getMixin(FooterBarMixin.class);
     }
 
     @Test
@@ -83,6 +88,7 @@ public class ToggleScreenMagnificationPreferenceFragmentForSetupWizardTest {
         verify(mGlifLayoutView).setDescriptionText(
                 mContext.getString(R.string.accessibility_screen_magnification_intro_text));
         verify(mGlifLayoutView).setDividerInsets(Integer.MAX_VALUE, 0);
+        verify(mFooterBarMixin).setPrimaryButton(any());
         assertThat(mFragment.mTopIntroPreference.isVisible()).isFalse();
         assertThat(mFragment.mSettingsPreference.isVisible()).isFalse();
         assertThat(mFragment.mFollowingTypingSwitchPreference.isVisible()).isFalse();

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

@@ -18,6 +18,7 @@ package com.android.settings.accessibility;
 
 import static com.google.common.truth.Truth.assertThat;
 
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.verify;
@@ -37,6 +38,7 @@ import com.android.settings.widget.SettingsMainSwitchBar;
 import com.android.settings.widget.SettingsMainSwitchPreference;
 import com.android.settingslib.widget.TopIntroPreference;
 
+import com.google.android.setupcompat.template.FooterBarMixin;
 import com.google.android.setupdesign.GlifPreferenceLayout;
 
 import org.junit.Before;
@@ -62,6 +64,8 @@ public class ToggleScreenReaderPreferenceFragmentForSetupWizardTest {
     private GlifPreferenceLayout mGlifLayoutView;
     @Mock
     private SettingsMainSwitchBar mSwitchBar;
+    @Mock
+    private FooterBarMixin mFooterBarMixin;
     private ToggleScreenReaderPreferenceFragmentForSetupWizard mFragment;
 
     @Before
@@ -69,6 +73,7 @@ public class ToggleScreenReaderPreferenceFragmentForSetupWizardTest {
         mFragment = spy(new TestToggleScreenReaderPreferenceFragmentForSetupWizard(mContext));
         doReturn(mActivity).when(mFragment).getActivity();
         when(mActivity.getSwitchBar()).thenReturn(mSwitchBar);
+        doReturn(mFooterBarMixin).when(mGlifLayoutView).getMixin(FooterBarMixin.class);
     }
 
     @Test
@@ -79,6 +84,7 @@ public class ToggleScreenReaderPreferenceFragmentForSetupWizardTest {
         verify(mGlifLayoutView).setDescriptionText(
                 mContext.getString(R.string.talkback_summary));
         verify(mGlifLayoutView).setDividerInsets(Integer.MAX_VALUE, 0);
+        verify(mFooterBarMixin).setPrimaryButton(any());
         assertThat(mFragment.mTopIntroPreference.isVisible()).isFalse();
     }
 

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

@@ -18,6 +18,7 @@ package com.android.settings.accessibility;
 
 import static com.google.common.truth.Truth.assertThat;
 
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.verify;
@@ -37,6 +38,7 @@ import com.android.settings.widget.SettingsMainSwitchBar;
 import com.android.settings.widget.SettingsMainSwitchPreference;
 import com.android.settingslib.widget.TopIntroPreference;
 
+import com.google.android.setupcompat.template.FooterBarMixin;
 import com.google.android.setupdesign.GlifPreferenceLayout;
 
 import org.junit.Before;
@@ -62,6 +64,8 @@ public class ToggleSelectToSpeakPreferenceFragmentForSetupWizardTest {
     private GlifPreferenceLayout mGlifLayoutView;
     @Mock
     private SettingsMainSwitchBar mSwitchBar;
+    @Mock
+    private FooterBarMixin mFooterBarMixin;
     private ToggleSelectToSpeakPreferenceFragmentForSetupWizard mFragment;
 
     @Before
@@ -69,6 +73,7 @@ public class ToggleSelectToSpeakPreferenceFragmentForSetupWizardTest {
         mFragment = spy(new TestToggleSelectToSpeakPreferenceFragmentForSetupWizard(mContext));
         doReturn(mActivity).when(mFragment).getActivity();
         when(mActivity.getSwitchBar()).thenReturn(mSwitchBar);
+        doReturn(mFooterBarMixin).when(mGlifLayoutView).getMixin(FooterBarMixin.class);
     }
 
     @Test
@@ -79,6 +84,7 @@ public class ToggleSelectToSpeakPreferenceFragmentForSetupWizardTest {
         verify(mGlifLayoutView).setDescriptionText(
                 mContext.getString(R.string.select_to_speak_summary));
         verify(mGlifLayoutView).setDividerInsets(Integer.MAX_VALUE, 0);
+        verify(mFooterBarMixin).setPrimaryButton(any());
         assertThat(mFragment.mTopIntroPreference.isVisible()).isFalse();
     }