[Catalyst] Migrate Adaptive brightness in the DisplayScreen
Migrate the AutoBrightnessPreferenceController to be a Catalyst type preference.
Test: atest AutoBrightnessScreenTest
Bug: 374712065
Flag: com.android.settings.flags.catalyst_screen_brightness_mode
Change-Id: I80d17a4f7fae237825ab84d1f428614affcb9065
diff --git a/aconfig/catalyst/display.aconfig b/aconfig/catalyst/display.aconfig
index 038a9b0..9485e70 100644
--- a/aconfig/catalyst/display.aconfig
+++ b/aconfig/catalyst/display.aconfig
@@ -22,3 +22,9 @@
bug: "323791114"
}
+flag {
+ name: "catalyst_screen_brightness_mode"
+ namespace: "android_settings"
+ description: "Flag for Adaptive brightness"
+ bug: "323791114"
+}
diff --git a/res/xml/display_settings.xml b/res/xml/display_settings.xml
index c7e2967..3baf439 100644
--- a/res/xml/display_settings.xml
+++ b/res/xml/display_settings.xml
@@ -34,7 +34,7 @@
settings:userRestriction="no_config_brightness"/>
<com.android.settingslib.PrimarySwitchPreference
- android:key="@string/preference_key_auto_brightness"
+ android:key="screen_brightness_mode"
android:title="@string/auto_brightness_title"
android:fragment="com.android.settings.display.AutoBrightnessSettings"
settings:useAdminDisabledSummary="true"
diff --git a/src/com/android/settings/display/AutoBrightnessPreferenceController.java b/src/com/android/settings/display/AutoBrightnessPreferenceController.java
index 0a80d69..5635a9b 100644
--- a/src/com/android/settings/display/AutoBrightnessPreferenceController.java
+++ b/src/com/android/settings/display/AutoBrightnessPreferenceController.java
@@ -32,6 +32,7 @@
/**
* The top-level preference controller that updates the adaptive brightness.
*/
+// LINT.IfChange
public class AutoBrightnessPreferenceController extends TogglePreferenceController {
private final String SYSTEM_KEY = SCREEN_BRIGHTNESS_MODE;
@@ -90,3 +91,4 @@
return R.string.menu_key_display;
}
}
+// LINT.ThenChange(AutoBrightnessScreen.kt)
diff --git a/src/com/android/settings/display/AutoBrightnessScreen.kt b/src/com/android/settings/display/AutoBrightnessScreen.kt
new file mode 100644
index 0000000..44a48dc
--- /dev/null
+++ b/src/com/android/settings/display/AutoBrightnessScreen.kt
@@ -0,0 +1,100 @@
+/*
+ * Copyright (C) 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.display
+
+import android.content.Context
+import android.os.Process
+import android.os.UserHandle
+import android.os.UserManager
+import android.provider.Settings
+import android.provider.Settings.System.SCREEN_BRIGHTNESS_MODE_AUTOMATIC
+import android.provider.Settings.System.SCREEN_BRIGHTNESS_MODE_MANUAL
+import androidx.preference.Preference
+import com.android.settings.R
+import com.android.settings.flags.Flags
+import com.android.settingslib.PrimarySwitchPreference
+import com.android.settingslib.RestrictedLockUtilsInternal
+import com.android.settingslib.datastore.SettingsSystemStore
+import com.android.settingslib.metadata.BooleanValue
+import com.android.settingslib.metadata.PersistentPreference
+import com.android.settingslib.metadata.PreferenceAvailabilityProvider
+import com.android.settingslib.metadata.PreferenceMetadata
+import com.android.settingslib.metadata.PreferenceRestrictionProvider
+import com.android.settingslib.metadata.ProvidePreferenceScreen
+import com.android.settingslib.metadata.preferenceHierarchy
+import com.android.settingslib.preference.PreferenceScreenBinding
+import com.android.settingslib.preference.PreferenceScreenCreator
+
+@ProvidePreferenceScreen
+class AutoBrightnessScreen :
+ PreferenceScreenCreator,
+ PreferenceScreenBinding,
+ PreferenceAvailabilityProvider,
+ PreferenceRestrictionProvider,
+ PersistentPreference<Boolean>,
+ BooleanValue {
+ override val key: String
+ get() = KEY
+
+ override val title: Int
+ get() = R.string.auto_brightness_title
+
+ override fun isFlagEnabled(context: Context) = Flags.catalystScreenBrightnessMode()
+
+ override fun fragmentClass() = AutoBrightnessSettings::class.java
+
+ override fun hasCompleteHierarchy() = false
+
+ override fun getPreferenceHierarchy(context: Context) = preferenceHierarchy(this) {}
+
+ override fun storage(context: Context) = SettingsSystemStore.get(context)
+
+ override fun isAvailable(context: Context) =
+ context.resources.getBoolean(
+ com.android.internal.R.bool.config_automatic_brightness_available
+ )
+
+ override fun isEnabled(context: Context) =
+ !UserManager.get(context)
+ .hasBaseUserRestriction(UserManager.DISALLOW_CONFIG_BRIGHTNESS, Process.myUserHandle())
+
+ override fun isRestricted(context: Context) =
+ RestrictedLockUtilsInternal.checkIfRestrictionEnforced(
+ context,
+ UserManager.DISALLOW_CONFIG_BRIGHTNESS,
+ UserHandle.myUserId(),
+ ) != null
+
+ override fun createWidget(context: Context) = PrimarySwitchPreference(context)
+
+ override fun bind(preference: Preference, metadata: PreferenceMetadata) {
+ super.bind(preference, metadata)
+ (preference as PrimarySwitchPreference).apply {
+ useAdminDisabledSummary(true)
+ isSwitchEnabled = isEnabled
+ isChecked =
+ storage(preference.context).getBoolean(KEY)
+ ?: getDefault(SCREEN_BRIGHTNESS_MODE_MANUAL)
+ }
+ }
+
+ private fun getDefault(brightnessDefault: Int): Boolean =
+ brightnessDefault == SCREEN_BRIGHTNESS_MODE_AUTOMATIC
+
+ companion object {
+ const val KEY = Settings.System.SCREEN_BRIGHTNESS_MODE
+ }
+}
diff --git a/src/com/android/settings/display/DisplayScreen.kt b/src/com/android/settings/display/DisplayScreen.kt
index 5248367..b1a822d 100644
--- a/src/com/android/settings/display/DisplayScreen.kt
+++ b/src/com/android/settings/display/DisplayScreen.kt
@@ -52,6 +52,7 @@
override fun getPreferenceHierarchy(context: Context) = preferenceHierarchy(this) {
+BrightnessLevelRestrictedPreference()
+ +AutoBrightnessScreen.KEY
+DarkModeScreen.KEY
+PeakRefreshRateSwitchPreference()
}
diff --git a/tests/robotests/src/com/android/settings/display/AutoBrightnessPreferenceControllerTest.java b/tests/robotests/src/com/android/settings/display/AutoBrightnessPreferenceControllerTest.java
index 0122044..902de78 100644
--- a/tests/robotests/src/com/android/settings/display/AutoBrightnessPreferenceControllerTest.java
+++ b/tests/robotests/src/com/android/settings/display/AutoBrightnessPreferenceControllerTest.java
@@ -43,6 +43,7 @@
/**
* Tests for {@link AutoBrightnessPreferenceController}.
*/
+// LINT.IfChange
@RunWith(RobolectricTestRunner.class)
@Config(shadows = {SettingsShadowResources.class})
public class AutoBrightnessPreferenceControllerTest {
@@ -139,3 +140,4 @@
assertThat(mController.getAvailabilityStatus()).isEqualTo(UNSUPPORTED_ON_DEVICE);
}
}
+// LINT.ThenChange(AutoBrightnessScreenTest.kt)
diff --git a/tests/robotests/src/com/android/settings/display/AutoBrightnessScreenTest.kt b/tests/robotests/src/com/android/settings/display/AutoBrightnessScreenTest.kt
new file mode 100644
index 0000000..c7f78cd
--- /dev/null
+++ b/tests/robotests/src/com/android/settings/display/AutoBrightnessScreenTest.kt
@@ -0,0 +1,140 @@
+/*
+ * Copyright (C) 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.display
+
+import android.content.Context
+import android.provider.Settings
+import android.provider.Settings.System.SCREEN_BRIGHTNESS_MODE_AUTOMATIC
+import android.provider.Settings.System.SCREEN_BRIGHTNESS_MODE_MANUAL
+import android.view.LayoutInflater
+import androidx.preference.PreferenceViewHolder
+import androidx.test.core.app.ApplicationProvider
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.android.settings.testutils.shadow.SettingsShadowResources
+import com.android.settingslib.PrimarySwitchPreference
+import com.android.settingslib.widget.SettingsThemeHelper.isExpressiveTheme
+import com.android.settingslib.widget.theme.R
+import com.google.common.truth.Truth.assertThat
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.annotation.Config
+
+// LINT.IfChange
+@RunWith(AndroidJUnit4::class)
+@Config(shadows = [SettingsShadowResources::class])
+class AutoBrightnessScreenTest {
+
+ private val context: Context = ApplicationProvider.getApplicationContext()
+
+ private val preferenceScreenCreator = AutoBrightnessScreen()
+
+ @Test
+ fun switchClick_defaultScreenBrightnessModeTurnOffAuto_returnTrue() {
+ setScreenBrightnessMode(SCREEN_BRIGHTNESS_MODE_MANUAL)
+ val preference = getPrimarySwitchPreference()
+
+ assertThat(preference.switch.isChecked).isFalse()
+
+ preference.switch.performClick()
+
+ assertThat(preference.isChecked).isTrue()
+ }
+
+ @Test
+ fun switchClick_defaultScreenBrightnessModeTurnOnAuto_returnFalse() {
+ setScreenBrightnessMode(SCREEN_BRIGHTNESS_MODE_AUTOMATIC)
+ val preference = getPrimarySwitchPreference()
+
+ assertThat(preference.switch.isChecked).isTrue()
+
+ preference.switch.performClick()
+
+ assertThat(preference.isChecked).isFalse()
+ }
+
+ @Test
+ fun setChecked_updatesCorrectly() {
+ val preference = getPrimarySwitchPreference()
+
+ preference.isChecked = true
+
+ assertThat(preference.switch.isChecked).isTrue()
+
+ preference.isChecked = false
+
+ assertThat(preference.switch.isChecked).isFalse()
+ }
+
+ @Test
+ fun isChecked_defaultScreenBrightnessModeTurnOffAuto_returnFalse() {
+ setScreenBrightnessMode(SCREEN_BRIGHTNESS_MODE_MANUAL)
+
+ val preference = getPrimarySwitchPreference()
+
+ assertThat(preference.isChecked).isFalse()
+ }
+
+ @Test
+ fun isChecked_defaultScreenBrightnessModeTurnOffAuto_returnTrue() {
+ setScreenBrightnessMode(SCREEN_BRIGHTNESS_MODE_AUTOMATIC)
+
+ val preference = getPrimarySwitchPreference()
+
+ assertThat(preference.isChecked).isTrue()
+ }
+
+ @Test
+ fun isAvailable_configTrueSet_shouldReturnTrue() {
+ SettingsShadowResources.overrideResource(
+ com.android.internal.R.bool.config_automatic_brightness_available,
+ true,
+ )
+
+ assertThat(preferenceScreenCreator.isAvailable(context)).isTrue()
+ }
+
+ @Test
+ fun isAvailable_configFalseSet_shouldReturnFalse() {
+ SettingsShadowResources.overrideResource(
+ com.android.internal.R.bool.config_automatic_brightness_available,
+ false,
+ )
+
+ assertThat(preferenceScreenCreator.isAvailable(context)).isFalse()
+ }
+
+ private fun getPrimarySwitchPreference(): PrimarySwitchPreference =
+ preferenceScreenCreator.run {
+ val preference = createWidget(context)
+ bind(preference, this)
+ val holder =
+ PreferenceViewHolder.createInstanceForTests(
+ LayoutInflater.from(context).inflate(getResId(), /* root= */ null)
+ )
+ .apply { findViewById(androidx.preference.R.id.switchWidget) }
+ preference.apply { onBindViewHolder(holder) }
+ }
+
+ private fun setScreenBrightnessMode(value: Int) =
+ Settings.System.putInt(context.contentResolver, AutoBrightnessScreen.KEY, value)
+
+ private fun getResId() =
+ when {
+ isExpressiveTheme(context) -> R.layout.settingslib_expressive_preference_switch
+ else -> androidx.preference.R.layout.preference_widget_switch_compat
+ }
+}
+// LINT.ThenChange(AutoBrightnessPreferenceControllerTest.java)