19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.preference; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 19212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powellimport com.android.internal.util.CharSequences; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.Context; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.Intent; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.SharedPreferences; 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.res.TypedArray; 25b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasaniimport android.graphics.drawable.Drawable; 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Bundle; 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Parcel; 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Parcelable; 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.text.TextUtils; 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.AttributeSet; 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.AbsSavedState; 32014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reckimport android.view.KeyEvent; 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.LayoutInflater; 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.View; 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.ViewGroup; 36b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasaniimport android.widget.ImageView; 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.widget.ListView; 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.widget.TextView; 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 40212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powellimport java.util.ArrayList; 41212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powellimport java.util.List; 42212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powellimport java.util.Set; 43212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Represents the basic Preference UI building 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * block displayed by a {@link PreferenceActivity} in the form of a 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link ListView}. This class provides the {@link View} to be displayed in 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the activity and associates with a {@link SharedPreferences} to 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * store/retrieve the preference data. 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * When specifying a preference hierarchy in XML, each element can point to a 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * subclass of {@link Preference}, similar to the view hierarchy and layouts. 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This class contains a {@code key} that will be used as the key into the 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link SharedPreferences}. It is up to the subclass to decide how to store 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the value. 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 58b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * @attr ref android.R.styleable#Preference_icon 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_key 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_title 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_summary 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_order 63b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn * @attr ref android.R.styleable#Preference_fragment 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_layout 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_widgetLayout 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_enabled 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_selectable 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_dependency 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_persistent 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_defaultValue 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @attr ref android.R.styleable#Preference_shouldDisableView 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class Preference implements Comparable<Preference>, OnDependencyChangeListener { 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Specify for {@link #setOrder(int)} if a specific order is not required. 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int DEFAULT_ORDER = Integer.MAX_VALUE; 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Context mContext; 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private PreferenceManager mPreferenceManager; 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Set when added to hierarchy since we need a unique ID within that 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * hierarchy. 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private long mId; 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private OnPreferenceChangeListener mOnChangeListener; 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private OnPreferenceClickListener mOnClickListener; 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int mOrder = DEFAULT_ORDER; 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private CharSequence mTitle; 93e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn private int mTitleRes; 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private CharSequence mSummary; 95b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani /** 96b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * mIconResId is overridden by mIcon, if mIcon is specified. 97b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani */ 98b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani private int mIconResId; 99b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani private Drawable mIcon; 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private String mKey; 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Intent mIntent; 102b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn private String mFragment; 103def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn private Bundle mExtras; 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mEnabled = true; 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mSelectable = true; 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mRequiresKey; 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mPersistent = true; 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private String mDependencyKey; 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Object mDefaultValue; 110da53eca79e02ac70761c379f9f2cb3babce9e79dMichael Chan private boolean mDependencyMet = true; 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setShouldDisableView(boolean) 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mShouldDisableView = true; 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int mLayoutResId = com.android.internal.R.layout.preference; 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int mWidgetLayoutResId; 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mHasSpecifiedLayout = false; 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private OnPreferenceChangeInternalListener mListener; 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private List<Preference> mDependents; 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean mBaseMethodCalled; 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Interface definition for a callback to be invoked when the value of this 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Preference} has been changed by the user and is 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * about to be set and/or persisted. This gives the client a chance 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to prevent setting and/or persisting the value. 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface OnPreferenceChangeListener { 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when a Preference has been changed by the user. This is 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * called before the state of the Preference is about to be updated and 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before the state is persisted. 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param preference The changed Preference. 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param newValue The new value of the Preference. 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True to update the state of the Preference with the new value. 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean onPreferenceChange(Preference preference, Object newValue); 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Interface definition for a callback to be invoked when a {@link Preference} is 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * clicked. 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface OnPreferenceClickListener { 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when a Preference has been clicked. 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param preference The Preference that was clicked. 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if the click was handled. 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean onPreferenceClick(Preference preference); 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Interface definition for a callback to be invoked when this 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Preference} is changed or, if this is a group, there is an 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * addition/removal of {@link Preference}(s). This is used internally. 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project interface OnPreferenceChangeInternalListener { 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when this Preference has changed. 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param preference This preference. 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void onPreferenceChange(Preference preference); 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when this group has added/removed {@link Preference}(s). 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param preference This Preference. 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void onPreferenceHierarchyChange(Preference preference); 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Perform inflation from XML and apply a class-specific base style. This 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * constructor of Preference allows subclasses to use their own base 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * style when they are inflating. For example, a {@link CheckBoxPreference} 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * constructor calls this version of the super class constructor and 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * supplies {@code android.R.attr.checkBoxPreferenceStyle} for <var>defStyle</var>. 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This allows the theme's checkbox preference style to modify all of the base 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * preference attributes as well as the {@link CheckBoxPreference} class's 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * attributes. 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param context The Context this is associated with, through which it can 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * access the current theme, resources, {@link SharedPreferences}, 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * etc. 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param attrs The attributes of the XML tag that is inflating the preference. 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param defStyle The default style to apply to this preference. If 0, no style 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be applied (beyond what is included in the theme). This 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * may either be an attribute resource, whose value will be 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * retrieved from the current theme, or an explicit style 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * resource. 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #Preference(Context, AttributeSet) 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Preference(Context context, AttributeSet attrs, int defStyle) { 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mContext = context; 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project TypedArray a = context.obtainStyledAttributes(attrs, 206a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani com.android.internal.R.styleable.Preference, defStyle, 0); 2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = a.getIndexCount(); i >= 0; i--) { 2089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int attr = a.getIndex(i); 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project switch (attr) { 210b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani case com.android.internal.R.styleable.Preference_icon: 211b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani mIconResId = a.getResourceId(attr, 0); 212b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani break; 213b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani 2149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_key: 2159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mKey = a.getString(attr); 2169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_title: 219e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn mTitleRes = a.getResourceId(attr, 0); 2209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mTitle = a.getString(attr); 2219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_summary: 2249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mSummary = a.getString(attr); 2259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_order: 2289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mOrder = a.getInt(attr, mOrder); 2299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 231b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn case com.android.internal.R.styleable.Preference_fragment: 232b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn mFragment = a.getString(attr); 233b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn break; 234b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn 2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_layout: 2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLayoutResId = a.getResourceId(attr, mLayoutResId); 2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_widgetLayout: 2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mWidgetLayoutResId = a.getResourceId(attr, mWidgetLayoutResId); 2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_enabled: 2449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mEnabled = a.getBoolean(attr, true); 2459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_selectable: 2489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mSelectable = a.getBoolean(attr, true); 2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_persistent: 2529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPersistent = a.getBoolean(attr, mPersistent); 2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_dependency: 2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDependencyKey = a.getString(attr); 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_defaultValue: 2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDefaultValue = onGetDefaultValue(a, attr); 2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case com.android.internal.R.styleable.Preference_shouldDisableView: 2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mShouldDisableView = a.getBoolean(attr, mShouldDisableView); 2659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project break; 2669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project a.recycle(); 269a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani 270a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani if (!getClass().getName().startsWith("android.preference")) { 271a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani // For subclasses not in this package, assume the worst and don't cache views 272a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani mHasSpecifiedLayout = true; 273a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani } 2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Constructor that is called when inflating a Preference from XML. This is 2789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * called when a Preference is being constructed from an XML file, supplying 2799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * attributes that were specified in the XML file. This version uses a 2809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * default style of 0, so the only attribute values applied are those in the 2819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Context's Theme and the given AttributeSet. 2829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param context The Context this is associated with, through which it can 2849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * access the current theme, resources, {@link SharedPreferences}, 2859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * etc. 2869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param attrs The attributes of the XML tag that is inflating the 2879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * preference. 2889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #Preference(Context, AttributeSet, int) 2899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Preference(Context context, AttributeSet attrs) { 291e494662c9998b9bb06d0850ec9df9239c8803d27Amith Yamasani this(context, attrs, com.android.internal.R.attr.preferenceStyle); 2929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Constructor to create a Preference. 2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param context The Context in which to store Preference values. 2989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Preference(Context context) { 3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this(context, null); 3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when a Preference is being inflated and the default value 3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * attribute needs to be read. Since different Preference types have 3069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * different value types, the subclass should get and return the default 3079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value which will be its value type. 3089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 3099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * For example, if the value type is String, the body of the method would 3109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * proxy to {@link TypedArray#getString(int)}. 3119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param a The set of attributes. 3139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param index The index of the default value attribute. 3149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The default value of this preference type. 3159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected Object onGetDefaultValue(TypedArray a, int index) { 3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return null; 3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets an {@link Intent} to be used for 3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Context#startActivity(Intent)} when this Preference is clicked. 3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param intent The intent associated with this Preference. 3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setIntent(Intent intent) { 3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mIntent = intent; 3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the {@link Intent} associated with this Preference. 3329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The {@link Intent} last set via {@link #setIntent(Intent)} or XML. 3349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Intent getIntent() { 3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mIntent; 3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 340b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn * Sets the class name of a fragment to be shown when this Preference is clicked. 341b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn * 342b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn * @param fragment The class name of the fragment associated with this Preference. 343b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn */ 344b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn public void setFragment(String fragment) { 345b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn mFragment = fragment; 346b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn } 347b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn 348b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn /** 349b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn * Return the fragment class name associated with this Preference. 350b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn * 351b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn * @return The fragment class name last set via {@link #setFragment} or XML. 352b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn */ 353b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn public String getFragment() { 354b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn return mFragment; 355b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn } 356b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn 357b3cf10ffa8ff9cac0da8b23a0d84076b3f501400Dianne Hackborn /** 358def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn * Return the extras Bundle object associated with this preference, creating 359def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn * a new Bundle if there currently isn't one. You can use this to get and 360def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn * set individual extra key/value pairs. 361def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn */ 362def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn public Bundle getExtras() { 363def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn if (mExtras == null) { 364def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn mExtras = new Bundle(); 365def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn } 366def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn return mExtras; 367def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn } 368def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn 369def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn /** 370def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn * Return the extras Bundle object associated with this preference, 371def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn * returning null if there is not currently one. 372def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn */ 373def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn public Bundle peekExtras() { 374def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn return mExtras; 375def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn } 376def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn 377def1537e9e8d0dd190cde5310ddae8b921088c9bDianne Hackborn /** 3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the layout resource that is inflated as the {@link View} to be shown 3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for this Preference. In most cases, the default layout is sufficient for 3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * custom Preference objects and only the widget layout needs to be changed. 3819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This layout should contain a {@link ViewGroup} with ID 3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.id#widget_frame} to be the parent of the specific widget 3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for this Preference. It should similarly contain 3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.id#title} and {@link android.R.id#summary}. 3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param layoutResId The layout resource ID to be inflated and returned as 3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a {@link View}. 3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setWidgetLayoutResource(int) 3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setLayoutResource(int layoutResId) { 392a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani if (layoutResId != mLayoutResId) { 393a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani // Layout changed 3949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mHasSpecifiedLayout = true; 3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 396a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani 3979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mLayoutResId = layoutResId; 3989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the layout resource that will be shown as the {@link View} for this Preference. 4029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The layout resource ID. 4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getLayoutResource() { 4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mLayoutResId; 4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets The layout for the controllable widget portion of this Preference. This 4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is inflated into the main layout. For example, a {@link CheckBoxPreference} 4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * would specify a custom layout (consisting of just the CheckBox) here, 4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * instead of creating its own main layout. 4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param widgetLayoutResId The layout resource ID to be inflated into the 4169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * main layout. 4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setLayoutResource(int) 4189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setWidgetLayoutResource(int widgetLayoutResId) { 420a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani if (widgetLayoutResId != mWidgetLayoutResId) { 421a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani // Layout changed 422a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani mHasSpecifiedLayout = true; 423a98129b9110371aa036d8fcf23fff709595b16ffAmith Yamasani } 4249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mWidgetLayoutResId = widgetLayoutResId; 4259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the layout resource for the controllable widget portion of this Preference. 4299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The layout resource ID. 4319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getWidgetLayoutResource() { 4339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mWidgetLayoutResId; 4349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the View that will be shown in the {@link PreferenceActivity}. 4389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param convertView The old View to reuse, if possible. Note: You should 4409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * check that this View is non-null and of an appropriate type 4419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * before using. If it is not possible to convert this View to 4429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * display the correct data, this method can create a new View. 4439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param parent The parent that this View will eventually be attached to. 4449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns the same Preference object, for chaining multiple calls 4459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * into a single statement. 4469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #onCreateView(ViewGroup) 4479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #onBindView(View) 4489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public View getView(View convertView, ViewGroup parent) { 4509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (convertView == null) { 451bae6fc244732476d6e6b565e64518e1beafd66c6Amith Yamasani convertView = onCreateView(parent); 4529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onBindView(convertView); 4549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return convertView; 4559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Creates the View to be shown for this Preference in the 4599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link PreferenceActivity}. The default behavior is to inflate the main 4609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * layout of this Preference (see {@link #setLayoutResource(int)}. If 4619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * changing this behavior, please specify a {@link ViewGroup} with ID 4629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.id#widget_frame}. 4639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 4649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Make sure to call through to the superclass's implementation. 4659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param parent The parent that this View will eventually be attached to. 4679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The View that displays this Preference. 4689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #onBindView(View) 4699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected View onCreateView(ViewGroup parent) { 4719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final LayoutInflater layoutInflater = 4729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project (LayoutInflater) mContext.getSystemService(Context.LAYOUT_INFLATER_SERVICE); 4739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final View layout = layoutInflater.inflate(mLayoutResId, parent, false); 4759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 476405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani final ViewGroup widgetFrame = (ViewGroup) layout 477405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani .findViewById(com.android.internal.R.id.widget_frame); 478405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani if (widgetFrame != null) { 479405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani if (mWidgetLayoutResId != 0) { 480405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani layoutInflater.inflate(mWidgetLayoutResId, widgetFrame); 481405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani } else { 482405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani widgetFrame.setVisibility(View.GONE); 483405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani } 4849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return layout; 4869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Binds the created View to the data for this Preference. 4909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 4919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is a good place to grab references to custom Views in the layout and 4929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * set properties on them. 4939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 4949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Make sure to call through to the superclass's implementation. 4959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param view The View that shows this Preference. 4979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #onCreateView(ViewGroup) 4989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onBindView(View view) { 5009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project TextView textView = (TextView) view.findViewById(com.android.internal.R.id.title); 5019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (textView != null) { 5029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project textView.setText(getTitle()); 5039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project textView = (TextView) view.findViewById(com.android.internal.R.id.summary); 5069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (textView != null) { 5079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final CharSequence summary = getSummary(); 5089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!TextUtils.isEmpty(summary)) { 5099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (textView.getVisibility() != View.VISIBLE) { 5109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project textView.setVisibility(View.VISIBLE); 5119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project textView.setText(getSummary()); 5149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 5159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (textView.getVisibility() != View.GONE) { 5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project textView.setVisibility(View.GONE); 5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 521b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani ImageView imageView = (ImageView) view.findViewById(com.android.internal.R.id.icon); 522405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani if (imageView != null) { 523405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani if (mIconResId != 0 || mIcon != null) { 524405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani if (mIcon == null) { 525405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani mIcon = getContext().getResources().getDrawable(mIconResId); 526405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani } 527405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani if (mIcon != null) { 528405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani imageView.setImageDrawable(mIcon); 529405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani } 530b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani } 531405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani imageView.setVisibility(mIcon != null ? View.VISIBLE : View.GONE); 532b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani } 533405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani 5349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mShouldDisableView) { 5359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setEnabledStateOnViews(view, isEnabled()); 5369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 538b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani 5399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Makes sure the view (and any children) get the enabled state changed. 5419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void setEnabledStateOnViews(View v, boolean enabled) { 5439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project v.setEnabled(enabled); 5449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (v instanceof ViewGroup) { 5469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final ViewGroup vg = (ViewGroup) v; 5479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = vg.getChildCount() - 1; i >= 0; i--) { 5489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setEnabledStateOnViews(vg.getChildAt(i), enabled); 5499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the order of this Preference with respect to other 5559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference objects on the same level. If this is not specified, the 5569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * default behavior is to sort alphabetically. The 5579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link PreferenceGroup#setOrderingAsAdded(boolean)} can be used to order 5589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference objects based on the order they appear in the XML. 5599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param order The order for this Preference. A lower value will be shown 5619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * first. Use {@link #DEFAULT_ORDER} to sort alphabetically or 5629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * allow ordering from XML. 5639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see PreferenceGroup#setOrderingAsAdded(boolean) 5649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #DEFAULT_ORDER 5659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setOrder(int order) { 5679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (order != mOrder) { 5689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mOrder = order; 5699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Reorder the list 5719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project notifyHierarchyChanged(); 5729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the order of this Preference with respect to other Preference objects 5779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * on the same level. 5789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The order of this Preference. 5809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setOrder(int) 5819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getOrder() { 5839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mOrder; 5849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the title for this Preference with a CharSequence. 5889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This title will be placed into the ID 5899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.R.id#title} within the View created by 5909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #onCreateView(ViewGroup)}. 5919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The title for this Preference. 5939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setTitle(CharSequence title) { 5959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (title == null && mTitle != null || title != null && !title.equals(mTitle)) { 596e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn mTitleRes = 0; 5979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mTitle = title; 5989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project notifyChanged(); 5999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the title for this Preference with a resource ID. 6049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setTitle(CharSequence) 6069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param titleResId The title as a resource ID. 6079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setTitle(int titleResId) { 6099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setTitle(mContext.getString(titleResId)); 610e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn mTitleRes = titleResId; 6119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 614e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn * Returns the title resource ID of this Preference. If the title did 615e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn * not come from a resource, 0 is returned. 616e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn * 617e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn * @return The title resource. 618e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn * @see #setTitle(int) 619e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn */ 620e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn public int getTitleRes() { 621e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn return mTitleRes; 622e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn } 623e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn 624e72f237defd9956a7e2d2e2bee8cd2558c3f83dbDianne Hackborn /** 6259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the title of this Preference. 6269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The title. 6289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setTitle(CharSequence) 6299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CharSequence getTitle() { 6319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mTitle; 6329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 635b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * Sets the icon for this Preference with a Drawable. 636b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * This icon will be placed into the ID 637b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * {@link android.R.id#icon} within the View created by 638b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * {@link #onCreateView(ViewGroup)}. 639b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * 640b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * @param icon The optional icon for this Preference. 641b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani */ 642b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani public void setIcon(Drawable icon) { 643b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani if ((icon == null && mIcon != null) || (icon != null && mIcon != icon)) { 644b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani mIcon = icon; 645405c1af75607fafdb1d6faf34e13e032e4934787Amith Yamasani 646b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani notifyChanged(); 647b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani } 648b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani } 649b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani 650b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani /** 651b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * Sets the icon for this Preference with a resource ID. 652b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * 653b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * @see #setIcon(Drawable) 654b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * @param iconResId The icon as a resource ID. 655b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani */ 656b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani public void setIcon(int iconResId) { 657b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani mIconResId = iconResId; 658b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani setIcon(mContext.getResources().getDrawable(iconResId)); 659b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani } 660b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani 661b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani /** 662b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * Returns the icon of this Preference. 663b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * 664b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * @return The icon. 665b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani * @see #setIcon(Drawable) 666b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani */ 667b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani public Drawable getIcon() { 668b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani return mIcon; 669b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani } 670b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani 671b65897ba50c76e2110f5b5de455c14ca53d4069bAmith Yamasani /** 6729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the summary of this Preference. 6739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The summary. 6759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setSummary(CharSequence) 6769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CharSequence getSummary() { 6789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mSummary; 6799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the summary for this Preference with a CharSequence. 6839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param summary The summary for the preference. 6859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setSummary(CharSequence summary) { 6879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (summary == null && mSummary != null || summary != null && !summary.equals(mSummary)) { 6889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mSummary = summary; 6899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project notifyChanged(); 6909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the summary for this Preference with a resource ID. 6959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 6969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setSummary(CharSequence) 6979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param summaryResId The summary as a resource. 6989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setSummary(int summaryResId) { 7009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setSummary(mContext.getString(summaryResId)); 7019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets whether this Preference is enabled. If disabled, it will 7059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * not handle clicks. 7069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param enabled Set true to enable it. 7089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setEnabled(boolean enabled) { 7109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mEnabled != enabled) { 7119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mEnabled = enabled; 7129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Enabled state can change dependent preferences' states, so notify 7149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project notifyDependencyChange(shouldDisableDependents()); 7159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project notifyChanged(); 7179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks whether this Preference should be enabled in the list. 7229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if this Preference is enabled, false otherwise. 7249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isEnabled() { 726da53eca79e02ac70761c379f9f2cb3babce9e79dMichael Chan return mEnabled && mDependencyMet; 7279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets whether this Preference is selectable. 7319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param selectable Set true to make it selectable. 7339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setSelectable(boolean selectable) { 7359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mSelectable != selectable) { 7369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mSelectable = selectable; 7379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project notifyChanged(); 7389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks whether this Preference should be selectable in the list. 7439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if it is selectable, false otherwise. 7459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isSelectable() { 7479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mSelectable; 7489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets whether this Preference should disable its view when it gets 7529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * disabled. 7539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 7549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * For example, set this and {@link #setEnabled(boolean)} to false for 7559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * preferences that are only displaying information and 1) should not be 7569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * clickable 2) should not have the view set to the disabled state. 7579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param shouldDisableView Set true if this preference should disable its view 7599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when the preference is disabled. 7609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setShouldDisableView(boolean shouldDisableView) { 7629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mShouldDisableView = shouldDisableView; 7639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project notifyChanged(); 7649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks whether this Preference should disable its view when it's action is disabled. 7689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setShouldDisableView(boolean) 7699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if it should disable the view. 7709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean getShouldDisableView() { 7729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mShouldDisableView; 7739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns a unique ID for this Preference. This ID should be unique across all 7779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference objects in a hierarchy. 7789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A unique ID for this Preference. 7809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project long getId() { 7829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mId; 7839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Processes a click on the preference. This includes saving the value to 7879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the {@link SharedPreferences}. However, the overridden method should 7889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * call {@link #callChangeListener(Object)} to make sure the client wants to 7899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * update the preference's state with the new value. 7909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 7919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onClick() { 7929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 7959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the key for this Preference, which is used as a key to the 7969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link SharedPreferences}. This should be unique for the package. 7979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 7989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param key The key for the preference. 7999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setKey(String key) { 8019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mKey = key; 8029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mRequiresKey && !hasKey()) { 8049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project requireKey(); 8059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the key for this Preference, which is also the key used for storing 8109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * values into SharedPreferences. 8119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The key. 8139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String getKey() { 8159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mKey; 8169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks whether the key is present, and if it isn't throws an 8209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * exception. This should be called by subclasses that store preferences in 8219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the {@link SharedPreferences}. 8229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws IllegalStateException If there is no key assigned. 8249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void requireKey() { 8269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mKey == null) { 8279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException("Preference does not have a key assigned."); 8289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mRequiresKey = true; 8319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks whether this Preference has a valid key. 8359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if the key exists and is not a blank string, false otherwise. 8379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean hasKey() { 8399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return !TextUtils.isEmpty(mKey); 8409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks whether this Preference is persistent. If it is, it stores its value(s) into 8449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the persistent {@link SharedPreferences} storage. 8459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if it is persistent. 8479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isPersistent() { 8499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPersistent; 8509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks whether, at the given time this method is called, 8549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this Preference should store/restore its value(s) into the 8559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link SharedPreferences}. This, at minimum, checks whether this 8569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference is persistent and it currently has a key. Before you 8579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * save/restore from the {@link SharedPreferences}, check this first. 8589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if it should persist the value. 8609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected boolean shouldPersist() { 8629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager != null && isPersistent() && hasKey(); 8639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets whether this Preference is persistent. When persistent, 8679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it stores its value(s) into the persistent {@link SharedPreferences} 8689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * storage. 8699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param persistent Set true if it should store its value(s) into the {@link SharedPreferences}. 8719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setPersistent(boolean persistent) { 8739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPersistent = persistent; 8749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Call this method after the user changes the preference, but before the 8789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * internal state is set. This allows the client to ignore the user value. 8799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param newValue The new value of this Preference. 8819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if the user value should be set as the preference 8829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value (and persisted). 8839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected boolean callChangeListener(Object newValue) { 8859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mOnChangeListener == null ? true : mOnChangeListener.onPreferenceChange(this, newValue); 8869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the callback to be invoked when this Preference is changed by the 8909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * user (but before the internal state has been updated). 8919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 8929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param onPreferenceChangeListener The callback to be invoked. 8939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 8949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setOnPreferenceChangeListener(OnPreferenceChangeListener onPreferenceChangeListener) { 8959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mOnChangeListener = onPreferenceChangeListener; 8969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 8979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 8999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the callback to be invoked when this Preference is changed by the 9009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * user (but before the internal state has been updated). 9019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The callback to be invoked. 9039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 9049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public OnPreferenceChangeListener getOnPreferenceChangeListener() { 9059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mOnChangeListener; 9069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 9099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the callback to be invoked when this Preference is clicked. 9109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param onPreferenceClickListener The callback to be invoked. 9129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 9139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setOnPreferenceClickListener(OnPreferenceClickListener onPreferenceClickListener) { 9149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mOnClickListener = onPreferenceClickListener; 9159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 9189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the callback to be invoked when this Preference is clicked. 9199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The callback to be invoked. 9219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 9229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public OnPreferenceClickListener getOnPreferenceClickListener() { 9239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mOnClickListener; 9249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 9279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when a click should be performed. 9289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param preferenceScreen A {@link PreferenceScreen} whose hierarchy click 9309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * listener should be called in the proper order (between other 9319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * processing). May be null. 9329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 9339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void performClick(PreferenceScreen preferenceScreen) { 9349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!isEnabled()) { 9369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 9379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onClick(); 9409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mOnClickListener != null && mOnClickListener.onPreferenceClick(this)) { 9429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 9439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project PreferenceManager preferenceManager = getPreferenceManager(); 9469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (preferenceManager != null) { 9479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project PreferenceManager.OnPreferenceTreeClickListener listener = preferenceManager 9489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project .getOnPreferenceTreeClickListener(); 9499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (preferenceScreen != null && listener != null 9509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project && listener.onPreferenceTreeClick(preferenceScreen, this)) { 9519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 9529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mIntent != null) { 9569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Context context = getContext(); 9579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project context.startActivity(mIntent); 9589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 960014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck 961014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck /** 962014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck * Allows a Preference to intercept key events without having focus. 963014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck * For example, SeekBarPreference uses this to intercept +/- to adjust 964014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck * the progress. 965014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck * @return True if the Preference handled the key. Returns false by default. 966014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck * @hide 967014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck */ 968014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck public boolean onKey(View v, int keyCode, KeyEvent event) { 969014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck return false; 970014fea2a663ab0bc2d80a6293b84b2647a4a1895John Reck } 9719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 9739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the {@link android.content.Context} of this Preference. 9749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Each Preference in a Preference hierarchy can be 9759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * from different Context (for example, if multiple activities provide preferences into a single 9769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link PreferenceActivity}). This Context will be used to save the Preference values. 9779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The Context of this Preference. 9799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 9809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Context getContext() { 9819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mContext; 9829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 9839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 9849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 9859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the {@link SharedPreferences} where this Preference can read its 9869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value(s). Usually, it's easier to use one of the helper read methods: 9879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #getPersistedBoolean(boolean)}, {@link #getPersistedFloat(float)}, 9889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #getPersistedInt(int)}, {@link #getPersistedLong(long)}, 9899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #getPersistedString(String)}. To save values, see 9909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #getEditor()}. 9919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 9929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * In some cases, writes to the {@link #getEditor()} will not be committed 9939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * right away and hence not show up in the returned 9949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link SharedPreferences}, this is intended behavior to improve 9959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * performance. 9969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 9979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The {@link SharedPreferences} where this Preference reads its 9989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value(s), or null if it isn't attached to a Preference hierarchy. 9999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getEditor() 10009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public SharedPreferences getSharedPreferences() { 10029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mPreferenceManager == null) { 10039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return null; 10049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager.getSharedPreferences(); 10079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns an {@link SharedPreferences.Editor} where this Preference can 10119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * save its value(s). Usually it's easier to use one of the helper save 10129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * methods: {@link #persistBoolean(boolean)}, {@link #persistFloat(float)}, 10139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #persistInt(int)}, {@link #persistLong(long)}, 10149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #persistString(String)}. To read values, see 10159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #getSharedPreferences()}. If {@link #shouldCommit()} returns 10169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * true, it is this Preference's responsibility to commit. 10179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 10189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * In some cases, writes to this will not be committed right away and hence 10199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * not show up in the SharedPreferences, this is intended behavior to 10209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * improve performance. 10219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A {@link SharedPreferences.Editor} where this preference saves 10239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * its value(s), or null if it isn't attached to a Preference 10249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * hierarchy. 10259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #shouldCommit() 10269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getSharedPreferences() 10279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public SharedPreferences.Editor getEditor() { 10299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mPreferenceManager == null) { 10309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return null; 10319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager.getEditor(); 10349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns whether the {@link Preference} should commit its saved value(s) in 10389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #getEditor()}. This may return false in situations where batch 10399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * committing is being done (by the manager) to improve performance. 10409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Whether the Preference should commit its saved value(s). 10429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getEditor() 10439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean shouldCommit() { 10459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mPreferenceManager == null) { 10469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 10479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager.shouldCommit(); 10509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Compares Preference objects based on order (if set), otherwise alphabetically on the titles. 10549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param another The Preference to compare to this one. 10569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return 0 if the same; less than 0 if this Preference sorts ahead of <var>another</var>; 10579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * greater than 0 if this Preference sorts after <var>another</var>. 10589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int compareTo(Preference another) { 10609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mOrder != DEFAULT_ORDER 10619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project || (mOrder == DEFAULT_ORDER && another.mOrder != DEFAULT_ORDER)) { 10629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Do order comparison 10639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mOrder - another.mOrder; 10649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else if (mTitle == null) { 10659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return 1; 10669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else if (another.mTitle == null) { 10679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return -1; 10689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 10699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Do name comparison 10709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return CharSequences.compareToIgnoreCase(mTitle, another.mTitle); 10719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the internal change listener. 10769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 10779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param listener The listener. 10789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #notifyChanged() 10799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final void setOnPreferenceChangeInternalListener(OnPreferenceChangeInternalListener listener) { 10819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mListener = listener; 10829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Should be called when the data of this {@link Preference} has changed. 10869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void notifyChanged() { 10889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mListener != null) { 10899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mListener.onPreferenceChange(this); 10909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 10929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 10939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 10949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Should be called when a Preference has been 10959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * added/removed from this group, or the ordering should be 10969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * re-evaluated. 10979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 10989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void notifyHierarchyChanged() { 10999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mListener != null) { 11009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mListener.onPreferenceHierarchyChange(this); 11019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the {@link PreferenceManager} that manages this Preference object's tree. 11069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 11079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The {@link PreferenceManager}. 11089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public PreferenceManager getPreferenceManager() { 11109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager; 11119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when this Preference has been attached to a Preference hierarchy. 11159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Make sure to call the super implementation. 11169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 11179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param preferenceManager The PreferenceManager of the hierarchy. 11189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onAttachedToHierarchy(PreferenceManager preferenceManager) { 11209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mPreferenceManager = preferenceManager; 11219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mId = preferenceManager.getNextId(); 11239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dispatchSetInitialValue(); 11259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when the Preference hierarchy has been attached to the 11299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link PreferenceActivity}. This can also be called when this 11309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference has been attached to a group that was already attached 11319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to the {@link PreferenceActivity}. 11329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onAttachedToActivity() { 11349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // At this point, the hierarchy that this preference is in is connected 11359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // with all other preferences. 11369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project registerDependency(); 11379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void registerDependency() { 11409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (TextUtils.isEmpty(mDependencyKey)) return; 11429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Preference preference = findPreferenceInHierarchy(mDependencyKey); 11449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (preference != null) { 11459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project preference.registerDependent(this); 11469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 11479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException("Dependency \"" + mDependencyKey 11489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project + "\" not found for preference \"" + mKey + "\" (title: \"" + mTitle + "\""); 11499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void unregisterDependency() { 11539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mDependencyKey != null) { 11549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final Preference oldDependency = findPreferenceInHierarchy(mDependencyKey); 11559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (oldDependency != null) { 11569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project oldDependency.unregisterDependent(this); 11579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Finds a Preference in this hierarchy (the whole thing, 11639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * even above/below your {@link PreferenceScreen} screen break) with the given 11649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * key. 11659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 11669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This only functions after we have been attached to a hierarchy. 11679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 11689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param key The key of the Preference to find. 11699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The Preference that uses the given key. 11709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected Preference findPreferenceInHierarchy(String key) { 11729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (TextUtils.isEmpty(key) || mPreferenceManager == null) { 11739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return null; 11749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager.findPreference(key); 11779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Adds a dependent Preference on this Preference so we can notify it. 11819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Usually, the dependent Preference registers itself (it's good for it to 11829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * know it depends on something), so please use 11839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Preference#setDependency(String)} on the dependent Preference. 11849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 11859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param dependent The dependent Preference that will be enabled/disabled 11869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * according to the state of this Preference. 11879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 11889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void registerDependent(Preference dependent) { 11899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mDependents == null) { 11909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDependents = new ArrayList<Preference>(); 11919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDependents.add(dependent); 11949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dependent.onDependencyChanged(this, shouldDisableDependents()); 11969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 11979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 11989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 11999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Removes a dependent Preference on this Preference. 12009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param dependent The dependent Preference that will be enabled/disabled 12029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * according to the state of this Preference. 12039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns the same Preference object, for chaining multiple calls 12049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * into a single statement. 12059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void unregisterDependent(Preference dependent) { 12079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mDependents != null) { 12089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDependents.remove(dependent); 12099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Notifies any listening dependents of a change that affects the 12149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * dependency. 12159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param disableDependents Whether this Preference should disable 12179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * its dependents. 12189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void notifyDependencyChange(boolean disableDependents) { 12209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final List<Preference> dependents = mDependents; 12219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (dependents == null) { 12239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 12249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int dependentsCount = dependents.size(); 12279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < dependentsCount; i++) { 12289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dependents.get(i).onDependencyChanged(this, disableDependents); 12299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when the dependency changes. 12349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param dependency The Preference that this Preference depends on. 12369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param disableDependent Set true to disable this Preference. 12379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void onDependencyChanged(Preference dependency, boolean disableDependent) { 1239da53eca79e02ac70761c379f9f2cb3babce9e79dMichael Chan if (mDependencyMet == disableDependent) { 1240da53eca79e02ac70761c379f9f2cb3babce9e79dMichael Chan mDependencyMet = !disableDependent; 1241da53eca79e02ac70761c379f9f2cb3babce9e79dMichael Chan 1242da53eca79e02ac70761c379f9f2cb3babce9e79dMichael Chan // Enabled state can change dependent preferences' states, so notify 1243da53eca79e02ac70761c379f9f2cb3babce9e79dMichael Chan notifyDependencyChange(shouldDisableDependents()); 1244da53eca79e02ac70761c379f9f2cb3babce9e79dMichael Chan 1245da53eca79e02ac70761c379f9f2cb3babce9e79dMichael Chan notifyChanged(); 1246da53eca79e02ac70761c379f9f2cb3babce9e79dMichael Chan } 12479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks whether this preference's dependents should currently be 12519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * disabled. 12529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if the dependents should be disabled, otherwise false. 12549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean shouldDisableDependents() { 12569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return !isEnabled(); 12579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the key of a Preference that this Preference will depend on. If that 12619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference is not set or is off, this Preference will be disabled. 12629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param dependencyKey The key of the Preference that this depends on. 12649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setDependency(String dependencyKey) { 12669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Unregister the old dependency, if we had one 12679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project unregisterDependency(); 12689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Register the new 12709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDependencyKey = dependencyKey; 12719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project registerDependency(); 12729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the key of the dependency on this Preference. 12769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The key of the dependency. 12789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setDependency(String) 12799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String getDependency() { 12819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mDependencyKey; 12829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when this Preference is being removed from the hierarchy. You 12869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * should remove any references to this Preference that you know about. Make 12879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * sure to call through to the superclass implementation. 12889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 12899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onPrepareForRemoval() { 12909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project unregisterDependency(); 12919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 12929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 12939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 12949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the default value for this Preference, which will be set either if 12959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * persistence is off or persistence is on and the preference is not found 12969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in the persistent storage. 12979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 12989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param defaultValue The default value. 12999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setDefaultValue(Object defaultValue) { 13019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mDefaultValue = defaultValue; 13029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void dispatchSetInitialValue() { 13059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // By now, we know if we are persistent. 13069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final boolean shouldPersist = shouldPersist(); 13079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!shouldPersist || !getSharedPreferences().contains(mKey)) { 13089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mDefaultValue != null) { 13099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onSetInitialValue(false, mDefaultValue); 13109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 13129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onSetInitialValue(true, null); 13139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 13179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Implement this to set the initial value of the Preference. 13189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 13199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If <var>restorePersistedValue</var> is true, you should restore the 13209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference value from the {@link android.content.SharedPreferences}. If 13219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <var>restorePersistedValue</var> is false, you should set the Preference 13229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value to defaultValue that is given (and possibly store to SharedPreferences 13239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if {@link #shouldPersist()} is true). 13249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 13259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This may not always be called. One example is if it should not persist 13269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * but there is no default value given. 13279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 13289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param restorePersistedValue True to restore the persisted value; 13299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * false to use the given <var>defaultValue</var>. 13309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param defaultValue The default value for this Preference. Only use this 13319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if <var>restorePersistedValue</var> is false. 13329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onSetInitialValue(boolean restorePersistedValue, Object defaultValue) { 13349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void tryCommit(SharedPreferences.Editor editor) { 13379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mPreferenceManager.shouldCommit()) { 1338dd644c179c1bf47d82d776d7f644e4fc1467159dBrad Fitzpatrick try { 1339dd644c179c1bf47d82d776d7f644e4fc1467159dBrad Fitzpatrick editor.apply(); 1340dd644c179c1bf47d82d776d7f644e4fc1467159dBrad Fitzpatrick } catch (AbstractMethodError unused) { 1341dd644c179c1bf47d82d776d7f644e4fc1467159dBrad Fitzpatrick // The app injected its own pre-Gingerbread 1342dd644c179c1bf47d82d776d7f644e4fc1467159dBrad Fitzpatrick // SharedPreferences.Editor implementation without 1343dd644c179c1bf47d82d776d7f644e4fc1467159dBrad Fitzpatrick // an apply method. 1344dd644c179c1bf47d82d776d7f644e4fc1467159dBrad Fitzpatrick editor.commit(); 1345dd644c179c1bf47d82d776d7f644e4fc1467159dBrad Fitzpatrick } 13469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 13509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to persist a String to the {@link android.content.SharedPreferences}. 13519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 13529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This will check if this Preference is persistent, get an editor from 13539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the {@link PreferenceManager}, put in the string, and check if we should commit (and 13549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * commit if so). 13559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 13569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param value The value to persist. 13579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if the Preference is persistent. (This is not whether the 13589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value was persisted, since we may not necessarily commit if there 13599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be a batch commit later.) 13609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getPersistedString(String) 13619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected boolean persistString(String value) { 13639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (shouldPersist()) { 13649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Shouldn't store null 13659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (value == getPersistedString(null)) { 13669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // It's already there, so the same as persisting 13679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 13689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SharedPreferences.Editor editor = mPreferenceManager.getEditor(); 13719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project editor.putString(mKey, value); 13729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project tryCommit(editor); 13739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 13749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 13769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 13799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to get a persisted String from the {@link android.content.SharedPreferences}. 13809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 13819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This will check if this Preference is persistent, get the SharedPreferences 13829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * from the {@link PreferenceManager}, and get the value. 13839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 13849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param defaultReturnValue The default value to return if either the 13859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference is not persistent or the Preference is not in the 13869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * shared preferences. 13879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The value from the SharedPreferences or the default return 13889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value. 13899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #persistString(String) 13909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 13919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected String getPersistedString(String defaultReturnValue) { 13929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!shouldPersist()) { 13939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return defaultReturnValue; 13949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager.getSharedPreferences().getString(mKey, defaultReturnValue); 13979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 13989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 13999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1400212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * Attempts to persist a set of Strings to the {@link android.content.SharedPreferences}. 1401212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * <p> 1402212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * This will check if this Preference is persistent, get an editor from 1403212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * the {@link PreferenceManager}, put in the strings, and check if we should commit (and 1404212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * commit if so). 1405212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * 1406212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * @param values The values to persist. 1407212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * @return True if the Preference is persistent. (This is not whether the 1408212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * value was persisted, since we may not necessarily commit if there 1409212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * will be a batch commit later.) 1410212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * @see #getPersistedString(Set) 1411212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * 1412212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * @hide Pending API approval 1413212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell */ 1414212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell protected boolean persistStringSet(Set<String> values) { 1415212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell if (shouldPersist()) { 1416212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell // Shouldn't store null 1417212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell if (values.equals(getPersistedStringSet(null))) { 1418212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell // It's already there, so the same as persisting 1419212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell return true; 1420212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell } 1421212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell 1422212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell SharedPreferences.Editor editor = mPreferenceManager.getEditor(); 1423212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell editor.putStringSet(mKey, values); 1424212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell tryCommit(editor); 1425212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell return true; 1426212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell } 1427212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell return false; 1428212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell } 1429212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell 1430212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell /** 1431212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * Attempts to get a persisted set of Strings from the 1432212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * {@link android.content.SharedPreferences}. 1433212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * <p> 1434212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * This will check if this Preference is persistent, get the SharedPreferences 1435212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * from the {@link PreferenceManager}, and get the value. 1436212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * 1437212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * @param defaultReturnValue The default value to return if either the 1438212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * Preference is not persistent or the Preference is not in the 1439212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * shared preferences. 1440212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * @return The value from the SharedPreferences or the default return 1441212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * value. 1442212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * @see #persistStringSet(Set) 1443212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * 1444212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell * @hide Pending API approval 1445212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell */ 1446212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell protected Set<String> getPersistedStringSet(Set<String> defaultReturnValue) { 1447212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell if (!shouldPersist()) { 1448212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell return defaultReturnValue; 1449212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell } 1450212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell 1451212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell return mPreferenceManager.getSharedPreferences().getStringSet(mKey, defaultReturnValue); 1452212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell } 1453212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell 1454212db7d3f8ce5297f4a556234a9c0675c697f1cfAdam Powell /** 14559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to persist an int to the {@link android.content.SharedPreferences}. 14569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 14579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param value The value to persist. 14589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if the Preference is persistent. (This is not whether the 14599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value was persisted, since we may not necessarily commit if there 14609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be a batch commit later.) 14619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #persistString(String) 14629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getPersistedInt(int) 14639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 14649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected boolean persistInt(int value) { 14659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (shouldPersist()) { 14669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (value == getPersistedInt(~value)) { 14679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // It's already there, so the same as persisting 14689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 14699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SharedPreferences.Editor editor = mPreferenceManager.getEditor(); 14729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project editor.putInt(mKey, value); 14739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project tryCommit(editor); 14749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 14759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 14779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 14809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to get a persisted int from the {@link android.content.SharedPreferences}. 14819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 14829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param defaultReturnValue The default value to return if either this 14839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference is not persistent or this Preference is not in the 14849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SharedPreferences. 14859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The value from the SharedPreferences or the default return 14869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value. 14879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getPersistedString(String) 14889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #persistInt(int) 14899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 14909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected int getPersistedInt(int defaultReturnValue) { 14919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!shouldPersist()) { 14929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return defaultReturnValue; 14939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager.getSharedPreferences().getInt(mKey, defaultReturnValue); 14969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 14979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 14989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 14999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to persist a float to the {@link android.content.SharedPreferences}. 15009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param value The value to persist. 15029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if this Preference is persistent. (This is not whether the 15039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value was persisted, since we may not necessarily commit if there 15049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be a batch commit later.) 15059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #persistString(String) 15069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getPersistedFloat(float) 15079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected boolean persistFloat(float value) { 15099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (shouldPersist()) { 15109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (value == getPersistedFloat(Float.NaN)) { 15119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // It's already there, so the same as persisting 15129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 15139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SharedPreferences.Editor editor = mPreferenceManager.getEditor(); 15169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project editor.putFloat(mKey, value); 15179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project tryCommit(editor); 15189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 15199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 15219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to get a persisted float from the {@link android.content.SharedPreferences}. 15259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param defaultReturnValue The default value to return if either this 15279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference is not persistent or this Preference is not in the 15289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SharedPreferences. 15299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The value from the SharedPreferences or the default return 15309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value. 15319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getPersistedString(String) 15329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #persistFloat(float) 15339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected float getPersistedFloat(float defaultReturnValue) { 15359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!shouldPersist()) { 15369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return defaultReturnValue; 15379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager.getSharedPreferences().getFloat(mKey, defaultReturnValue); 15409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to persist a long to the {@link android.content.SharedPreferences}. 15449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param value The value to persist. 15469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if this Preference is persistent. (This is not whether the 15479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value was persisted, since we may not necessarily commit if there 15489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be a batch commit later.) 15499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #persistString(String) 15509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getPersistedLong(long) 15519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected boolean persistLong(long value) { 15539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (shouldPersist()) { 15549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (value == getPersistedLong(~value)) { 15559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // It's already there, so the same as persisting 15569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 15579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SharedPreferences.Editor editor = mPreferenceManager.getEditor(); 15609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project editor.putLong(mKey, value); 15619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project tryCommit(editor); 15629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 15639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 15659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to get a persisted long from the {@link android.content.SharedPreferences}. 15699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param defaultReturnValue The default value to return if either this 15719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference is not persistent or this Preference is not in the 15729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SharedPreferences. 15739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The value from the SharedPreferences or the default return 15749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value. 15759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getPersistedString(String) 15769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #persistLong(long) 15779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected long getPersistedLong(long defaultReturnValue) { 15799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!shouldPersist()) { 15809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return defaultReturnValue; 15819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager.getSharedPreferences().getLong(mKey, defaultReturnValue); 15849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 15859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 15869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 15879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to persist a boolean to the {@link android.content.SharedPreferences}. 15889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 15899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param value The value to persist. 15909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if this Preference is persistent. (This is not whether the 15919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value was persisted, since we may not necessarily commit if there 15929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be a batch commit later.) 15939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #persistString(String) 15949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getPersistedBoolean(boolean) 15959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 15969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected boolean persistBoolean(boolean value) { 15979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (shouldPersist()) { 15989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (value == getPersistedBoolean(!value)) { 15999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // It's already there, so the same as persisting 16009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 16019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SharedPreferences.Editor editor = mPreferenceManager.getEditor(); 16049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project editor.putBoolean(mKey, value); 16059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project tryCommit(editor); 16069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 16079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 16099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 16129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Attempts to get a persisted boolean from the {@link android.content.SharedPreferences}. 16139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param defaultReturnValue The default value to return if either this 16159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference is not persistent or this Preference is not in the 16169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SharedPreferences. 16179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The value from the SharedPreferences or the default return 16189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * value. 16199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getPersistedString(String) 16209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #persistBoolean(boolean) 16219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected boolean getPersistedBoolean(boolean defaultReturnValue) { 16239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!shouldPersist()) { 16249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return defaultReturnValue; 16259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mPreferenceManager.getSharedPreferences().getBoolean(mKey, defaultReturnValue); 16289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean hasSpecifiedLayout() { 16319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mHasSpecifiedLayout; 16329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 16359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String toString() { 16369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return getFilterableStringBuilder().toString(); 16379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 16409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the text that will be used to filter this Preference depending on 16419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * user input. 16429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 16439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If overridding and calling through to the superclass, make sure to prepend 16449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your additions with a space. 16459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Text as a {@link StringBuilder} that will be used to filter this 16479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * preference. By default, this is the title and summary 16489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (concatenated with a space). 16499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project StringBuilder getFilterableStringBuilder() { 16519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project StringBuilder sb = new StringBuilder(); 16529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project CharSequence title = getTitle(); 16539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!TextUtils.isEmpty(title)) { 16549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sb.append(title).append(' '); 16559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project CharSequence summary = getSummary(); 16579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!TextUtils.isEmpty(summary)) { 16589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sb.append(summary).append(' '); 16599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16600bb9960598067f3320cdae8ab42c1ba0f3376f21Tammo Spalink if (sb.length() > 0) { 16610bb9960598067f3320cdae8ab42c1ba0f3376f21Tammo Spalink // Drop the last space 16620bb9960598067f3320cdae8ab42c1ba0f3376f21Tammo Spalink sb.setLength(sb.length() - 1); 16630bb9960598067f3320cdae8ab42c1ba0f3376f21Tammo Spalink } 16649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sb; 16659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 16689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Store this Preference hierarchy's frozen state into the given container. 16699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param container The Bundle in which to save the instance of this Preference. 16719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #restoreHierarchyState 16739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #onSaveInstanceState 16749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void saveHierarchyState(Bundle container) { 16769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dispatchSaveInstanceState(container); 16779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 16799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 16809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called by {@link #saveHierarchyState} to store the instance for this Preference and its children. 16819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * May be overridden to modify how the save happens for children. For example, some 16829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference objects may want to not store an instance for their children. 16839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param container The Bundle in which to save the instance of this Preference. 16859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 16869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #saveHierarchyState 16879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #onSaveInstanceState 16889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 16899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void dispatchSaveInstanceState(Bundle container) { 16909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (hasKey()) { 16919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBaseMethodCalled = false; 16929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Parcelable state = onSaveInstanceState(); 16939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mBaseMethodCalled) { 16949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException( 16959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "Derived class did not call super.onSaveInstanceState()"); 16969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 16979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (state != null) { 16989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project container.putParcelable(mKey, state); 16999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 17049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Hook allowing a Preference to generate a representation of its internal 17059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * state that can later be used to create a new instance with that same 17069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * state. This state should only contain information that is not persistent 17079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * or can be reconstructed later. 17089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 17099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return A Parcelable object containing the current dynamic state of 17109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this Preference, or null if there is nothing interesting to save. 17119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The default implementation returns null. 17129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #onRestoreInstanceState 17139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #saveHierarchyState 17149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 17159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected Parcelable onSaveInstanceState() { 17169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBaseMethodCalled = true; 17179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return BaseSavedState.EMPTY_STATE; 17189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 17219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Restore this Preference hierarchy's previously saved state from the given container. 17229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 17239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param container The Bundle that holds the previously saved state. 17249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 17259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #saveHierarchyState 17269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #onRestoreInstanceState 17279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 17289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void restoreHierarchyState(Bundle container) { 17299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dispatchRestoreInstanceState(container); 17309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 17339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called by {@link #restoreHierarchyState} to retrieve the saved state for this 17349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Preference and its children. May be overridden to modify how restoring 17359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * happens to the children of a Preference. For example, some Preference objects may 17369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * not want to save state for their children. 17379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 17389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param container The Bundle that holds the previously saved state. 17399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #restoreHierarchyState 17409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #onRestoreInstanceState 17419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 17429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void dispatchRestoreInstanceState(Bundle container) { 17439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (hasKey()) { 17449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Parcelable state = container.getParcelable(mKey); 17459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (state != null) { 17469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBaseMethodCalled = false; 17479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onRestoreInstanceState(state); 17489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mBaseMethodCalled) { 17499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalStateException( 17509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project "Derived class did not call super.onRestoreInstanceState()"); 17519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 17579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Hook allowing a Preference to re-apply a representation of its internal 17589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * state that had previously been generated by {@link #onSaveInstanceState}. 17599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This function will never be called with a null state. 17609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 17619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param state The saved state that had previously been returned by 17629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link #onSaveInstanceState}. 17639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #onSaveInstanceState 17649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #restoreHierarchyState 17659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 17669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onRestoreInstanceState(Parcelable state) { 17679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mBaseMethodCalled = true; 17689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (state != BaseSavedState.EMPTY_STATE && state != null) { 17699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalArgumentException("Wrong state class -- expecting Preference State"); 17709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 17749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * A base class for managing the instance state of a {@link Preference}. 17759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 17769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static class BaseSavedState extends AbsSavedState { 17779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public BaseSavedState(Parcel source) { 17789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super(source); 17799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public BaseSavedState(Parcelable superState) { 17829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super(superState); 17839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final Parcelable.Creator<BaseSavedState> CREATOR = 17869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project new Parcelable.Creator<BaseSavedState>() { 17879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public BaseSavedState createFromParcel(Parcel in) { 17889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return new BaseSavedState(in); 17899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public BaseSavedState[] newArray(int size) { 17929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return new BaseSavedState[size]; 17939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project }; 17959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 17969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 17979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 1798