| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package com.android.settings.dashboard; |
| 17 | |
| 18 | import android.app.Activity; |
| Fan Zhang | ff47b30 | 2018-11-09 14:52:42 -0800 | [diff] [blame] | 19 | import android.app.settings.SettingsEnums; |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 20 | import android.content.ContentResolver; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 21 | import android.content.Context; |
| jasonwshsu | d3b3ed5 | 2023-04-05 22:14:49 +0800 | [diff] [blame] | 22 | import android.content.Intent; |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 23 | import android.os.Bundle; |
| jasonwshsu | d3b3ed5 | 2023-04-05 22:14:49 +0800 | [diff] [blame] | 24 | import android.preference.PreferenceManager.OnActivityResultListener; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 25 | import android.text.TextUtils; |
| 26 | import android.util.ArrayMap; |
| 27 | import android.util.Log; |
| Chaohui Wang | eb4fea1 | 2023-06-13 17:08:33 +0800 | [diff] [blame] | 28 | import android.view.View; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 29 | |
| Yanting Yang | 4e56cb2 | 2019-04-18 21:37:31 +0800 | [diff] [blame] | 30 | import androidx.annotation.CallSuper; |
| Chaohui Wang | eb4fea1 | 2023-06-13 17:08:33 +0800 | [diff] [blame] | 31 | import androidx.annotation.NonNull; |
| jasonwshsu | d3b3ed5 | 2023-04-05 22:14:49 +0800 | [diff] [blame] | 32 | import androidx.annotation.Nullable; |
| Fan Zhang | 1c61a58 | 2018-07-26 11:26:11 -0700 | [diff] [blame] | 33 | import androidx.annotation.VisibleForTesting; |
| Chaohui Wang | 7047058 | 2022-03-29 14:37:53 +0800 | [diff] [blame] | 34 | import androidx.lifecycle.LifecycleObserver; |
| Chaohui Wang | eb4fea1 | 2023-06-13 17:08:33 +0800 | [diff] [blame] | 35 | import androidx.lifecycle.LifecycleOwner; |
| Fan Zhang | 1c61a58 | 2018-07-26 11:26:11 -0700 | [diff] [blame] | 36 | import androidx.preference.Preference; |
| Peter Zhang | baeca6f | 2023-05-08 16:59:01 +0200 | [diff] [blame] | 37 | import androidx.preference.PreferenceCategory; |
| Doris Ling | 8741c04 | 2018-08-27 14:11:55 -0700 | [diff] [blame] | 38 | import androidx.preference.PreferenceGroup; |
| Fan Zhang | 1c61a58 | 2018-07-26 11:26:11 -0700 | [diff] [blame] | 39 | import androidx.preference.PreferenceManager; |
| 40 | import androidx.preference.PreferenceScreen; |
| Chaohui Wang | cfdb3b1 | 2023-10-24 11:38:26 +0800 | [diff] [blame] | 41 | import androidx.preference.SwitchPreferenceCompat; |
| Fan Zhang | 1c61a58 | 2018-07-26 11:26:11 -0700 | [diff] [blame] | 42 | |
| Yanting Yang | 4e56cb2 | 2019-04-18 21:37:31 +0800 | [diff] [blame] | 43 | import com.android.settings.R; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 44 | import com.android.settings.SettingsPreferenceFragment; |
| Fan Zhang | 917f101 | 2018-02-21 15:22:25 -0800 | [diff] [blame] | 45 | import com.android.settings.core.BasePreferenceController; |
| Jason Chiu | c713c3e | 2021-06-17 17:48:02 +0800 | [diff] [blame] | 46 | import com.android.settings.core.CategoryMixin.CategoryHandler; |
| 47 | import com.android.settings.core.CategoryMixin.CategoryListener; |
| Fan Zhang | 917f101 | 2018-02-21 15:22:25 -0800 | [diff] [blame] | 48 | import com.android.settings.core.PreferenceControllerListHelper; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 49 | import com.android.settings.overlay.FeatureFactory; |
| Wilson Wu | 9edf797 | 2021-08-27 10:19:56 +0800 | [diff] [blame] | 50 | import com.android.settingslib.PrimarySwitchPreference; |
| Tony Mantler | 1d583e1 | 2017-06-13 13:09:25 -0700 | [diff] [blame] | 51 | import com.android.settingslib.core.AbstractPreferenceController; |
| Fan Zhang | 917f101 | 2018-02-21 15:22:25 -0800 | [diff] [blame] | 52 | import com.android.settingslib.core.lifecycle.Lifecycle; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 53 | import com.android.settingslib.drawer.DashboardCategory; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 54 | import com.android.settingslib.drawer.Tile; |
| Jacky Wang | 20558e2 | 2024-10-12 16:09:15 +0800 | [diff] [blame] | 55 | import com.android.settingslib.preference.PreferenceScreenCreator; |
| Raff Tsai | 6db277e | 2019-10-02 16:43:23 +0800 | [diff] [blame] | 56 | import com.android.settingslib.search.Indexable; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 57 | |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 58 | import java.util.ArrayList; |
| Yanting Yang | 4e56cb2 | 2019-04-18 21:37:31 +0800 | [diff] [blame] | 59 | import java.util.Arrays; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 60 | import java.util.Collection; |
| Christian Göllner | ff9065a | 2022-02-17 11:32:54 +0000 | [diff] [blame] | 61 | import java.util.Collections; |
| Peter Zhang | baeca6f | 2023-05-08 16:59:01 +0200 | [diff] [blame] | 62 | import java.util.Comparator; |
| Jacky Wang | 20558e2 | 2024-10-12 16:09:15 +0800 | [diff] [blame] | 63 | import java.util.Iterator; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 64 | import java.util.List; |
| 65 | import java.util.Map; |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 66 | import java.util.Objects; |
| Jason Chiu | 20df25e | 2020-09-30 14:08:33 +0800 | [diff] [blame] | 67 | import java.util.Set; |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 68 | import java.util.concurrent.CountDownLatch; |
| 69 | import java.util.concurrent.TimeUnit; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 70 | |
| 71 | /** |
| 72 | * Base fragment for dashboard style UI containing a list of static and dynamic setting items. |
| 73 | */ |
| 74 | public abstract class DashboardFragment extends SettingsPreferenceFragment |
| Jason Chiu | c713c3e | 2021-06-17 17:48:02 +0800 | [diff] [blame] | 75 | implements CategoryListener, Indexable, PreferenceGroup.OnExpandButtonClickListener, |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 76 | BasePreferenceController.UiBlockListener { |
| Raff Tsai | f71db73 | 2019-12-02 10:55:29 +0800 | [diff] [blame] | 77 | public static final String CATEGORY = "category"; |
| Fan Zhang | db1112a | 2016-10-18 12:58:31 -0700 | [diff] [blame] | 78 | private static final String TAG = "DashboardFragment"; |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 79 | private static final long TIMEOUT_MILLIS = 50L; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 80 | |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 81 | @VisibleForTesting |
| 82 | final ArrayMap<String, List<DynamicDataObserver>> mDashboardTilePrefKeys = new ArrayMap<>(); |
| Ben Lin | 9275177 | 2017-12-21 17:32:34 -0800 | [diff] [blame] | 83 | private final Map<Class, List<AbstractPreferenceController>> mPreferenceControllers = |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 84 | new ArrayMap<>(); |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 85 | private final List<DynamicDataObserver> mRegisteredObservers = new ArrayList<>(); |
| hughchen | d49de61 | 2019-09-24 10:30:49 +0800 | [diff] [blame] | 86 | private final List<AbstractPreferenceController> mControllers = new ArrayList<>(); |
| Sunny Shao | e5e8240 | 2019-11-27 18:55:16 +0800 | [diff] [blame] | 87 | @VisibleForTesting |
| 88 | UiBlockerController mBlockerController; |
| Fan Zhang | b297abc | 2018-02-21 09:37:10 -0800 | [diff] [blame] | 89 | private DashboardFeatureProvider mDashboardFeatureProvider; |
| Fan Zhang | 9dc9c61 | 2016-11-11 13:23:21 -0800 | [diff] [blame] | 90 | private DashboardTilePlaceholderPreferenceController mPlaceholderPreferenceController; |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 91 | private boolean mListeningToCategoryChange; |
| Yanting Yang | 4e56cb2 | 2019-04-18 21:37:31 +0800 | [diff] [blame] | 92 | private List<String> mSuppressInjectedTileKeys; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 93 | |
| 94 | @Override |
| 95 | public void onAttach(Context context) { |
| 96 | super.onAttach(context); |
| Yanting Yang | 4e56cb2 | 2019-04-18 21:37:31 +0800 | [diff] [blame] | 97 | mSuppressInjectedTileKeys = Arrays.asList(context.getResources().getStringArray( |
| 98 | R.array.config_suppress_injected_tile_keys)); |
| Chaohui Wang | 58f0ee3 | 2023-07-20 12:21:16 +0800 | [diff] [blame] | 99 | mDashboardFeatureProvider = |
| 100 | FeatureFactory.getFeatureFactory().getDashboardFeatureProvider(); |
| Fan Zhang | 66b573a | 2016-10-06 16:33:13 -0700 | [diff] [blame] | 101 | |
| Jacky Wang | 20558e2 | 2024-10-12 16:09:15 +0800 | [diff] [blame] | 102 | PreferenceScreenCreator preferenceScreenCreator = getPreferenceScreenCreator(); |
| 103 | if (preferenceScreenCreator == null || !preferenceScreenCreator.hasCompleteHierarchy()) { |
| Jacky Wang | b3e1b52 | 2024-09-09 20:58:38 +0800 | [diff] [blame] | 104 | // Load preference controllers from code |
| 105 | final List<AbstractPreferenceController> controllersFromCode = |
| 106 | createPreferenceControllers(context); |
| 107 | // Load preference controllers from xml definition |
| 108 | final List<BasePreferenceController> controllersFromXml = PreferenceControllerListHelper |
| 109 | .getPreferenceControllersFromXml(context, getPreferenceScreenResId()); |
| 110 | // Filter xml-based controllers in case a similar controller is created from code |
| 111 | // already. |
| 112 | final List<BasePreferenceController> uniqueControllerFromXml = |
| 113 | PreferenceControllerListHelper.filterControllers( |
| 114 | controllersFromXml, controllersFromCode); |
| Fan Zhang | 917f101 | 2018-02-21 15:22:25 -0800 | [diff] [blame] | 115 | |
| Jacky Wang | b3e1b52 | 2024-09-09 20:58:38 +0800 | [diff] [blame] | 116 | // Add unique controllers to list. |
| 117 | if (controllersFromCode != null) { |
| 118 | mControllers.addAll(controllersFromCode); |
| Jason Chiu | 1a1f931 | 2019-10-01 17:35:00 +0800 | [diff] [blame] | 119 | } |
| Jacky Wang | b3e1b52 | 2024-09-09 20:58:38 +0800 | [diff] [blame] | 120 | mControllers.addAll(uniqueControllerFromXml); |
| 121 | |
| 122 | // And wire up with lifecycle. |
| 123 | final Lifecycle lifecycle = getSettingsLifecycle(); |
| 124 | uniqueControllerFromXml.forEach(controller -> { |
| 125 | if (controller instanceof LifecycleObserver) { |
| 126 | lifecycle.addObserver((LifecycleObserver) controller); |
| 127 | } |
| 128 | }); |
| 129 | } |
| Fan Zhang | 917f101 | 2018-02-21 15:22:25 -0800 | [diff] [blame] | 130 | |
| Jason Chiu | 819abf7 | 2020-04-01 15:40:47 +0800 | [diff] [blame] | 131 | // Set metrics category for BasePreferenceController. |
| 132 | final int metricCategory = getMetricsCategory(); |
| 133 | mControllers.forEach(controller -> { |
| 134 | if (controller instanceof BasePreferenceController) { |
| 135 | ((BasePreferenceController) controller).setMetricsCategory(metricCategory); |
| 136 | } |
| 137 | }); |
| 138 | |
| Fan Zhang | 9dc9c61 | 2016-11-11 13:23:21 -0800 | [diff] [blame] | 139 | mPlaceholderPreferenceController = |
| 140 | new DashboardTilePlaceholderPreferenceController(context); |
| hughchen | d49de61 | 2019-09-24 10:30:49 +0800 | [diff] [blame] | 141 | mControllers.add(mPlaceholderPreferenceController); |
| 142 | for (AbstractPreferenceController controller : mControllers) { |
| Fan Zhang | 66b573a | 2016-10-06 16:33:13 -0700 | [diff] [blame] | 143 | addPreferenceController(controller); |
| 144 | } |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 145 | } |
| 146 | |
| jackqdyulei | a5f1b5c | 2019-01-14 10:55:39 -0800 | [diff] [blame] | 147 | @VisibleForTesting |
| 148 | void checkUiBlocker(List<AbstractPreferenceController> controllers) { |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 149 | final List<String> keys = new ArrayList<>(); |
| Yi-Ling Chuang | 61022c6 | 2022-04-18 15:35:52 +0800 | [diff] [blame] | 150 | final List<BasePreferenceController> baseControllers = new ArrayList<>(); |
| Jason Chiu | 1a1f931 | 2019-10-01 17:35:00 +0800 | [diff] [blame] | 151 | controllers.forEach(controller -> { |
| 152 | if (controller instanceof BasePreferenceController.UiBlocker |
| 153 | && controller.isAvailable()) { |
| 154 | ((BasePreferenceController) controller).setUiBlockListener(this); |
| 155 | keys.add(controller.getPreferenceKey()); |
| Yi-Ling Chuang | 61022c6 | 2022-04-18 15:35:52 +0800 | [diff] [blame] | 156 | baseControllers.add((BasePreferenceController) controller); |
| Jason Chiu | 1a1f931 | 2019-10-01 17:35:00 +0800 | [diff] [blame] | 157 | } |
| 158 | }); |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 159 | |
| jackqdyulei | a5f1b5c | 2019-01-14 10:55:39 -0800 | [diff] [blame] | 160 | if (!keys.isEmpty()) { |
| 161 | mBlockerController = new UiBlockerController(keys); |
| Yi-Ling Chuang | 61022c6 | 2022-04-18 15:35:52 +0800 | [diff] [blame] | 162 | mBlockerController.start(() -> { |
| 163 | updatePreferenceVisibility(mPreferenceControllers); |
| 164 | baseControllers.forEach(controller -> controller.setUiBlockerFinished(true)); |
| 165 | }); |
| jackqdyulei | a5f1b5c | 2019-01-14 10:55:39 -0800 | [diff] [blame] | 166 | } |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 167 | } |
| 168 | |
| 169 | @Override |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 170 | public void onCreate(Bundle icicle) { |
| 171 | super.onCreate(icicle); |
| 172 | // Set ComparisonCallback so we get better animation when list changes. |
| 173 | getPreferenceManager().setPreferenceComparisonCallback( |
| 174 | new PreferenceManager.SimplePreferenceComparisonCallback()); |
| jeffreyhuang | bf234af | 2017-11-14 15:09:12 -0800 | [diff] [blame] | 175 | if (icicle != null) { |
| 176 | // Upon rotation configuration change we need to update preference states before any |
| 177 | // editing dialog is recreated (that would happen before onResume is called). |
| 178 | updatePreferenceStates(); |
| 179 | } |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 180 | } |
| 181 | |
| 182 | @Override |
| Chaohui Wang | eb4fea1 | 2023-06-13 17:08:33 +0800 | [diff] [blame] | 183 | public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) { |
| 184 | super.onViewCreated(view, savedInstanceState); |
| 185 | LifecycleOwner viewLifecycleOwner = getViewLifecycleOwner(); |
| 186 | for (AbstractPreferenceController controller : mControllers) { |
| 187 | controller.onViewCreated(viewLifecycleOwner); |
| 188 | } |
| 189 | } |
| 190 | |
| 191 | @Override |
| Jason Chiu | 20df25e | 2020-09-30 14:08:33 +0800 | [diff] [blame] | 192 | public void onCategoriesChanged(Set<String> categories) { |
| 193 | final String categoryKey = getCategoryKey(); |
| 194 | final DashboardCategory dashboardCategory = |
| 195 | mDashboardFeatureProvider.getTilesForCategory(categoryKey); |
| 196 | if (dashboardCategory == null) { |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 197 | return; |
| 198 | } |
| Jason Chiu | 20df25e | 2020-09-30 14:08:33 +0800 | [diff] [blame] | 199 | |
| 200 | if (categories == null) { |
| 201 | // force refreshing |
| 202 | refreshDashboardTiles(getLogTag()); |
| 203 | } else if (categories.contains(categoryKey)) { |
| 204 | Log.i(TAG, "refresh tiles for " + categoryKey); |
| 205 | refreshDashboardTiles(getLogTag()); |
| 206 | } |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 207 | } |
| 208 | |
| 209 | @Override |
| 210 | public void onCreatePreferences(Bundle savedInstanceState, String rootKey) { |
| hughchen | d49de61 | 2019-09-24 10:30:49 +0800 | [diff] [blame] | 211 | checkUiBlocker(mControllers); |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 212 | refreshAllPreferences(getLogTag()); |
| Jason Chiu | b12e3b9 | 2020-04-07 16:30:18 +0800 | [diff] [blame] | 213 | mControllers.stream() |
| 214 | .map(controller -> (Preference) findPreference(controller.getPreferenceKey())) |
| 215 | .filter(Objects::nonNull) |
| 216 | .forEach(preference -> { |
| 217 | // Give all controllers a chance to handle click. |
| 218 | preference.getExtras().putInt(CATEGORY, getMetricsCategory()); |
| 219 | }); |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 220 | } |
| 221 | |
| 222 | @Override |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 223 | public void onStart() { |
| 224 | super.onStart(); |
| Fan Zhang | fabbfb4 | 2016-10-07 12:41:43 -0700 | [diff] [blame] | 225 | final DashboardCategory category = |
| 226 | mDashboardFeatureProvider.getTilesForCategory(getCategoryKey()); |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 227 | if (category == null) { |
| 228 | return; |
| 229 | } |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 230 | final Activity activity = getActivity(); |
| Jason Chiu | c713c3e | 2021-06-17 17:48:02 +0800 | [diff] [blame] | 231 | if (activity instanceof CategoryHandler) { |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 232 | mListeningToCategoryChange = true; |
| Jason Chiu | c713c3e | 2021-06-17 17:48:02 +0800 | [diff] [blame] | 233 | ((CategoryHandler) activity).getCategoryMixin().addCategoryListener(this); |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 234 | } |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 235 | final ContentResolver resolver = getContentResolver(); |
| 236 | mDashboardTilePrefKeys.values().stream() |
| 237 | .filter(Objects::nonNull) |
| 238 | .flatMap(List::stream) |
| 239 | .forEach(observer -> { |
| 240 | if (!mRegisteredObservers.contains(observer)) { |
| 241 | registerDynamicDataObserver(resolver, observer); |
| 242 | } |
| 243 | }); |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 244 | } |
| 245 | |
| 246 | @Override |
| Fan Zhang | 66b573a | 2016-10-06 16:33:13 -0700 | [diff] [blame] | 247 | public void onResume() { |
| 248 | super.onResume(); |
| 249 | updatePreferenceStates(); |
| 250 | } |
| 251 | |
| 252 | @Override |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 253 | public boolean onPreferenceTreeClick(Preference preference) { |
| Jacky Wang | 1c48603 | 2024-09-25 11:58:10 +0800 | [diff] [blame] | 254 | if (isCatalystEnabled()) { |
| 255 | Intent intent = preference.getIntent(); |
| 256 | if (intent != null && preference.getContext().getPackageManager().queryIntentActivities( |
| 257 | intent, 0).isEmpty()) { |
| 258 | Log.w(TAG, "No activity to start for " + intent); |
| 259 | return true; |
| 260 | } |
| 261 | } |
| 262 | |
| Jason Chiu | 1281e59 | 2019-12-12 17:31:28 +0800 | [diff] [blame] | 263 | final Collection<List<AbstractPreferenceController>> controllers = |
| Ben Lin | 9275177 | 2017-12-21 17:32:34 -0800 | [diff] [blame] | 264 | mPreferenceControllers.values(); |
| Ben Lin | 9275177 | 2017-12-21 17:32:34 -0800 | [diff] [blame] | 265 | for (List<AbstractPreferenceController> controllerList : controllers) { |
| 266 | for (AbstractPreferenceController controller : controllerList) { |
| 267 | if (controller.handlePreferenceTreeClick(preference)) { |
| Jason Chiu | 1281e59 | 2019-12-12 17:31:28 +0800 | [diff] [blame] | 268 | // log here since calling super.onPreferenceTreeClick will be skipped |
| 269 | writePreferenceClickMetric(preference); |
| Ben Lin | 9275177 | 2017-12-21 17:32:34 -0800 | [diff] [blame] | 270 | return true; |
| 271 | } |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 272 | } |
| 273 | } |
| 274 | return super.onPreferenceTreeClick(preference); |
| 275 | } |
| 276 | |
| 277 | @Override |
| 278 | public void onStop() { |
| 279 | super.onStop(); |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 280 | unregisterDynamicDataObservers(new ArrayList<>(mRegisteredObservers)); |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 281 | if (mListeningToCategoryChange) { |
| 282 | final Activity activity = getActivity(); |
| Jason Chiu | c713c3e | 2021-06-17 17:48:02 +0800 | [diff] [blame] | 283 | if (activity instanceof CategoryHandler) { |
| 284 | ((CategoryHandler) activity).getCategoryMixin().removeCategoryListener(this); |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 285 | } |
| 286 | mListeningToCategoryChange = false; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 287 | } |
| 288 | } |
| 289 | |
| Fan Zhang | 9679dba | 2017-10-31 14:27:18 -0700 | [diff] [blame] | 290 | @Override |
| 291 | protected abstract int getPreferenceScreenResId(); |
| 292 | |
| Doris Ling | 8741c04 | 2018-08-27 14:11:55 -0700 | [diff] [blame] | 293 | @Override |
| 294 | public void onExpandButtonClick() { |
| Fan Zhang | ff47b30 | 2018-11-09 14:52:42 -0800 | [diff] [blame] | 295 | mMetricsFeatureProvider.action(SettingsEnums.PAGE_UNKNOWN, |
| Fan Zhang | 31b2100 | 2019-01-16 13:49:47 -0800 | [diff] [blame] | 296 | SettingsEnums.ACTION_SETTINGS_ADVANCED_BUTTON_EXPAND, |
| Fan Zhang | ff47b30 | 2018-11-09 14:52:42 -0800 | [diff] [blame] | 297 | getMetricsCategory(), null, 0); |
| Doris Ling | 8741c04 | 2018-08-27 14:11:55 -0700 | [diff] [blame] | 298 | } |
| 299 | |
| jasonwshsu | d3b3ed5 | 2023-04-05 22:14:49 +0800 | [diff] [blame] | 300 | @Override |
| 301 | public void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) { |
| 302 | for (List<AbstractPreferenceController> controllerList : mPreferenceControllers.values()) { |
| 303 | for (AbstractPreferenceController controller : controllerList) { |
| 304 | if (controller instanceof OnActivityResultListener) { |
| 305 | ((OnActivityResultListener) controller).onActivityResult( |
| 306 | requestCode, resultCode, data); |
| 307 | } |
| 308 | } |
| 309 | } |
| 310 | super.onActivityResult(requestCode, resultCode, data); |
| 311 | } |
| 312 | |
| Fan Zhang | 7d5a9ee | 2018-08-09 17:32:37 -0700 | [diff] [blame] | 313 | protected boolean shouldForceRoundedIcon() { |
| 314 | return false; |
| 315 | } |
| 316 | |
| Fan Zhang | f7843ad | 2018-02-22 13:51:41 -0800 | [diff] [blame] | 317 | protected <T extends AbstractPreferenceController> T use(Class<T> clazz) { |
| Ben Lin | 9275177 | 2017-12-21 17:32:34 -0800 | [diff] [blame] | 318 | List<AbstractPreferenceController> controllerList = mPreferenceControllers.get(clazz); |
| 319 | if (controllerList != null) { |
| 320 | if (controllerList.size() > 1) { |
| 321 | Log.w(TAG, "Multiple controllers of Class " + clazz.getSimpleName() |
| 322 | + " found, returning first one."); |
| 323 | } |
| 324 | return (T) controllerList.get(0); |
| 325 | } |
| 326 | |
| 327 | return null; |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 328 | } |
| 329 | |
| tomhsu | 253cb87 | 2024-12-06 10:37:34 +0000 | [diff] [blame] | 330 | /** Returns grouped controllers of input type T. */ |
| 331 | protected <T extends AbstractPreferenceController> List<AbstractPreferenceController> useGroup( |
| 332 | Class<T> clazz) { |
| 333 | return mPreferenceControllers.values().stream().flatMap(Collection::stream).filter( |
| 334 | controller -> clazz.isInstance(controller)).toList(); |
| 335 | } |
| 336 | |
| Christian Göllner | ff9065a | 2022-02-17 11:32:54 +0000 | [diff] [blame] | 337 | /** Returns all controllers of type T. */ |
| 338 | protected <T extends AbstractPreferenceController> List<T> useAll(Class<T> clazz) { |
| 339 | return (List<T>) mPreferenceControllers.getOrDefault(clazz, Collections.emptyList()); |
| 340 | } |
| 341 | |
| Tony Mantler | 1d583e1 | 2017-06-13 13:09:25 -0700 | [diff] [blame] | 342 | protected void addPreferenceController(AbstractPreferenceController controller) { |
| Ben Lin | 9275177 | 2017-12-21 17:32:34 -0800 | [diff] [blame] | 343 | if (mPreferenceControllers.get(controller.getClass()) == null) { |
| 344 | mPreferenceControllers.put(controller.getClass(), new ArrayList<>()); |
| 345 | } |
| 346 | mPreferenceControllers.get(controller.getClass()).add(controller); |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 347 | } |
| 348 | |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 349 | /** |
| Fan Zhang | fabbfb4 | 2016-10-07 12:41:43 -0700 | [diff] [blame] | 350 | * Returns the CategoryKey for loading {@link DashboardCategory} for this fragment. |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 351 | */ |
| Fan Zhang | 26a1def | 2017-07-26 10:58:32 -0700 | [diff] [blame] | 352 | @VisibleForTesting |
| Fan Zhang | 7e6df83 | 2017-01-24 14:02:17 -0800 | [diff] [blame] | 353 | public String getCategoryKey() { |
| 354 | return DashboardFragmentRegistry.PARENT_TO_CATEGORY_KEY_MAP.get(getClass().getName()); |
| 355 | } |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 356 | |
| 357 | /** |
| Fan Zhang | 66b573a | 2016-10-06 16:33:13 -0700 | [diff] [blame] | 358 | * Get the tag string for logging. |
| 359 | */ |
| 360 | protected abstract String getLogTag(); |
| 361 | |
| 362 | /** |
| Tony Mantler | 1d583e1 | 2017-06-13 13:09:25 -0700 | [diff] [blame] | 363 | * Get a list of {@link AbstractPreferenceController} for this fragment. |
| Fan Zhang | 66b573a | 2016-10-06 16:33:13 -0700 | [diff] [blame] | 364 | */ |
| Fan Zhang | f7843ad | 2018-02-22 13:51:41 -0800 | [diff] [blame] | 365 | protected List<AbstractPreferenceController> createPreferenceControllers(Context context) { |
| Fan Zhang | 917f101 | 2018-02-21 15:22:25 -0800 | [diff] [blame] | 366 | return null; |
| 367 | } |
| Fan Zhang | 66b573a | 2016-10-06 16:33:13 -0700 | [diff] [blame] | 368 | |
| 369 | /** |
| Doris Ling | 20d4b04 | 2016-11-22 16:37:06 -0800 | [diff] [blame] | 370 | * Returns true if this tile should be displayed |
| 371 | */ |
| Yanting Yang | 4e56cb2 | 2019-04-18 21:37:31 +0800 | [diff] [blame] | 372 | @CallSuper |
| Doris Ling | 20d4b04 | 2016-11-22 16:37:06 -0800 | [diff] [blame] | 373 | protected boolean displayTile(Tile tile) { |
| Yanting Yang | 4e56cb2 | 2019-04-18 21:37:31 +0800 | [diff] [blame] | 374 | if (mSuppressInjectedTileKeys != null && tile.hasKey()) { |
| 375 | // For suppressing injected tiles for OEMs. |
| 376 | return !mSuppressInjectedTileKeys.contains(tile.getKey(getContext())); |
| 377 | } |
| Doris Ling | 20d4b04 | 2016-11-22 16:37:06 -0800 | [diff] [blame] | 378 | return true; |
| 379 | } |
| 380 | |
| 381 | /** |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 382 | * Displays resource based tiles. |
| 383 | */ |
| Fan Zhang | 66b573a | 2016-10-06 16:33:13 -0700 | [diff] [blame] | 384 | private void displayResourceTiles() { |
| Jacky Wang | b3e1b52 | 2024-09-09 20:58:38 +0800 | [diff] [blame] | 385 | PreferenceScreen screen; |
| Jacky Wang | 20558e2 | 2024-10-12 16:09:15 +0800 | [diff] [blame] | 386 | PreferenceScreenCreator preferenceScreenCreator = getPreferenceScreenCreator(); |
| 387 | if (preferenceScreenCreator != null) { |
| Jacky Wang | b3e1b52 | 2024-09-09 20:58:38 +0800 | [diff] [blame] | 388 | screen = createPreferenceScreen(); |
| Jacky Wang | 20558e2 | 2024-10-12 16:09:15 +0800 | [diff] [blame] | 389 | if (!preferenceScreenCreator.hasCompleteHierarchy()) { |
| 390 | removeControllersForHybridMode(); |
| 391 | } |
| Jacky Wang | b3e1b52 | 2024-09-09 20:58:38 +0800 | [diff] [blame] | 392 | setPreferenceScreen(screen); |
| Jacky Wang | b3e1b52 | 2024-09-09 20:58:38 +0800 | [diff] [blame] | 393 | } else { |
| Jacky Wang | 4cadb75 | 2025-01-22 11:21:54 +0800 | [diff] [blame] | 394 | final int resId = getPreferenceScreenResId(); |
| 395 | if (resId <= 0) { |
| 396 | return; |
| 397 | } |
| Jacky Wang | b3e1b52 | 2024-09-09 20:58:38 +0800 | [diff] [blame] | 398 | addPreferencesFromResource(resId); |
| 399 | screen = getPreferenceScreen(); |
| 400 | } |
| Doris Ling | 8741c04 | 2018-08-27 14:11:55 -0700 | [diff] [blame] | 401 | screen.setOnExpandButtonClickListener(this); |
| Bonian Chen | 048d9fe | 2020-04-20 12:33:49 +0800 | [diff] [blame] | 402 | displayResourceTilesToScreen(screen); |
| 403 | } |
| 404 | |
| Jacky Wang | 20558e2 | 2024-10-12 16:09:15 +0800 | [diff] [blame] | 405 | /** |
| 406 | * Removes preference controllers that have been migrated to catalyst. |
| 407 | * |
| 408 | * In hybrid mode, preference screen is inflated from XML resource, while preference metadata |
| 409 | * in the preference hierarchy are used to update preference widget UI. To avoid conflict, |
| 410 | * remove the preference controllers. |
| 411 | */ |
| 412 | private void removeControllersForHybridMode() { |
| 413 | Set<String> keys = getPreferenceKeysInHierarchy(); |
| 414 | Iterator<AbstractPreferenceController> iterator = mControllers.iterator(); |
| Jacky Wang | b613257 | 2024-11-20 19:08:26 +0800 | [diff] [blame] | 415 | Lifecycle lifecycle = getSettingsLifecycle(); |
| Jacky Wang | 20558e2 | 2024-10-12 16:09:15 +0800 | [diff] [blame] | 416 | while (iterator.hasNext()) { |
| 417 | AbstractPreferenceController controller = iterator.next(); |
| 418 | String key = controller.getPreferenceKey(); |
| 419 | if (keys.contains(key)) { |
| 420 | Log.i(TAG, "Remove preference controller for " + key); |
| 421 | iterator.remove(); |
| 422 | List<AbstractPreferenceController> controllers = mPreferenceControllers.get( |
| 423 | controller.getClass()); |
| 424 | if (controllers != null) { |
| 425 | controllers.remove(controller); |
| 426 | } |
| Jacky Wang | b613257 | 2024-11-20 19:08:26 +0800 | [diff] [blame] | 427 | if (controller instanceof LifecycleObserver) { |
| 428 | lifecycle.removeObserver((LifecycleObserver) controller); |
| 429 | } |
| Jacky Wang | 20558e2 | 2024-10-12 16:09:15 +0800 | [diff] [blame] | 430 | } |
| 431 | } |
| 432 | } |
| 433 | |
| Bonian Chen | 048d9fe | 2020-04-20 12:33:49 +0800 | [diff] [blame] | 434 | /** |
| 435 | * Perform {@link AbstractPreferenceController#displayPreference(PreferenceScreen)} |
| 436 | * on all {@link AbstractPreferenceController}s. |
| 437 | */ |
| 438 | protected void displayResourceTilesToScreen(PreferenceScreen screen) { |
| Ben Lin | 9275177 | 2017-12-21 17:32:34 -0800 | [diff] [blame] | 439 | mPreferenceControllers.values().stream().flatMap(Collection::stream).forEach( |
| 440 | controller -> controller.displayPreference(screen)); |
| Fan Zhang | 66b573a | 2016-10-06 16:33:13 -0700 | [diff] [blame] | 441 | } |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 442 | |
| 443 | /** |
| Bonian Chen | 1b9bda3 | 2020-02-04 10:27:50 +0800 | [diff] [blame] | 444 | * Get current PreferenceController(s) |
| 445 | */ |
| 446 | protected Collection<List<AbstractPreferenceController>> getPreferenceControllers() { |
| 447 | return mPreferenceControllers.values(); |
| 448 | } |
| 449 | |
| 450 | /** |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 451 | * Update state of each preference managed by PreferenceController. |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 452 | */ |
| Fan Zhang | beddff8 | 2016-11-18 11:10:05 -0800 | [diff] [blame] | 453 | protected void updatePreferenceStates() { |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 454 | final PreferenceScreen screen = getPreferenceScreen(); |
| Ben Lin | 9275177 | 2017-12-21 17:32:34 -0800 | [diff] [blame] | 455 | Collection<List<AbstractPreferenceController>> controllerLists = |
| 456 | mPreferenceControllers.values(); |
| 457 | for (List<AbstractPreferenceController> controllerList : controllerLists) { |
| 458 | for (AbstractPreferenceController controller : controllerList) { |
| 459 | if (!controller.isAvailable()) { |
| 460 | continue; |
| 461 | } |
| Jason Chiu | a42a93b | 2018-12-18 18:27:50 +0800 | [diff] [blame] | 462 | |
| Ben Lin | 9275177 | 2017-12-21 17:32:34 -0800 | [diff] [blame] | 463 | final String key = controller.getPreferenceKey(); |
| Jason Chiu | a42a93b | 2018-12-18 18:27:50 +0800 | [diff] [blame] | 464 | if (TextUtils.isEmpty(key)) { |
| 465 | Log.d(TAG, String.format("Preference key is %s in Controller %s", |
| 466 | key, controller.getClass().getSimpleName())); |
| 467 | continue; |
| 468 | } |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 469 | |
| Ben Lin | 9275177 | 2017-12-21 17:32:34 -0800 | [diff] [blame] | 470 | final Preference preference = screen.findPreference(key); |
| 471 | if (preference == null) { |
| 472 | Log.d(TAG, String.format("Cannot find preference with key %s in Controller %s", |
| 473 | key, controller.getClass().getSimpleName())); |
| 474 | continue; |
| 475 | } |
| 476 | controller.updateState(preference); |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 477 | } |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 478 | } |
| 479 | } |
| 480 | |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 481 | /** |
| 482 | * Refresh all preference items, including both static prefs from xml, and dynamic items from |
| 483 | * DashboardCategory. |
| 484 | */ |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 485 | private void refreshAllPreferences(final String tag) { |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 486 | final PreferenceScreen screen = getPreferenceScreen(); |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 487 | // First remove old preferences. |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 488 | if (screen != null) { |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 489 | // Intentionally do not cache PreferenceScreen because it will be recreated later. |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 490 | screen.removeAll(); |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 491 | } |
| 492 | |
| 493 | // Add resource based tiles. |
| 494 | displayResourceTiles(); |
| 495 | |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 496 | refreshDashboardTiles(tag); |
| Fan Zhang | 293883b | 2018-10-26 14:53:12 -0700 | [diff] [blame] | 497 | |
| 498 | final Activity activity = getActivity(); |
| 499 | if (activity != null) { |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 500 | Log.d(tag, "All preferences added, reporting fully drawn"); |
| Fan Zhang | 293883b | 2018-10-26 14:53:12 -0700 | [diff] [blame] | 501 | activity.reportFullyDrawn(); |
| 502 | } |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 503 | |
| jackqdyulei | a5f1b5c | 2019-01-14 10:55:39 -0800 | [diff] [blame] | 504 | updatePreferenceVisibility(mPreferenceControllers); |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 505 | } |
| 506 | |
| Jason Chiu | c897555 | 2022-07-06 16:53:59 +0800 | [diff] [blame] | 507 | /** |
| 508 | * Force update all the preferences in this fragment. |
| 509 | */ |
| 510 | public void forceUpdatePreferences() { |
| 511 | final PreferenceScreen screen = getPreferenceScreen(); |
| 512 | if (screen == null || mPreferenceControllers == null) { |
| 513 | return; |
| 514 | } |
| 515 | for (List<AbstractPreferenceController> controllerList : mPreferenceControllers.values()) { |
| 516 | for (AbstractPreferenceController controller : controllerList) { |
| 517 | final String key = controller.getPreferenceKey(); |
| 518 | final Preference preference = findPreference(key); |
| 519 | if (preference == null) { |
| 520 | continue; |
| 521 | } |
| 522 | final boolean available = controller.isAvailable(); |
| 523 | if (available) { |
| 524 | controller.updateState(preference); |
| 525 | } |
| 526 | preference.setVisible(available); |
| 527 | } |
| 528 | } |
| 529 | } |
| 530 | |
| jackqdyulei | a5f1b5c | 2019-01-14 10:55:39 -0800 | [diff] [blame] | 531 | @VisibleForTesting |
| 532 | void updatePreferenceVisibility( |
| 533 | Map<Class, List<AbstractPreferenceController>> preferenceControllers) { |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 534 | final PreferenceScreen screen = getPreferenceScreen(); |
| jackqdyulei | a5f1b5c | 2019-01-14 10:55:39 -0800 | [diff] [blame] | 535 | if (screen == null || preferenceControllers == null || mBlockerController == null) { |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 536 | return; |
| 537 | } |
| 538 | |
| 539 | final boolean visible = mBlockerController.isBlockerFinished(); |
| 540 | for (List<AbstractPreferenceController> controllerList : |
| jackqdyulei | a5f1b5c | 2019-01-14 10:55:39 -0800 | [diff] [blame] | 541 | preferenceControllers.values()) { |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 542 | for (AbstractPreferenceController controller : controllerList) { |
| 543 | final String key = controller.getPreferenceKey(); |
| jackqdyulei | a5f1b5c | 2019-01-14 10:55:39 -0800 | [diff] [blame] | 544 | final Preference preference = findPreference(key); |
| Yi-Ling Chuang | a28770e | 2022-03-08 18:20:15 +0800 | [diff] [blame] | 545 | if (preference == null) { |
| 546 | continue; |
| 547 | } |
| 548 | if (controller instanceof BasePreferenceController.UiBlocker) { |
| 549 | final boolean prefVisible = |
| 550 | ((BasePreferenceController) controller).getSavedPrefVisibility(); |
| 551 | preference.setVisible(visible && controller.isAvailable() && prefVisible); |
| 552 | } else { |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 553 | preference.setVisible(visible && controller.isAvailable()); |
| 554 | } |
| 555 | } |
| 556 | } |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 557 | } |
| 558 | |
| 559 | /** |
| 560 | * Refresh preference items backed by DashboardCategory. |
| 561 | */ |
| Jacky Wang | b1d2cd8 | 2025-05-13 20:16:30 +0800 | [diff] [blame] | 562 | protected void refreshDashboardTiles(final String tag) { |
| Fan Zhang | 8b5bca5 | 2016-10-19 12:00:32 -0700 | [diff] [blame] | 563 | final PreferenceScreen screen = getPreferenceScreen(); |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 564 | |
| Fan Zhang | fabbfb4 | 2016-10-07 12:41:43 -0700 | [diff] [blame] | 565 | final DashboardCategory category = |
| 566 | mDashboardFeatureProvider.getTilesForCategory(getCategoryKey()); |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 567 | if (category == null) { |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 568 | Log.d(tag, "NO dashboard tiles for " + tag); |
| Fan Zhang | 3692465 | 2016-10-07 08:38:48 -0700 | [diff] [blame] | 569 | return; |
| 570 | } |
| Doris Ling | bcb7635 | 2017-11-22 17:29:21 -0800 | [diff] [blame] | 571 | final List<Tile> tiles = category.getTiles(); |
| Fan Zhang | e6c60c2 | 2016-10-04 17:48:32 -0700 | [diff] [blame] | 572 | if (tiles == null) { |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 573 | Log.d(tag, "tile list is empty, skipping category " + category.key); |
| Fan Zhang | e6c60c2 | 2016-10-04 17:48:32 -0700 | [diff] [blame] | 574 | return; |
| 575 | } |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 576 | // Create a list to track which tiles are to be removed. |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 577 | final Map<String, List<DynamicDataObserver>> remove = new ArrayMap(mDashboardTilePrefKeys); |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 578 | |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 579 | // Install dashboard tiles and collect pending observers. |
| Fan Zhang | 7d5a9ee | 2018-08-09 17:32:37 -0700 | [diff] [blame] | 580 | final boolean forceRoundedIcons = shouldForceRoundedIcon(); |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 581 | final List<DynamicDataObserver> pendingObservers = new ArrayList<>(); |
| Peter Zhang | baeca6f | 2023-05-08 16:59:01 +0200 | [diff] [blame] | 582 | |
| 583 | // Move group tiles to the beginning of the list to ensure they are created before the |
| 584 | // other tiles. |
| 585 | tiles.sort(Comparator.comparingInt(tile -> tile.getType() == Tile.Type.GROUP ? 0 : 1)); |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 586 | for (Tile tile : tiles) { |
| 587 | final String key = mDashboardFeatureProvider.getDashboardKeyForTile(tile); |
| 588 | if (TextUtils.isEmpty(key)) { |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 589 | Log.d(tag, "tile does not contain a key, skipping " + tile); |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 590 | continue; |
| 591 | } |
| Doris Ling | 20d4b04 | 2016-11-22 16:37:06 -0800 | [diff] [blame] | 592 | if (!displayTile(tile)) { |
| 593 | continue; |
| 594 | } |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 595 | final List<DynamicDataObserver> observers; |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 596 | if (mDashboardTilePrefKeys.containsKey(key)) { |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 597 | // Have the key already, will rebind. |
| Doris Ling | 8b14a1a | 2017-08-17 14:45:12 -0700 | [diff] [blame] | 598 | final Preference preference = screen.findPreference(key); |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 599 | observers = mDashboardFeatureProvider.bindPreferenceToTileAndGetObservers( |
| 600 | getActivity(), this, forceRoundedIcons, preference, tile, key, |
| Fan Zhang | 7d5a9ee | 2018-08-09 17:32:37 -0700 | [diff] [blame] | 601 | mPlaceholderPreferenceController.getOrder()); |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 602 | } else { |
| 603 | // Don't have this key, add it. |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 604 | final Preference pref = createPreference(tile); |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 605 | observers = mDashboardFeatureProvider.bindPreferenceToTileAndGetObservers( |
| 606 | getActivity(), this, forceRoundedIcons, pref, tile, key, |
| 607 | mPlaceholderPreferenceController.getOrder()); |
| Edgar Wang | cc0cd09 | 2025-06-20 07:21:45 +0000 | [diff] [blame] | 608 | if (tile.hasGroupKey()) { |
| 609 | Preference group = screen.findPreference(tile.getGroupKey()); |
| 610 | if (group instanceof PreferenceCategory) { |
| 611 | ((PreferenceCategory) group).addPreference(pref); |
| Edgar Wang | 9ff8dde | 2024-04-09 18:03:15 +0000 | [diff] [blame] | 612 | } else { |
| 613 | screen.addPreference(pref); |
| Peter Zhang | baeca6f | 2023-05-08 16:59:01 +0200 | [diff] [blame] | 614 | } |
| 615 | } else { |
| Edgar Wang | cc0cd09 | 2025-06-20 07:21:45 +0000 | [diff] [blame] | 616 | screen.addPreference(pref); |
| Peter Zhang | baeca6f | 2023-05-08 16:59:01 +0200 | [diff] [blame] | 617 | } |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 618 | registerDynamicDataObservers(observers); |
| 619 | mDashboardTilePrefKeys.put(key, observers); |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 620 | } |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 621 | if (observers != null) { |
| 622 | pendingObservers.addAll(observers); |
| 623 | } |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 624 | remove.remove(key); |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 625 | } |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 626 | |
| 627 | // Remove tiles that are gone. |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 628 | for (Map.Entry<String, List<DynamicDataObserver>> entry : remove.entrySet()) { |
| 629 | final String key = entry.getKey(); |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 630 | mDashboardTilePrefKeys.remove(key); |
| Edgar Wang | cc0cd09 | 2025-06-20 07:21:45 +0000 | [diff] [blame] | 631 | screen.removePreferenceRecursively(key); |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 632 | unregisterDynamicDataObservers(entry.getValue()); |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 633 | } |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 634 | |
| 635 | // Wait for pending observers to update UI. |
| 636 | if (!pendingObservers.isEmpty()) { |
| 637 | final CountDownLatch mainLatch = new CountDownLatch(1); |
| 638 | new Thread(() -> { |
| 639 | pendingObservers.forEach(observer -> |
| 640 | awaitObserverLatch(observer.getCountDownLatch())); |
| 641 | mainLatch.countDown(); |
| 642 | }).start(); |
| 643 | Log.d(tag, "Start waiting observers"); |
| 644 | awaitObserverLatch(mainLatch); |
| 645 | Log.d(tag, "Stop waiting observers"); |
| 646 | pendingObservers.forEach(DynamicDataObserver::updateUi); |
| 647 | } |
| Fan Zhang | a1a84e6 | 2016-10-19 14:15:34 -0700 | [diff] [blame] | 648 | } |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 649 | |
| 650 | @Override |
| 651 | public void onBlockerWorkFinished(BasePreferenceController controller) { |
| 652 | mBlockerController.countDown(controller.getPreferenceKey()); |
| Yi-Ling Chuang | a28770e | 2022-03-08 18:20:15 +0800 | [diff] [blame] | 653 | controller.setUiBlockerFinished(mBlockerController.isBlockerFinished()); |
| jackqdyulei | 22904a0 | 2018-12-27 14:40:09 -0800 | [diff] [blame] | 654 | } |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 655 | |
| Jason Chiu | 90eef24 | 2021-11-19 14:35:27 +0800 | [diff] [blame] | 656 | protected Preference createPreference(Tile tile) { |
| Peter Zhang | baeca6f | 2023-05-08 16:59:01 +0200 | [diff] [blame] | 657 | switch (tile.getType()) { |
| 658 | case EXTERNAL_ACTION: |
| 659 | Preference externalActionPreference = new Preference(getPrefContext()); |
| 660 | externalActionPreference |
| 661 | .setWidgetLayoutResource(R.layout.preference_external_action_icon); |
| 662 | return externalActionPreference; |
| 663 | case SWITCH: |
| Chaohui Wang | cfdb3b1 | 2023-10-24 11:38:26 +0800 | [diff] [blame] | 664 | return new SwitchPreferenceCompat(getPrefContext()); |
| Peter Zhang | baeca6f | 2023-05-08 16:59:01 +0200 | [diff] [blame] | 665 | case SWITCH_WITH_ACTION: |
| 666 | return new PrimarySwitchPreference(getPrefContext()); |
| 667 | case GROUP: |
| Peter Zhang | f6a267b | 2023-05-10 16:01:58 +0200 | [diff] [blame] | 668 | mMetricsFeatureProvider.action( |
| 669 | mMetricsFeatureProvider.getAttribution(getActivity()), |
| 670 | SettingsEnums.ACTION_SETTINGS_GROUP_TILE_ADDED_TO_SCREEN, |
| 671 | getMetricsCategory(), |
| 672 | tile.getKey(getContext()), |
| 673 | /* value= */ 0); |
| Peter Zhang | baeca6f | 2023-05-08 16:59:01 +0200 | [diff] [blame] | 674 | return new PreferenceCategory((getPrefContext())); |
| 675 | case ACTION: |
| 676 | default: |
| 677 | return new Preference(getPrefContext()); |
| Peter Zhang | ddb65e5 | 2023-05-07 23:55:50 +0200 | [diff] [blame] | 678 | } |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 679 | } |
| 680 | |
| 681 | @VisibleForTesting |
| 682 | void registerDynamicDataObservers(List<DynamicDataObserver> observers) { |
| 683 | if (observers == null || observers.isEmpty()) { |
| 684 | return; |
| 685 | } |
| 686 | final ContentResolver resolver = getContentResolver(); |
| 687 | observers.forEach(observer -> registerDynamicDataObserver(resolver, observer)); |
| 688 | } |
| 689 | |
| 690 | private void registerDynamicDataObserver(ContentResolver resolver, |
| 691 | DynamicDataObserver observer) { |
| 692 | Log.d(TAG, "register observer: @" + Integer.toHexString(observer.hashCode()) |
| 693 | + ", uri: " + observer.getUri()); |
| Jason Chiu | f22b266 | 2024-06-25 20:55:35 +0800 | [diff] [blame] | 694 | try { |
| 695 | resolver.registerContentObserver(observer.getUri(), false, observer); |
| 696 | mRegisteredObservers.add(observer); |
| 697 | } catch (Exception e) { |
| 698 | Log.w(TAG, "Cannot register observer: " + observer.getUri(), e); |
| 699 | } |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 700 | } |
| 701 | |
| 702 | private void unregisterDynamicDataObservers(List<DynamicDataObserver> observers) { |
| 703 | if (observers == null || observers.isEmpty()) { |
| 704 | return; |
| 705 | } |
| 706 | final ContentResolver resolver = getContentResolver(); |
| 707 | observers.forEach(observer -> { |
| 708 | Log.d(TAG, "unregister observer: @" + Integer.toHexString(observer.hashCode()) |
| 709 | + ", uri: " + observer.getUri()); |
| Jason Chiu | f22b266 | 2024-06-25 20:55:35 +0800 | [diff] [blame] | 710 | if (mRegisteredObservers.remove(observer)) { |
| 711 | try { |
| 712 | resolver.unregisterContentObserver(observer); |
| 713 | } catch (Exception e) { |
| 714 | Log.w(TAG, "Cannot unregister observer: " + observer.getUri(), e); |
| 715 | } |
| 716 | } |
| Jason Chiu | bac5987 | 2019-10-24 17:30:34 +0800 | [diff] [blame] | 717 | }); |
| 718 | } |
| Jason Chiu | c961561 | 2022-05-06 11:14:54 +0800 | [diff] [blame] | 719 | |
| 720 | private void awaitObserverLatch(CountDownLatch latch) { |
| 721 | try { |
| 722 | latch.await(TIMEOUT_MILLIS, TimeUnit.MILLISECONDS); |
| 723 | } catch (InterruptedException e) { |
| 724 | // Do nothing |
| 725 | } |
| 726 | } |
| Fan Zhang | bb6d260 | 2016-10-04 13:21:06 -0700 | [diff] [blame] | 727 | } |