Preference

DEFAULT_ORDER

int DEFAULT_ORDER

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

Constant Value: 2147483647 (0x7fffffff)

Preference

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.

Preference

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.

Preference

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.

Preference

Preference (Context context)

Constructor to create a Preference.

callChangeListener

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.

compareTo

int compareTo (Preference another)

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

getContext

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.

getDependency

String getDependency ()

Returns the key of the dependency on this Preference.

getExtras

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.

getFragment

String getFragment ()

Return the fragment class name associated with this Preference.

getIcon

Drawable getIcon ()

Returns the icon of this Preference.

getIntent

Intent getIntent ()

Return the Intent associated with this Preference.

getKey

String getKey ()

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

getLayoutResource

int getLayoutResource ()

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

getOnPreferenceChangeListener

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

getOnPreferenceClickListener

Preference.OnPreferenceClickListener getOnPreferenceClickListener ()

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

getOrder

int getOrder ()

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

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.

getPersistedStringSet

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

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

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

getPreferenceManager

PreferenceManager getPreferenceManager ()

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

getSharedPreferences

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

getShouldDisableView

boolean getShouldDisableView ()

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

getSummary

CharSequence getSummary ()

Returns the summary of this Preference.

getTitle

CharSequence getTitle ()

Returns the title of this Preference.

getWidgetLayoutResource

int getWidgetLayoutResource ()

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

hasKey

boolean hasKey ()

Checks whether this Preference has a valid key.

isEnabled

boolean isEnabled ()

Checks whether this Preference should be enabled in the list.

isIconSpaceReserved

boolean isIconSpaceReserved ()

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

Related XML Attributes:

• Preference_android_iconSpaceReserved

isPersistent

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.

isSelectable

boolean isSelectable ()

Checks whether this Preference should be selectable in the list.

isSingleLineTitle

boolean isSingleLineTitle ()

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

Related XML Attributes:

• Preference_android_singleLineTitle

isVisible

boolean isVisible ()

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

notifyDependencyChange

void notifyDependencyChange (boolean disableDependents)

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

onAttached

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

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.

onDependencyChanged

void onDependencyChanged (Preference dependency, 
                boolean disableDependent)

Called when the dependency changes.

onDetached

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

void onInitializeAccessibilityNodeInfo (AccessibilityNodeInfoCompat info)

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

onParentChanged

void onParentChanged (Preference parent, 
                boolean disableChild)

Called when the implicit parent dependency changes.

peekExtras

Bundle peekExtras ()

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

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.

restoreHierarchyState

void restoreHierarchyState (Bundle container)

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

saveHierarchyState

void saveHierarchyState (Bundle container)

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

setDefaultValue

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.

setDependency

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.

setEnabled

void setEnabled (boolean enabled)

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

setFragment

void setFragment (String fragment)

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

setIcon

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

setIcon

void setIcon (int iconResId)

Sets the icon for this Preference with a resource ID.

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:

• Preference_android_iconSpaceReserved

setIntent

void setIntent (Intent intent)

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

setKey

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.

setLayoutResource

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

setOnPreferenceChangeListener

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

setOnPreferenceClickListener

void setOnPreferenceClickListener (Preference.OnPreferenceClickListener onPreferenceClickListener)

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

setOrder

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.

setPersistent

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.

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.

setSelectable

void setSelectable (boolean selectable)

Sets whether this Preference is selectable.

setShouldDisableView

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.

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:

• Preference_android_singleLineTitle

setSummary

void setSummary (CharSequence summary)

Sets the summary for this Preference with a CharSequence.

setSummary

void setSummary (int summaryResId)

Sets the summary for this Preference with a resource ID.

setTitle

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

setTitle

void setTitle (int titleResId)

Sets the title for this Preference with a resource ID.

setViewId

void setViewId (int viewId)

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

setVisible

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

setWidgetLayoutResource

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

shouldDisableDependents

boolean shouldDisableDependents ()

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

findPreferenceInHierarchy

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.

getPersistedBoolean

boolean getPersistedBoolean (boolean defaultReturnValue)

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

getPersistedFloat

float getPersistedFloat (float defaultReturnValue)

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

getPersistedInt

int getPersistedInt (int defaultReturnValue)

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

getPersistedLong

long getPersistedLong (long defaultReturnValue)

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

getPersistedString

String getPersistedString (String defaultReturnValue)

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

notifyChanged

void notifyChanged ()

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

notifyHierarchyChanged

void notifyHierarchyChanged ()

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

onAttachedToHierarchy

void onAttachedToHierarchy (PreferenceManager preferenceManager)

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

onClick

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

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

onPrepareForRemoval

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

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.

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

onSetInitialValue

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.

persistBoolean

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.

persistFloat

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.

persistInt

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.

persistLong

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.

persistString

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.

shouldPersist

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.