Preference

Artifact: androidx.preference:preference

Added in 1.0.0

Kotlin |Java

class Preference : Comparable

Known direct subclasses

DialogPreference, PreferenceGroup, SeekBarPreference, TwoStatePreference

`DialogPreference`	A base class for `Preference`s that are dialog-based.
`PreferenceGroup`	A container for multiple `Preference`s.
`SeekBarPreference`	Preference based on android.preference.SeekBarPreference but uses support preference as a base .
`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, DropDownPreference, EditTextPreference, ListPreference, MultiSelectListPreference, PreferenceCategory, PreferenceScreen, SwitchPreferenceCompat, SwitchPreference

`CheckBoxPreference`	A `Preference` that provides checkbox widget functionality.
`DropDownPreference`	A `ListPreference` that presents the options in a drop down menu rather than a dialog.
`EditTextPreference`	A `DialogPreference` that shows a `EditText` in the dialog.
`ListPreference`	A `Preference` that displays a list of entries as a dialog.
`MultiSelectListPreference`	A `Preference` that displays a list of entries as a dialog.
`PreferenceCategory`	A container that is used to group similar `Preference`s.
`PreferenceScreen`	A top-level container that represents a settings screen.
`SwitchPreferenceCompat`	A `Preference` that provides a two-state toggleable option.
`SwitchPreference`	A `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 SharedPreferences or PreferenceDataStore instance that persists the preference's values.

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

This class contains a key that 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
`class Preference.BaseSavedState : AbsSavedState` A base class for managing the instance state of a `Preference`.
`interface Preference.OnPreferenceChangeListener` Interface definition for a callback to be invoked when the value of this `Preference` has been changed by the user and is about to be set and/or persisted.
`interface Preference.OnPreferenceClickListener` Interface definition for a callback to be invoked when a `Preference` is clicked.
`interface Preference.SummaryProvider<T : Preference?>` Interface definition for a callback to be invoked when the summary of this `Preference` is requested (typically when this preference is added to the hierarchy or its value is updated).

Constants
`const Int`	`DEFAULT_ORDER = 2147483647` Specify for `setOrder` if a specific order is not required.

Public constructors
`Preference(context: Context)` Constructor to create a preference.
`Preference(context: Context, attrs: AttributeSet?)` Constructor that is called when inflating a preference from XML.
`Preference(context: Context, attrs: AttributeSet?, defStyleAttr: Int)` Perform inflation from XML and apply a class-specific base style.
`Preference( context: Context, attrs: AttributeSet?, defStyleAttr: Int, defStyleRes: Int )` Perform inflation from XML and apply a class-specific base style.

Public functions
`Boolean`	`callChangeListener(newValue: Any!)` Call this method after the user changes the preference, but before the internal state is set.
`Int`	`compareTo(another: Preference)` Compares preference objects based on order (if set), otherwise alphabetically on the titles.
`Context`	`getContext()` Returns the `Context` of this preference.
`String?`	`getDependency()` Returns the key of the dependency on this preference.
`Bundle`	`getExtras()` Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.
`String?`	`getFragment()` Return the fragment class name associated with this preference.
`Drawable?`	`getIcon()` Returns the icon of this preference.
`Intent?`	`getIntent()` Return the `Intent` associated with this preference.
`String!`	`getKey()` Gets the key for this preference, which is also the key used for storing values into `SharedPreferences` or `PreferenceDataStore`.
`Int`	`getLayoutResource()` Gets the layout resource that will be shown as the `View` for this preference.
`Preference.OnPreferenceChangeListener?`	`getOnPreferenceChangeListener()` Returns the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).
`Preference.OnPreferenceClickListener?`	`getOnPreferenceClickListener()` Returns the callback to be invoked when this preference is clicked.
`Int`	`getOrder()` Gets the order of this preference with respect to other preference objects on the same level.
`PreferenceGroup?`	`getParent()` Returns the `PreferenceGroup` which is this preference assigned to or `null` if this preference is not assigned to any group or is a root preference.
`(Mutable)Set<String!>!`	`getPersistedStringSet(defaultReturnValue: (Mutable)Set<String!>!)` Attempts to get a persisted set of Strings if this preference is persistent.
`PreferenceDataStore?`	`getPreferenceDataStore()` Returns `PreferenceDataStore` used by this preference.
`PreferenceManager!`	`getPreferenceManager()` Gets the `PreferenceManager` that manages this preference object's tree.
`SharedPreferences?`	`getSharedPreferences()` Returns the `SharedPreferences` where this preference can read its value(s).
`Boolean`	`getShouldDisableView()` Checks whether this preference should disable its view when it's action is disabled.
`CharSequence?`	`getSummary()` Returns the summary of this preference.
`Preference.SummaryProvider?`	`getSummaryProvider()` Returns the `SummaryProvider` used to configure the summary of this preference.
`CharSequence?`	`getTitle()` Returns the title of this preference.
`Int`	`getWidgetLayoutResource()` Gets the layout resource for the controllable widget portion of this preference.
`Boolean`	`hasKey()` Checks whether this preference has a valid key.
`Boolean`	`isCopyingEnabled()` Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference.
`Boolean`	`isEnabled()` Checks whether this preference should be enabled in the list.
`Boolean`	`isIconSpaceReserved()` Returns whether the space of this preference icon view is reserved.
`Boolean`	`isPersistent()` Checks whether this preference is persistent.
`Boolean`	`isSelectable()` Checks whether this preference should be selectable in the list.
`Boolean`	`isShown()` Checks whether this preference is shown to the user in the hierarchy.
`Boolean`	`isSingleLineTitle()` Gets whether the title of this preference is constrained to a single line.
`Boolean`	`isVisible()` Checks whether this preference should be visible to the user.
`Unit`	`notifyDependencyChange(disableDependents: Boolean)` Notifies any listening dependents of a change that affects the dependency.
`Unit`	`onAttached()` Called when the preference hierarchy has been attached to the list of preferences.
`Unit`	`onBindViewHolder(holder: PreferenceViewHolder)` Binds the created View to the data for this preference.
`Unit`	`onDependencyChanged(dependency: Preference, disableDependent: Boolean)` Called when the dependency changes.
`Unit`	`onDetached()` Called when the preference hierarchy has been detached from the list of preferences.
`Unit`	`@CallSuper onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfoCompat!)` This function is deprecated. Preferences aren't views.
`Unit`	`onParentChanged(parent: Preference, disableChild: Boolean)` Called when the implicit parent dependency changes.
`Bundle?`	`peekExtras()` Return the extras Bundle object associated with this preference, returning `null` if there is not currently one.
`Boolean`	`persistStringSet(values: (Mutable)Set<String!>!)` Attempts to persist a set of Strings if this preference is persistent.
`Unit`	`restoreHierarchyState(container: Bundle)` Restore this preference hierarchy's previously saved state from the given container.
`Unit`	`saveHierarchyState(container: Bundle)` Store this preference hierarchy's frozen state into the given container.
`Unit`	`setCopyingEnabled(enabled: Boolean)` Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference.
`Unit`	`setDefaultValue(defaultValue: Any!)` 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.
`Unit`	`setDependency(dependencyKey: String?)` Sets the key of a preference that this preference will depend on.
`Unit`	`setEnabled(enabled: Boolean)` Sets whether this preference is enabled.
`Unit`	`setFragment(fragment: String?)` Sets the class name of a fragment to be shown when this preference is clicked.
`Unit`	`setIcon(icon: Drawable?)` Sets the icon for this preference with a Drawable.
`Unit`	`setIcon(iconResId: Int)` Sets the icon for this preference with a resource ID.
`Unit`	`setIconSpaceReserved(iconSpaceReserved: Boolean)` Sets whether to reserve the space of this preference icon view when no icon is provided.
`Unit`	`setIntent(intent: Intent?)` Sets an `Intent` to be used for `startActivity` when this preference is clicked.
`Unit`	`setKey(key: String!)` Sets the key for this preference, which is used as a key to the `SharedPreferences` or `PreferenceDataStore`.
`Unit`	`setLayoutResource(layoutResId: Int)` Sets the layout resource that is inflated as the `View` to be shown for this preference.
`Unit`	`setOnPreferenceChangeListener( onPreferenceChangeListener: Preference.OnPreferenceChangeListener? )` Sets the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).
`Unit`	`setOnPreferenceClickListener( onPreferenceClickListener: Preference.OnPreferenceClickListener? )` Sets the callback to be invoked when this preference is clicked.
`Unit`	`setOrder(order: Int)` Sets the order of this preference with respect to other preference objects on the same level.
`Unit`	`setPersistent(persistent: Boolean)` Sets whether this preference is persistent.
`Unit`	`setPreferenceDataStore(dataStore: PreferenceDataStore?)` Sets a `PreferenceDataStore` to be used by this preference instead of using `SharedPreferences`.
`Unit`	`setSelectable(selectable: Boolean)` Sets whether this preference is selectable.
`Unit`	`setShouldDisableView(shouldDisableView: Boolean)` Sets whether this preference should disable its view when it gets disabled.
`Unit`	`setSingleLineTitle(singleLineTitle: Boolean)` Sets whether to constrain the title of this preference to a single line instead of letting it wrap onto multiple lines.
`Unit`	`setSummary(summary: CharSequence?)` Sets the summary for this preference with a CharSequence.
`Unit`	`setSummary(summaryResId: Int)` Sets the summary for this preference with a resource ID.
`Unit`	`setSummaryProvider(summaryProvider: Preference.SummaryProvider?)` Set a `SummaryProvider` that will be invoked whenever the summary of this preference is requested.
`Unit`	`setTitle(title: CharSequence?)` Sets the title for this preference with a CharSequence.
`Unit`	`setTitle(titleResId: Int)` Sets the title for this preference with a resource ID.
`Unit`	`setViewId(viewId: Int)` Set the ID that will be assigned to the overall View representing this preference, once bound.
`Unit`	`setVisible(visible: Boolean)` Sets whether this preference should be visible to the user.
`Unit`	`setWidgetLayoutResource(widgetLayoutResId: Int)` Sets the layout for the controllable widget portion of this preference.
`Boolean`	`shouldDisableDependents()` Checks whether this preference's dependents should currently be disabled.
`String`	`toString()`

Protected functions
`T?`	`<T : Preference?> findPreferenceInHierarchy(key: String)` Finds a preference in the entire hierarchy (above or below this preference) with the given key.
`Boolean`	`getPersistedBoolean(defaultReturnValue: Boolean)` Attempts to get a persisted `Boolean` if this preference is persistent.
`Float`	`getPersistedFloat(defaultReturnValue: Float)` Attempts to get a persisted `Float` if this preference is persistent.
`Int`	`getPersistedInt(defaultReturnValue: Int)` Attempts to get a persisted `Integer` if this preference is persistent.
`Long`	`getPersistedLong(defaultReturnValue: Long)` Attempts to get a persisted `Long` if this preference is persistent.
`String!`	`getPersistedString(defaultReturnValue: String!)` Attempts to get a persisted set of Strings if this preference is persistent.
`Unit`	`notifyChanged()` Should be called when the data of this `Preference` has changed.
`Unit`	`notifyHierarchyChanged()` Should be called when a preference has been added/removed from this group, or the ordering should be re-evaluated.
`Unit`	`onAttachedToHierarchy(preferenceManager: PreferenceManager)` Called when this preference has been attached to a preference hierarchy.
`Unit`	`onClick()` Processes a click on the preference.
`Any?`	`onGetDefaultValue(a: TypedArray, index: Int)` Called when a preference is being inflated and the default value attribute needs to be read.
`Unit`	`onPrepareForRemoval()` Called when this preference is being removed from the hierarchy.
`Unit`	`onRestoreInstanceState(state: Parcelable?)` Hook allowing a preference to re-apply a representation of its internal state that had previously been generated by `onSaveInstanceState`.
`Parcelable?`	`onSaveInstanceState()` Hook allowing a preference to generate a representation of its internal state that can later be used to create a new instance with that same state.
`Unit`	`onSetInitialValue(defaultValue: Any?)` Implement this to set the initial value of the preference.
`Unit`	`onSetInitialValue(restorePersistedValue: Boolean, defaultValue: Any!)` This function is deprecated. Use `onSetInitialValue` instead.
`Boolean`	`persistBoolean(value: Boolean)` Attempts to persist a `Boolean` if this preference is persistent.
`Boolean`	`persistFloat(value: Float)` Attempts to persist a `Float` if this preference is persistent.
`Boolean`	`persistInt(value: Int)` Attempts to persist an `Integer` if this preference is persistent.
`Boolean`	`persistLong(value: Long)` Attempts to persist a `Long` if this preference is persistent.
`Boolean`	`persistString(value: String!)` Attempts to persist a `String` if this preference is persistent.
`Boolean`	`shouldPersist()` Checks whether, at the given time this method is called, this preference should store/restore its value(s) into the `SharedPreferences` or into `PreferenceDataStore` if assigned.

Constants

DEFAULT_ORDER

Added in 1.0.0

const val DEFAULT_ORDER = 2147483647: Int

Specify for setOrder if a specific order is not required.

Public constructors

Preference

Added in 1.0.0

Preference(context: Context)

Constructor to create a preference.

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

Preference

Added in 1.0.0

Preference(context: Context, attrs: AttributeSet?)

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

Parameters
`context: Context`	The Context this is associated with, through which it can access the current theme, resources, `SharedPreferences`, etc.
`attrs: AttributeSet?`	The attributes of the XML tag that is inflating the preference

See also
`Preference`

Preference

Added in 1.0.0

Preference(context: Context, attrs: AttributeSet?, defStyleAttr: Int)

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 CheckBoxPreference constructor calls this version of the super class constructor and supplies android.R.attr.checkBoxPreferenceStyle for defStyleAttr. This allows the theme's checkbox preference style to modify all of the base preference attributes as well as the CheckBoxPreference class's attributes.

Parameters
`context: Context`	The Context this is associated with, through which it can access the current theme, resources, `SharedPreferences`, etc.
`attrs: AttributeSet?`	The attributes of the XML tag that is inflating the preference
`defStyleAttr: Int`	An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults.

See also
`Preference`

Preference

Added in 1.0.0

Preference(
    context: Context,
    attrs: AttributeSet?,
    defStyleAttr: Int,
    defStyleRes: Int
)

Parameters
`context: Context`	The `Context` this is associated with, through which it can access the current theme, resources, `SharedPreferences`, etc.
`attrs: AttributeSet?`	The attributes of the XML tag that is inflating the preference
`defStyleAttr: Int`	An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults.
`defStyleRes: Int`	A resource identifier of a style resource that supplies default values for the view, used only if defStyleAttr is 0 or can not be found in the theme. Can be 0 to not look for defaults.

See also
`Preference`

Public functions

callChangeListener

Added in 1.0.0

fun callChangeListener(newValue: Any!): Boolean

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

Parameters
`newValue: Any!`	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

fun compareTo(another: Preference): Int

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

Parameters
`another: Preference`	The preference to compare to this one

Returns
`Int`	0 if the same; less than 0 if this preference sorts ahead of `another`; greater than 0 if this preference sorts after `another`.

getContext

Added in 1.0.0

fun getContext(): Context

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

Returns
`Context`	The Context of this preference

getDependency

Added in 1.0.0

fun getDependency(): String?

Returns the key of the dependency on this preference.

Returns
`String?`	The key of the dependency

See also
`setDependency`

getExtras

Added in 1.0.0

fun getExtras(): Bundle

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

fun getFragment(): String?

Return the fragment class name associated with this preference.

Returns
`String?`	The fragment class name last set via `setFragment` or XML

getIcon

Added in 1.0.0

fun getIcon(): Drawable?

Returns the icon of this preference.

Returns
`Drawable?`	The icon

See also
`setIcon`

getIntent

Added in 1.0.0

fun getIntent(): Intent?

Return the Intent associated with this preference.

Returns
`Intent?`	The `Intent` last set via `setIntent` or XML

getKey

Added in 1.0.0

fun getKey(): String!

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

Returns
`String!`	The key

getLayoutResource

Added in 1.0.0

fun getLayoutResource(): Int

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

Returns
`Int`	The layout resource ID

getOnPreferenceChangeListener

Added in 1.0.0

fun getOnPreferenceChangeListener(): Preference.OnPreferenceChangeListener?

Returns the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).

Returns
`Preference.OnPreferenceChangeListener?`	The callback to be invoked

getOnPreferenceClickListener

Added in 1.0.0

fun getOnPreferenceClickListener(): Preference.OnPreferenceClickListener?

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

Returns
`Preference.OnPreferenceClickListener?`	The callback to be invoked

getOrder

Added in 1.0.0

fun getOrder(): Int

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
`setOrder`

getParent

Added in 1.0.0

fun getParent(): PreferenceGroup?

Returns the PreferenceGroup which is this preference assigned to or null if this preference is not assigned to any group or is a root preference.

Returns
`PreferenceGroup?`	The parent PreferenceGroup or `null` if not attached to any

getPersistedStringSet

Added in 1.0.0

fun getPersistedStringSet(defaultReturnValue: (Mutable)Set<String!>!): (Mutable)Set<String!>!

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

Parameters
`defaultReturnValue: (Mutable)Set<String!>!`	The default value to return if either this preference is not persistent or this preference is not present.

Returns
`(Mutable)Set<String!>!`	The value from the storage or the default return value

See also
`persistStringSet`

getPreferenceDataStore

Added in 1.0.0

fun getPreferenceDataStore(): PreferenceDataStore?

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

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

Returns
`PreferenceDataStore?`	The `PreferenceDataStore` used by this preference or `null` if none

getPreferenceManager

Added in 1.0.0

fun getPreferenceManager(): PreferenceManager!

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

Returns
`PreferenceManager!`	The `PreferenceManager`

getSharedPreferences

Added in 1.0.0

fun getSharedPreferences(): SharedPreferences?

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

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

See also
`setPreferenceDataStore`

getShouldDisableView

Added in 1.0.0

fun getShouldDisableView(): Boolean

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
`setShouldDisableView`

getSummary

Added in 1.0.0

fun getSummary(): CharSequence?

Returns the summary of this preference. If a SummaryProvider has been set for this preference, it will be used to provide the summary returned by this method.

Returns
`CharSequence?`	The summary

See also
`setSummary`
`setSummaryProvider`

getSummaryProvider

Added in 1.1.0

fun getSummaryProvider(): Preference.SummaryProvider?

Returns the SummaryProvider used to configure the summary of this preference.

Returns
`Preference.SummaryProvider?`	The `SummaryProvider` used to configure the summary of this preference, or `null` if there is no SummaryProvider set

See also
`Preference.SummaryProvider`

getTitle

Added in 1.0.0

fun getTitle(): CharSequence?

Returns the title of this preference.

Returns
`CharSequence?`	The title

See also
`setTitle`

getWidgetLayoutResource

Added in 1.0.0

fun getWidgetLayoutResource(): Int

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

Returns
`Int`	The layout resource ID

hasKey

Added in 1.0.0

fun hasKey(): Boolean

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

fun isCopyingEnabled(): Boolean

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

fun isEnabled(): Boolean

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

fun isIconSpaceReserved(): Boolean

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

Returns
`Boolean`	`true` if the space of this preference icon view is reserved `iconSpaceReserved`

See also
`setIconSpaceReserved`

isPersistent

Added in 1.0.0

fun isPersistent(): Boolean

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

Returns
`Boolean`	`true` if persistent

isSelectable

Added in 1.0.0

fun isSelectable(): Boolean

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

fun isShown(): Boolean

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

Returns
`Boolean`	`true` if this preference is shown to the user in the hierarchy

isSingleLineTitle

Added in 1.0.0

fun isSingleLineTitle(): Boolean

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 `singleLineTitle`

See also
`setSingleLineTitle`

isVisible

Added in 1.0.0

fun isVisible(): Boolean

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
`setVisible`
`isShown`

notifyDependencyChange

Added in 1.0.0

fun notifyDependencyChange(disableDependents: Boolean): Unit

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

Parameters
`disableDependents: Boolean`	Whether this preference should disable its dependents.

onAttached

Added in 1.0.0

fun onAttached(): Unit

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

fun onBindViewHolder(holder: PreferenceViewHolder): Unit

Binds the created View to the data for this preference.

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

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

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

onDependencyChanged

Added in 1.0.0

fun onDependencyChanged(dependency: Preference, disableDependent: Boolean): Unit

Called when the dependency changes.

Parameters
`dependency: Preference`	The preference that this preference depends on
`disableDependent: Boolean`	Set true to disable this preference

onDetached

Added in 1.0.0

fun onDetached(): Unit

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

Deprecated in 1.1.0

@CallSuper
fun onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfoCompat!): Unit

Initializes an android.view.accessibility.AccessibilityNodeInfo with information about the View for this preference.

onParentChanged

Added in 1.0.0

fun onParentChanged(parent: Preference, disableChild: Boolean): Unit

Called when the implicit parent dependency changes.

Parameters
`parent: Preference`	The preference that this preference depends on
`disableChild: Boolean`	Set true to disable this preference

peekExtras

Added in 1.0.0

fun peekExtras(): Bundle?

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

persistStringSet

Added in 1.0.0

fun persistStringSet(values: (Mutable)Set<String!>!): Boolean

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

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

Parameters
`values: (Mutable)Set<String!>!`	The values to persist

Returns
`Boolean`	`true` if the preference is persistent, `false` otherwise

See also
`getPersistedStringSet`

restoreHierarchyState

Added in 1.0.0

fun restoreHierarchyState(container: Bundle): Unit

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

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

See also
`saveHierarchyState`
`onRestoreInstanceState`

saveHierarchyState

Added in 1.0.0

fun saveHierarchyState(container: Bundle): Unit

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

Parameters
`container: Bundle`	The Bundle in which to save the instance of this preference

See also
`restoreHierarchyState`
`onSaveInstanceState`

setCopyingEnabled

Added in 1.1.0

fun setCopyingEnabled(enabled: Boolean): Unit

Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference.

Parameters
`enabled: Boolean`	Set true to enable copying the summary of this preference

setDefaultValue

Added in 1.0.0

fun setDefaultValue(defaultValue: Any!): Unit

Sets the default value for this preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.

Parameters
`defaultValue: Any!`	The default value

setDependency

Added in 1.0.0

fun setDependency(dependencyKey: String?): Unit

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

Parameters
`dependencyKey: String?`	The key of the preference that this depends on

setEnabled

Added in 1.0.0

fun setEnabled(enabled: Boolean): Unit

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

Parameters
`enabled: Boolean`	Set true to enable it

setFragment

Added in 1.0.0

fun setFragment(fragment: String?): Unit

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

Parameters
`fragment: String?`	The class name of the fragment associated with this preference

setIcon

Added in 1.0.0

fun setIcon(icon: Drawable?): Unit

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

Parameters
`icon: Drawable?`	The optional icon for this preference

setIcon

Added in 1.0.0

fun setIcon(iconResId: Int): Unit

Sets the icon for this preference with a resource ID.

Parameters
`iconResId: Int`	The icon as a resource ID

See also
`setIcon`

setIconSpaceReserved

Added in 1.0.0

fun setIconSpaceReserved(iconSpaceReserved: Boolean): Unit

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
`iconSpaceReserved: Boolean`	Set `true` if the space for the icon view should be reserved `iconSpaceReserved`

setIntent

Added in 1.0.0

fun setIntent(intent: Intent?): Unit

Sets an Intent to be used for startActivity when this preference is clicked.

Parameters
`intent: Intent?`	The intent associated with this preference

setKey

Added in 1.0.0

fun setKey(key: String!): Unit

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

Parameters
`key: String!`	The key for the preference

setLayoutResource

Added in 1.0.0

fun setLayoutResource(layoutResId: Int): Unit

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

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

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

Parameters
`layoutResId: Int`	The layout resource ID to be inflated and returned as a `View`

See also
`setWidgetLayoutResource`

setOnPreferenceChangeListener

Added in 1.0.0

fun setOnPreferenceChangeListener(
    onPreferenceChangeListener: Preference.OnPreferenceChangeListener?
): Unit

Sets the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).

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

setOnPreferenceClickListener

Added in 1.0.0

fun setOnPreferenceClickListener(
    onPreferenceClickListener: Preference.OnPreferenceClickListener?
): Unit

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

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

setOrder

Added in 1.0.0

fun setOrder(order: Int): Unit

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

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

See also
`setOrderingAsAdded`
`DEFAULT_ORDER`

setPersistent

Added in 1.0.0

fun setPersistent(persistent: Boolean): Unit

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

Parameters
`persistent: Boolean`	Set `true` if it should store its value(s) into the storage

setPreferenceDataStore

Added in 1.0.0

fun setPreferenceDataStore(dataStore: PreferenceDataStore?): Unit

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

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

Parameters
`dataStore: PreferenceDataStore?`	The `PreferenceDataStore` to be used by this preference

See also
`setPreferenceDataStore`

setSelectable

Added in 1.0.0

fun setSelectable(selectable: Boolean): Unit

Sets whether this preference is selectable.

Parameters
`selectable: Boolean`	Set true to make it selectable

setShouldDisableView

Added in 1.0.0

fun setShouldDisableView(shouldDisableView: Boolean): Unit

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

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

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

setSingleLineTitle

Added in 1.0.0

fun setSingleLineTitle(singleLineTitle: Boolean): Unit

Sets whether to constrain the title of this preference to a single line instead of letting it wrap onto multiple lines.

Parameters
`singleLineTitle: Boolean`	Set `true` if the title should be constrained to one line `singleLineTitle`

setSummary

Added in 1.0.0

fun setSummary(summary: CharSequence?): Unit

Sets the summary for this preference with a CharSequence.

You can also use a SummaryProvider to dynamically configure the summary of this preference.

Parameters
`summary: CharSequence?`	The summary for the preference

Throws
`java.lang.IllegalStateException`	If a `SummaryProvider` has already been set.

See also
`setSummaryProvider`

setSummary

Added in 1.0.0

fun setSummary(summaryResId: Int): Unit

Sets the summary for this preference with a resource ID.

You can also use a SummaryProvider to dynamically configure the summary of this preference.

Parameters
`summaryResId: Int`	The summary as a resource

See also
`setSummary`
`setSummaryProvider`

setSummaryProvider

Added in 1.1.0

fun setSummaryProvider(summaryProvider: Preference.SummaryProvider?): Unit

Set a SummaryProvider that will be invoked whenever the summary of this preference is requested. Set null to remove the existing SummaryProvider.

Parameters
`summaryProvider: Preference.SummaryProvider?`	The `SummaryProvider` that will be invoked whenever the summary of this preference is requested

See also
`Preference.SummaryProvider`

setTitle

Added in 1.0.0

fun setTitle(title: CharSequence?): Unit

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

Parameters
`title: CharSequence?`	The title for this preference

setTitle

Added in 1.0.0

fun setTitle(titleResId: Int): Unit

Sets the title for this preference with a resource ID.

Parameters
`titleResId: Int`	The title as a resource ID

See also
`setTitle`

setViewId

Added in 1.0.0

fun setViewId(viewId: Int): Unit

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

See also
`setId`

setVisible

Added in 1.0.0

fun setVisible(visible: Boolean): Unit

Sets whether this preference should be visible to the user. If false, it is excluded from the adapter, but can still be retrieved using findPreference.

To show this preference to the user, its ancestors must also all be visible. If you make a PreferenceGroup invisible, none of its children will be shown to the user until the group is visible.

Parameters
`visible: Boolean`	Set false if this preference should be hidden from the user `isPreferenceVisible`

See also
`isShown`

setWidgetLayoutResource

Added in 1.0.0

fun setWidgetLayoutResource(widgetLayoutResId: Int): Unit

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

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

Parameters
`widgetLayoutResId: Int`	The layout resource ID to be inflated into the main layout

See also
`setLayoutResource`

shouldDisableDependents

Added in 1.0.0

fun shouldDisableDependents(): Boolean

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

Returns
`Boolean`	`true` if the dependents should be disabled, otherwise false

toString

fun toString(): String

Protected functions

findPreferenceInHierarchy

Added in 1.1.0

protected fun <T : Preference?> findPreferenceInHierarchy(key: String): T?

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
`key: String`	The key of the preference to retrieve

Returns
`T?`	The preference with the key, or `null`

See also
`findPreference`

getPersistedBoolean

Added in 1.0.0

protected fun getPersistedBoolean(defaultReturnValue: Boolean): Boolean

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

Parameters
`defaultReturnValue: Boolean`	The default value to return if either this preference is not persistent or this preference is not in the SharedPreferences.

Returns
`Boolean`	The value from the storage or the default return value

See also
`getPersistedString`
`persistBoolean`

getPersistedFloat

Added in 1.0.0

protected fun getPersistedFloat(defaultReturnValue: Float): Float

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

Parameters
`defaultReturnValue: Float`	The default value to return if either this preference is not persistent or this preference is not saved.

Returns
`Float`	The value from the storage or the default return value

See also
`getPersistedString`
`persistFloat`

getPersistedInt

Added in 1.0.0

protected fun getPersistedInt(defaultReturnValue: Int): Int

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

Parameters
`defaultReturnValue: Int`	The default value to return if either this preference is not persistent or this preference is not in the SharedPreferences.

Returns
`Int`	The value from the storage or the default return value

See also
`getPersistedString`
`persistInt`

getPersistedLong

Added in 1.0.0

protected fun getPersistedLong(defaultReturnValue: Long): Long

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

Parameters
`defaultReturnValue: Long`	The default value to return if either this preference is not persistent or this preference is not in the SharedPreferences.

Returns
`Long`	The value from the storage or the default return value

See also
`getPersistedString`
`persistLong`

getPersistedString

Added in 1.0.0

protected fun getPersistedString(defaultReturnValue: String!): String!

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

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

Returns
`String!`	The value from the storage or the default return value

See also
`persistString`

notifyChanged

Added in 1.0.0

protected fun notifyChanged(): Unit

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

notifyHierarchyChanged

Added in 1.0.0

protected fun notifyHierarchyChanged(): Unit

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

protected fun onAttachedToHierarchy(preferenceManager: PreferenceManager): Unit

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

Parameters
`preferenceManager: PreferenceManager`	The PreferenceManager of the hierarchy

onClick

Added in 1.0.0

protected fun onClick(): Unit

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

onGetDefaultValue

Added in 1.0.0

protected fun onGetDefaultValue(a: TypedArray, index: Int): Any?

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

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

Parameters
`a: TypedArray`	The set of attributes
`index: Int`	The index of the default value attribute

Returns
`Any?`	The default value of this preference type

onPrepareForRemoval

Added in 1.0.0

protected fun onPrepareForRemoval(): Unit

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

protected fun onRestoreInstanceState(state: Parcelable?): Unit

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

Parameters
`state: Parcelable?`	The saved state that had previously been returned by `onSaveInstanceState`.

See also
`onSaveInstanceState`
`restoreHierarchyState`

onSaveInstanceState

Added in 1.0.0

protected fun onSaveInstanceState(): Parcelable?

Hook allowing a preference to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can be reconstructed later.

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

See also
`onRestoreInstanceState`
`saveHierarchyState`

onSetInitialValue

Added in 1.0.0

protected fun onSetInitialValue(defaultValue: Any?): Unit

Implement this to set the initial value of the preference.

If you are persisting values to SharedPreferences or a 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
`defaultValue: Any?`	The default value for the preference if set, otherwise `null`.

onSetInitialValue

Added in 1.0.0

Deprecated in 1.0.0

protected fun onSetInitialValue(restorePersistedValue: Boolean, defaultValue: Any!): Unit

Implement this to set the initial value of the preference.

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

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

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

Parameters
`restorePersistedValue: Boolean`	True to restore the persisted value; false to use the given `defaultValue`.
`defaultValue: Any!`	The default value for this preference. Only use this if `restorePersistedValue` is false.

persistBoolean

Added in 1.0.0

protected fun persistBoolean(value: Boolean): Boolean

Attempts to persist a Boolean if this preference is persistent.

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

Parameters
`value: Boolean`	The value to persist

Returns
`Boolean`	`true` if the preference is persistent, `false` otherwise

See also
`persistString`
`getPersistedBoolean`

persistFloat

Added in 1.0.0

protected fun persistFloat(value: Float): Boolean

Attempts to persist a Float if this preference is persistent.

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

Parameters
`value: Float`	The value to persist

Returns
`Boolean`	`true` if the preference is persistent, `false` otherwise

See also
`persistString`
`getPersistedFloat`

persistInt

Added in 1.0.0

protected fun persistInt(value: Int): Boolean

Attempts to persist an Integer if this preference is persistent.

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

Parameters
`value: Int`	The value to persist

Returns
`Boolean`	`true` if the preference is persistent, `false` otherwise

See also
`persistString`
`getPersistedInt`

persistLong

Added in 1.0.0

protected fun persistLong(value: Long): Boolean

Attempts to persist a Long if this preference is persistent.

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

Parameters
`value: Long`	The value to persist

Returns
`Boolean`	`true` if the preference is persistent, `false` otherwise

See also
`persistString`
`getPersistedLong`

persistString

Added in 1.0.0

protected fun persistString(value: String!): Boolean

Attempts to persist a String if this preference is persistent.

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

Parameters
`value: String!`	The value to persist

Returns
`Boolean`	`true` if the preference is persistent, `false` otherwise

See also
`getPersistedString`

shouldPersist

Added in 1.0.0

protected fun shouldPersist(): Boolean

Checks whether, at the given time this method is called, this preference should store/restore its value(s) into the SharedPreferences or into PreferenceDataStore if assigned. This, at minimum, checks whether this preference is persistent and it currently has a key. Before you save/restore from the storage, check this first.

Returns
`Boolean`	`true` if it should persist the value

Preference

Summary

Nested types

Constants

Public constructors

Public functions

Protected functions

Constants

DEFAULT_ORDER

Public constructors

Preference

Preference

Preference

Preference

Public functions

callChangeListener

compareTo

getContext

getDependency

getExtras

getFragment

getIcon

getIntent

getKey

getLayoutResource

getOnPreferenceChangeListener

getOnPreferenceClickListener

getOrder

getParent

getPersistedStringSet

getPreferenceDataStore

getPreferenceManager

getSharedPreferences

getShouldDisableView

getSummary

getSummaryProvider

getTitle

getWidgetLayoutResource

hasKey

isCopyingEnabled

isEnabled

isIconSpaceReserved

isPersistent

isSelectable

isShown

isSingleLineTitle

isVisible

notifyDependencyChange

onAttached

onBindViewHolder

onDependencyChanged

onDetached

onInitializeAccessibilityNodeInfo

onParentChanged

peekExtras

persistStringSet

restoreHierarchyState

saveHierarchyState

setCopyingEnabled

setDefaultValue

setDependency

setEnabled

setFragment

setIcon

setIcon

setIconSpaceReserved

setIntent

setKey

setLayoutResource

setOnPreferenceChangeListener

setOnPreferenceClickListener

setOrder

setPersistent

setPreferenceDataStore

setSelectable

setShouldDisableView

setSingleLineTitle

setSummary

setSummary

setSummaryProvider