Move PreferenceControllers to member variables to prevent memory leak

- Move PreferenceControllers to xml
- Clean up the PreferenceController so that it's less tied to a fragment
- Update and clean up the related robolectric test, so there are less
  mocks needed

Bug: 352606511
Test: manually check the Color Correction screen is shown correctly, and
choosing color correction options are reflected correctly
Test: atest DaltonizerRadioButtonPreferenceControllerTest
Test: atest ToggleDaltonizerPreferenceFragmentTest
Flag: EXEMPT (moving controller to xml can't be flagged)

Change-Id: I89b9366cfd7a398bb0572d34226d31d49373fd94
This commit is contained in:
Chun-Ku Lin
2024-07-13 04:21:38 +00:00
parent dc5469cf24
commit ec61f8bea3
5 changed files with 173 additions and 292 deletions

View File

@@ -19,17 +19,21 @@ package com.android.settings.accessibility;
import android.content.ContentResolver;
import android.content.Context;
import android.content.res.Resources;
import android.database.ContentObserver;
import android.os.Handler;
import android.os.Looper;
import android.provider.Settings;
import android.view.View;
import android.view.accessibility.AccessibilityManager;
import androidx.lifecycle.LifecycleObserver;
import androidx.annotation.NonNull;
import androidx.lifecycle.DefaultLifecycleObserver;
import androidx.lifecycle.LifecycleOwner;
import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;
import com.android.settings.R;
import com.android.settings.core.BasePreferenceController;
import com.android.settingslib.core.lifecycle.Lifecycle;
import com.android.settingslib.widget.SelectorWithWidgetPreference;
import com.google.common.primitives.Ints;
@@ -39,41 +43,36 @@ import java.util.Map;
/** Controller class that control radio button of accessibility daltonizer settings. */
public class DaltonizerRadioButtonPreferenceController extends BasePreferenceController implements
LifecycleObserver, SelectorWithWidgetPreference.OnClickListener {
private static final String TYPE = Settings.Secure.ACCESSIBILITY_DISPLAY_DALTONIZER;
DefaultLifecycleObserver, SelectorWithWidgetPreference.OnClickListener {
private static final String DALTONIZER_TYPE_SETTINGS_KEY =
Settings.Secure.ACCESSIBILITY_DISPLAY_DALTONIZER;
// pair the preference key and daltonizer value.
private final Map<String, Integer> mAccessibilityDaltonizerKeyToValueMap = new HashMap<>();
// RadioButtonPreference key, each preference represent a daltonizer value.
private final ContentResolver mContentResolver;
private final ContentObserver mSettingsContentObserver;
private final Resources mResources;
private DaltonizerRadioButtonPreferenceController.OnChangeListener mOnChangeListener;
private SelectorWithWidgetPreference mPreference;
private int mAccessibilityDaltonizerValue;
public DaltonizerRadioButtonPreferenceController(Context context, String preferenceKey) {
super(context, preferenceKey);
mContentResolver = context.getContentResolver();
mResources = context.getResources();
mSettingsContentObserver = new ContentObserver(new Handler(Looper.getMainLooper())) {
@Override
public void onChange(boolean selfChange) {
if (mPreference != null) {
updateState(mPreference);
}
}
};
}
public DaltonizerRadioButtonPreferenceController(Context context, Lifecycle lifecycle,
String preferenceKey) {
super(context, preferenceKey);
mContentResolver = context.getContentResolver();
mResources = context.getResources();
if (lifecycle != null) {
lifecycle.addObserver(this);
}
}
protected static int getSecureAccessibilityDaltonizerValue(ContentResolver resolver,
String name) {
final String daltonizerStringValue = Settings.Secure.getString(resolver, name);
protected static int getSecureAccessibilityDaltonizerValue(ContentResolver resolver) {
final String daltonizerStringValue = Settings.Secure.getString(
resolver, DALTONIZER_TYPE_SETTINGS_KEY);
if (daltonizerStringValue == null) {
return AccessibilityManager.DALTONIZER_CORRECT_DEUTERANOMALY;
}
@@ -82,13 +81,8 @@ public class DaltonizerRadioButtonPreferenceController extends BasePreferenceCon
: daltonizerIntValue;
}
public void setOnChangeListener(
DaltonizerRadioButtonPreferenceController.OnChangeListener listener) {
mOnChangeListener = listener;
}
private Map<String, Integer> getDaltonizerValueToKeyMap() {
if (mAccessibilityDaltonizerKeyToValueMap.size() == 0) {
if (mAccessibilityDaltonizerKeyToValueMap.isEmpty()) {
final String[] daltonizerKeys = mResources.getStringArray(
R.array.daltonizer_mode_keys);
@@ -104,12 +98,8 @@ public class DaltonizerRadioButtonPreferenceController extends BasePreferenceCon
return mAccessibilityDaltonizerKeyToValueMap;
}
private void putSecureString(String name, String value) {
Settings.Secure.putString(mContentResolver, name, value);
}
private void handlePreferenceChange(String value) {
putSecureString(TYPE, value);
Settings.Secure.putString(mContentResolver, DALTONIZER_TYPE_SETTINGS_KEY, value);
}
@Override
@@ -124,44 +114,38 @@ public class DaltonizerRadioButtonPreferenceController extends BasePreferenceCon
screen.findPreference(getPreferenceKey());
mPreference.setOnClickListener(this);
mPreference.setAppendixVisibility(View.GONE);
updateState(mPreference);
}
@Override
public void onRadioButtonClicked(SelectorWithWidgetPreference preference) {
final int value = getDaltonizerValueToKeyMap().get(mPreferenceKey);
handlePreferenceChange(String.valueOf(value));
if (mOnChangeListener != null) {
mOnChangeListener.onCheckedChanged(mPreference);
}
}
private int getAccessibilityDaltonizerValue() {
final int daltonizerValue = getSecureAccessibilityDaltonizerValue(mContentResolver,
TYPE);
final int daltonizerValue = getSecureAccessibilityDaltonizerValue(mContentResolver);
return daltonizerValue;
}
protected void updatePreferenceCheckedState(int value) {
if (mAccessibilityDaltonizerValue == value) {
mPreference.setChecked(true);
}
}
@Override
public void updateState(Preference preference) {
super.updateState(preference);
mAccessibilityDaltonizerValue = getAccessibilityDaltonizerValue();
// reset RadioButton
mPreference.setChecked(false);
final int daltonizerValueInSetting = getAccessibilityDaltonizerValue();
final int preferenceValue = getDaltonizerValueToKeyMap().get(mPreference.getKey());
updatePreferenceCheckedState(preferenceValue);
mPreference.setChecked(preferenceValue == daltonizerValueInSetting);
}
/** Listener interface handles checked event. */
public interface OnChangeListener {
/** A hook that is called when preference checked. */
void onCheckedChanged(Preference preference);
@Override
public void onResume(@NonNull LifecycleOwner owner) {
mContentResolver.registerContentObserver(
Settings.Secure.getUriFor(DALTONIZER_TYPE_SETTINGS_KEY),
/* notifyForDescendants= */ false,
mSettingsContentObserver
);
}
@Override
public void onPause(@NonNull LifecycleOwner owner) {
mContentResolver.unregisterContentObserver(mSettingsContentObserver);
}
}