Skip to content

Most visited

Recently visited

navigation

Preference

public class Preference
extends Object implements Comparable<Preference>

java.lang.Object
   ↳ android.support.v7.preference.Preference
Known Direct Subclasses
Known Indirect Subclasses


Represents the basic Preference UI building block displayed by a PreferenceFragmentCompat in the form of a RecyclerView. This class provides data for the View to be displayed in the list and associates with a SharedPreferences to store/retrieve the preference data.

When specifying a preference hierarchy in XML, each element can point to a subclass of Preference, similar to the view hierarchy and layouts.

This class contains a key that will be used as the key into the SharedPreferences. It is up to the subclass to decide how to store the value.

Developer Guides

For information about building a settings UI with Preferences, read the Settings guide.

Summary

Nested classes

class Preference.BaseSavedState

A base class for managing the instance state of a Preference

interface Preference.OnPreferenceChangeListener

Interface definition for a callback to be invoked when the value of this Preference has been changed by the user and is about to be set and/or persisted. 

interface Preference.OnPreferenceClickListener

Interface definition for a callback to be invoked when a Preference is clicked. 

XML attributes

android:iconSpaceReserved  
android:singleLineTitle  

Constants

int DEFAULT_ORDER

Specify for setOrder(int) if a specific order is not required.

Public constructors

Preference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

Perform inflation from XML and apply a class-specific base style.

Preference(Context context, AttributeSet attrs, int defStyleAttr)

Perform inflation from XML and apply a class-specific base style.

Preference(Context context, AttributeSet attrs)

Constructor that is called when inflating a Preference from XML.

Preference(Context context)

Constructor to create a Preference.

Public methods

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.

Context getContext()

Returns the Context of this Preference.

String getDependency()

Returns the key of the dependency on this Preference.

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.

final 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.

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.

final 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()

Returns whether the space of this preference icon view is reserved.

boolean isPersistent()

Checks whether this Preference is persistent.

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.

final boolean isVisible()

Checks whether this preference should be visible to the user in the list.

void notifyDependencyChange(boolean disableDependents)

Notifies any listening dependents of a change that affects the dependency.

void onAttached()

Called when the Preference hierarchy has been attached to the list of preferences.

void onBindViewHolder(PreferenceViewHolder holder)

Binds the created View to the data for this Preference.

void onDependencyChanged(Preference dependency, boolean disableDependent)

Called when the dependency changes.

void onDetached()

Called when the Preference hierarchy has been detached from the list of preferences.

void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfoCompat info)

Initializes an AccessibilityNodeInfo with information about the View for this Preference.

void onParentChanged(Preference parent, boolean disableChild)

Called when the implicit parent dependency changes.

Bundle peekExtras()

Return the extras Bundle object associated with this preference, returning null if there is not currently one.

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 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 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 setViewId(int viewId)

Set the ID that will be assigned to the overall View representing this preference, once bound.

final void setVisible(boolean visible)

Sets whether this preference should be visible in the list.

void setWidgetLayoutResource(int widgetLayoutResId)

Sets the layout for the controllable widget portion of this Preference.

boolean shouldDisableDependents()

Checks whether this preference's dependents should currently be disabled.

String toString()

Returns a string representation of the object.

Protected methods

Preference findPreferenceInHierarchy(String key)

Finds a Preference in this hierarchy (the whole thing, even above/below your PreferenceScreen screen break) with the given key.

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 Integer 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 set of Strings if this Preference is persistent.

void notifyChanged()

Should be called when the data of this Preference has changed.

void notifyHierarchyChanged()

Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated.

void onAttachedToHierarchy(PreferenceManager preferenceManager)

Called when this Preference has been attached to a Preference hierarchy.

void onClick()

Processes a click on the preference.

Object onGetDefaultValue(TypedArray a, int index)

Called when a Preference is being inflated and the default value attribute needs to be read.

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.

boolean persistBoolean(boolean value)

Attempts to persist a Boolean if this Preference is persistent.

boolean persistFloat(float value)

Attempts to persist a Float if this Preference is persistent.

boolean persistInt(int value)

Attempts to persist an Integer 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 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.

Inherited methods

From class java.lang.Object
From interface java.lang.Comparable

XML attributes

android:iconSpaceReserved

Related methods:

android:singleLineTitle

Related methods:

Constants

DEFAULT_ORDER

added in version 23.0.0
int DEFAULT_ORDER

Specify for setOrder(int) if a specific order is not required.

Constant Value: 2147483647 (0x7fffffff)

Public constructors

Preference

added in version 23.0.0
Preference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Perform inflation from XML and apply a class-specific base style. This constructor of Preference allows subclasses to use their own base style when they are inflating. For example, a CheckBoxPreference constructor calls this version of the super class constructor and supplies android.R.attr.checkBoxPreferenceStyle for defStyleAttr. This allows the theme's checkbox preference style to modify all of the base preference attributes as well as the CheckBoxPreference class's attributes.

Parameters
context Context: The Context this is associated with, through which it can access the current theme, resources, SharedPreferences, etc.

attrs AttributeSet: The attributes of the XML tag that is inflating the preference.

defStyleAttr int: An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults.

defStyleRes int: A resource identifier of a style resource that supplies default values for the view, used only if defStyleAttr is 0 or can not be found in the theme. Can be 0 to not look for defaults.

See also:

Preference

added in version 23.0.0
Preference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Perform inflation from XML and apply a class-specific base style. This constructor of Preference allows subclasses to use their own base style when they are inflating. For example, a CheckBoxPreference constructor calls this version of the super class constructor and supplies android.R.attr.checkBoxPreferenceStyle for defStyleAttr. This allows the theme's checkbox preference style to modify all of the base preference attributes as well as the CheckBoxPreference class's attributes.

Parameters
context Context: The Context this is associated with, through which it can access the current theme, resources, SharedPreferences, etc.

attrs AttributeSet: The attributes of the XML tag that is inflating the preference.

defStyleAttr int: An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults.

See also:

Preference

added in version 23.0.0
Preference (Context context, 
                AttributeSet attrs)

Constructor that is called when inflating a Preference from XML. This is called when a Preference is being constructed from an XML file, supplying attributes that were specified in the XML file. This version uses a default style of 0, so the only attribute values applied are those in the Context's Theme and the given AttributeSet.

Parameters
context Context: The Context this is associated with, through which it can access the current theme, resources, SharedPreferences, etc.

attrs AttributeSet: The attributes of the XML tag that is inflating the preference.

See also:

Preference

added in version 23.0.0
Preference (Context context)

Constructor to create a Preference.

Parameters
context Context: The Context in which to store Preference values.

Public methods

callChangeListener

added in version 23.0.0
boolean callChangeListener (Object newValue)

Call this method after the user changes the preference, but before the internal state is set. This allows the client to ignore the user value.

Parameters
newValue Object: The new value of this Preference.

Returns
boolean True if the user value should be set as the preference value (and persisted).

compareTo

added in version 23.0.0
int compareTo (Preference another)

Compares Preference objects based on order (if set), otherwise alphabetically on the titles.

Parameters
another Preference: The Preference to compare to this one.

Returns
int 0 if the same; less than 0 if this Preference sorts ahead of another; greater than 0 if this Preference sorts after another.

getContext

added in version 23.0.0
Context getContext ()

Returns the Context of this Preference. Each Preference in a Preference hierarchy can be from different Context (for example, if multiple activities provide preferences into a single PreferenceFragmentCompat). This Context will be used to save the Preference values.

Returns
Context The Context of this Preference.

getDependency

added in version 23.0.0
String getDependency ()

Returns the key of the dependency on this Preference.

Returns
String The key of the dependency.

See also:

getExtras

added in version 23.0.0
Bundle getExtras ()

Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one. You can use this to get and set individual extra key/value pairs.

Returns
Bundle

getFragment

added in version 23.0.0
String getFragment ()

Return the fragment class name associated with this Preference.

Returns
String The fragment class name last set via setFragment(String) or XML.

getIcon

added in version 23.0.0
Drawable getIcon ()

Returns the icon of this Preference.

Returns
Drawable The icon.

See also:

getIntent

added in version 23.0.0
Intent getIntent ()

Return the Intent associated with this Preference.

Returns
Intent The Intent last set via setIntent(Intent) or XML.

getKey

added in version 23.0.0
String getKey ()

Gets the key for this Preference, which is also the key used for storing values into SharedPreferences or PreferenceDataStore.

Returns
String The key.

getLayoutResource

added in version 23.0.0
int getLayoutResource ()

Gets the layout resource that will be shown as the View for this Preference.

Returns
int The layout resource ID.

getOnPreferenceChangeListener

added in version 23.0.0
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).

Returns
Preference.OnPreferenceChangeListener The callback to be invoked.

getOnPreferenceClickListener

added in version 23.0.0
Preference.OnPreferenceClickListener getOnPreferenceClickListener ()

Returns the callback to be invoked when this Preference is clicked.

Returns
Preference.OnPreferenceClickListener The callback to be invoked.

getOrder

added in version 23.0.0
int getOrder ()

Gets the order of this Preference with respect to other Preference objects on the same level.

Returns
int The order of this Preference.

See also:

getParent

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.

Returns
PreferenceGroup The parent PreferenceGroup or null if not attached to any.

getPersistedStringSet

Set<String> getPersistedStringSet (Set<String> defaultReturnValue)

Attempts to get a persisted set of Strings if this Preference is persistent.

Parameters
defaultReturnValue Set: the default value to return if either this Preference is not persistent or this Preference is not present

Returns
Set<String> the value from the storage or the default return value

See also:

getPreferenceDataStore

PreferenceDataStore getPreferenceDataStore ()

Returns PreferenceDataStore used by this Preference. Returns null if SharedPreferences is used instead.

By default preferences always use SharedPreferences. To make this preference to use the PreferenceDataStore you need to assign your implementation to the Preference itself via setPreferenceDataStore(PreferenceDataStore) or to its PreferenceManager via setPreferenceDataStore(PreferenceDataStore).

Returns
PreferenceDataStore the PreferenceDataStore used by this Preference or null if none

getPreferenceManager

added in version 23.0.0
PreferenceManager getPreferenceManager ()

Gets the PreferenceManager that manages this Preference object's tree.

Returns
PreferenceManager The PreferenceManager.

getSharedPreferences

added in version 23.0.0
SharedPreferences getSharedPreferences ()

Returns the SharedPreferences where this Preference can read its value(s). Usually, it's easier to use one of the helper read methods: getPersistedBoolean(boolean), getPersistedFloat(float), getPersistedInt(int), getPersistedLong(long), getPersistedString(String).

Returns
SharedPreferences the SharedPreferences where this Preference reads its value(s). If this preference is not attached to a Preference hierarchy or if a PreferenceDataStore has been set, this method returns null.

See also:

getShouldDisableView

added in version 23.0.0
boolean getShouldDisableView ()

Checks whether this Preference should disable its view when it's action is disabled.

Returns
boolean True if it should disable the view.

See also:

getSummary

added in version 23.0.0
CharSequence getSummary ()

Returns the summary of this Preference.

Returns
CharSequence The summary.

See also:

getTitle

added in version 23.0.0
CharSequence getTitle ()

Returns the title of this Preference.

Returns
CharSequence The title.

See also:

getWidgetLayoutResource

added in version 23.0.0
int getWidgetLayoutResource ()

Gets the layout resource for the controllable widget portion of this Preference.

Returns
int The layout resource ID.

hasKey

added in version 23.0.0
boolean hasKey ()

Checks whether this Preference has a valid key.

Returns
boolean True if the key exists and is not a blank string, false otherwise.

isEnabled

added in version 23.0.0
boolean isEnabled ()

Checks whether this Preference should be enabled in the list.

Returns
boolean True if this Preference is enabled, false otherwise.

isIconSpaceReserved

boolean isIconSpaceReserved ()

Returns whether the space of this preference icon view is reserved.

Related XML Attributes:

Returns
boolean true if the space of this preference icon view is reserved

See also:

isPersistent

added in version 23.0.0
boolean isPersistent ()

Checks whether this Preference is persistent. If it is, it stores its value(s) into the persistent SharedPreferences storage by default or into PreferenceDataStore if assigned.

Returns
boolean true if persistent

isSelectable

added in version 23.0.0
boolean isSelectable ()

Checks whether this Preference should be selectable in the list.

Returns
boolean True if it is selectable, false otherwise.

isSingleLineTitle

boolean isSingleLineTitle ()

Gets whether the title of this preference is constrained to a single line.

Related XML Attributes:

Returns
boolean true if the title of this preference is constrained to a single line

See also:

isVisible

added in version 23.0.0
boolean isVisible ()

Checks whether this preference should be visible to the user in the list.

Returns
boolean True if this preference should be displayed.

See also:

notifyDependencyChange

added in version 23.0.0
void notifyDependencyChange (boolean disableDependents)

Notifies any listening dependents of a change that affects the dependency.

Parameters
disableDependents boolean: Whether this Preference should disable its dependents.

onAttached

added in version 23.0.0
void onAttached ()

Called when the Preference hierarchy has been attached to the list of preferences. This can also be called when this Preference has been attached to a group that was already attached to the list of preferences.

onBindViewHolder

added in version 23.0.0
void onBindViewHolder (PreferenceViewHolder holder)

Binds the created View to the data for this Preference.

This is a good place to grab references to custom Views in the layout and set properties on them.

Make sure to call through to the superclass's implementation.

Parameters
holder PreferenceViewHolder: The ViewHolder that provides references to the views to fill in. These views will be recycled, so you should not hold a reference to them after this method returns.

onDependencyChanged

added in version 23.0.0
void onDependencyChanged (Preference dependency, 
                boolean disableDependent)

Called when the dependency changes.

Parameters
dependency Preference: The Preference that this Preference depends on.

disableDependent boolean: Set true to disable this Preference.

onDetached

added in version 24.0.0
void onDetached ()

Called when the Preference hierarchy has been detached from the list of preferences. This can also be called when this Preference has been removed from a group that was attached to the list of preferences.

onInitializeAccessibilityNodeInfo

added in version 24.0.0
void onInitializeAccessibilityNodeInfo (AccessibilityNodeInfoCompat info)

Initializes an AccessibilityNodeInfo with information about the View for this Preference.

Parameters
info AccessibilityNodeInfoCompat

onParentChanged

added in version 23.0.0
void onParentChanged (Preference parent, 
                boolean disableChild)

Called when the implicit parent dependency changes.

Parameters
parent Preference: The Preference that this Preference depends on.

disableChild boolean: Set true to disable this Preference.

peekExtras

added in version 23.0.0
Bundle peekExtras ()

Return the extras Bundle object associated with this preference, returning null if there is not currently one.

Returns
Bundle

persistStringSet

boolean persistStringSet (Set<String> values)

Attempts to persist a set of Strings if this Preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

Parameters
values Set: the values to persist

Returns
boolean true if the Preference is persistent, false otherwise

See also:

restoreHierarchyState

added in version 23.0.0
void restoreHierarchyState (Bundle container)

Restore this Preference hierarchy's previously saved state from the given container.

Parameters
container Bundle: The Bundle that holds the previously saved state.

See also:

saveHierarchyState

added in version 23.0.0
void saveHierarchyState (Bundle container)

Store this Preference hierarchy's frozen state into the given container.

Parameters
container Bundle: The Bundle in which to save the instance of this Preference.

See also:

setDefaultValue

added in version 23.0.0
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.

Parameters
defaultValue Object: The default value.

setDependency

added in version 23.0.0
void setDependency (String dependencyKey)

Sets the key of a Preference that this Preference will depend on. If that Preference is not set or is off, this Preference will be disabled.

Parameters
dependencyKey String: The key of the Preference that this depends on.

setEnabled

added in version 23.0.0
void setEnabled (boolean enabled)

Sets whether this Preference is enabled. If disabled, it will not handle clicks.

Parameters
enabled boolean: Set true to enable it.

setFragment

added in version 23.0.0
void setFragment (String fragment)

Sets the class name of a fragment to be shown when this Preference is clicked.

Parameters
fragment String: The class name of the fragment associated with this Preference.

setIcon

added in version 23.0.0
void setIcon (Drawable icon)

Sets the icon for this Preference with a Drawable. This icon will be placed into the ID icon within the View created by onBindViewHolder(PreferenceViewHolder).

Parameters
icon Drawable: The optional icon for this Preference.

setIcon

added in version 23.0.0
void setIcon (int iconResId)

Sets the icon for this Preference with a resource ID.

Parameters
iconResId int: The icon as a resource ID.

See also:

setIconSpaceReserved

void setIconSpaceReserved (boolean iconSpaceReserved)

Sets whether to reserve the space of this Preference icon view when no icon is provided. If set to true, the preference will be offset as if it would have the icon and thus aligned with other preferences having icons.

Related XML Attributes:

Parameters
iconSpaceReserved boolean: set true if the space for the icon view should be reserved

setIntent

added in version 23.0.0
void setIntent (Intent intent)

Sets an Intent to be used for startActivity(Intent) when this Preference is clicked.

Parameters
intent Intent: The intent associated with this Preference.

setKey

added in version 23.0.0
void setKey (String key)

Sets the key for this Preference, which is used as a key to the SharedPreferences or PreferenceDataStore. This should be unique for the package.

Parameters
key String: The key for the preference.

setLayoutResource

added in version 23.0.0
void setLayoutResource (int layoutResId)

Sets the layout resource that is inflated as the View to be shown for this Preference. In most cases, the default layout is sufficient for custom Preference objects and only the widget layout needs to be changed.

This layout should contain a ViewGroup with ID widget_frame to be the parent of the specific widget for this Preference. It should similarly contain title and summary.

It is an error to change the layout after adding the preference to a PreferenceGroup

Parameters
layoutResId int: The layout resource ID to be inflated and returned as a View.

See also:

setOnPreferenceChangeListener

added in version 23.0.0
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).

Parameters
onPreferenceChangeListener Preference.OnPreferenceChangeListener: The callback to be invoked.

setOnPreferenceClickListener

added in version 23.0.0
void setOnPreferenceClickListener (Preference.OnPreferenceClickListener onPreferenceClickListener)

Sets the callback to be invoked when this Preference is clicked.

Parameters
onPreferenceClickListener Preference.OnPreferenceClickListener: The callback to be invoked.

setOrder

added in version 23.0.0
void setOrder (int order)

Sets the order of this Preference with respect to other Preference objects on the same level. If this is not specified, the default behavior is to sort alphabetically. The setOrderingAsAdded(boolean) can be used to order Preference objects based on the order they appear in the XML.

Parameters
order int: The order for this Preference. A lower value will be shown first. Use DEFAULT_ORDER to sort alphabetically or allow ordering from XML.

See also:

setPersistent

added in version 23.0.0
void setPersistent (boolean persistent)

Sets whether this Preference is persistent. When persistent, it stores its value(s) into the persistent SharedPreferences storage by default or into PreferenceDataStore if assigned.

Parameters
persistent boolean: set true if it should store its value(s) into the storage.

setPreferenceDataStore

void setPreferenceDataStore (PreferenceDataStore dataStore)

Sets a PreferenceDataStore to be used by this Preference instead of using SharedPreferences.

The data store will remain assigned even if the Preference is moved around the preference hierarchy. It will also override a data store propagated from the PreferenceManager that owns this Preference.

Parameters
dataStore PreferenceDataStore: the PreferenceDataStore to be used by this Preference

See also:

setSelectable

added in version 23.0.0
void setSelectable (boolean selectable)

Sets whether this Preference is selectable.

Parameters
selectable boolean: Set true to make it selectable.

setShouldDisableView

added in version 23.0.0
void setShouldDisableView (boolean shouldDisableView)

Sets whether this Preference should disable its view when it gets disabled.

For example, set this and setEnabled(boolean) to false for preferences that are only displaying information and 1) should not be clickable 2) should not have the view set to the disabled state.

Parameters
shouldDisableView boolean: Set true if this preference should disable its view when the preference is disabled.

setSingleLineTitle

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.

Related XML Attributes:

Parameters
singleLineTitle boolean: set true if the title should be constrained to one line

setSummary

added in version 23.0.0
void setSummary (CharSequence summary)

Sets the summary for this Preference with a CharSequence.

Parameters
summary CharSequence: The summary for the preference.

setSummary

added in version 23.0.0
void setSummary (int summaryResId)

Sets the summary for this Preference with a resource ID.

Parameters
summaryResId int: The summary as a resource.

See also:

setTitle

added in version 23.0.0
void setTitle (CharSequence title)

Sets the title for this Preference with a CharSequence. This title will be placed into the ID title within the View bound by onBindViewHolder(PreferenceViewHolder).

Parameters
title CharSequence: The title for this Preference.

setTitle

added in version 23.0.0
void setTitle (int titleResId)

Sets the title for this Preference with a resource ID.

Parameters
titleResId int: The title as a resource ID.

See also:

setViewId

added in version 24.0.0
void setViewId (int viewId)

Set the ID that will be assigned to the overall View representing this preference, once bound.

Parameters
viewId int

See also:

setVisible

added in version 23.0.0
void setVisible (boolean visible)

Sets whether this preference should be visible in the list. If false, it is excluded from the adapter, but can still be retrieved using findPreference(CharSequence).

Parameters
visible boolean: Set false if this preference should be hidden from the list.

setWidgetLayoutResource

added in version 23.0.0
void setWidgetLayoutResource (int widgetLayoutResId)

Sets the layout for the controllable widget portion of this Preference. This is inflated into the main layout. For example, a CheckBoxPreference would specify a custom layout (consisting of just the CheckBox) here, instead of creating its own main layout.

It is an error to change the layout after adding the preference to a PreferenceGroup

Parameters
widgetLayoutResId int: The layout resource ID to be inflated into the main layout.

See also:

shouldDisableDependents

added in version 23.0.0
boolean shouldDisableDependents ()

Checks whether this preference's dependents should currently be disabled.

Returns
boolean True if the dependents should be disabled, otherwise false.

toString

String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

Protected methods

findPreferenceInHierarchy

added in version 23.0.0
Preference findPreferenceInHierarchy (String key)

Finds a Preference in this hierarchy (the whole thing, even above/below your PreferenceScreen screen break) with the given key.

This only functions after we have been attached to a hierarchy.

Parameters
key String: The key of the Preference to find.

Returns
Preference The Preference that uses the given key.

getPersistedBoolean

added in version 23.0.0
boolean getPersistedBoolean (boolean defaultReturnValue)

Attempts to get a persisted Boolean if this Preference is persistent.

Parameters
defaultReturnValue boolean: The default value to return if either this Preference is not persistent or this Preference is not in the SharedPreferences.

Returns
boolean the value from the storage or the default return value

See also:

getPersistedFloat

added in version 23.0.0
float getPersistedFloat (float defaultReturnValue)

Attempts to get a persisted Float if this Preference is persistent.

Parameters
defaultReturnValue float: The default value to return if either this Preference is not persistent or this Preference is not in the SharedPreferences.

Returns
float the value from the storage or the default return value

See also:

getPersistedInt

added in version 23.0.0
int getPersistedInt (int defaultReturnValue)

Attempts to get a persisted Integer if this Preference is persistent.

Parameters
defaultReturnValue int: The default value to return if either this Preference is not persistent or this Preference is not in the SharedPreferences.

Returns
int the value from the storage or the default return value

See also:

getPersistedLong

added in version 23.0.0
long getPersistedLong (long defaultReturnValue)

Attempts to get a persisted Long if this Preference is persistent.

Parameters
defaultReturnValue long: The default value to return if either this Preference is not persistent or this Preference is not in the SharedPreferences.

Returns
long the value from the storage or the default return value

See also:

getPersistedString

added in version 23.0.0
String getPersistedString (String defaultReturnValue)

Attempts to get a persisted set of Strings if this Preference is persistent.

Parameters
defaultReturnValue String: The default value to return if either the Preference is not persistent or the Preference is not in the shared preferences.

Returns
String the value from the storage or the default return value

See also:

notifyChanged

added in version 23.0.0
void notifyChanged ()

Should be called when the data of this Preference has changed.

notifyHierarchyChanged

added in version 23.0.0
void notifyHierarchyChanged ()

Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated.

onAttachedToHierarchy

added in version 23.0.0
void onAttachedToHierarchy (PreferenceManager preferenceManager)

Called when this Preference has been attached to a Preference hierarchy. Make sure to call the super implementation.

Parameters
preferenceManager PreferenceManager: The PreferenceManager of the hierarchy.

onClick

added in version 23.0.0
void onClick ()

Processes a click on the preference. This includes saving the value to the SharedPreferences. However, the overridden method should call callChangeListener(Object) to make sure the client wants to update the preference's state with the new value.

onGetDefaultValue

added in version 23.0.0
Object onGetDefaultValue (TypedArray a, 
                int index)

Called when a Preference is being inflated and the default value attribute needs to be read. Since different Preference types have different value types, the subclass should get and return the default value which will be its value type.

For example, if the value type is String, the body of the method would proxy to getString(int).

Parameters
a TypedArray: The set of attributes.

index int: The index of the default value attribute.

Returns
Object The default value of this preference type.

onPrepareForRemoval

added in version 23.0.0
void onPrepareForRemoval ()

Called when this Preference is being removed from the hierarchy. You should remove any references to this Preference that you know about. Make sure to call through to the superclass implementation.

onRestoreInstanceState

added in version 23.0.0
void onRestoreInstanceState (Parcelable state)

Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). This function will never be called with a null state.

Parameters
state Parcelable: The saved state that had previously been returned by onSaveInstanceState().

See also:

onSaveInstanceState

added in version 23.0.0
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. This state should only contain information that is not persistent or can be reconstructed later.

Returns
Parcelable A Parcelable object containing the current dynamic state of this Preference, or null if there is nothing interesting to save. The default implementation returns null.

See also:

onSetInitialValue

added in version 23.0.0
void onSetInitialValue (boolean restorePersistedValue, 
                Object defaultValue)

Implement this to set the initial value of the Preference.

If restorePersistedValue is true, you should restore the Preference value from the SharedPreferences. If restorePersistedValue is false, you should set the Preference value to defaultValue that is given (and possibly store to SharedPreferences if shouldPersist() is true).

In case of using PreferenceDataStore, the restorePersistedValue is always true but the default value (if provided) is set.

This may not always be called. One example is if it should not persist but there is no default value given.

Parameters
restorePersistedValue boolean: True to restore the persisted value; false to use the given defaultValue.

defaultValue Object: The default value for this Preference. Only use this if restorePersistedValue is false.

persistBoolean

added in version 23.0.0
boolean persistBoolean (boolean value)

Attempts to persist a Boolean if this Preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

Parameters
value boolean: The value to persist.

Returns
boolean true if the Preference is persistent, false otherwise

See also:

persistFloat

added in version 23.0.0
boolean persistFloat (float value)

Attempts to persist a Float if this Preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

Parameters
value float: The value to persist.

Returns
boolean true if the Preference is persistent, false otherwise

See also:

persistInt

added in version 23.0.0
boolean persistInt (int value)

Attempts to persist an Integer if this Preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

Parameters
value int: The value to persist.

Returns
boolean true if the Preference is persistent, false otherwise

See also:

persistLong

added in version 23.0.0
boolean persistLong (long value)

Attempts to persist a Long if this Preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

Parameters
value long: The value to persist.

Returns
boolean true if the Preference is persistent, false otherwise

See also:

persistString

added in version 23.0.0
boolean persistString (String value)

Attempts to persist a String if this Preference is persistent.

The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.

Parameters
value String: The value to persist.

Returns
boolean true if the Preference is persistent, false otherwise

See also:

shouldPersist

added in version 23.0.0
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. This, at minimum, checks whether this Preference is persistent and it currently has a key. Before you save/restore from the storage, check this first.

Returns
boolean true if it should persist the value

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.