PreferenceScreen | API reference | Android Developers
boolean
callChangeListener(Object newValue)
Call this method after the user changes the preference, but before the internal state is set.
int
compareTo(Preference another)
Compares Preference objects based on order (if set), otherwise alphabetically on the titles.
Preference
findPreferenceInHierarchy(String key)
Finds a Preference in this hierarchy (the whole thing,
even above/below your PreferenceScreen screen break) with the given
key.
Context
getContext()
Returns the Context of this Preference.
String
getDependency()
Returns the key of the dependency on this Preference.
SharedPreferences.Editor
getEditor()
Returns an SharedPreferences.Editor where this Preference can
save its value(s).
Bundle
getExtras()
Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.
String
getFragment()
Return the fragment class name associated with this Preference.
Drawable
getIcon()
Returns the icon of this Preference.
Intent
getIntent()
Return the Intent associated with this Preference.
String
getKey()
Gets the key for this Preference, which is also the key used for storing values into
SharedPreferences or PreferenceDataStore.
int
getLayoutResource()
Gets the layout resource that will be shown as the View for this Preference.
Preference.OnPreferenceChangeListener
getOnPreferenceChangeListener()
Returns the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).
Preference.OnPreferenceClickListener
getOnPreferenceClickListener()
Returns the callback to be invoked when this Preference is clicked.
int
getOrder()
Gets the order of this Preference with respect to other Preference objects on the same level.
PreferenceGroup
getParent()
Returns the PreferenceGroup which is this Preference assigned to or null if
this preference is not assigned to any group or is a root Preference.
boolean
getPersistedBoolean(boolean defaultReturnValue)
Attempts to get a persisted boolean if this Preference is persistent.
float
getPersistedFloat(float defaultReturnValue)
Attempts to get a persisted float if this Preference is persistent.
int
getPersistedInt(int defaultReturnValue)
Attempts to get a persisted int if this Preference is persistent.
long
getPersistedLong(long defaultReturnValue)
Attempts to get a persisted long if this Preference is persistent.
String
getPersistedString(String defaultReturnValue)
Attempts to get a persisted String if this Preference is persistent.
Set<String>
getPersistedStringSet(Set<String> defaultReturnValue)
Attempts to get a persisted set of Strings if this Preference is persistent.
PreferenceDataStore
getPreferenceDataStore()
Returns PreferenceDataStore used by this Preference.
PreferenceManager
getPreferenceManager()
Gets the PreferenceManager that manages this Preference object's tree.
SharedPreferences
getSharedPreferences()
Returns the SharedPreferences where this Preference can read its
value(s).
boolean
getShouldDisableView()
Checks whether this Preference should disable its view when it's action is disabled.
CharSequence
getSummary()
Returns the summary of this Preference.
CharSequence
getTitle()
Returns the title of this Preference.
int
getTitleRes()
Returns the title resource ID of this Preference.
View
getView(View convertView, ViewGroup parent)
Gets the View that will be shown in the PreferenceActivity.
int
getWidgetLayoutResource()
Gets the layout resource for the controllable widget portion of this Preference.
boolean
hasKey()
Checks whether this Preference has a valid key.
boolean
isEnabled()
Checks whether this Preference should be enabled in the list.
boolean
isIconSpaceReserved()
Gets whether the space this preference icon view is reserved.
boolean
isPersistent()
Checks whether this Preference is persistent.
boolean
isRecycleEnabled()
Checks whether this Preference has enabled to have its view recycled when used in the list view.
boolean
isSelectable()
Checks whether this Preference should be selectable in the list.
boolean
isSingleLineTitle()
Gets whether the title of this preference is constrained to a single line.
void
notifyChanged()
Should be called when the data of this Preference has changed.
void
notifyDependencyChange(boolean disableDependents)
Notifies any listening dependents of a change that affects the dependency.
void
notifyHierarchyChanged()
Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated.
void
onAttachedToActivity()
Called when the Preference hierarchy has been attached to the
PreferenceActivity.
void
onAttachedToHierarchy(PreferenceManager preferenceManager)
Called when this Preference has been attached to a Preference hierarchy.
void
onBindView(View view)
Binds the created View to the data for this Preference.
void
onClick()
Processes a click on the preference.
View
onCreateView(ViewGroup parent)
Creates the View to be shown for this Preference in the
PreferenceActivity.
void
onDependencyChanged(Preference dependency, boolean disableDependent)
Called when the dependency changes.
Object
onGetDefaultValue(TypedArray a, int index)
Called when a Preference is being inflated and the default value attribute needs to be read.
void
onParentChanged(Preference parent, boolean disableChild)
Called when the implicit parent dependency changes.
void
onPrepareForRemoval()
Called when this Preference is being removed from the hierarchy.
void
onRestoreInstanceState(Parcelable state)
Hook allowing a Preference to re-apply a representation of its internal state that had
previously been generated by onSaveInstanceState().
Parcelable
onSaveInstanceState()
Hook allowing a Preference to generate a representation of its internal state that can later be used to create a new instance with that same state.
void
onSetInitialValue(boolean restorePersistedValue, Object defaultValue)
Implement this to set the initial value of the Preference.
Bundle
peekExtras()
Return the extras Bundle object associated with this preference, returning null if
there is not currently one.
boolean
persistBoolean(boolean value)
Attempts to persist a boolean if this Preference is persistent.
boolean
persistFloat(float value)
Attempts to persist a long if this Preference is persistent.
boolean
persistInt(int value)
Attempts to persist an int if this Preference is persistent.
boolean
persistLong(long value)
Attempts to persist a long if this Preference is persistent.
boolean
persistString(String value)
Attempts to persist a String if this Preference is persistent.
boolean
persistStringSet(Set<String> values)
Attempts to persist a set of Strings if this Preference is persistent.
void
restoreHierarchyState(Bundle container)
Restore this Preference hierarchy's previously saved state from the given container.
void
saveHierarchyState(Bundle container)
Store this Preference hierarchy's frozen state into the given container.
void
setDefaultValue(Object defaultValue)
Sets the default value for this Preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
void
setDependency(String dependencyKey)
Sets the key of a Preference that this Preference will depend on.
void
setEnabled(boolean enabled)
Sets whether this Preference is enabled.
void
setFragment(String fragment)
Sets the class name of a fragment to be shown when this Preference is clicked.
void
setIcon(Drawable icon)
Sets the icon for this Preference with a Drawable.
void
setIcon(int iconResId)
Sets the icon for this Preference with a resource ID.
void
setIconSpaceReserved(boolean iconSpaceReserved)
Sets whether to reserve the space of this Preference icon view when no icon is provided.
void
setIntent(Intent intent)
Sets an Intent to be used for
Context.startActivity(Intent) when this Preference is clicked.
void
setKey(String key)
Sets the key for this Preference, which is used as a key to the SharedPreferences or
PreferenceDataStore.
void
setLayoutResource(int layoutResId)
Sets the layout resource that is inflated as the View to be shown
for this Preference.
void
setOnPreferenceChangeListener(Preference.OnPreferenceChangeListener onPreferenceChangeListener)
Sets the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).
void
setOnPreferenceClickListener(Preference.OnPreferenceClickListener onPreferenceClickListener)
Sets the callback to be invoked when this Preference is clicked.
void
setOrder(int order)
Sets the order of this Preference with respect to other Preference objects on the same level.
void
setPersistent(boolean persistent)
Sets whether this Preference is persistent.
void
setPreferenceDataStore(PreferenceDataStore dataStore)
Sets a PreferenceDataStore to be used by this Preference instead of using
SharedPreferences.
void
setRecycleEnabled(boolean enabled)
Sets whether this Preference has enabled to have its view recycled when used in the list view.
void
setSelectable(boolean selectable)
Sets whether this Preference is selectable.
void
setShouldDisableView(boolean shouldDisableView)
Sets whether this Preference should disable its view when it gets disabled.
void
setSingleLineTitle(boolean singleLineTitle)
Sets whether to constrain the title of this Preference to a single line instead of letting it wrap onto multiple lines.
void
setSummary(CharSequence summary)
Sets the summary for this Preference with a CharSequence.
void
setSummary(int summaryResId)
Sets the summary for this Preference with a resource ID.
void
setTitle(CharSequence title)
Sets the title for this Preference with a CharSequence.
void
setTitle(int titleResId)
Sets the title for this Preference with a resource ID.
void
setWidgetLayoutResource(int widgetLayoutResId)
Sets the layout for the controllable widget portion of this Preference.
boolean
shouldCommit()
Returns whether the Preference should commit its saved value(s) in
getEditor().
boolean
shouldDisableDependents()
Checks whether this preference's dependents should currently be disabled.
boolean
shouldPersist()
Checks whether, at the given time this method is called, this Preference should store/restore
its value(s) into the SharedPreferences or into PreferenceDataStore if
assigned.
String
toString()
Returns a string representation of the object.