Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2010 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 | |
| 17 | package com.android.settings; |
| 18 | |
Fabrice Di Meglio | 5bdf042 | 2014-07-01 15:15:18 -0700 | [diff] [blame] | 19 | import android.app.Activity; |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 20 | import android.app.Dialog; |
| 21 | import android.app.DialogFragment; |
Daisuke Miyakawa | b5647c5 | 2010-09-10 18:04:02 -0700 | [diff] [blame] | 22 | import android.app.Fragment; |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 23 | import android.content.ContentResolver; |
Amith Yamasani | 350938e | 2013-04-09 10:22:47 -0700 | [diff] [blame] | 24 | import android.content.Context; |
Hung-ying Tyan | 0ee51e0 | 2011-01-25 16:42:14 +0800 | [diff] [blame] | 25 | import android.content.DialogInterface; |
Jason Monk | b7e4380 | 2016-06-06 16:01:58 -0400 | [diff] [blame] | 26 | import android.content.Intent; |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 27 | import android.content.pm.PackageManager; |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 28 | import android.os.Bundle; |
Fan Zhang | e84407f | 2017-05-24 11:19:52 -0700 | [diff] [blame] | 29 | import android.support.annotation.VisibleForTesting; |
Jason Monk | 91e2f89 | 2016-02-23 15:31:09 -0500 | [diff] [blame] | 30 | import android.support.annotation.XmlRes; |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 31 | import android.support.v7.preference.Preference; |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 32 | import android.support.v7.preference.PreferenceGroup; |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 33 | import android.support.v7.preference.PreferenceGroupAdapter; |
| 34 | import android.support.v7.preference.PreferenceScreen; |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 35 | import android.support.v7.preference.PreferenceViewHolder; |
| 36 | import android.support.v7.widget.LinearLayoutManager; |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 37 | import android.support.v7.widget.RecyclerView; |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 38 | import android.text.TextUtils; |
Jason Monk | 2071eda | 2016-02-25 13:55:48 -0500 | [diff] [blame] | 39 | import android.util.ArrayMap; |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 40 | import android.util.Log; |
Fabrice Di Meglio | 8615928 | 2014-07-21 16:02:27 -0700 | [diff] [blame] | 41 | import android.view.LayoutInflater; |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 42 | import android.view.Menu; |
| 43 | import android.view.MenuInflater; |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 44 | import android.view.View; |
Fabrice Di Meglio | 8615928 | 2014-07-21 16:02:27 -0700 | [diff] [blame] | 45 | import android.view.ViewGroup; |
Daisuke Miyakawa | 9c8bde5 | 2010-08-25 11:58:37 -0700 | [diff] [blame] | 46 | import android.widget.Button; |
Jason Monk | b7e4380 | 2016-06-06 16:01:58 -0400 | [diff] [blame] | 47 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 48 | import com.android.settings.applications.LayoutPreference; |
Fan Zhang | 2d0b344 | 2016-12-05 17:02:33 -0800 | [diff] [blame] | 49 | import com.android.settings.core.InstrumentedPreferenceFragment; |
Fan Zhang | 4fe7c08 | 2016-10-03 13:48:55 -0700 | [diff] [blame] | 50 | import com.android.settings.core.instrumentation.Instrumentable; |
Fan Zhang | d65184f | 2016-09-19 17:45:24 -0700 | [diff] [blame] | 51 | import com.android.settings.core.instrumentation.InstrumentedDialogFragment; |
Juan Lang | 4482812 | 2017-05-10 17:26:02 -0700 | [diff] [blame^] | 52 | import com.android.settingslib.CustomDialogPreference; |
| 53 | import com.android.settingslib.CustomEditTextPreference; |
Suprabh Shukla | b84720c | 2016-04-05 14:37:20 -0700 | [diff] [blame] | 54 | import com.android.settingslib.HelpUtils; |
Juan Lang | 777ed25 | 2017-05-09 15:42:36 -0700 | [diff] [blame] | 55 | import com.android.settingslib.widget.FooterPreferenceMixin; |
John Spurlock | b8e02b8 | 2015-04-15 21:15:55 -0400 | [diff] [blame] | 56 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 57 | import java.util.UUID; |
| 58 | |
Daisuke Miyakawa | f58090d | 2010-09-12 17:27:33 -0700 | [diff] [blame] | 59 | /** |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 60 | * Base class for Settings fragments, with some helper functions and dialog management. |
| 61 | */ |
Fan Zhang | 2d0b344 | 2016-12-05 17:02:33 -0800 | [diff] [blame] | 62 | public abstract class SettingsPreferenceFragment extends InstrumentedPreferenceFragment |
Chris Wren | 8a963ba | 2015-03-20 10:29:14 -0400 | [diff] [blame] | 63 | implements DialogCreatable { |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 64 | |
Anna Galusza | 0285c80 | 2016-01-29 17:32:19 -0800 | [diff] [blame] | 65 | /** |
| 66 | * The Help Uri Resource key. This can be passed as an extra argument when creating the |
| 67 | * Fragment. |
| 68 | **/ |
| 69 | public static final String HELP_URI_RESOURCE_KEY = "help_uri_resource"; |
| 70 | |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 71 | private static final String TAG = "SettingsPreference"; |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 72 | |
Matthew Fritze | 33f3e3f | 2017-06-06 17:14:33 -0700 | [diff] [blame] | 73 | @VisibleForTesting |
| 74 | static final int DELAY_HIGHLIGHT_DURATION_MILLIS = 600; |
Fabrice Di Meglio | 6602d02 | 2014-04-15 16:45:20 -0700 | [diff] [blame] | 75 | |
| 76 | private static final String SAVE_HIGHLIGHTED_KEY = "android:preference_highlighted"; |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 77 | |
Fan Zhang | d5b4845 | 2016-12-13 12:42:50 -0800 | [diff] [blame] | 78 | protected final FooterPreferenceMixin mFooterPreferenceMixin = |
| 79 | new FooterPreferenceMixin(this, getLifecycle()); |
| 80 | |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 81 | private SettingsDialogFragment mDialogFragment; |
| 82 | |
Jason Monk | 23acc2b | 2015-04-14 15:06:39 -0400 | [diff] [blame] | 83 | private String mHelpUri; |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 84 | |
Sudheer Shanka | 5590e2e | 2016-01-22 20:40:56 +0000 | [diff] [blame] | 85 | private static final int ORDER_FIRST = -1; |
| 86 | private static final int ORDER_LAST = Integer.MAX_VALUE -1; |
| 87 | |
Amith Yamasani | 350938e | 2013-04-09 10:22:47 -0700 | [diff] [blame] | 88 | // Cache the content resolver for async callbacks |
| 89 | private ContentResolver mContentResolver; |
| 90 | |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 91 | private String mPreferenceKey; |
Fabrice Di Meglio | 6602d02 | 2014-04-15 16:45:20 -0700 | [diff] [blame] | 92 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 93 | private RecyclerView.Adapter mCurrentRootAdapter; |
Fabrice Di Meglio | 829c8fb | 2014-04-21 11:40:21 -0700 | [diff] [blame] | 94 | private boolean mIsDataSetObserverRegistered = false; |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 95 | private RecyclerView.AdapterDataObserver mDataSetObserver = |
| 96 | new RecyclerView.AdapterDataObserver() { |
Tony Mantler | 0b825f5 | 2016-09-27 14:48:16 -0700 | [diff] [blame] | 97 | @Override |
| 98 | public void onChanged() { |
| 99 | onDataSetChanged(); |
| 100 | } |
| 101 | |
| 102 | @Override |
| 103 | public void onItemRangeChanged(int positionStart, int itemCount) { |
| 104 | onDataSetChanged(); |
| 105 | } |
| 106 | |
| 107 | @Override |
| 108 | public void onItemRangeChanged(int positionStart, int itemCount, Object payload) { |
| 109 | onDataSetChanged(); |
| 110 | } |
| 111 | |
| 112 | @Override |
| 113 | public void onItemRangeInserted(int positionStart, int itemCount) { |
| 114 | onDataSetChanged(); |
| 115 | } |
| 116 | |
| 117 | @Override |
| 118 | public void onItemRangeRemoved(int positionStart, int itemCount) { |
| 119 | onDataSetChanged(); |
| 120 | } |
| 121 | |
| 122 | @Override |
| 123 | public void onItemRangeMoved(int fromPosition, int toPosition, int itemCount) { |
| 124 | onDataSetChanged(); |
| 125 | } |
| 126 | }; |
Fabrice Di Meglio | c853a42 | 2014-04-18 19:40:40 -0700 | [diff] [blame] | 127 | |
Fabrice Di Meglio | 8615928 | 2014-07-21 16:02:27 -0700 | [diff] [blame] | 128 | private ViewGroup mPinnedHeaderFrameLayout; |
Daichi Hirono | 5e76cdc | 2015-07-08 11:38:55 +0900 | [diff] [blame] | 129 | private ViewGroup mButtonBar; |
Fabrice Di Meglio | 8615928 | 2014-07-21 16:02:27 -0700 | [diff] [blame] | 130 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 131 | private LayoutPreference mHeader; |
| 132 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 133 | private View mEmptyView; |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 134 | private LinearLayoutManager mLayoutManager; |
Jason Monk | 2071eda | 2016-02-25 13:55:48 -0500 | [diff] [blame] | 135 | private ArrayMap<String, Preference> mPreferenceCache; |
Jason Monk | f38fb38 | 2016-03-18 14:23:01 -0400 | [diff] [blame] | 136 | private boolean mAnimationAllowed; |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 137 | |
Matthew Fritze | 33f3e3f | 2017-06-06 17:14:33 -0700 | [diff] [blame] | 138 | @VisibleForTesting |
| 139 | public HighlightablePreferenceGroupAdapter mAdapter; |
| 140 | @VisibleForTesting |
| 141 | public boolean mPreferenceHighlighted = false; |
| 142 | |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 143 | @Override |
| 144 | public void onCreate(Bundle icicle) { |
| 145 | super.onCreate(icicle); |
| 146 | |
Fabrice Di Meglio | 6602d02 | 2014-04-15 16:45:20 -0700 | [diff] [blame] | 147 | if (icicle != null) { |
| 148 | mPreferenceHighlighted = icicle.getBoolean(SAVE_HIGHLIGHTED_KEY); |
| 149 | } |
| 150 | |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 151 | // Prepare help url and enable menu if necessary |
Anna Galusza | 0285c80 | 2016-01-29 17:32:19 -0800 | [diff] [blame] | 152 | Bundle arguments = getArguments(); |
| 153 | int helpResource; |
| 154 | if (arguments != null && arguments.containsKey(HELP_URI_RESOURCE_KEY)) { |
| 155 | helpResource = arguments.getInt(HELP_URI_RESOURCE_KEY); |
| 156 | } else { |
| 157 | helpResource = getHelpResource(); |
| 158 | } |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 159 | if (helpResource != 0) { |
Jason Monk | 23acc2b | 2015-04-14 15:06:39 -0400 | [diff] [blame] | 160 | mHelpUri = getResources().getString(helpResource); |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 161 | } |
| 162 | } |
| 163 | |
Daisuke Miyakawa | b5647c5 | 2010-09-10 18:04:02 -0700 | [diff] [blame] | 164 | @Override |
Fabrice Di Meglio | 8615928 | 2014-07-21 16:02:27 -0700 | [diff] [blame] | 165 | public View onCreateView(LayoutInflater inflater, ViewGroup container, |
| 166 | Bundle savedInstanceState) { |
| 167 | final View root = super.onCreateView(inflater, container, savedInstanceState); |
| 168 | mPinnedHeaderFrameLayout = (ViewGroup) root.findViewById(R.id.pinned_header); |
Daichi Hirono | 5e76cdc | 2015-07-08 11:38:55 +0900 | [diff] [blame] | 169 | mButtonBar = (ViewGroup) root.findViewById(R.id.button_bar); |
Fabrice Di Meglio | 8615928 | 2014-07-21 16:02:27 -0700 | [diff] [blame] | 170 | return root; |
| 171 | } |
| 172 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 173 | @Override |
Jason Monk | 91e2f89 | 2016-02-23 15:31:09 -0500 | [diff] [blame] | 174 | public void addPreferencesFromResource(@XmlRes int preferencesResId) { |
| 175 | super.addPreferencesFromResource(preferencesResId); |
| 176 | checkAvailablePrefs(getPreferenceScreen()); |
| 177 | } |
| 178 | |
| 179 | private void checkAvailablePrefs(PreferenceGroup preferenceGroup) { |
| 180 | if (preferenceGroup == null) return; |
| 181 | for (int i = 0; i < preferenceGroup.getPreferenceCount(); i++) { |
| 182 | Preference pref = preferenceGroup.getPreference(i); |
| 183 | if (pref instanceof SelfAvailablePreference |
| 184 | && !((SelfAvailablePreference) pref).isAvailable(getContext())) { |
| 185 | preferenceGroup.removePreference(pref); |
| 186 | } else if (pref instanceof PreferenceGroup) { |
| 187 | checkAvailablePrefs((PreferenceGroup) pref); |
| 188 | } |
| 189 | } |
| 190 | } |
| 191 | |
Daichi Hirono | 5e76cdc | 2015-07-08 11:38:55 +0900 | [diff] [blame] | 192 | public ViewGroup getButtonBar() { |
| 193 | return mButtonBar; |
| 194 | } |
| 195 | |
Maurice Lam | 28c3f6b | 2015-04-21 23:01:11 -0700 | [diff] [blame] | 196 | public View setPinnedHeaderView(int layoutResId) { |
| 197 | final LayoutInflater inflater = getActivity().getLayoutInflater(); |
| 198 | final View pinnedHeader = |
| 199 | inflater.inflate(layoutResId, mPinnedHeaderFrameLayout, false); |
| 200 | setPinnedHeaderView(pinnedHeader); |
| 201 | return pinnedHeader; |
| 202 | } |
| 203 | |
Fabrice Di Meglio | 8615928 | 2014-07-21 16:02:27 -0700 | [diff] [blame] | 204 | public void setPinnedHeaderView(View pinnedHeader) { |
| 205 | mPinnedHeaderFrameLayout.addView(pinnedHeader); |
| 206 | mPinnedHeaderFrameLayout.setVisibility(View.VISIBLE); |
| 207 | } |
| 208 | |
Fabrice Di Meglio | 8615928 | 2014-07-21 16:02:27 -0700 | [diff] [blame] | 209 | @Override |
Fabrice Di Meglio | 6602d02 | 2014-04-15 16:45:20 -0700 | [diff] [blame] | 210 | public void onSaveInstanceState(Bundle outState) { |
| 211 | super.onSaveInstanceState(outState); |
| 212 | |
| 213 | outState.putBoolean(SAVE_HIGHLIGHTED_KEY, mPreferenceHighlighted); |
| 214 | } |
| 215 | |
| 216 | @Override |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 217 | public void onActivityCreated(Bundle savedInstanceState) { |
| 218 | super.onActivityCreated(savedInstanceState); |
Johan Redestig | 76218e5 | 2016-04-19 08:29:30 +0200 | [diff] [blame] | 219 | setHasOptionsMenu(true); |
Fabrice Di Meglio | 4a2ee7e | 2014-05-21 16:19:41 -0700 | [diff] [blame] | 220 | } |
| 221 | |
| 222 | @Override |
| 223 | public void onResume() { |
| 224 | super.onResume(); |
Fabrice Di Meglio | c145732 | 2014-04-04 19:07:50 -0700 | [diff] [blame] | 225 | |
| 226 | final Bundle args = getArguments(); |
| 227 | if (args != null) { |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 228 | mPreferenceKey = args.getString(SettingsActivity.EXTRA_FRAGMENT_ARG_KEY); |
| 229 | highlightPreferenceIfNeeded(); |
Fabrice Di Meglio | c145732 | 2014-04-04 19:07:50 -0700 | [diff] [blame] | 230 | } |
| 231 | } |
| 232 | |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 233 | @Override |
| 234 | protected void onBindPreferences() { |
Fabrice Di Meglio | 405febf | 2014-04-24 10:13:59 -0700 | [diff] [blame] | 235 | registerObserverIfNeeded(); |
| 236 | } |
| 237 | |
| 238 | @Override |
Fabrice Di Meglio | d83b3c2 | 2014-08-13 10:45:19 -0700 | [diff] [blame] | 239 | protected void onUnbindPreferences() { |
| 240 | unregisterObserverIfNeeded(); |
| 241 | } |
| 242 | |
Jason Monk | b5aa73f | 2015-03-31 12:59:33 -0400 | [diff] [blame] | 243 | public void showLoadingWhenEmpty() { |
| 244 | View loading = getView().findViewById(R.id.loading_container); |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 245 | setEmptyView(loading); |
Jason Monk | b5aa73f | 2015-03-31 12:59:33 -0400 | [diff] [blame] | 246 | } |
| 247 | |
Jason Monk | b37e288 | 2016-01-11 14:27:20 -0500 | [diff] [blame] | 248 | public void setLoading(boolean loading, boolean animate) { |
| 249 | View loading_container = getView().findViewById(R.id.loading_container); |
| 250 | Utils.handleLoadingContainer(loading_container, getListView(), !loading, animate); |
| 251 | } |
| 252 | |
Fabrice Di Meglio | 405febf | 2014-04-24 10:13:59 -0700 | [diff] [blame] | 253 | public void registerObserverIfNeeded() { |
Fabrice Di Meglio | d83b3c2 | 2014-08-13 10:45:19 -0700 | [diff] [blame] | 254 | if (!mIsDataSetObserverRegistered) { |
| 255 | if (mCurrentRootAdapter != null) { |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 256 | mCurrentRootAdapter.unregisterAdapterDataObserver(mDataSetObserver); |
Fabrice Di Meglio | 7c435f6 | 2014-07-29 16:02:22 -0700 | [diff] [blame] | 257 | } |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 258 | mCurrentRootAdapter = getListView().getAdapter(); |
| 259 | mCurrentRootAdapter.registerAdapterDataObserver(mDataSetObserver); |
Fabrice Di Meglio | d83b3c2 | 2014-08-13 10:45:19 -0700 | [diff] [blame] | 260 | mIsDataSetObserverRegistered = true; |
Jason Monk | 77467e0 | 2016-01-30 12:15:11 -0500 | [diff] [blame] | 261 | onDataSetChanged(); |
Fabrice Di Meglio | 829c8fb | 2014-04-21 11:40:21 -0700 | [diff] [blame] | 262 | } |
Fabrice Di Meglio | c853a42 | 2014-04-18 19:40:40 -0700 | [diff] [blame] | 263 | } |
| 264 | |
Fabrice Di Meglio | 405febf | 2014-04-24 10:13:59 -0700 | [diff] [blame] | 265 | public void unregisterObserverIfNeeded() { |
Fabrice Di Meglio | d83b3c2 | 2014-08-13 10:45:19 -0700 | [diff] [blame] | 266 | if (mIsDataSetObserverRegistered) { |
| 267 | if (mCurrentRootAdapter != null) { |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 268 | mCurrentRootAdapter.unregisterAdapterDataObserver(mDataSetObserver); |
Fabrice Di Meglio | d83b3c2 | 2014-08-13 10:45:19 -0700 | [diff] [blame] | 269 | mCurrentRootAdapter = null; |
Fabrice Di Meglio | 7c435f6 | 2014-07-29 16:02:22 -0700 | [diff] [blame] | 270 | } |
Fabrice Di Meglio | d83b3c2 | 2014-08-13 10:45:19 -0700 | [diff] [blame] | 271 | mIsDataSetObserverRegistered = false; |
Fabrice Di Meglio | 829c8fb | 2014-04-21 11:40:21 -0700 | [diff] [blame] | 272 | } |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 273 | } |
Fabrice Di Meglio | 6602d02 | 2014-04-15 16:45:20 -0700 | [diff] [blame] | 274 | |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 275 | public void highlightPreferenceIfNeeded() { |
Fabrice Di Meglio | c853a42 | 2014-04-18 19:40:40 -0700 | [diff] [blame] | 276 | if (isAdded() && !mPreferenceHighlighted &&!TextUtils.isEmpty(mPreferenceKey)) { |
Matthew Fritze | 33f3e3f | 2017-06-06 17:14:33 -0700 | [diff] [blame] | 277 | getView().postDelayed(new Runnable() { |
| 278 | @Override |
| 279 | public void run() { |
| 280 | highlightPreference(mPreferenceKey); |
| 281 | } |
| 282 | }, DELAY_HIGHLIGHT_DURATION_MILLIS); |
Fabrice Di Meglio | 6602d02 | 2014-04-15 16:45:20 -0700 | [diff] [blame] | 283 | } |
Fabrice Di Meglio | 6602d02 | 2014-04-15 16:45:20 -0700 | [diff] [blame] | 284 | } |
| 285 | |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 286 | protected void onDataSetChanged() { |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 287 | highlightPreferenceIfNeeded(); |
| 288 | updateEmptyView(); |
| 289 | } |
| 290 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 291 | public LayoutPreference getHeaderView() { |
| 292 | return mHeader; |
| 293 | } |
| 294 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 295 | protected void setHeaderView(int resource) { |
| 296 | mHeader = new LayoutPreference(getPrefContext(), resource); |
Udam Saini | d553abc | 2016-02-16 17:54:13 -0800 | [diff] [blame] | 297 | addPreferenceToTop(mHeader); |
| 298 | } |
| 299 | |
| 300 | protected void setHeaderView(View view) { |
| 301 | mHeader = new LayoutPreference(getPrefContext(), view); |
| 302 | addPreferenceToTop(mHeader); |
| 303 | } |
| 304 | |
| 305 | private void addPreferenceToTop(LayoutPreference preference) { |
| 306 | preference.setOrder(ORDER_FIRST); |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 307 | if (getPreferenceScreen() != null) { |
Udam Saini | d553abc | 2016-02-16 17:54:13 -0800 | [diff] [blame] | 308 | getPreferenceScreen().addPreference(preference); |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 309 | } |
| 310 | } |
| 311 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 312 | @Override |
| 313 | public void setPreferenceScreen(PreferenceScreen preferenceScreen) { |
Jason Monk | 1cb12bb | 2016-03-29 13:21:48 -0400 | [diff] [blame] | 314 | if (preferenceScreen != null && !preferenceScreen.isAttached()) { |
Jason Monk | f38fb38 | 2016-03-18 14:23:01 -0400 | [diff] [blame] | 315 | // Without ids generated, the RecyclerView won't animate changes to the preferences. |
| 316 | preferenceScreen.setShouldUseGeneratedIds(mAnimationAllowed); |
| 317 | } |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 318 | super.setPreferenceScreen(preferenceScreen); |
| 319 | if (preferenceScreen != null) { |
| 320 | if (mHeader != null) { |
| 321 | preferenceScreen.addPreference(mHeader); |
| 322 | } |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 323 | } |
| 324 | } |
| 325 | |
jackqdyulei | 2b2abac | 2017-05-26 10:47:55 -0700 | [diff] [blame] | 326 | @VisibleForTesting |
| 327 | void updateEmptyView() { |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 328 | if (mEmptyView == null) return; |
| 329 | if (getPreferenceScreen() != null) { |
jackqdyulei | 2b2abac | 2017-05-26 10:47:55 -0700 | [diff] [blame] | 330 | final View listContainer = getActivity().findViewById(android.R.id.list_container); |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 331 | boolean show = (getPreferenceScreen().getPreferenceCount() |
| 332 | - (mHeader != null ? 1 : 0) |
jackqdyulei | 2b2abac | 2017-05-26 10:47:55 -0700 | [diff] [blame] | 333 | - (mFooterPreferenceMixin.hasFooter() ? 1 : 0)) <= 0 |
| 334 | || (listContainer != null && listContainer.getVisibility() != View.VISIBLE); |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 335 | mEmptyView.setVisibility(show ? View.VISIBLE : View.GONE); |
| 336 | } else { |
| 337 | mEmptyView.setVisibility(View.VISIBLE); |
| 338 | } |
| 339 | } |
| 340 | |
| 341 | public void setEmptyView(View v) { |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 342 | if (mEmptyView != null) { |
| 343 | mEmptyView.setVisibility(View.GONE); |
| 344 | } |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 345 | mEmptyView = v; |
| 346 | updateEmptyView(); |
| 347 | } |
| 348 | |
| 349 | public View getEmptyView() { |
| 350 | return mEmptyView; |
| 351 | } |
| 352 | |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 353 | /** |
| 354 | * Return a valid ListView position or -1 if none is found |
| 355 | */ |
| 356 | private int canUseListViewForHighLighting(String key) { |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 357 | if (getListView() == null) { |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 358 | return -1; |
| 359 | } |
| 360 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 361 | RecyclerView listView = getListView(); |
| 362 | RecyclerView.Adapter adapter = listView.getAdapter(); |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 363 | |
| 364 | if (adapter != null && adapter instanceof PreferenceGroupAdapter) { |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 365 | return findListPositionFromKey((PreferenceGroupAdapter) adapter, key); |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 366 | } |
| 367 | |
| 368 | return -1; |
| 369 | } |
| 370 | |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 371 | @Override |
| 372 | public RecyclerView.LayoutManager onCreateLayoutManager() { |
| 373 | mLayoutManager = new LinearLayoutManager(getContext()); |
| 374 | return mLayoutManager; |
| 375 | } |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 376 | |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 377 | @Override |
| 378 | protected RecyclerView.Adapter onCreateAdapter(PreferenceScreen preferenceScreen) { |
| 379 | mAdapter = new HighlightablePreferenceGroupAdapter(preferenceScreen); |
| 380 | return mAdapter; |
| 381 | } |
| 382 | |
Jason Monk | f38fb38 | 2016-03-18 14:23:01 -0400 | [diff] [blame] | 383 | protected void setAnimationAllowed(boolean animationAllowed) { |
| 384 | mAnimationAllowed = animationAllowed; |
| 385 | } |
| 386 | |
Jason Monk | 2071eda | 2016-02-25 13:55:48 -0500 | [diff] [blame] | 387 | protected void cacheRemoveAllPrefs(PreferenceGroup group) { |
| 388 | mPreferenceCache = new ArrayMap<String, Preference>(); |
| 389 | final int N = group.getPreferenceCount(); |
| 390 | for (int i = 0; i < N; i++) { |
| 391 | Preference p = group.getPreference(i); |
| 392 | if (TextUtils.isEmpty(p.getKey())) { |
| 393 | continue; |
| 394 | } |
| 395 | mPreferenceCache.put(p.getKey(), p); |
| 396 | } |
| 397 | } |
| 398 | |
| 399 | protected Preference getCachedPreference(String key) { |
| 400 | return mPreferenceCache != null ? mPreferenceCache.remove(key) : null; |
| 401 | } |
| 402 | |
| 403 | protected void removeCachedPrefs(PreferenceGroup group) { |
| 404 | for (Preference p : mPreferenceCache.values()) { |
| 405 | group.removePreference(p); |
| 406 | } |
Jason Monk | db7868e | 2016-06-30 15:17:57 -0400 | [diff] [blame] | 407 | mPreferenceCache = null; |
Jason Monk | 2071eda | 2016-02-25 13:55:48 -0500 | [diff] [blame] | 408 | } |
| 409 | |
Jason Monk | a627844 | 2016-04-21 10:12:30 -0400 | [diff] [blame] | 410 | protected int getCachedCount() { |
Jason Monk | db7868e | 2016-06-30 15:17:57 -0400 | [diff] [blame] | 411 | return mPreferenceCache != null ? mPreferenceCache.size() : 0; |
Jason Monk | a627844 | 2016-04-21 10:12:30 -0400 | [diff] [blame] | 412 | } |
| 413 | |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 414 | private void highlightPreference(String key) { |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 415 | final int position = canUseListViewForHighLighting(key); |
Matthew Fritze | 33f3e3f | 2017-06-06 17:14:33 -0700 | [diff] [blame] | 416 | if (position < 0) { |
| 417 | return; |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 418 | } |
Matthew Fritze | 33f3e3f | 2017-06-06 17:14:33 -0700 | [diff] [blame] | 419 | |
| 420 | mPreferenceHighlighted = true; |
| 421 | mLayoutManager.scrollToPosition(position); |
| 422 | mAdapter.highlight(position); |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 423 | } |
| 424 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 425 | private int findListPositionFromKey(PreferenceGroupAdapter adapter, String key) { |
| 426 | final int count = adapter.getItemCount(); |
Fabrice Di Meglio | f2a5226 | 2014-04-17 17:20:27 -0700 | [diff] [blame] | 427 | for (int n = 0; n < count; n++) { |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 428 | final Preference preference = adapter.getItem(n); |
| 429 | final String preferenceKey = preference.getKey(); |
| 430 | if (preferenceKey != null && preferenceKey.equals(key)) { |
| 431 | return n; |
Fabrice Di Meglio | c145732 | 2014-04-04 19:07:50 -0700 | [diff] [blame] | 432 | } |
| 433 | } |
| 434 | return -1; |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 435 | } |
| 436 | |
Fan Zhang | e84407f | 2017-05-24 11:19:52 -0700 | [diff] [blame] | 437 | protected boolean removePreference(String key) { |
| 438 | return removePreference(getPreferenceScreen(), key); |
| 439 | } |
| 440 | |
| 441 | @VisibleForTesting |
| 442 | boolean removePreference(PreferenceGroup group, String key) { |
| 443 | final int preferenceCount = group.getPreferenceCount(); |
| 444 | for (int i = 0; i < preferenceCount; i++) { |
| 445 | final Preference preference = group.getPreference(i); |
| 446 | final String curKey = preference.getKey(); |
| 447 | |
| 448 | if (TextUtils.equals(curKey, key)) { |
| 449 | return group.removePreference(preference); |
| 450 | } |
| 451 | |
| 452 | if (preference instanceof PreferenceGroup) { |
| 453 | if (removePreference((PreferenceGroup) preference, key)) { |
| 454 | return true; |
| 455 | } |
| 456 | } |
Amith Yamasani | 9627a8e | 2012-09-23 12:54:14 -0700 | [diff] [blame] | 457 | } |
Fan Zhang | e84407f | 2017-05-24 11:19:52 -0700 | [diff] [blame] | 458 | return false; |
Amith Yamasani | 9627a8e | 2012-09-23 12:54:14 -0700 | [diff] [blame] | 459 | } |
| 460 | |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 461 | /** |
| 462 | * Override this if you want to show a help item in the menu, by returning the resource id. |
| 463 | * @return the resource id for the help url |
| 464 | */ |
| 465 | protected int getHelpResource() { |
Jason Monk | 23acc2b | 2015-04-14 15:06:39 -0400 | [diff] [blame] | 466 | return R.string.help_uri_default; |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 467 | } |
| 468 | |
| 469 | @Override |
| 470 | public void onCreateOptionsMenu(Menu menu, MenuInflater inflater) { |
Daniel Nishi | e6740f7 | 2017-04-14 14:12:35 -0700 | [diff] [blame] | 471 | super.onCreateOptionsMenu(menu, inflater); |
Jason Monk | 23acc2b | 2015-04-14 15:06:39 -0400 | [diff] [blame] | 472 | if (mHelpUri != null && getActivity() != null) { |
Jason Monk | 15dcebe | 2015-05-27 16:02:08 -0400 | [diff] [blame] | 473 | HelpUtils.prepareHelpMenuItem(getActivity(), menu, mHelpUri, getClass().getName()); |
Amith Yamasani | b0b37ae | 2012-04-23 15:35:36 -0700 | [diff] [blame] | 474 | } |
| 475 | } |
| 476 | |
Daisuke Miyakawa | b5647c5 | 2010-09-10 18:04:02 -0700 | [diff] [blame] | 477 | /* |
| 478 | * The name is intentionally made different from Activity#finish(), so that |
| 479 | * users won't misunderstand its meaning. |
| 480 | */ |
| 481 | public final void finishFragment() { |
| 482 | getActivity().onBackPressed(); |
| 483 | } |
| 484 | |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 485 | // Some helpers for functions used by the settings fragments when they were activities |
| 486 | |
| 487 | /** |
| 488 | * Returns the ContentResolver from the owning Activity. |
| 489 | */ |
| 490 | protected ContentResolver getContentResolver() { |
Amith Yamasani | 350938e | 2013-04-09 10:22:47 -0700 | [diff] [blame] | 491 | Context context = getActivity(); |
| 492 | if (context != null) { |
| 493 | mContentResolver = context.getContentResolver(); |
| 494 | } |
| 495 | return mContentResolver; |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 496 | } |
| 497 | |
| 498 | /** |
| 499 | * Returns the specified system service from the owning Activity. |
| 500 | */ |
| 501 | protected Object getSystemService(final String name) { |
| 502 | return getActivity().getSystemService(name); |
| 503 | } |
| 504 | |
| 505 | /** |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 506 | * Returns the PackageManager from the owning Activity. |
| 507 | */ |
| 508 | protected PackageManager getPackageManager() { |
| 509 | return getActivity().getPackageManager(); |
| 510 | } |
| 511 | |
Dianne Hackborn | 0385cf1 | 2011-01-24 16:22:13 -0800 | [diff] [blame] | 512 | @Override |
| 513 | public void onDetach() { |
| 514 | if (isRemoving()) { |
| 515 | if (mDialogFragment != null) { |
| 516 | mDialogFragment.dismiss(); |
| 517 | mDialogFragment = null; |
| 518 | } |
| 519 | } |
| 520 | super.onDetach(); |
| 521 | } |
| 522 | |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 523 | // Dialog management |
| 524 | |
| 525 | protected void showDialog(int dialogId) { |
| 526 | if (mDialogFragment != null) { |
| 527 | Log.e(TAG, "Old dialog fragment not null!"); |
| 528 | } |
| 529 | mDialogFragment = new SettingsDialogFragment(this, dialogId); |
Fabrice Di Meglio | 377dd62 | 2014-02-12 20:05:57 -0800 | [diff] [blame] | 530 | mDialogFragment.show(getChildFragmentManager(), Integer.toString(dialogId)); |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 531 | } |
| 532 | |
Fan Zhang | d65184f | 2016-09-19 17:45:24 -0700 | [diff] [blame] | 533 | @Override |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 534 | public Dialog onCreateDialog(int dialogId) { |
| 535 | return null; |
| 536 | } |
| 537 | |
Fan Zhang | d65184f | 2016-09-19 17:45:24 -0700 | [diff] [blame] | 538 | @Override |
| 539 | public int getDialogMetricsCategory(int dialogId) { |
| 540 | return 0; |
| 541 | } |
| 542 | |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 543 | protected void removeDialog(int dialogId) { |
Hung-ying Tyan | adc83d8 | 2011-01-24 15:05:27 +0800 | [diff] [blame] | 544 | // mDialogFragment may not be visible yet in parent fragment's onResume(). |
| 545 | // To be able to dismiss dialog at that time, don't check |
| 546 | // mDialogFragment.isVisible(). |
| 547 | if (mDialogFragment != null && mDialogFragment.getDialogId() == dialogId) { |
Jason Monk | 8a7d074 | 2016-07-15 13:18:48 -0400 | [diff] [blame] | 548 | mDialogFragment.dismissAllowingStateLoss(); |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 549 | } |
| 550 | mDialogFragment = null; |
| 551 | } |
| 552 | |
Hung-ying Tyan | 0ee51e0 | 2011-01-25 16:42:14 +0800 | [diff] [blame] | 553 | /** |
| 554 | * Sets the OnCancelListener of the dialog shown. This method can only be |
| 555 | * called after showDialog(int) and before removeDialog(int). The method |
| 556 | * does nothing otherwise. |
| 557 | */ |
| 558 | protected void setOnCancelListener(DialogInterface.OnCancelListener listener) { |
| 559 | if (mDialogFragment != null) { |
| 560 | mDialogFragment.mOnCancelListener = listener; |
| 561 | } |
| 562 | } |
| 563 | |
| 564 | /** |
| 565 | * Sets the OnDismissListener of the dialog shown. This method can only be |
| 566 | * called after showDialog(int) and before removeDialog(int). The method |
| 567 | * does nothing otherwise. |
| 568 | */ |
| 569 | protected void setOnDismissListener(DialogInterface.OnDismissListener listener) { |
| 570 | if (mDialogFragment != null) { |
| 571 | mDialogFragment.mOnDismissListener = listener; |
| 572 | } |
| 573 | } |
| 574 | |
Amith Yamasani | c861cf8 | 2012-10-02 14:51:46 -0700 | [diff] [blame] | 575 | public void onDialogShowing() { |
| 576 | // override in subclass to attach a dismiss listener, for instance |
| 577 | } |
| 578 | |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 579 | @Override |
| 580 | public void onDisplayPreferenceDialog(Preference preference) { |
| 581 | if (preference.getKey() == null) { |
| 582 | // Auto-key preferences that don't have a key, so the dialog can find them. |
| 583 | preference.setKey(UUID.randomUUID().toString()); |
| 584 | } |
| 585 | DialogFragment f = null; |
Sudheer Shanka | 550d068 | 2016-01-13 15:16:55 +0000 | [diff] [blame] | 586 | if (preference instanceof RestrictedListPreference) { |
| 587 | f = RestrictedListPreference.RestrictedListPreferenceDialogFragment |
| 588 | .newInstance(preference.getKey()); |
| 589 | } else if (preference instanceof CustomListPreference) { |
Jason Monk | 39b4674 | 2015-09-10 15:52:51 -0400 | [diff] [blame] | 590 | f = CustomListPreference.CustomListPreferenceDialogFragment |
| 591 | .newInstance(preference.getKey()); |
| 592 | } else if (preference instanceof CustomDialogPreference) { |
| 593 | f = CustomDialogPreference.CustomPreferenceDialogFragment |
| 594 | .newInstance(preference.getKey()); |
| 595 | } else if (preference instanceof CustomEditTextPreference) { |
| 596 | f = CustomEditTextPreference.CustomPreferenceDialogFragment |
| 597 | .newInstance(preference.getKey()); |
| 598 | } else { |
| 599 | super.onDisplayPreferenceDialog(preference); |
| 600 | return; |
| 601 | } |
| 602 | f.setTargetFragment(this, 0); |
| 603 | f.show(getFragmentManager(), "dialog_preference"); |
| 604 | onDialogShowing(); |
| 605 | } |
| 606 | |
Fan Zhang | d65184f | 2016-09-19 17:45:24 -0700 | [diff] [blame] | 607 | public static class SettingsDialogFragment extends InstrumentedDialogFragment { |
Svetoslav Ganov | 749ba65 | 2010-12-09 14:53:02 -0800 | [diff] [blame] | 608 | private static final String KEY_DIALOG_ID = "key_dialog_id"; |
| 609 | private static final String KEY_PARENT_FRAGMENT_ID = "key_parent_fragment_id"; |
| 610 | |
Svetoslav Ganov | 749ba65 | 2010-12-09 14:53:02 -0800 | [diff] [blame] | 611 | private Fragment mParentFragment; |
| 612 | |
Hung-ying Tyan | 0ee51e0 | 2011-01-25 16:42:14 +0800 | [diff] [blame] | 613 | private DialogInterface.OnCancelListener mOnCancelListener; |
| 614 | private DialogInterface.OnDismissListener mOnDismissListener; |
| 615 | |
Svetoslav Ganov | 749ba65 | 2010-12-09 14:53:02 -0800 | [diff] [blame] | 616 | public SettingsDialogFragment() { |
| 617 | /* do nothing */ |
| 618 | } |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 619 | |
Amith Yamasani | 43c6978 | 2010-12-01 09:04:36 -0800 | [diff] [blame] | 620 | public SettingsDialogFragment(DialogCreatable fragment, int dialogId) { |
Fan Zhang | d65184f | 2016-09-19 17:45:24 -0700 | [diff] [blame] | 621 | super(fragment, dialogId); |
Svetoslav Ganov | 749ba65 | 2010-12-09 14:53:02 -0800 | [diff] [blame] | 622 | if (!(fragment instanceof Fragment)) { |
| 623 | throw new IllegalArgumentException("fragment argument must be an instance of " |
| 624 | + Fragment.class.getName()); |
| 625 | } |
| 626 | mParentFragment = (Fragment) fragment; |
| 627 | } |
| 628 | |
Fan Zhang | d65184f | 2016-09-19 17:45:24 -0700 | [diff] [blame] | 629 | |
| 630 | @Override |
| 631 | public int getMetricsCategory() { |
Fan Zhang | 4fe7c08 | 2016-10-03 13:48:55 -0700 | [diff] [blame] | 632 | if (mDialogCreatable == null) { |
| 633 | return Instrumentable.METRICS_CATEGORY_UNKNOWN; |
| 634 | } |
Fan Zhang | d65184f | 2016-09-19 17:45:24 -0700 | [diff] [blame] | 635 | final int metricsCategory = mDialogCreatable.getDialogMetricsCategory(mDialogId); |
| 636 | if (metricsCategory <= 0) { |
| 637 | throw new IllegalStateException("Dialog must provide a metrics category"); |
| 638 | } |
| 639 | return metricsCategory; |
| 640 | } |
| 641 | |
Svetoslav Ganov | 749ba65 | 2010-12-09 14:53:02 -0800 | [diff] [blame] | 642 | @Override |
Dianne Hackborn | 300768f | 2011-01-27 20:39:21 -0800 | [diff] [blame] | 643 | public void onSaveInstanceState(Bundle outState) { |
| 644 | super.onSaveInstanceState(outState); |
| 645 | if (mParentFragment != null) { |
| 646 | outState.putInt(KEY_DIALOG_ID, mDialogId); |
| 647 | outState.putInt(KEY_PARENT_FRAGMENT_ID, mParentFragment.getId()); |
| 648 | } |
| 649 | } |
| 650 | |
| 651 | @Override |
Amith Yamasani | c861cf8 | 2012-10-02 14:51:46 -0700 | [diff] [blame] | 652 | public void onStart() { |
| 653 | super.onStart(); |
| 654 | |
| 655 | if (mParentFragment != null && mParentFragment instanceof SettingsPreferenceFragment) { |
| 656 | ((SettingsPreferenceFragment) mParentFragment).onDialogShowing(); |
| 657 | } |
| 658 | } |
| 659 | |
| 660 | @Override |
Dianne Hackborn | 300768f | 2011-01-27 20:39:21 -0800 | [diff] [blame] | 661 | public Dialog onCreateDialog(Bundle savedInstanceState) { |
Svetoslav Ganov | 749ba65 | 2010-12-09 14:53:02 -0800 | [diff] [blame] | 662 | if (savedInstanceState != null) { |
| 663 | mDialogId = savedInstanceState.getInt(KEY_DIALOG_ID, 0); |
Fabrice Di Meglio | 377dd62 | 2014-02-12 20:05:57 -0800 | [diff] [blame] | 664 | mParentFragment = getParentFragment(); |
Svetoslav Ganov | 749ba65 | 2010-12-09 14:53:02 -0800 | [diff] [blame] | 665 | int mParentFragmentId = savedInstanceState.getInt(KEY_PARENT_FRAGMENT_ID, -1); |
Fabrice Di Meglio | b7bd72f | 2014-07-25 13:03:09 -0700 | [diff] [blame] | 666 | if (mParentFragment == null) { |
| 667 | mParentFragment = getFragmentManager().findFragmentById(mParentFragmentId); |
| 668 | } |
Fabrice Di Meglio | 377dd62 | 2014-02-12 20:05:57 -0800 | [diff] [blame] | 669 | if (!(mParentFragment instanceof DialogCreatable)) { |
| 670 | throw new IllegalArgumentException( |
| 671 | (mParentFragment != null |
| 672 | ? mParentFragment.getClass().getName() |
| 673 | : mParentFragmentId) |
| 674 | + " must implement " |
| 675 | + DialogCreatable.class.getName()); |
Svetoslav Ganov | 749ba65 | 2010-12-09 14:53:02 -0800 | [diff] [blame] | 676 | } |
Amith Yamasani | 8875ede | 2011-01-31 12:46:57 -0800 | [diff] [blame] | 677 | // This dialog fragment could be created from non-SettingsPreferenceFragment |
| 678 | if (mParentFragment instanceof SettingsPreferenceFragment) { |
| 679 | // restore mDialogFragment in mParentFragment |
| 680 | ((SettingsPreferenceFragment) mParentFragment).mDialogFragment = this; |
| 681 | } |
Svetoslav Ganov | 749ba65 | 2010-12-09 14:53:02 -0800 | [diff] [blame] | 682 | } |
Svetoslav Ganov | 749ba65 | 2010-12-09 14:53:02 -0800 | [diff] [blame] | 683 | return ((DialogCreatable) mParentFragment).onCreateDialog(mDialogId); |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 684 | } |
| 685 | |
Hung-ying Tyan | 0ee51e0 | 2011-01-25 16:42:14 +0800 | [diff] [blame] | 686 | @Override |
| 687 | public void onCancel(DialogInterface dialog) { |
| 688 | super.onCancel(dialog); |
| 689 | if (mOnCancelListener != null) { |
| 690 | mOnCancelListener.onCancel(dialog); |
| 691 | } |
| 692 | } |
| 693 | |
| 694 | @Override |
| 695 | public void onDismiss(DialogInterface dialog) { |
| 696 | super.onDismiss(dialog); |
| 697 | if (mOnDismissListener != null) { |
| 698 | mOnDismissListener.onDismiss(dialog); |
| 699 | } |
| 700 | } |
Amith Yamasani | 8875ede | 2011-01-31 12:46:57 -0800 | [diff] [blame] | 701 | |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 702 | public int getDialogId() { |
| 703 | return mDialogId; |
| 704 | } |
Hung-ying Tyan | 18eb39d | 2011-01-28 16:17:27 +0800 | [diff] [blame] | 705 | |
| 706 | @Override |
| 707 | public void onDetach() { |
| 708 | super.onDetach(); |
| 709 | |
Amith Yamasani | 8875ede | 2011-01-31 12:46:57 -0800 | [diff] [blame] | 710 | // This dialog fragment could be created from non-SettingsPreferenceFragment |
| 711 | if (mParentFragment instanceof SettingsPreferenceFragment) { |
| 712 | // in case the dialog is not explicitly removed by removeDialog() |
| 713 | if (((SettingsPreferenceFragment) mParentFragment).mDialogFragment == this) { |
| 714 | ((SettingsPreferenceFragment) mParentFragment).mDialogFragment = null; |
| 715 | } |
Hung-ying Tyan | 18eb39d | 2011-01-28 16:17:27 +0800 | [diff] [blame] | 716 | } |
| 717 | } |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 718 | } |
Daisuke Miyakawa | 9c8bde5 | 2010-08-25 11:58:37 -0700 | [diff] [blame] | 719 | |
| 720 | protected boolean hasNextButton() { |
Daisuke Miyakawa | 79c5fd9 | 2011-01-15 14:58:00 -0800 | [diff] [blame] | 721 | return ((ButtonBarHandler)getActivity()).hasNextButton(); |
Daisuke Miyakawa | 9c8bde5 | 2010-08-25 11:58:37 -0700 | [diff] [blame] | 722 | } |
| 723 | |
| 724 | protected Button getNextButton() { |
Daisuke Miyakawa | 79c5fd9 | 2011-01-15 14:58:00 -0800 | [diff] [blame] | 725 | return ((ButtonBarHandler)getActivity()).getNextButton(); |
Daisuke Miyakawa | 9c8bde5 | 2010-08-25 11:58:37 -0700 | [diff] [blame] | 726 | } |
| 727 | |
Daisuke Miyakawa | 6ebf861 | 2010-09-10 09:48:51 -0700 | [diff] [blame] | 728 | public void finish() { |
Jorim Jaggi | f92fbc1 | 2015-08-10 18:11:07 -0700 | [diff] [blame] | 729 | Activity activity = getActivity(); |
Jason Monk | 656bc60 | 2016-06-10 09:49:12 -0400 | [diff] [blame] | 730 | if (activity == null) return; |
| 731 | if (getFragmentManager().getBackStackEntryCount() > 0) { |
| 732 | getFragmentManager().popBackStack(); |
| 733 | } else { |
Udam Saini | 6a8b99d | 2016-02-10 16:07:41 -0800 | [diff] [blame] | 734 | activity.finish(); |
Jorim Jaggi | f92fbc1 | 2015-08-10 18:11:07 -0700 | [diff] [blame] | 735 | } |
Daisuke Miyakawa | 6ebf861 | 2010-09-10 09:48:51 -0700 | [diff] [blame] | 736 | } |
| 737 | |
Jason Monk | b7e4380 | 2016-06-06 16:01:58 -0400 | [diff] [blame] | 738 | protected Intent getIntent() { |
| 739 | if (getActivity() == null) { |
| 740 | return null; |
| 741 | } |
| 742 | return getActivity().getIntent(); |
| 743 | } |
| 744 | |
| 745 | protected void setResult(int result, Intent intent) { |
| 746 | if (getActivity() == null) { |
| 747 | return; |
| 748 | } |
| 749 | getActivity().setResult(result, intent); |
| 750 | } |
| 751 | |
| 752 | protected void setResult(int result) { |
| 753 | if (getActivity() == null) { |
| 754 | return; |
| 755 | } |
| 756 | getActivity().setResult(result); |
| 757 | } |
| 758 | |
Fabrice Di Meglio | 5bdf042 | 2014-07-01 15:15:18 -0700 | [diff] [blame] | 759 | public boolean startFragment(Fragment caller, String fragmentClass, int titleRes, |
| 760 | int requestCode, Bundle extras) { |
| 761 | final Activity activity = getActivity(); |
| 762 | if (activity instanceof SettingsActivity) { |
| 763 | SettingsActivity sa = (SettingsActivity) activity; |
Fan Zhang | c6ca314 | 2017-02-14 15:02:35 -0800 | [diff] [blame] | 764 | sa.startPreferencePanel( |
| 765 | caller, fragmentClass, extras, titleRes, null, caller, requestCode); |
Fabrice Di Meglio | 5bdf042 | 2014-07-01 15:15:18 -0700 | [diff] [blame] | 766 | return true; |
Daisuke Miyakawa | b5647c5 | 2010-09-10 18:04:02 -0700 | [diff] [blame] | 767 | } else { |
Fabrice Di Meglio | 5bdf042 | 2014-07-01 15:15:18 -0700 | [diff] [blame] | 768 | Log.w(TAG, |
| 769 | "Parent isn't SettingsActivity nor PreferenceActivity, thus there's no way to " |
| 770 | + "launch the given Fragment (name: " + fragmentClass |
| 771 | + ", requestCode: " + requestCode + ")"); |
Daisuke Miyakawa | b5647c5 | 2010-09-10 18:04:02 -0700 | [diff] [blame] | 772 | return false; |
| 773 | } |
| 774 | } |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 775 | |
| 776 | public static class HighlightablePreferenceGroupAdapter extends PreferenceGroupAdapter { |
| 777 | |
Matthew Fritze | 33f3e3f | 2017-06-06 17:14:33 -0700 | [diff] [blame] | 778 | @VisibleForTesting(otherwise=VisibleForTesting.NONE) |
| 779 | int initialHighlightedPosition = -1; |
| 780 | |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 781 | private int mHighlightPosition = -1; |
| 782 | |
| 783 | public HighlightablePreferenceGroupAdapter(PreferenceGroup preferenceGroup) { |
| 784 | super(preferenceGroup); |
| 785 | } |
| 786 | |
| 787 | public void highlight(int position) { |
| 788 | mHighlightPosition = position; |
Matthew Fritze | 33f3e3f | 2017-06-06 17:14:33 -0700 | [diff] [blame] | 789 | initialHighlightedPosition = position; |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 790 | notifyDataSetChanged(); |
| 791 | } |
| 792 | |
| 793 | @Override |
| 794 | public void onBindViewHolder(PreferenceViewHolder holder, int position) { |
| 795 | super.onBindViewHolder(holder, position); |
| 796 | if (position == mHighlightPosition) { |
| 797 | View v = holder.itemView; |
Qi Ding | c477263 | 2016-09-18 17:03:47 +0800 | [diff] [blame] | 798 | v.post(() -> { |
| 799 | if (v.getBackground() != null) { |
| 800 | final int centerX = v.getWidth() / 2; |
| 801 | final int centerY = v.getHeight() / 2; |
| 802 | v.getBackground().setHotspot(centerX, centerY); |
| 803 | } |
| 804 | v.setPressed(true); |
| 805 | v.setPressed(false); |
| 806 | mHighlightPosition = -1; |
| 807 | }); |
Jason Monk | 65bb097 | 2015-12-17 10:39:44 -0500 | [diff] [blame] | 808 | } |
| 809 | } |
| 810 | } |
Amith Yamasani | d799347 | 2010-08-18 13:59:28 -0700 | [diff] [blame] | 811 | } |