Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 32420a07 authored by Daniel Hsieh's avatar Daniel Hsieh Committed by Android (Google) Code Review
Browse files

Merge "Refactor SettingsContentObserver and add it to follow typing feature."

parents 8662e464 55bc4986

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

+4 −8
Original line number Diff line number Diff line
@@ -30,7 +30,6 @@ import android.content.pm.ResolveInfo; 
import android.content.pm.ServiceInfo;

import android.graphics.Color;

import android.graphics.drawable.Drawable;

import android.net.Uri;

import android.os.Bundle;

import android.os.Handler;

import android.os.UserHandle;
@@ -147,7 +146,7 @@ public class AccessibilitySettings extends DashboardFragment { 
    };



    @VisibleForTesting

    final SettingsContentObserver mSettingsContentObserver;

    final AccessibilitySettingsContentObserver mSettingsContentObserver;



    private final Map<String, PreferenceCategory> mCategoryToPrefCategoryMap =

            new ArrayMap<>();
@@ -171,12 +170,9 @@ public class AccessibilitySettings extends DashboardFragment { 
        // Observe changes from accessibility selection menu

        shortcutFeatureKeys.add(Settings.Secure.ACCESSIBILITY_BUTTON_TARGETS);

        shortcutFeatureKeys.add(Settings.Secure.ACCESSIBILITY_SHORTCUT_TARGET_SERVICE);

        mSettingsContentObserver = new SettingsContentObserver(mHandler, shortcutFeatureKeys) {

            @Override

            public void onChange(boolean selfChange, Uri uri) {

                onContentChanged();

            }

        };

        mSettingsContentObserver = new AccessibilitySettingsContentObserver(mHandler);

        mSettingsContentObserver.registerKeysToObserverCallback(shortcutFeatureKeys,

                key -> onContentChanged());

    }



    @Override

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

0 → 100644
+132 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2022 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.accessibility;



import android.content.ContentResolver;

import android.database.ContentObserver;

import android.net.Uri;

import android.os.Handler;

import android.provider.Settings;

import android.util.Log;



import java.util.Collections;

import java.util.HashMap;

import java.util.List;

import java.util.Map;



class AccessibilitySettingsContentObserver extends ContentObserver {



    private static final String TAG = "AccessibilitySettingsContentObserver";



    public interface ContentObserverCallback {

        void onChange(String key);

    }



    // Key: Preference key's uri, Value: Preference key

    private final Map<Uri, String> mUriToKey = new HashMap<>(2);



    // Key: Collection of preference keys, Value: onChange callback for keys

    private final Map<List<String>, ContentObserverCallback> mUrisToCallback = new HashMap<>();



    AccessibilitySettingsContentObserver(Handler handler) {

        super(handler);



        // default key to be observed

        addDefaultKeysToMap();

    }



    public void register(ContentResolver contentResolver) {

        for (Uri uri : mUriToKey.keySet()) {

            contentResolver.registerContentObserver(uri, false, this);

        }

    }



    public void unregister(ContentResolver contentResolver) {

        contentResolver.unregisterContentObserver(this);

    }



    private void addDefaultKeysToMap() {

        addKeyToMap(Settings.Secure.ACCESSIBILITY_ENABLED);

        addKeyToMap(Settings.Secure.ENABLED_ACCESSIBILITY_SERVICES);

    }



    private boolean isDefaultKey(String key) {

        return Settings.Secure.ACCESSIBILITY_ENABLED.equals(key)

                || Settings.Secure.ENABLED_ACCESSIBILITY_SERVICES.equals(key);

    }



    private void addKeyToMap(String key) {

        mUriToKey.put(Settings.Secure.getUriFor(key), key);

    }



    /**

     * {@link ContentObserverCallback} is added to {@link ContentObserver} to handle the

     * onChange event triggered by the key collection of {@code keysToObserve} and the default

     * keys.

     *

     * Note: The following key are default to be observed.

     *      {@link Settings.Secure.ACCESSIBILITY_ENABLED}

     *      {@link Settings.Secure.ENABLED_ACCESSIBILITY_SERVICES}

     *

     * @param keysToObserve A collection of keys which are going to be observed.

     * @param observerCallback A callback which is used to handle the onChange event triggered

     *                         by the key collection of {@code keysToObserve}.

     */

    public void registerKeysToObserverCallback(List<String> keysToObserve,

            ContentObserverCallback observerCallback) {



        for (String key: keysToObserve) {

            addKeyToMap(key);

        }



        mUrisToCallback.put(keysToObserve, observerCallback);

    }



    /**

     * {@link ContentObserverCallback} is added to {@link ContentObserver} to handle the

     * onChange event triggered by the default keys.

     *

     * Note: The following key are default to be observed.

     *      {@link Settings.Secure.ACCESSIBILITY_ENABLED}

     *      {@link Settings.Secure.ENABLED_ACCESSIBILITY_SERVICES}

     *

     * @param observerCallback A callback which is used to handle the onChange event triggered

     *      *                         by the key collection of {@code keysToObserve}.

     */

    public void registerObserverCallback(ContentObserverCallback observerCallback) {

        mUrisToCallback.put(Collections.emptyList(), observerCallback);

    }



    @Override

    public final void onChange(boolean selfChange, Uri uri) {



        final String key = mUriToKey.get(uri);



        if (key == null) {

            Log.w(TAG, "AccessibilitySettingsContentObserver can not find the key for "

                    + "uri: " + uri);

            return;

        }



        for (List<String> keys : mUrisToCallback.keySet()) {

            final boolean isDefaultKey = isDefaultKey(key);

            if (isDefaultKey || keys.contains(key)) {

                mUrisToCallback.get(keys).onChange(key);

            }

        }

    }

}

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

+6 −9
Original line number Diff line number Diff line
@@ -25,7 +25,6 @@ import android.content.ComponentName; 
import android.content.Context;

import android.content.DialogInterface;

import android.icu.text.CaseMap;

import android.net.Uri;

import android.os.Bundle;

import android.os.Handler;

import android.provider.Settings;
@@ -64,7 +63,7 @@ public abstract class AccessibilityShortcutPreferenceFragment extends DashboardF 
    protected ShortcutPreference mShortcutPreference;

    private AccessibilityManager.TouchExplorationStateChangeListener

            mTouchExplorationStateChangeListener;

    private SettingsContentObserver mSettingsContentObserver;

    private AccessibilitySettingsContentObserver mSettingsContentObserver;

    private CheckBox mSoftwareTypeCheckBox;

    private CheckBox mHardwareTypeCheckBox;
@@ -98,13 +97,11 @@ public abstract class AccessibilityShortcutPreferenceFragment extends DashboardF 
        final List<String> shortcutFeatureKeys = new ArrayList<>();

        shortcutFeatureKeys.add(Settings.Secure.ACCESSIBILITY_BUTTON_TARGETS);

        shortcutFeatureKeys.add(Settings.Secure.ACCESSIBILITY_SHORTCUT_TARGET_SERVICE);

        mSettingsContentObserver = new SettingsContentObserver(new Handler(), shortcutFeatureKeys) {

            @Override

            public void onChange(boolean selfChange, Uri uri) {

        mSettingsContentObserver = new AccessibilitySettingsContentObserver(new Handler());

        mSettingsContentObserver.registerKeysToObserverCallback(shortcutFeatureKeys, key -> {

            updateShortcutPreferenceData();

            updateShortcutPreference();

            }

        };

        });

    }



    @Override

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

+10 −0
Original line number Diff line number Diff line
@@ -35,6 +35,8 @@ import com.android.settings.core.TogglePreferenceController; 
public class MagnificationFollowTypingPreferenceController extends TogglePreferenceController

        implements LifecycleObserver {



    private static final String TAG =

            MagnificationFollowTypingPreferenceController.class.getSimpleName();

    static final String PREF_KEY = "magnification_follow_typing";



    private SwitchPreference mFollowTypingPreference;
@@ -75,6 +77,14 @@ public class MagnificationFollowTypingPreferenceController extends TogglePrefere 
    // TODO(b/186731461): Remove it when this controller is used in DashBoardFragment only.

    @OnLifecycleEvent(Lifecycle.Event.ON_RESUME)

    void onResume() {

        updateState();

    }



    /**

     * Updates the state of preference components which has been displayed by

     * {@link MagnificationFollowTypingPreferenceController#displayPreference}.

     */

    void updateState() {

        updateState(mFollowTypingPreference);

    }

}

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

deleted100644 → 0
+0 −55
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2013 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.accessibility;



import android.content.ContentResolver;

import android.database.ContentObserver;

import android.net.Uri;

import android.os.Handler;

import android.provider.Settings;



import java.util.ArrayList;

import java.util.List;



abstract class SettingsContentObserver extends ContentObserver {

    private final List<String> mKeysToObserve = new ArrayList<>(2);



    public SettingsContentObserver(Handler handler) {

        super(handler);

        mKeysToObserve.add(Settings.Secure.ACCESSIBILITY_ENABLED);

        mKeysToObserve.add(Settings.Secure.ENABLED_ACCESSIBILITY_SERVICES);

    }



    public SettingsContentObserver(Handler handler, List<String> keysToObserve) {

        this(handler);

        mKeysToObserve.addAll(keysToObserve);

    }



    public void register(ContentResolver contentResolver) {

        for (int i = 0; i < mKeysToObserve.size(); i++) {

            contentResolver.registerContentObserver(

                    Settings.Secure.getUriFor(mKeysToObserve.get(i)), false, this);

        }

    }



    public void unregister(ContentResolver contentResolver) {

        contentResolver.unregisterContentObserver(this);

    }



    @Override

    public abstract void onChange(boolean selfChange, Uri uri);

}