From 3cb889fc781d66f003017beb09f8b8c126f54d27 Mon Sep 17 00:00:00 2001
From: jasonwshsu <jasonwshsu@google.com>
Date: Mon, 5 Jul 2021 10:07:49 +0800
Subject: [PATCH] Fix accessibility button footer preference did not announced
 correct by TalkBack

Root Cause: Description would be altered after displayPreference(), but getSummary() would be called after it.

Solution: Update title before displayPreference(), then it could be set correctly.

Fix: 192738520
Test: atest AccessibilityButtonFooterPreferenceControllerTest
Change-Id: I068994fca8202b166fedf43f9d9657b0c1a64c4e
---
 res/xml/accessibility_button_settings.xml     |  1 +
 ...ilityButtonFooterPreferenceController.java | 17 ++++++++---
 ...yButtonFooterPreferenceControllerTest.java | 30 +++++++++----------
 3 files changed, 29 insertions(+), 19 deletions(-)

diff --git a/res/xml/accessibility_button_settings.xml b/res/xml/accessibility_button_settings.xml
index 78d13ab1a8d..02b1c7d4693 100644
--- a/res/xml/accessibility_button_settings.xml
+++ b/res/xml/accessibility_button_settings.xml
@@ -61,6 +61,7 @@
 
     <com.android.settings.accessibility.AccessibilityFooterPreference
         android:key="accessibility_button_footer"
+        android:title="@string/accessibility_button_description"
         android:persistent="false"
         android:selectable="false"
         settings:searchable="false"
diff --git a/src/com/android/settings/accessibility/AccessibilityButtonFooterPreferenceController.java b/src/com/android/settings/accessibility/AccessibilityButtonFooterPreferenceController.java
index 8b4a364a393..de90374c393 100644
--- a/src/com/android/settings/accessibility/AccessibilityButtonFooterPreferenceController.java
+++ b/src/com/android/settings/accessibility/AccessibilityButtonFooterPreferenceController.java
@@ -18,6 +18,8 @@ package com.android.settings.accessibility;
 
 import android.content.Context;
 
+import androidx.preference.PreferenceScreen;
+
 import com.android.settings.R;
 
 /**
@@ -36,9 +38,16 @@ public class AccessibilityButtonFooterPreferenceController extends
     }
 
     @Override
-    public CharSequence getSummary() {
-        return AccessibilityUtil.isGestureNavigateEnabled(mContext)
-                ? mContext.getString(R.string.accessibility_button_gesture_description)
-                : mContext.getString(R.string.accessibility_button_description);
+    public void displayPreference(PreferenceScreen screen) {
+        // Need to update footerPreference's data before super.displayPreference(), then it will use
+        // data to update related property of footerPreference.
+        if (AccessibilityUtil.isGestureNavigateEnabled(mContext)) {
+            final AccessibilityFooterPreference footerPreference =
+                    screen.findPreference(getPreferenceKey());
+            footerPreference.setTitle(
+                    mContext.getString(R.string.accessibility_button_gesture_description));
+        }
+
+        super.displayPreference(screen);
     }
 }
diff --git a/tests/robotests/src/com/android/settings/accessibility/AccessibilityButtonFooterPreferenceControllerTest.java b/tests/robotests/src/com/android/settings/accessibility/AccessibilityButtonFooterPreferenceControllerTest.java
index 33c57625860..010b444f914 100644
--- a/tests/robotests/src/com/android/settings/accessibility/AccessibilityButtonFooterPreferenceControllerTest.java
+++ b/tests/robotests/src/com/android/settings/accessibility/AccessibilityButtonFooterPreferenceControllerTest.java
@@ -16,7 +16,6 @@
 
 package com.android.settings.accessibility;
 
-import static android.view.WindowManagerPolicyConstants.NAV_BAR_MODE_2BUTTON;
 import static android.view.WindowManagerPolicyConstants.NAV_BAR_MODE_GESTURAL;
 
 import static com.google.common.truth.Truth.assertThat;
@@ -26,6 +25,7 @@ import static org.mockito.Mockito.when;
 import android.content.Context;
 import android.content.res.Resources;
 
+import androidx.preference.PreferenceScreen;
 import androidx.test.core.app.ApplicationProvider;
 
 import com.android.settings.R;
@@ -34,6 +34,7 @@ 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;
@@ -50,30 +51,29 @@ public class AccessibilityButtonFooterPreferenceControllerTest {
     private final Context mContext = ApplicationProvider.getApplicationContext();
     @Spy
     private final Resources mResources = mContext.getResources();
+    @Mock
+    private PreferenceScreen mScreen;
     private AccessibilityButtonFooterPreferenceController mController;
+    private AccessibilityFooterPreference mPreference;
 
     @Before
     public void setUp() {
-        mController = new AccessibilityButtonFooterPreferenceController(mContext,
-                "test_key");
+        mController = new AccessibilityButtonFooterPreferenceController(mContext, "test_key");
+        mPreference = new AccessibilityFooterPreference(mContext);
+        mPreference.setKey("test_key");
+
+        when(mScreen.findPreference(mController.getPreferenceKey())).thenReturn(mPreference);
         when(mContext.getResources()).thenReturn(mResources);
     }
 
     @Test
-    public void getSummary_navigationGestureEnabled_shouldReturnButtonAndGestureSummary() {
+    public void displayPreference_navigationGestureEnabled_setCorrectTitle() {
         when(mResources.getInteger(com.android.internal.R.integer.config_navBarInteractionMode))
-                    .thenReturn(NAV_BAR_MODE_GESTURAL);
+                .thenReturn(NAV_BAR_MODE_GESTURAL);
 
-        assertThat(mController.getSummary()).isEqualTo(
+        mController.displayPreference(mScreen);
+
+        assertThat(mPreference.getTitle()).isEqualTo(
                 mContext.getText(R.string.accessibility_button_gesture_description));
     }
-
-    @Test
-    public void getSummary_navigationGestureDisabled_shouldReturnButtonSummary() {
-        when(mResources.getInteger(com.android.internal.R.integer.config_navBarInteractionMode))
-                .thenReturn(NAV_BAR_MODE_2BUTTON);
-
-        assertThat(mController.getSummary()).isEqualTo(
-                mContext.getText(R.string.accessibility_button_description));
-    }
 }