# Preference Artifact: [androidx.preference:preference](https://developer.android.com/jetpack/androidx/releases/preference) [View Source](https://cs.android.com/search?q=file:androidx/preference/Preference.java+class:androidx.preference.Preference) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) *** ** * ** *** ``` public class Preference implements Comparable ```
Known direct subclasses [DialogPreference](https://developer.android.com/reference/androidx/preference/DialogPreference), [PreferenceGroup](https://developer.android.com/reference/androidx/preference/PreferenceGroup), [SeekBarPreference](https://developer.android.com/reference/androidx/preference/SeekBarPreference), [TwoStatePreference](https://developer.android.com/reference/androidx/preference/TwoStatePreference) |---|---| | `https://developer.android.com/reference/androidx/preference/DialogPreference` | A base class for `https://developer.android.com/reference/androidx/preference/Preference`s that are dialog-based. | | `https://developer.android.com/reference/androidx/preference/PreferenceGroup` | A container for multiple `https://developer.android.com/reference/androidx/preference/Preference`s. | | `https://developer.android.com/reference/androidx/preference/SeekBarPreference` | Preference based on android.preference.SeekBarPreference but uses support preference as a base . | | `https://developer.android.com/reference/androidx/preference/TwoStatePreference` | Common base class for preferences that have two selectable states, save a boolean value, and may have dependent preferences that are enabled/disabled based on the current state. | Known indirect subclasses [CheckBoxPreference](https://developer.android.com/reference/androidx/preference/CheckBoxPreference), [DropDownPreference](https://developer.android.com/reference/androidx/preference/DropDownPreference), [EditTextPreference](https://developer.android.com/reference/androidx/preference/EditTextPreference), [ListPreference](https://developer.android.com/reference/androidx/preference/ListPreference), [MultiSelectListPreference](https://developer.android.com/reference/androidx/preference/MultiSelectListPreference), [PreferenceCategory](https://developer.android.com/reference/androidx/preference/PreferenceCategory), [PreferenceScreen](https://developer.android.com/reference/androidx/preference/PreferenceScreen), [SwitchPreferenceCompat](https://developer.android.com/reference/androidx/preference/SwitchPreferenceCompat), [SwitchPreference](https://developer.android.com/reference/androidx/preference/SwitchPreference) |---|---| | `https://developer.android.com/reference/androidx/preference/CheckBoxPreference` | A `https://developer.android.com/reference/androidx/preference/Preference` that provides checkbox widget functionality. | | `https://developer.android.com/reference/androidx/preference/DropDownPreference` | A `https://developer.android.com/reference/androidx/preference/ListPreference` that presents the options in a drop down menu rather than a dialog. | | `https://developer.android.com/reference/androidx/preference/EditTextPreference` | A `https://developer.android.com/reference/androidx/preference/DialogPreference` that shows a `https://developer.android.com/reference/android/widget/EditText.html` in the dialog. | | `https://developer.android.com/reference/androidx/preference/ListPreference` | A `https://developer.android.com/reference/androidx/preference/Preference` that displays a list of entries as a dialog. | | `https://developer.android.com/reference/androidx/preference/MultiSelectListPreference` | A `https://developer.android.com/reference/androidx/preference/Preference` that displays a list of entries as a dialog. | | `https://developer.android.com/reference/androidx/preference/PreferenceCategory` | A container that is used to group similar `https://developer.android.com/reference/androidx/preference/Preference`s. | | `https://developer.android.com/reference/androidx/preference/PreferenceScreen` | A top-level container that represents a settings screen. | | `https://developer.android.com/reference/androidx/preference/SwitchPreferenceCompat` | A `https://developer.android.com/reference/androidx/preference/Preference` that provides a two-state toggleable option. | | `https://developer.android.com/reference/androidx/preference/SwitchPreference` | A `https://developer.android.com/reference/androidx/preference/Preference` that provides a two-state toggleable option. | *** ** * ** *** The basic building block that represents an individual setting displayed to a user in the preference hierarchy. This class provides the data that will be displayed to the user and has a reference to the `https://developer.android.com/reference/android/content/SharedPreferences.html` or `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` instance that persists the preference's values. When specifying a preference hierarchy in XML, each element can point to a subclass of `https://developer.android.com/reference/androidx/preference/Preference`, similar to the view hierarchy and layouts. This class contains a `key` that that represents the key that is used to persist the value to the device. It is up to the subclass to decide how to store the value. name android:icon name android:key name android:title name android:summary name android:order name android:fragment name android:layout name android:widgetLayout name android:enabled name android:selectable name android:dependency name android:persistent name android:defaultValue name android:shouldDisableView name android:singleLineTitle name android:iconSpaceReserved ## Summary | ### Nested types | |---| | `public class https://developer.android.com/reference/androidx/preference/Preference.BaseSavedState extends https://developer.android.com/reference/android/view/AbsSavedState.html` A base class for managing the instance state of a `https://developer.android.com/reference/androidx/preference/Preference`. | | `public interface https://developer.android.com/reference/androidx/preference/Preference.OnPreferenceChangeListener` Interface definition for a callback to be invoked when the value of this `https://developer.android.com/reference/androidx/preference/Preference` has been changed by the user and is about to be set and/or persisted. | | `public interface https://developer.android.com/reference/androidx/preference/Preference.OnPreferenceClickListener` Interface definition for a callback to be invoked when a `https://developer.android.com/reference/androidx/preference/Preference` is clicked. | | `public interface https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` Interface definition for a callback to be invoked when the summary of this `https://developer.android.com/reference/androidx/preference/Preference` is requested (typically when this preference is added to the hierarchy or its value is updated). | | ### Constants | |---|---| | `static final int` | `https://developer.android.com/reference/androidx/preference/Preference#DEFAULT_ORDER() = 2147483647` Specify for `https://developer.android.com/reference/androidx/preference/Preference#setOrder(int)` if a specific order is not required. | | ### Public constructors | |---| | `https://developer.android.com/reference/androidx/preference/Preference#Preference(android.content.Context)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context)` Constructor to create a preference. | | `https://developer.android.com/reference/androidx/preference/Preference#Preference(android.content.Context,android.util.AttributeSet)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context, @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/util/AttributeSet.html attrs)` Constructor that is called when inflating a preference from XML. | | `https://developer.android.com/reference/androidx/preference/Preference#Preference(android.content.Context,android.util.AttributeSet,int)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context, @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/util/AttributeSet.html attrs, int defStyleAttr )` Perform inflation from XML and apply a class-specific base style. | | `https://developer.android.com/reference/androidx/preference/Preference#Preference(android.content.Context,android.util.AttributeSet,int,int)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context, @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/util/AttributeSet.html attrs, int defStyleAttr, int defStyleRes )` Perform inflation from XML and apply a class-specific base style. | | ### Public methods | |---|---| | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#callChangeListener(java.lang.Object)(https://developer.android.com/reference/java/lang/Object.html newValue)` Call this method after the user changes the preference, but before the internal state is set. | | `int` | `https://developer.android.com/reference/androidx/preference/Preference#compareTo(androidx.preference.Preference)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/preference/Preference another)` Compares preference objects based on order (if set), otherwise alphabetically on the titles. | | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html` | `https://developer.android.com/reference/androidx/preference/Preference#getContext()()` Returns the `https://developer.android.com/reference/android/content/Context.html` of this preference. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/preference/Preference#getDependency()()` Returns the key of the dependency on this preference. | | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/preference/Preference#getExtras()()` Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/preference/Preference#getFragment()()` Return the fragment class name associated with this preference. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/graphics/drawable/Drawable.html` | `https://developer.android.com/reference/androidx/preference/Preference#getIcon()()` Returns the icon of this preference. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/content/Intent.html` | `https://developer.android.com/reference/androidx/preference/Preference#getIntent()()` Return the `https://developer.android.com/reference/android/content/Intent.html` associated with this preference. | | `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/preference/Preference#getKey()()` Gets the key for this preference, which is also the key used for storing values into `https://developer.android.com/reference/android/content/SharedPreferences.html` or `https://developer.android.com/reference/androidx/preference/PreferenceDataStore`. | | `final int` | `https://developer.android.com/reference/androidx/preference/Preference#getLayoutResource()()` Gets the layout resource that will be shown as the `https://developer.android.com/reference/android/view/View.html` for this preference. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.OnPreferenceChangeListener` | `https://developer.android.com/reference/androidx/preference/Preference#getOnPreferenceChangeListener()()` Returns the callback to be invoked when this preference is changed by the user (but before the internal state has been updated). | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.OnPreferenceClickListener` | `https://developer.android.com/reference/androidx/preference/Preference#getOnPreferenceClickListener()()` Returns the callback to be invoked when this preference is clicked. | | `int` | `https://developer.android.com/reference/androidx/preference/Preference#getOrder()()` Gets the order of this preference with respect to other preference objects on the same level. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/PreferenceGroup` | `https://developer.android.com/reference/androidx/preference/Preference#getParent()()` Returns the `https://developer.android.com/reference/androidx/preference/PreferenceGroup` which is this preference assigned to or `null` if this preference is not assigned to any group or is a root preference. | | `https://developer.android.com/reference/java/util/Set.html` | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedStringSet(java.util.Set)(https://developer.android.com/reference/java/util/Set.html defaultReturnValue)` Attempts to get a persisted set of Strings if this preference is persistent. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/PreferenceDataStore` | `https://developer.android.com/reference/androidx/preference/Preference#getPreferenceDataStore()()` Returns `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` used by this preference. | | `https://developer.android.com/reference/androidx/preference/PreferenceManager` | `https://developer.android.com/reference/androidx/preference/Preference#getPreferenceManager()()` Gets the `https://developer.android.com/reference/androidx/preference/PreferenceManager` that manages this preference object's tree. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/content/SharedPreferences.html` | `https://developer.android.com/reference/androidx/preference/Preference#getSharedPreferences()()` Returns the `https://developer.android.com/reference/android/content/SharedPreferences.html` where this preference can read its value(s). | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#getShouldDisableView()()` Checks whether this preference should disable its view when it's action is disabled. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/CharSequence.html` | `https://developer.android.com/reference/androidx/preference/Preference#getSummary()()` Returns the summary of this preference. | | `final @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` | `https://developer.android.com/reference/androidx/preference/Preference#getSummaryProvider()()` Returns the `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` used to configure the summary of this preference. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/CharSequence.html` | `https://developer.android.com/reference/androidx/preference/Preference#getTitle()()` Returns the title of this preference. | | `final int` | `https://developer.android.com/reference/androidx/preference/Preference#getWidgetLayoutResource()()` Gets the layout resource for the controllable widget portion of this preference. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#hasKey()()` Checks whether this preference has a valid key. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#isCopyingEnabled()()` Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#isEnabled()()` Checks whether this preference should be enabled in the list. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#isIconSpaceReserved()()` Returns whether the space of this preference icon view is reserved. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#isPersistent()()` Checks whether this preference is persistent. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#isSelectable()()` Checks whether this preference should be selectable in the list. | | `final boolean` | `https://developer.android.com/reference/androidx/preference/Preference#isShown()()` Checks whether this preference is shown to the user in the hierarchy. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#isSingleLineTitle()()` Gets whether the title of this preference is constrained to a single line. | | `final boolean` | `https://developer.android.com/reference/androidx/preference/Preference#isVisible()()` Checks whether this preference should be visible to the user. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#notifyDependencyChange(boolean)(boolean disableDependents)` Notifies any listening dependents of a change that affects the dependency. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#onAttached()()` Called when the preference hierarchy has been attached to the list of preferences. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#onBindViewHolder(androidx.preference.PreferenceViewHolder)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/preference/PreferenceViewHolder holder)` Binds the created View to the data for this preference. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#onDependencyChanged(androidx.preference.Preference,boolean)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/preference/Preference dependency, boolean disableDependent )` Called when the dependency changes. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#onDetached()()` Called when the preference hierarchy has been detached from the list of preferences. | | `void` | `@https://developer.android.com/reference/androidx/annotation/CallSuper [onInitializeAccessibilityNodeInfo](https://developer.android.com/reference/androidx/preference/Preference#onInitializeAccessibilityNodeInfo(androidx.core.view.accessibility.AccessibilityNodeInfoCompat))(https://developer.android.com/reference/androidx/core/view/accessibility/AccessibilityNodeInfoCompat info)` **This method is deprecated.** Preferences aren't views.
| | `void` | `https://developer.android.com/reference/androidx/preference/Preference#onParentChanged(androidx.preference.Preference,boolean)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/preference/Preference parent, boolean disableChild)` Called when the implicit parent dependency changes. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/preference/Preference#peekExtras()()` Return the extras Bundle object associated with this preference, returning `null` if there is not currently one. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#persistStringSet(java.util.Set)(https://developer.android.com/reference/java/util/Set.html values)` Attempts to persist a set of Strings if this preference is persistent. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#restoreHierarchyState(android.os.Bundle)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html container)` Restore this preference hierarchy's previously saved state from the given container. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#saveHierarchyState(android.os.Bundle)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html container)` Store this preference hierarchy's frozen state into the given container. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setCopyingEnabled(boolean)(boolean enabled)` Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setDefaultValue(java.lang.Object)(https://developer.android.com/reference/java/lang/Object.html 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` | `https://developer.android.com/reference/androidx/preference/Preference#setDependency(java.lang.String)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html dependencyKey)` Sets the key of a preference that this preference will depend on. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setEnabled(boolean)(boolean enabled)` Sets whether this preference is enabled. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setFragment(java.lang.String)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html fragment)` Sets the class name of a fragment to be shown when this preference is clicked. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setIcon(android.graphics.drawable.Drawable)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/graphics/drawable/Drawable.html icon)` Sets the icon for this preference with a Drawable. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setIcon(int)(int iconResId)` Sets the icon for this preference with a resource ID. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setIconSpaceReserved(boolean)(boolean iconSpaceReserved)` Sets whether to reserve the space of this preference icon view when no icon is provided. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setIntent(android.content.Intent)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/content/Intent.html intent)` Sets an `https://developer.android.com/reference/android/content/Intent.html` to be used for `https://developer.android.com/reference/android/content/Context.html#startActivity(android.content.Intent)` when this preference is clicked. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setKey(java.lang.String)(https://developer.android.com/reference/java/lang/String.html key)` Sets the key for this preference, which is used as a key to the `https://developer.android.com/reference/android/content/SharedPreferences.html` or `https://developer.android.com/reference/androidx/preference/PreferenceDataStore`. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setLayoutResource(int)(int layoutResId)` Sets the layout resource that is inflated as the `https://developer.android.com/reference/android/view/View.html` to be shown for this preference. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setOnPreferenceChangeListener(androidx.preference.Preference.OnPreferenceChangeListener)( @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/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` | `https://developer.android.com/reference/androidx/preference/Preference#setOnPreferenceClickListener(androidx.preference.Preference.OnPreferenceClickListener)( @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.OnPreferenceClickListener onPreferenceClickListener )` Sets the callback to be invoked when this preference is clicked. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setOrder(int)(int order)` Sets the order of this preference with respect to other preference objects on the same level. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setPersistent(boolean)(boolean persistent)` Sets whether this preference is persistent. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setPreferenceDataStore(androidx.preference.PreferenceDataStore)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/PreferenceDataStore dataStore)` Sets a `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` to be used by this preference instead of using `https://developer.android.com/reference/android/content/SharedPreferences.html`. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setSelectable(boolean)(boolean selectable)` Sets whether this preference is selectable. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setShouldDisableView(boolean)(boolean shouldDisableView)` Sets whether this preference should disable its view when it gets disabled. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setSingleLineTitle(boolean)(boolean singleLineTitle)` Sets whether to constrain the title of this preference to a single line instead of letting it wrap onto multiple lines. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setSummary(java.lang.CharSequence)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/CharSequence.html summary)` Sets the summary for this preference with a CharSequence. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setSummary(int)(int summaryResId)` Sets the summary for this preference with a resource ID. | | `final void` | `https://developer.android.com/reference/androidx/preference/Preference#setSummaryProvider(androidx.preference.Preference.SummaryProvider)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider summaryProvider)` Set a `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` that will be invoked whenever the summary of this preference is requested. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setTitle(java.lang.CharSequence)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/CharSequence.html title)` Sets the title for this preference with a CharSequence. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setTitle(int)(int titleResId)` Sets the title for this preference with a resource ID. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setViewId(int)(int viewId)` Set the ID that will be assigned to the overall View representing this preference, once bound. | | `final void` | `https://developer.android.com/reference/androidx/preference/Preference#setVisible(boolean)(boolean visible)` Sets whether this preference should be visible to the user. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#setWidgetLayoutResource(int)(int widgetLayoutResId)` Sets the layout for the controllable widget portion of this preference. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#shouldDisableDependents()()` Checks whether this preference's dependents should currently be disabled. | | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/preference/Preference#toString()()` | | ### Protected methods | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable T` | ` https://developer.android.com/reference/androidx/preference/Preference#findPreferenceInHierarchy(java.lang.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html key)` Finds a preference in the entire hierarchy (above or below this preference) with the given key. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedBoolean(boolean)(boolean defaultReturnValue)` Attempts to get a persisted `https://developer.android.com/reference/java/lang/Boolean.html` if this preference is persistent. | | `float` | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedFloat(float)(float defaultReturnValue)` Attempts to get a persisted `https://developer.android.com/reference/java/lang/Float.html` if this preference is persistent. | | `int` | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedInt(int)(int defaultReturnValue)` Attempts to get a persisted `https://developer.android.com/reference/java/lang/Integer.html` if this preference is persistent. | | `long` | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedLong(long)(long defaultReturnValue)` Attempts to get a persisted `https://developer.android.com/reference/java/lang/Long.html` if this preference is persistent. | | `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedString(java.lang.String)(https://developer.android.com/reference/java/lang/String.html defaultReturnValue)` Attempts to get a persisted set of Strings if this preference is persistent. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#notifyChanged()()` Should be called when the data of this `https://developer.android.com/reference/androidx/preference/Preference` has changed. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#notifyHierarchyChanged()()` Should be called when a preference has been added/removed from this group, or the ordering should be re-evaluated. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#onAttachedToHierarchy(androidx.preference.PreferenceManager)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/preference/PreferenceManager preferenceManager)` Called when this preference has been attached to a preference hierarchy. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#onClick()()` Processes a click on the preference. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/Object.html` | `https://developer.android.com/reference/androidx/preference/Preference#onGetDefaultValue(android.content.res.TypedArray,int)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/res/TypedArray.html a, int index)` Called when a preference is being inflated and the default value attribute needs to be read. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#onPrepareForRemoval()()` Called when this preference is being removed from the hierarchy. | | `void` | `https://developer.android.com/reference/androidx/preference/Preference#onRestoreInstanceState(android.os.Parcelable)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/os/Parcelable.html state)` Hook allowing a preference to re-apply a representation of its internal state that had previously been generated by `https://developer.android.com/reference/androidx/preference/Preference#onSaveInstanceState()`. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/os/Parcelable.html` | `https://developer.android.com/reference/androidx/preference/Preference#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` | `https://developer.android.com/reference/androidx/preference/Preference#onSetInitialValue(java.lang.Object)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/Object.html defaultValue)` Implement this to set the initial value of the preference. | | `void` | `[onSetInitialValue](https://developer.android.com/reference/androidx/preference/Preference#onSetInitialValue(boolean,java.lang.Object))(boolean restorePersistedValue, https://developer.android.com/reference/java/lang/Object.html defaultValue)` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/preference/Preference#onSetInitialValue(java.lang.Object)` instead.
| | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#persistBoolean(boolean)(boolean value)` Attempts to persist a `https://developer.android.com/reference/java/lang/Boolean.html` if this preference is persistent. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#persistFloat(float)(float value)` Attempts to persist a `https://developer.android.com/reference/java/lang/Float.html` if this preference is persistent. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#persistInt(int)(int value)` Attempts to persist an `https://developer.android.com/reference/java/lang/Integer.html` if this preference is persistent. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#persistLong(long)(long value)` Attempts to persist a `https://developer.android.com/reference/java/lang/Long.html` if this preference is persistent. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#persistString(java.lang.String)(https://developer.android.com/reference/java/lang/String.html value)` Attempts to persist a `https://developer.android.com/reference/java/lang/String.html` if this preference is persistent. | | `boolean` | `https://developer.android.com/reference/androidx/preference/Preference#shouldPersist()()` Checks whether, at the given time this method is called, this preference should store/restore its value(s) into the `https://developer.android.com/reference/android/content/SharedPreferences.html` or into `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` if assigned. | ## Constants ### DEFAULT_ORDER Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public static final int DEFAULT_ORDER = 2147483647 ``` Specify for `https://developer.android.com/reference/androidx/preference/Preference#setOrder(int)` if a specific order is not required. ## Public constructors ### Preference Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public Preference(@NonNull Context context) ``` Constructor to create a preference. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context` | The Context this is associated with, through which it can access the current theme, resources, `https://developer.android.com/reference/android/content/SharedPreferences.html`, etc. | ### Preference Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public Preference(@NonNull Context context, @Nullable 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 | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context` | The Context this is associated with, through which it can access the current theme, resources, `https://developer.android.com/reference/android/content/SharedPreferences.html`, etc. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/util/AttributeSet.html attrs` | The attributes of the XML tag that is inflating the preference | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#Preference(android.content.Context,android.util.AttributeSet,int)` | | ### Preference Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public Preference(     @NonNull Context context,     @Nullable AttributeSet attrs,     int defStyleAttr ) ``` Perform inflation from XML and apply a class-specific base style. This constructor allows subclasses to use their own base style when they are inflating. For example, a `https://developer.android.com/reference/androidx/preference/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 `https://developer.android.com/reference/androidx/preference/CheckBoxPreference` class's attributes. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context` | The Context this is associated with, through which it can access the current theme, resources, `https://developer.android.com/reference/android/content/SharedPreferences.html`, etc. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/util/AttributeSet.html attrs` | The attributes of the XML tag that is inflating the preference | | `int defStyleAttr` | 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 | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#Preference(android.content.Context,android.util.AttributeSet)` | | ### Preference Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public Preference(     @NonNull Context context,     @Nullable AttributeSet attrs,     int defStyleAttr,     int defStyleRes ) ``` Perform inflation from XML and apply a class-specific base style. This constructor allows subclasses to use their own base style when they are inflating. For example, a `https://developer.android.com/reference/androidx/preference/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 `https://developer.android.com/reference/androidx/preference/CheckBoxPreference` class's attributes. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html context` | The `https://developer.android.com/reference/android/content/Context.html` this is associated with, through which it can access the current theme, resources, `https://developer.android.com/reference/android/content/SharedPreferences.html`, etc. | | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/util/AttributeSet.html attrs` | The attributes of the XML tag that is inflating the preference | | `int defStyleAttr` | 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. | | `int defStyleRes` | 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 | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#Preference(android.content.Context,android.util.AttributeSet)` | | ## Public methods ### callChangeListener Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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 | |---|---| | `https://developer.android.com/reference/java/lang/Object.html newValue` | 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 [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public int compareTo(@NonNull Preference another) ``` Compares preference objects based on order (if set), otherwise alphabetically on the titles. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/preference/Preference another` | 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 [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @NonNull Context getContext() ``` Returns the `https://developer.android.com/reference/android/content/Context.html` of this preference. Each preference in a preference hierarchy can be from different Context (for example, if multiple activities provide preferences into a single `https://developer.android.com/reference/androidx/preference/PreferenceFragmentCompat`). This Context will be used to save the preference values. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/Context.html` | The Context of this preference | ### getDependency Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable String getDependency() ``` Returns the key of the dependency on this preference. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html` | The key of the dependency | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setDependency(java.lang.String)` | | ### getExtras Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @NonNull 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 Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable String getFragment() ``` Return the fragment class name associated with this preference. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html` | The fragment class name last set via `https://developer.android.com/reference/androidx/preference/Preference#setFragment(java.lang.String)` or XML | ### getIcon Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable Drawable getIcon() ``` Returns the icon of this preference. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/graphics/drawable/Drawable.html` | The icon | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setIcon(android.graphics.drawable.Drawable)` | | ### getIntent Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable Intent getIntent() ``` Return the `https://developer.android.com/reference/android/content/Intent.html` associated with this preference. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/content/Intent.html` | The `https://developer.android.com/reference/android/content/Intent.html` last set via `https://developer.android.com/reference/androidx/preference/Preference#setIntent(android.content.Intent)` or XML | ### getKey Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public String getKey() ``` Gets the key for this preference, which is also the key used for storing values into `https://developer.android.com/reference/android/content/SharedPreferences.html` or `https://developer.android.com/reference/androidx/preference/PreferenceDataStore`. | Returns | |---|---| | `https://developer.android.com/reference/java/lang/String.html` | The key | ### getLayoutResource Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public final int getLayoutResource() ``` Gets the layout resource that will be shown as the `https://developer.android.com/reference/android/view/View.html` for this preference. | Returns | |---|---| | `int` | The layout resource ID | ### getOnPreferenceChangeListener Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable 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 | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.OnPreferenceChangeListener` | The callback to be invoked | ### getOnPreferenceClickListener Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable Preference.OnPreferenceClickListener getOnPreferenceClickListener() ``` Returns the callback to be invoked when this preference is clicked. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.OnPreferenceClickListener` | The callback to be invoked | ### getOrder Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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 | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setOrder(int)` | | ### getParent Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable PreferenceGroup getParent() ``` Returns the `https://developer.android.com/reference/androidx/preference/PreferenceGroup` which is this preference assigned to or `null` if this preference is not assigned to any group or is a root preference. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/PreferenceGroup` | The parent PreferenceGroup or `null` if not attached to any | ### getPersistedStringSet Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public Set getPersistedStringSet(Set defaultReturnValue) ``` Attempts to get a persisted set of Strings if this preference is persistent. | Parameters | |---|---| | `https://developer.android.com/reference/java/util/Set.html defaultReturnValue` | The default value to return if either this preference is not persistent or this preference is not present. | | Returns | |---|---| | `https://developer.android.com/reference/java/util/Set.html` | The value from the storage or the default return value | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#persistStringSet(java.util.Set)` | | ### getPreferenceDataStore Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable PreferenceDataStore getPreferenceDataStore() ``` Returns `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` used by this preference. Returns `null` if `https://developer.android.com/reference/android/content/SharedPreferences.html` is used instead. By default preferences always use `https://developer.android.com/reference/android/content/SharedPreferences.html`. To make this preference to use the `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` you need to assign your implementation to the preference itself via `https://developer.android.com/reference/androidx/preference/Preference#setPreferenceDataStore(androidx.preference.PreferenceDataStore)` or to its `https://developer.android.com/reference/androidx/preference/PreferenceManager` via `https://developer.android.com/reference/androidx/preference/PreferenceManager#setPreferenceDataStore(androidx.preference.PreferenceDataStore)`. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/PreferenceDataStore` | The `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` used by this preference or `null` if none | ### getPreferenceManager Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public PreferenceManager getPreferenceManager() ``` Gets the `https://developer.android.com/reference/androidx/preference/PreferenceManager` that manages this preference object's tree. | Returns | |---|---| | `https://developer.android.com/reference/androidx/preference/PreferenceManager` | The `https://developer.android.com/reference/androidx/preference/PreferenceManager` | ### getSharedPreferences Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable SharedPreferences getSharedPreferences() ``` Returns the `https://developer.android.com/reference/android/content/SharedPreferences.html` where this preference can read its value(s). Usually, it's easier to use one of the helper read methods: `https://developer.android.com/reference/androidx/preference/Preference#getPersistedBoolean(boolean)`, `https://developer.android.com/reference/androidx/preference/Preference#getPersistedFloat(float)`, `https://developer.android.com/reference/androidx/preference/Preference#getPersistedInt(int)`, `https://developer.android.com/reference/androidx/preference/Preference#getPersistedLong(long)`, `https://developer.android.com/reference/androidx/preference/Preference#getPersistedString(java.lang.String)`. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/content/SharedPreferences.html` | The `https://developer.android.com/reference/android/content/SharedPreferences.html` where this preference reads its value(s). If this preference is not attached to a preference hierarchy or if a `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` has been set, this method returns `null`. | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setPreferenceDataStore(androidx.preference.PreferenceDataStore)` | | ### getShouldDisableView Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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 | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setShouldDisableView(boolean)` | | ### getSummary Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable CharSequence getSummary() ``` Returns the summary of this preference. If a `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` has been set for this preference, it will be used to provide the summary returned by this method. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/CharSequence.html` | The summary | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setSummary(java.lang.CharSequence)` | | | `https://developer.android.com/reference/androidx/preference/Preference#setSummaryProvider(androidx.preference.Preference.SummaryProvider)` | | ### getSummaryProvider Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/preference#1.1.0) ``` public final @Nullable Preference.SummaryProvider getSummaryProvider() ``` Returns the `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` used to configure the summary of this preference. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` | The `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` used to configure the summary of this preference, or `null` if there is no SummaryProvider set | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` | | ### getTitle Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable CharSequence getTitle() ``` Returns the title of this preference. | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/CharSequence.html` | The title | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setTitle(java.lang.CharSequence)` | | ### getWidgetLayoutResource Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public final int getWidgetLayoutResource() ``` Gets the layout resource for the controllable widget portion of this preference. | Returns | |---|---| | `int` | The layout resource ID | ### hasKey Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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 | ### isCopyingEnabled Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/preference#1.1.0) ``` public boolean isCopyingEnabled() ``` Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference. | Returns | |---|---| | `boolean` | `true` if copying is enabled, false otherwise | ### isEnabled Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public boolean isEnabled() ``` Checks whether this preference should be enabled in the list. | Returns | |---|---| | `boolean` | `true` if this preference is enabled, false otherwise | ### isIconSpaceReserved Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public boolean isIconSpaceReserved() ``` Returns whether the space of this preference icon view is reserved. | Returns | |---|---| | `boolean` | `true` if the space of this preference icon view is reserved `https://developer.android.com/reference/android/R.attr.html#iconSpaceReserved` | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setIconSpaceReserved(boolean)` | | ### isPersistent Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public boolean isPersistent() ``` Checks whether this preference is persistent. If it is, it stores its value(s) into the persistent `https://developer.android.com/reference/android/content/SharedPreferences.html` storage by default or into `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` if assigned. | Returns | |---|---| | `boolean` | `true` if persistent | ### isSelectable Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public boolean isSelectable() ``` Checks whether this preference should be selectable in the list. | Returns | |---|---| | `boolean` | `true` if it is selectable, false otherwise | ### isShown Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public final boolean isShown() ``` Checks whether this preference is shown to the user in the hierarchy. For a preference to be shown in the hierarchy, it and all of its ancestors must be visible and attached to the root `https://developer.android.com/reference/androidx/preference/PreferenceScreen`. | Returns | |---|---| | `boolean` | `true` if this preference is shown to the user in the hierarchy | ### isSingleLineTitle Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public boolean isSingleLineTitle() ``` Gets whether the title of this preference is constrained to a single line. | Returns | |---|---| | `boolean` | `true` if the title of this preference is constrained to a single line `https://developer.android.com/reference/android/R.attr.html#singleLineTitle` | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setSingleLineTitle(boolean)` | | ### isVisible Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public final boolean isVisible() ``` Checks whether this preference should be visible to the user. If this preference is visible, but one or more of its ancestors are not visible, then this preference will not be shown until its ancestors are all visible. | Returns | |---|---| | `boolean` | `true` if this preference should be displayed | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setVisible(boolean)` | | | `https://developer.android.com/reference/androidx/preference/Preference#isShown()` | | ### notifyDependencyChange Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void notifyDependencyChange(boolean disableDependents) ``` Notifies any listening dependents of a change that affects the dependency. | Parameters | |---|---| | `boolean disableDependents` | Whether this preference should disable its dependents. | ### onAttached Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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 [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void onBindViewHolder(@NonNull 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 | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/preference/PreferenceViewHolder holder` | 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 [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void onDependencyChanged(     @NonNull Preference dependency,     boolean disableDependent ) ``` Called when the dependency changes. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/preference/Preference dependency` | The preference that this preference depends on | | `boolean disableDependent` | Set true to disable this preference | ### onDetached Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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 [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/preference#1.1.0) ``` @CallSuper public void [onInitializeAccessibilityNodeInfo](https://developer.android.com/reference/androidx/preference/Preference#onInitializeAccessibilityNodeInfo(androidx.core.view.accessibility.AccessibilityNodeInfoCompat))(AccessibilityNodeInfoCompat info) ``` > [!CAUTION] > **This method is deprecated.** > > Preferences aren't views. They should not need any accessibility changes, unless the view hierarchy is customized. In this situation, please add Accessibility information in `https://developer.android.com/reference/androidx/preference/Preference#onBindViewHolder(androidx.preference.PreferenceViewHolder)`. Initializes an `https://developer.android.com/reference/android/view/accessibility/AccessibilityNodeInfo.html` with information about the View for this preference. ### onParentChanged Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void onParentChanged(@NonNull Preference parent, boolean disableChild) ``` Called when the implicit parent dependency changes. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/preference/Preference parent` | The preference that this preference depends on | | `boolean disableChild` | Set true to disable this preference | ### peekExtras Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public @Nullable Bundle peekExtras() ``` Return the extras Bundle object associated with this preference, returning `null` if there is not currently one. ### persistStringSet Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public boolean persistStringSet(Set 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 | |---|---| | `https://developer.android.com/reference/java/util/Set.html values` | The values to persist | | Returns | |---|---| | `boolean` | `true` if the preference is persistent, `false` otherwise | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedStringSet(java.util.Set)` | | ### restoreHierarchyState Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void restoreHierarchyState(@NonNull Bundle container) ``` Restore this preference hierarchy's previously saved state from the given container. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html container` | The Bundle that holds the previously saved state | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#saveHierarchyState(android.os.Bundle)` | | | `https://developer.android.com/reference/androidx/preference/Preference#onRestoreInstanceState(android.os.Parcelable)` | | ### saveHierarchyState Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void saveHierarchyState(@NonNull Bundle container) ``` Store this preference hierarchy's frozen state into the given container. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html container` | The Bundle in which to save the instance of this preference | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#restoreHierarchyState(android.os.Bundle)` | | | `https://developer.android.com/reference/androidx/preference/Preference#onSaveInstanceState()` | | ### setCopyingEnabled Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/preference#1.1.0) ``` public void setCopyingEnabled(boolean enabled) ``` Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference. | Parameters | |---|---| | `boolean enabled` | Set true to enable copying the summary of this preference | ### setDefaultValue Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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 | |---|---| | `https://developer.android.com/reference/java/lang/Object.html defaultValue` | The default value | ### setDependency Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setDependency(@Nullable 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 | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html dependencyKey` | The key of the preference that this depends on | ### setEnabled Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setEnabled(boolean enabled) ``` Sets whether this preference is enabled. If disabled, it will not handle clicks. | Parameters | |---|---| | `boolean enabled` | Set true to enable it | ### setFragment Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setFragment(@Nullable String fragment) ``` Sets the class name of a fragment to be shown when this preference is clicked. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/String.html fragment` | The class name of the fragment associated with this preference | ### setIcon Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setIcon(@Nullable Drawable icon) ``` Sets the icon for this preference with a Drawable. This icon will be placed into the ID `https://developer.android.com/reference/android/R.id.html#icon` within the View created by `https://developer.android.com/reference/androidx/preference/Preference#onBindViewHolder(androidx.preference.PreferenceViewHolder)`. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/graphics/drawable/Drawable.html icon` | The optional icon for this preference | ### setIcon Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setIcon(int iconResId) ``` Sets the icon for this preference with a resource ID. | Parameters | |---|---| | `int iconResId` | The icon as a resource ID | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setIcon(android.graphics.drawable.Drawable)` | | ### setIconSpaceReserved Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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. | Parameters | |---|---| | `boolean iconSpaceReserved` | Set `true` if the space for the icon view should be reserved `https://developer.android.com/reference/android/R.attr.html#iconSpaceReserved` | ### setIntent Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setIntent(@Nullable Intent intent) ``` Sets an `https://developer.android.com/reference/android/content/Intent.html` to be used for `https://developer.android.com/reference/android/content/Context.html#startActivity(android.content.Intent)` when this preference is clicked. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/content/Intent.html intent` | The intent associated with this preference | ### setKey Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setKey(String key) ``` Sets the key for this preference, which is used as a key to the `https://developer.android.com/reference/android/content/SharedPreferences.html` or `https://developer.android.com/reference/androidx/preference/PreferenceDataStore`. This should be unique for the package. | Parameters | |---|---| | `https://developer.android.com/reference/java/lang/String.html key` | The key for the preference | ### setLayoutResource Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setLayoutResource(int layoutResId) ``` Sets the layout resource that is inflated as the `https://developer.android.com/reference/android/view/View.html` 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 `https://developer.android.com/reference/android/view/ViewGroup.html` with ID `https://developer.android.com/reference/android/R.id.html#widget_frame` to be the parent of the specific widget for this preference. It should similarly contain `https://developer.android.com/reference/android/R.id.html#title` and `https://developer.android.com/reference/android/R.id.html#summary`. It is an error to change the layout after adding the preference to a `https://developer.android.com/reference/androidx/preference/PreferenceGroup`. | Parameters | |---|---| | `int layoutResId` | The layout resource ID to be inflated and returned as a `https://developer.android.com/reference/android/view/View.html` | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setWidgetLayoutResource(int)` | | ### setOnPreferenceChangeListener Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setOnPreferenceChangeListener(     @Nullable 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 | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.OnPreferenceChangeListener onPreferenceChangeListener` | The callback to be invoked | ### setOnPreferenceClickListener Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setOnPreferenceClickListener(     @Nullable Preference.OnPreferenceClickListener onPreferenceClickListener ) ``` Sets the callback to be invoked when this preference is clicked. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.OnPreferenceClickListener onPreferenceClickListener` | The callback to be invoked | ### setOrder Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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 `https://developer.android.com/reference/androidx/preference/PreferenceGroup#setOrderingAsAdded(boolean)` can be used to order preference objects based on the order they appear in the XML. | Parameters | |---|---| | `int order` | The order for this preference. A lower value will be shown first. Use `https://developer.android.com/reference/androidx/preference/Preference#DEFAULT_ORDER()` to sort alphabetically or allow ordering from XML. | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/PreferenceGroup#setOrderingAsAdded(boolean)` | | | `https://developer.android.com/reference/androidx/preference/Preference#DEFAULT_ORDER()` | | ### setPersistent Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setPersistent(boolean persistent) ``` Sets whether this preference is persistent. When persistent, it stores its value(s) into the persistent `https://developer.android.com/reference/android/content/SharedPreferences.html` storage by default or into `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` if assigned. | Parameters | |---|---| | `boolean persistent` | Set `true` if it should store its value(s) into the storage | ### setPreferenceDataStore Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setPreferenceDataStore(@Nullable PreferenceDataStore dataStore) ``` Sets a `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` to be used by this preference instead of using `https://developer.android.com/reference/android/content/SharedPreferences.html`. 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 `https://developer.android.com/reference/androidx/preference/PreferenceManager` that owns this preference. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/PreferenceDataStore dataStore` | The `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` to be used by this preference | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/PreferenceManager#setPreferenceDataStore(androidx.preference.PreferenceDataStore)` | | ### setSelectable Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setSelectable(boolean selectable) ``` Sets whether this preference is selectable. | Parameters | |---|---| | `boolean selectable` | Set true to make it selectable | ### setShouldDisableView Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setShouldDisableView(boolean shouldDisableView) ``` Sets whether this preference should disable its view when it gets disabled. For example, set this and `https://developer.android.com/reference/androidx/preference/Preference#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 | |---|---| | `boolean shouldDisableView` | Set true if this preference should disable its view when the preference is disabled. | ### setSingleLineTitle Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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. | Parameters | |---|---| | `boolean singleLineTitle` | Set `true` if the title should be constrained to one line `https://developer.android.com/reference/android/R.attr.html#singleLineTitle` | ### setSummary Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setSummary(@Nullable CharSequence summary) ``` Sets the summary for this preference with a CharSequence. You can also use a `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` to dynamically configure the summary of this preference. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/CharSequence.html summary` | The summary for the preference | | Throws | |---|---| | `https://developer.android.com/reference/java/lang/IllegalStateException.html` | If a `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` has already been set. | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setSummaryProvider(androidx.preference.Preference.SummaryProvider)` | | ### setSummary Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setSummary(int summaryResId) ``` Sets the summary for this preference with a resource ID. You can also use a `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` to dynamically configure the summary of this preference. | Parameters | |---|---| | `int summaryResId` | The summary as a resource | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setSummary(java.lang.CharSequence)` | | | `https://developer.android.com/reference/androidx/preference/Preference#setSummaryProvider(androidx.preference.Preference.SummaryProvider)` | | ### setSummaryProvider Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/preference#1.1.0) ``` public final void setSummaryProvider(@Nullable Preference.SummaryProvider summaryProvider) ``` Set a `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` that will be invoked whenever the summary of this preference is requested. Set `null` to remove the existing SummaryProvider. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider summaryProvider` | The `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` that will be invoked whenever the summary of this preference is requested | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference.SummaryProvider` | | ### setTitle Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setTitle(@Nullable CharSequence title) ``` Sets the title for this preference with a CharSequence. This title will be placed into the ID `https://developer.android.com/reference/android/R.id.html#title` within the View bound by `https://developer.android.com/reference/androidx/preference/Preference#onBindViewHolder(androidx.preference.PreferenceViewHolder)`. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/CharSequence.html title` | The title for this preference | ### setTitle Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setTitle(int titleResId) ``` Sets the title for this preference with a resource ID. | Parameters | |---|---| | `int titleResId` | The title as a resource ID | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setTitle(java.lang.CharSequence)` | | ### setViewId Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public void setViewId(int viewId) ``` Set the ID that will be assigned to the overall View representing this preference, once bound. | See also | |---|---| | `https://developer.android.com/reference/android/view/View.html#setId(int)` | | ### setVisible Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public final void setVisible(boolean visible) ``` Sets whether this preference should be visible to the user. If false, it is excluded from the adapter, but can still be retrieved using `https://developer.android.com/reference/androidx/preference/PreferenceFragmentCompat#findPreference(java.lang.CharSequence)`. To show this preference to the user, its ancestors must also all be visible. If you make a `https://developer.android.com/reference/androidx/preference/PreferenceGroup` invisible, none of its children will be shown to the user until the group is visible. | Parameters | |---|---| | `boolean visible` | Set false if this preference should be hidden from the user isPreferenceVisible | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#isShown()` | | ### setWidgetLayoutResource Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public 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 `https://developer.android.com/reference/androidx/preference/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 `https://developer.android.com/reference/androidx/preference/PreferenceGroup`. | Parameters | |---|---| | `int widgetLayoutResId` | The layout resource ID to be inflated into the main layout | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#setLayoutResource(int)` | | ### shouldDisableDependents Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` public boolean shouldDisableDependents() ``` Checks whether this preference's dependents should currently be disabled. | Returns | |---|---| | `boolean` | `true` if the dependents should be disabled, otherwise false | ### toString ``` public @NonNull String toString() ``` ## Protected methods ### findPreferenceInHierarchy Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/preference#1.1.0) ``` protected @Nullable T  findPreferenceInHierarchy(@NonNull String key) ``` Finds a preference in the entire hierarchy (above or below this preference) with the given key. Returns `null` if no preference could be found with the given key. This only works after this preference has been attached to a hierarchy. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html key` | The key of the preference to retrieve | | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable T` | The preference with the key, or `null` | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/PreferenceGroup#findPreference(java.lang.CharSequence)` | | ### getPersistedBoolean Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected boolean getPersistedBoolean(boolean defaultReturnValue) ``` Attempts to get a persisted `https://developer.android.com/reference/java/lang/Boolean.html` if this preference is persistent. | Parameters | |---|---| | `boolean defaultReturnValue` | 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 | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedString(java.lang.String)` | | | `https://developer.android.com/reference/androidx/preference/Preference#persistBoolean(boolean)` | | ### getPersistedFloat Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected float getPersistedFloat(float defaultReturnValue) ``` Attempts to get a persisted `https://developer.android.com/reference/java/lang/Float.html` if this preference is persistent. | Parameters | |---|---| | `float defaultReturnValue` | The default value to return if either this preference is not persistent or this preference is not saved. | | Returns | |---|---| | `float` | The value from the storage or the default return value | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedString(java.lang.String)` | | | `https://developer.android.com/reference/androidx/preference/Preference#persistFloat(float)` | | ### getPersistedInt Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected int getPersistedInt(int defaultReturnValue) ``` Attempts to get a persisted `https://developer.android.com/reference/java/lang/Integer.html` if this preference is persistent. | Parameters | |---|---| | `int defaultReturnValue` | 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 | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedString(java.lang.String)` | | | `https://developer.android.com/reference/androidx/preference/Preference#persistInt(int)` | | ### getPersistedLong Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected long getPersistedLong(long defaultReturnValue) ``` Attempts to get a persisted `https://developer.android.com/reference/java/lang/Long.html` if this preference is persistent. | Parameters | |---|---| | `long defaultReturnValue` | 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 | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedString(java.lang.String)` | | | `https://developer.android.com/reference/androidx/preference/Preference#persistLong(long)` | | ### getPersistedString Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected String getPersistedString(String defaultReturnValue) ``` Attempts to get a persisted set of Strings if this preference is persistent. | Parameters | |---|---| | `https://developer.android.com/reference/java/lang/String.html defaultReturnValue` | The default value to return if either the preference is not persistent or the preference is not in the shared preferences. | | Returns | |---|---| | `https://developer.android.com/reference/java/lang/String.html` | The value from the storage or the default return value | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#persistString(java.lang.String)` | | ### notifyChanged Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected void notifyChanged() ``` Should be called when the data of this `https://developer.android.com/reference/androidx/preference/Preference` has changed. ### notifyHierarchyChanged Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected 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 [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected void onAttachedToHierarchy(@NonNull PreferenceManager preferenceManager) ``` Called when this preference has been attached to a preference hierarchy. Make sure to call the super implementation. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/preference/PreferenceManager preferenceManager` | The PreferenceManager of the hierarchy | ### onClick Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected void onClick() ``` Processes a click on the preference. This includes saving the value to the `https://developer.android.com/reference/android/content/SharedPreferences.html`. However, the overridden method should call `https://developer.android.com/reference/androidx/preference/Preference#callChangeListener(java.lang.Object)` to make sure the client wants to update the preference's state with the new value. ### onGetDefaultValue Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected @Nullable Object onGetDefaultValue(@NonNull 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 `https://developer.android.com/reference/android/content/res/TypedArray.html#getString(int)`. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/res/TypedArray.html a` | The set of attributes | | `int index` | The index of the default value attribute | | Returns | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/Object.html` | The default value of this preference type | ### onPrepareForRemoval Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected 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 [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected void onRestoreInstanceState(@Nullable Parcelable state) ``` Hook allowing a preference to re-apply a representation of its internal state that had previously been generated by `https://developer.android.com/reference/androidx/preference/Preference#onSaveInstanceState()`. This function will never be called with a null state. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/os/Parcelable.html state` | The saved state that had previously been returned by `https://developer.android.com/reference/androidx/preference/Preference#onSaveInstanceState()`. | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#onSaveInstanceState()` | | | `https://developer.android.com/reference/androidx/preference/Preference#restoreHierarchyState(android.os.Bundle)` | | ### onSaveInstanceState Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected @Nullable 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 | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/os/Parcelable.html` | 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 | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#onRestoreInstanceState(android.os.Parcelable)` | | | `https://developer.android.com/reference/androidx/preference/Preference#saveHierarchyState(android.os.Bundle)` | | ### onSetInitialValue Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected void onSetInitialValue(@Nullable Object defaultValue) ``` Implement this to set the initial value of the preference. If you are persisting values to `https://developer.android.com/reference/android/content/SharedPreferences.html` or a `https://developer.android.com/reference/androidx/preference/PreferenceDataStore` you should restore the saved value for the preference. If you are not persisting values, or there is no value saved for the preference, you should set the value of the preference to defaultValue. | Parameters | |---|---| | `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/Object.html defaultValue` | The default value for the preference if set, otherwise `null`. | ### onSetInitialValue Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) Deprecated in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected void [onSetInitialValue](https://developer.android.com/reference/androidx/preference/Preference#onSetInitialValue(boolean,java.lang.Object))(boolean restorePersistedValue, Object defaultValue) ``` > [!CAUTION] > **This method is deprecated.** > > Use `https://developer.android.com/reference/androidx/preference/Preference#onSetInitialValue(java.lang.Object)` instead. Implement this to set the initial value of the preference. If restorePersistedValue is true, you should restore the preference value from the `https://developer.android.com/reference/android/content/SharedPreferences.html`. If restorePersistedValue is false, you should set the preference value to defaultValue that is given (and possibly store to SharedPreferences if `https://developer.android.com/reference/androidx/preference/Preference#shouldPersist()` is true). In case of using `https://developer.android.com/reference/androidx/preference/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 | |---|---| | `boolean restorePersistedValue` | True to restore the persisted value; false to use the given defaultValue. | | `https://developer.android.com/reference/java/lang/Object.html defaultValue` | The default value for this preference. Only use this if restorePersistedValue is false. | ### persistBoolean Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected boolean persistBoolean(boolean value) ``` Attempts to persist a `https://developer.android.com/reference/java/lang/Boolean.html` 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 | |---|---| | `boolean value` | The value to persist | | Returns | |---|---| | `boolean` | `true` if the preference is persistent, `false` otherwise | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#persistString(java.lang.String)` | | | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedBoolean(boolean)` | | ### persistFloat Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected boolean persistFloat(float value) ``` Attempts to persist a `https://developer.android.com/reference/java/lang/Float.html` 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 | |---|---| | `float value` | The value to persist | | Returns | |---|---| | `boolean` | `true` if the preference is persistent, `false` otherwise | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#persistString(java.lang.String)` | | | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedFloat(float)` | | ### persistInt Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected boolean persistInt(int value) ``` Attempts to persist an `https://developer.android.com/reference/java/lang/Integer.html` 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 | |---|---| | `int value` | The value to persist | | Returns | |---|---| | `boolean` | `true` if the preference is persistent, `false` otherwise | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#persistString(java.lang.String)` | | | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedInt(int)` | | ### persistLong Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected boolean persistLong(long value) ``` Attempts to persist a `https://developer.android.com/reference/java/lang/Long.html` 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 | |---|---| | `long value` | The value to persist | | Returns | |---|---| | `boolean` | `true` if the preference is persistent, `false` otherwise | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#persistString(java.lang.String)` | | | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedLong(long)` | | ### persistString Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected boolean persistString(String value) ``` Attempts to persist a `https://developer.android.com/reference/java/lang/String.html` 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 | |---|---| | `https://developer.android.com/reference/java/lang/String.html value` | The value to persist | | Returns | |---|---| | `boolean` | `true` if the preference is persistent, `false` otherwise | | See also | |---|---| | `https://developer.android.com/reference/androidx/preference/Preference#getPersistedString(java.lang.String)` | | ### shouldPersist Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/preference#1.0.0) ``` protected boolean shouldPersist() ``` Checks whether, at the given time this method is called, this preference should store/restore its value(s) into the `https://developer.android.com/reference/android/content/SharedPreferences.html` or into `https://developer.android.com/reference/androidx/preference/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 |