From f9616e0e5ade9347155bf1ae23da948ad621db3b Mon Sep 17 00:00:00 2001
From: Tiger <tigerhuang@google.com>
Date: Tue, 21 Feb 2023 23:15:45 +0800
Subject: [PATCH] Add an developer option to enable
 config_navBarDefaultTransparent

This enables the user to make navigation bar color transparent by
default. It will only affect apps which don't specify the navigation
bar color.

Fix: 232195501
Test: atest TransparentNavigationBarPreferenceControllerTest
Change-Id: I91581558b92abeaa3501b9749f1a1ab43db8e771
---
 res/xml/development_settings.xml              |   5 +
 .../DevelopmentSettingsDashboardFragment.java |   1 +
 ...rentNavigationBarPreferenceController.java |  91 ++++++++++++++++
 ...NavigationBarPreferenceControllerTest.java | 102 ++++++++++++++++++
 4 files changed, 199 insertions(+)
 create mode 100644 src/com/android/settings/development/TransparentNavigationBarPreferenceController.java
 create mode 100644 tests/robotests/src/com/android/settings/development/TransparentNavigationBarPreferenceControllerTest.java

diff --git a/res/xml/development_settings.xml b/res/xml/development_settings.xml
index ae93eed13ae..33364bf25cb 100644
--- a/res/xml/development_settings.xml
+++ b/res/xml/development_settings.xml
@@ -505,6 +505,11 @@
             android:title="@string/display_cutout_emulation"
             settings:keywords="@string/display_cutout_emulation_keywords" />
 
+        <SwitchPreference
+            android:key="transparent_navigation_bar"
+            android:title="@string/transparent_navigation_bar"
+            android:summary="@string/transparent_navigation_bar_summary" />
+
     </PreferenceCategory>
 
     <PreferenceCategory
diff --git a/src/com/android/settings/development/DevelopmentSettingsDashboardFragment.java b/src/com/android/settings/development/DevelopmentSettingsDashboardFragment.java
index c732c0a5549..3f685f43a43 100644
--- a/src/com/android/settings/development/DevelopmentSettingsDashboardFragment.java
+++ b/src/com/android/settings/development/DevelopmentSettingsDashboardFragment.java
@@ -616,6 +616,7 @@ public class DevelopmentSettingsDashboardFragment extends RestrictedDashboardFra
         controllers.add(new RtlLayoutPreferenceController(context));
         controllers.add(new WindowAnimationScalePreferenceController(context));
         controllers.add(new EmulateDisplayCutoutPreferenceController(context));
+        controllers.add(new TransparentNavigationBarPreferenceController(context));
         controllers.add(new TransitionAnimationScalePreferenceController(context));
         controllers.add(new AnimatorDurationScalePreferenceController(context));
         controllers.add(new SecondaryDisplayPreferenceController(context));
diff --git a/src/com/android/settings/development/TransparentNavigationBarPreferenceController.java b/src/com/android/settings/development/TransparentNavigationBarPreferenceController.java
new file mode 100644
index 00000000000..d1f54b54e18
--- /dev/null
+++ b/src/com/android/settings/development/TransparentNavigationBarPreferenceController.java
@@ -0,0 +1,91 @@
+/*
+ * Copyright (C) 2023 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.development;
+
+import static android.os.UserHandle.USER_CURRENT;
+
+import android.content.Context;
+import android.content.om.IOverlayManager;
+import android.os.RemoteException;
+import android.os.ServiceManager;
+
+import androidx.preference.Preference;
+import androidx.preference.SwitchPreference;
+
+import com.android.internal.R;
+import com.android.internal.annotations.VisibleForTesting;
+import com.android.settings.core.PreferenceControllerMixin;
+import com.android.settingslib.development.DeveloperOptionsPreferenceController;
+
+public class TransparentNavigationBarPreferenceController
+        extends DeveloperOptionsPreferenceController
+        implements Preference.OnPreferenceChangeListener, PreferenceControllerMixin {
+
+    private static final String TRANSPARENT_NAVIGATION_BAR_KEY =
+            "transparent_navigation_bar";
+
+    private static final String OVERLAY_PACKAGE_NAME =
+            "com.android.internal.systemui.navbar.transparent";
+
+    private final IOverlayManager mOverlayManager;
+
+    public TransparentNavigationBarPreferenceController(Context context) {
+        super(context);
+        mOverlayManager = IOverlayManager.Stub.asInterface(
+                ServiceManager.getService(Context.OVERLAY_SERVICE));
+    }
+
+    @Override
+    public String getPreferenceKey() {
+        return TRANSPARENT_NAVIGATION_BAR_KEY;
+    }
+
+    @Override
+    public boolean onPreferenceChange(Preference preference, Object newValue) {
+        setEnabled((boolean) newValue);
+        return true;
+    }
+
+    @Override
+    public void updateState(Preference preference) {
+        ((SwitchPreference) mPreference).setChecked(isEnabled());
+    }
+
+    @Override
+    protected void onDeveloperOptionsSwitchDisabled() {
+        super.onDeveloperOptionsSwitchDisabled();
+        ((SwitchPreference) mPreference).setChecked(false);
+        final boolean enabled = isEnabled();
+        if (!enabled) {
+            setEnabled(false);
+        }
+    }
+
+    @VisibleForTesting
+    protected boolean isEnabled() {
+        return mContext.getResources().getBoolean(R.bool.config_navBarDefaultTransparent);
+    }
+
+    @VisibleForTesting
+    protected void setEnabled(boolean enabled) {
+        try {
+            mOverlayManager.setEnabled(OVERLAY_PACKAGE_NAME, enabled, USER_CURRENT);
+        } catch (RemoteException e) {
+            throw e.rethrowFromSystemServer();
+        }
+    }
+}
diff --git a/tests/robotests/src/com/android/settings/development/TransparentNavigationBarPreferenceControllerTest.java b/tests/robotests/src/com/android/settings/development/TransparentNavigationBarPreferenceControllerTest.java
new file mode 100644
index 00000000000..a1b3892b6e0
--- /dev/null
+++ b/tests/robotests/src/com/android/settings/development/TransparentNavigationBarPreferenceControllerTest.java
@@ -0,0 +1,102 @@
+/*
+ * Copyright (C) 2023 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.development;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import androidx.preference.PreferenceScreen;
+import androidx.preference.SwitchPreference;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.RuntimeEnvironment;
+
+@RunWith(RobolectricTestRunner.class)
+public class TransparentNavigationBarPreferenceControllerTest {
+
+    @Mock
+    private PreferenceScreen mScreen;
+    @Mock
+    private SwitchPreference mPreference;
+
+    private TransparentNavigationBarPreferenceController mController;
+
+    @Before
+    public void setUp() {
+        MockitoAnnotations.initMocks(this);
+        mController = new TransparentNavigationBarPreferenceController(
+                RuntimeEnvironment.application) {
+            private boolean mEnabled;
+
+            protected boolean isEnabled() {
+                return mEnabled;
+            }
+
+            protected void setEnabled(boolean enabled) {
+                mEnabled = enabled;
+            }
+        };
+        when(mScreen.findPreference(mController.getPreferenceKey())).thenReturn(mPreference);
+        mController.displayPreference(mScreen);
+    }
+
+    @Test
+    public void updateState_enabled_shouldCheckedPreference() {
+        mController.setEnabled(true);
+        mController.updateState(mPreference);
+
+        verify(mPreference).setChecked(true);
+    }
+
+    @Test
+    public void updateState_disabled_shouldUncheckedPreference() {
+        mController.setEnabled(false);
+        mController.updateState(mPreference);
+
+        verify(mPreference).setChecked(false);
+    }
+
+    @Test
+    public void onPreferenceChange_preferenceChecked_shouldBeEnabled() {
+        mController.onPreferenceChange(mPreference, true /* new value */);
+
+        assertTrue(mController.isEnabled());
+    }
+
+    @Test
+    public void onPreferenceChange__preferenceUnchecked_shouldNotBeEnabled() {
+        mController.onPreferenceChange(mPreference, false /* new value */);
+
+        assertFalse(mController.isEnabled());
+    }
+
+    @Test
+    public void onDeveloperOptionsSwitchDisabled_preferenceShouldNotBeEnabled() {
+        mController.onDeveloperOptionsSwitchDisabled();
+
+        assertFalse(mController.isEnabled());
+        verify(mPreference).setEnabled(false);
+        verify(mPreference).setChecked(false);
+    }
+}