Added in API level 1
Deprecated in API level 29

Preference

open class Preference : Comparable<Preference!>
kotlin.Any
   ↳ android.preference.Preference

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

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

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

Summary

Nested classes
open

A base class for managing the instance state of a Preference.
abstract

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

Interface definition for a callback to be invoked when a Preference is clicked.
XML attributes
android:defaultValue The default value for the preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
android:dependency The key of another Preference that this Preference will depend on.
android:enabled Whether the Preference is enabled.
android:fragment When used inside of a modern PreferenceActivity, this declares a new PreferenceFragment to be shown when the user selects this item.
android:icon The optional icon for the preference.
android:iconSpaceReserved Whether the space for the preference icon view will be reserved.
android:key The key to store the Preference value.
android:layout The layout for the Preference in a PreferenceActivity screen.
android:order The order for the Preference (lower values are to be ordered first).
android:persistent Whether the Preference stores its value to the storage.
android:recycleEnabled Whether the preference has enabled to have its view recycled when used in the list view.
android:selectable Whether the Preference is selectable.
android:shouldDisableView Whether the view of this Preference should be disabled when this Preference is disabled.
android:singleLineTitle Whether to use single line for the preference title text.
android:summary The summary for the Preference.
android:title The title for the Preference.
android:widgetLayout The layout for the controllable widget portion of a Preference.
Constants
static Int

Specify for setOrder(int) if a specific order is not required.
Public constructors
Preference(context: Context!, attrs: AttributeSet!, defStyleAttr: Int, defStyleRes: Int)

Perform inflation from XML and apply a class-specific base style.
Preference(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)

Perform inflation from XML and apply a class-specific base style.
Preference(context: Context!, attrs: AttributeSet!)

Constructor that is called when inflating a Preference from XML.
Preference(context: Context!)

Constructor to create a Preference.
Public methods
open Int

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

Returns the android.content.Context of this Preference.
open String!

Returns the key of the dependency on this Preference.
open SharedPreferences.Editor!

Returns an SharedPreferences.Editor where this Preference can save its value(s).
open Bundle!

Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.
open String!

Return the fragment class name associated with this Preference.
open Drawable!

Returns the icon of this Preference.
open Intent!

Return the Intent associated with this Preference.
open String!

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

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

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

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

Gets the order of this Preference with respect to other Preference objects on the same level.
open 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.
open MutableSet<String!>!
getPersistedStringSet(defaultReturnValue: MutableSet<String!>!)

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

Returns PreferenceDataStore used by this Preference.
open PreferenceManager!

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

Returns the SharedPreferences where this Preference can read its value(s).
open Boolean

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

Returns the summary of this Preference.
open CharSequence!

Returns the title of this Preference.
open Int

Returns the title resource ID of this Preference.
open View!
getView(convertView: View!, parent: ViewGroup!)

Gets the View that will be shown in the PreferenceActivity.
open Int

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

Checks whether this Preference has a valid key.
open Boolean

Checks whether this Preference should be enabled in the list.
open Boolean

Gets whether the space this preference icon view is reserved.
open Boolean

Checks whether this Preference is persistent.
open Boolean

Checks whether this Preference has enabled to have its view recycled when used in the list view.
open Boolean

Checks whether this Preference should be selectable in the list.
open Boolean

Gets whether the title of this preference is constrained to a single line.
open Unit
notifyDependencyChange(disableDependents: Boolean)

Notifies any listening dependents of a change that affects the dependency.
open Unit
onDependencyChanged(dependency: Preference!, disableDependent: Boolean)

Called when the dependency changes.
open Unit
onParentChanged(parent: Preference!, disableChild: Boolean)

Called when the implicit parent dependency changes.
open Bundle!

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

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

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

Store this Preference hierarchy's frozen state into the given container.
open 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.
open Unit
setDependency(dependencyKey: String!)

Sets the key of a Preference that this Preference will depend on.
open Unit
setEnabled(enabled: Boolean)

Sets whether this Preference is enabled.
open Unit
setFragment(fragment: String!)

Sets the class name of a fragment to be shown when this Preference is clicked.
open Unit
setIcon(icon: Drawable!)

Sets the icon for this Preference with a Drawable.
open Unit
setIcon(iconResId: Int)

Sets the icon for this Preference with a resource ID.
open Unit
setIconSpaceReserved(iconSpaceReserved: Boolean)

Sets whether to reserve the space of this Preference icon view when no icon is provided.
open Unit
setIntent(intent: Intent!)

Sets an Intent to be used for Context#startActivity(Intent) when this Preference is clicked.
open Unit
setKey(key: String!)

Sets the key for this Preference, which is used as a key to the SharedPreferences or PreferenceDataStore.
open Unit
setLayoutResource(layoutResId: Int)

Sets the layout resource that is inflated as the View to be shown for this Preference.
open Unit

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

Sets the callback to be invoked when this Preference is clicked.
open Unit
setOrder(order: Int)

Sets the order of this Preference with respect to other Preference objects on the same level.
open Unit
setPersistent(persistent: Boolean)

Sets whether this Preference is persistent.
open Unit

Sets a PreferenceDataStore to be used by this Preference instead of using android.content.SharedPreferences.
open Unit

Sets whether this Preference has enabled to have its view recycled when used in the list view.
open Unit
setSelectable(selectable: Boolean)

Sets whether this Preference is selectable.
open Unit
setShouldDisableView(shouldDisableView: Boolean)

Sets whether this Preference should disable its view when it gets disabled.
open 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.
open Unit

Sets the summary for this Preference with a CharSequence.
open Unit
setSummary(summaryResId: Int)

Sets the summary for this Preference with a resource ID.
open Unit

Sets the title for this Preference with a CharSequence.
open Unit
setTitle(titleResId: Int)

Sets the title for this Preference with a resource ID.
open Unit
setWidgetLayoutResource(widgetLayoutResId: Int)

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

Returns whether the Preference should commit its saved value(s) in getEditor().
open Boolean

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

Protected methods
open Boolean
callChangeListener(newValue: Any!)

Call this method after the user changes the preference, but before the internal state is set.
open Preference!

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

Attempts to get a persisted boolean if this Preference is persistent.
open Float
getPersistedFloat(defaultReturnValue: Float)

Attempts to get a persisted float if this Preference is persistent.
open Int
getPersistedInt(defaultReturnValue: Int)

Attempts to get a persisted int if this Preference is persistent.
open Long
getPersistedLong(defaultReturnValue: Long)

Attempts to get a persisted long if this Preference is persistent.
open String!
getPersistedString(defaultReturnValue: String!)

Attempts to get a persisted String if this Preference is persistent.
open Unit

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

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

Called when the Preference hierarchy has been attached to the PreferenceActivity.
open Unit

Called when this Preference has been attached to a Preference hierarchy.
open Unit
onBindView(view: View!)

Binds the created View to the data for this Preference.
open Unit

Processes a click on the preference.
open View!

Creates the View to be shown for this Preference in the PreferenceActivity.
open Any!

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

Called when this Preference is being removed from the hierarchy.
open Unit

Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState.
open 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.
open Unit
onSetInitialValue(restorePersistedValue: Boolean, defaultValue: Any!)

Implement this to set the initial value of the Preference.
open Boolean

Attempts to persist a boolean if this Preference is persistent.
open Boolean

Attempts to persist a long if this Preference is persistent.
open Boolean
persistInt(value: Int)

Attempts to persist an int if this Preference is persistent.
open Boolean
persistLong(value: Long)

Attempts to persist a long if this Preference is persistent.
open Boolean

Attempts to persist a String if this Preference is persistent.
open 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.

XML attributes

android:defaultValue

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

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

May be an integer value, such as "100".

May be a boolean value, such as "true" or "false".

May be a floating point value, such as "1.2".

android:dependency

android:dependency
The key of another Preference that this Preference will depend on. If the other Preference is not set or is off, this Preference will be disabled.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:enabled

android:enabled
Whether the Preference is enabled.

May be a boolean value, such as "true" or "false".

android:fragment

android:fragment
When used inside of a modern PreferenceActivity, this declares a new PreferenceFragment to be shown when the user selects this item.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:icon

android:icon
The optional icon for the preference.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:iconSpaceReserved

android:iconSpaceReserved
Whether the space for the preference icon view will be reserved. By default, preference icon view visibility will be set to GONE when there is no icon provided, so the default value of this attribute is false.

May be a boolean value, such as "true" or "false".

android:key

android:key
The key to store the Preference value.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:layout

android:layout
The layout for the Preference in a PreferenceActivity screen. This should rarely need to be changed, look at widgetLayout instead.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:order

android:order
The order for the Preference (lower values are to be ordered first). If this is not specified, the default ordering will be alphabetic.

May be an integer value, such as "100".

android:persistent

android:persistent
Whether the Preference stores its value to the storage.

May be a boolean value, such as "true" or "false".

android:recycleEnabled

android:recycleEnabled
Whether the preference has enabled to have its view recycled when used in the list view. This is true by default.

May be a boolean value, such as "true" or "false".

android:selectable

android:selectable
Whether the Preference is selectable.

May be a boolean value, such as "true" or "false".

android:shouldDisableView

android:shouldDisableView
Whether the view of this Preference should be disabled when this Preference is disabled.

May be a boolean value, such as "true" or "false".

android:singleLineTitle

android:singleLineTitle
Whether to use single line for the preference title text. By default, preference title will be constrained to one line, so the default value of this attribute is true.

May be a boolean value, such as "true" or "false".

android:summary

android:summary
The summary for the Preference. In API 25 and earlier, this value is read as a plain string with styling information stripped.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:title

android:title
The title for the Preference. In API 25 and earlier, this value is read as a plain string with styling information stripped.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:widgetLayout

android:widgetLayout
The layout for the controllable widget portion of a Preference. This is inflated into the layout for a Preference and should be used more frequently than the layout attribute. For example, a checkbox preference would specify a custom layout (consisting of just the CheckBox) here.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

Constants

DEFAULT_ORDER

Added in API level 1
static val DEFAULT_ORDER: Int

Deprecated: Deprecated in Java.

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

Value: 2147483647

Public constructors

Preference

Added in API level 21
Preference(
    context: Context!, 
    attrs: AttributeSet!, 
    defStyleAttr: Int, 
    defStyleRes: Int)

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

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

Preference

Added in API level 1
Preference(
    context: Context!, 
    attrs: AttributeSet!, 
    defStyleAttr: Int)

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

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

Preference

Added in API level 1
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.

Preference

Added in API level 1
Preference(context: Context!)

Constructor to create a Preference.

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

Public methods

compareTo

Added in API level 1
open fun compareTo(other: Preference!): Int

Deprecated: Deprecated in Java.

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

Parameters
o the object to be compared.
another The Preference to compare to this one.
Return
Int 0 if the same; less than 0 if this Preference sorts ahead of another; greater than 0 if this Preference sorts after another.
Exceptions
java.lang.NullPointerException if the specified object is null
java.lang.ClassCastException if the specified object's type prevents it from being compared to this object.

getContext

Added in API level 1
open fun getContext(): Context!

Deprecated: Deprecated in Java.

Returns the android.content.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 PreferenceActivity). This Context will be used to save the Preference values.

Return
Context! The Context of this Preference.

getDependency

Added in API level 1
open fun getDependency(): String!

Deprecated: Deprecated in Java.

Returns the key of the dependency on this Preference.

Return
String! The key of the dependency.

getEditor

Added in API level 1
open fun getEditor(): SharedPreferences.Editor!

Deprecated: Deprecated in Java.

Returns an SharedPreferences.Editor where this Preference can save its value(s). Usually it's easier to use one of the helper save methods: persistBoolean(boolean), persistFloat(float), persistInt(int), persistLong(long), persistString(java.lang.String). To read values, see getSharedPreferences(). If shouldCommit() returns true, it is this Preference's responsibility to commit.

In some cases, writes to this will not be committed right away and hence not show up in the SharedPreferences, this is intended behavior to improve performance.

Return
SharedPreferences.Editor! a SharedPreferences.Editor where this preference saves its value(s). If this preference isn't attached to a Preference hierarchy or if a PreferenceDataStore has been set, this method returns null.

getExtras

Added in API level 11
Deprecated in API level 29
open fun getExtras(): Bundle!

Deprecated: Deprecated in Java.

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 API level 11
Deprecated in API level 29
open fun getFragment(): String!

Deprecated: Deprecated in Java.

Return the fragment class name associated with this Preference.

Return
String! The fragment class name last set via setFragment or XML.

getIcon

Added in API level 11
Deprecated in API level 29
open fun getIcon(): Drawable!

Deprecated: Deprecated in Java.

Returns the icon of this Preference.

Return
Drawable! the icon

getIntent

Added in API level 1
open fun getIntent(): Intent!

Deprecated: Deprecated in Java.

Return the Intent associated with this Preference.

Return
Intent! The Intent last set via setIntent(android.content.Intent) or XML.

getKey

Added in API level 1
open fun getKey(): String!

Deprecated: Deprecated in Java.

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

Return
String! The key.

getLayoutResource

Added in API level 1
open fun getLayoutResource(): Int

Deprecated: Deprecated in Java.

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

Return
Int The layout resource ID.

getOnPreferenceChangeListener

Added in API level 1
open fun getOnPreferenceChangeListener(): Preference.OnPreferenceChangeListener!

Deprecated: Deprecated in Java.

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

Return
Preference.OnPreferenceChangeListener! The callback to be invoked.

getOnPreferenceClickListener

Added in API level 1
open fun getOnPreferenceClickListener(): Preference.OnPreferenceClickListener!

Deprecated: Deprecated in Java.

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

Return
Preference.OnPreferenceClickListener! The callback to be invoked.

getOrder

Added in API level 1
open fun getOrder(): Int

Deprecated: Deprecated in Java.

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

Return
Int the order of this Preference

See Also

getParent

Added in API level 26
Deprecated in API level 29
open fun getParent(): PreferenceGroup?

Deprecated: Deprecated in Java.

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.

Return
PreferenceGroup? the parent PreferenceGroup or null if not attached to any

getPersistedStringSet

Added in API level 24
Deprecated in API level 29
open fun getPersistedStringSet(defaultReturnValue: MutableSet<String!>!): MutableSet<String!>!

Deprecated: Deprecated in Java.

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

Parameters
defaultReturnValue MutableSet<String!>!: The default value to return if either this Preference is not persistent or this Preference is not present.
Return
MutableSet<String!>! The value from the data store or the default return value.

getPreferenceDataStore

Added in API level 26
Deprecated in API level 29
open fun getPreferenceDataStore(): PreferenceDataStore?

Deprecated: Deprecated in Java.

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

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

Return
PreferenceDataStore? The PreferenceDataStore used by this Preference or null if none.

getPreferenceManager

Added in API level 1
open fun getPreferenceManager(): PreferenceManager!

Deprecated: Deprecated in Java.

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

Return
PreferenceManager! The PreferenceManager.

getSharedPreferences

Added in API level 1
open fun getSharedPreferences(): SharedPreferences!

Deprecated: Deprecated in Java.

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

In some cases, writes to the getEditor() will not be committed right away and hence not show up in the returned SharedPreferences, this is intended behavior to improve performance.

Return
SharedPreferences! the SharedPreferences where this Preference reads its value(s). If this preference isn't attached to a Preference hierarchy or if a PreferenceDataStore has been set, this method returns null.

getShouldDisableView

Added in API level 1
open fun getShouldDisableView(): Boolean

Deprecated: Deprecated in Java.

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

Return
Boolean true if it should disable the view

getSummary

Added in API level 1
open fun getSummary(): CharSequence!

Deprecated: Deprecated in Java.

Returns the summary of this Preference.

Return
CharSequence! the summary

getTitle

Added in API level 1
open fun getTitle(): CharSequence!

Deprecated: Deprecated in Java.

Returns the title of this Preference.

Return
CharSequence! the title

getTitleRes

Added in API level 14
Deprecated in API level 29
open fun getTitleRes(): Int

Deprecated: Deprecated in Java.

Returns the title resource ID of this Preference. If the title did not come from a resource, 0 is returned.

Return
Int the title resource

See Also

getView

Added in API level 1
open fun getView(
    convertView: View!, 
    parent: ViewGroup!
): View!

Deprecated: Deprecated in Java.

Gets the View that will be shown in the PreferenceActivity.

Parameters
convertView View!: The old View to reuse, if possible. Note: You should check that this View is non-null and of an appropriate type before using. If it is not possible to convert this View to display the correct data, this method can create a new View.
parent ViewGroup!: The parent that this View will eventually be attached to.
Return
View! Returns the same Preference object, for chaining multiple calls into a single statement.

getWidgetLayoutResource

Added in API level 1
open fun getWidgetLayoutResource(): Int

Deprecated: Deprecated in Java.

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

Return
Int The layout resource ID.

hasKey

Added in API level 1
open fun hasKey(): Boolean

Deprecated: Deprecated in Java.

Checks whether this Preference has a valid key.

Return
Boolean True if the key exists and is not a blank string, false otherwise.

isEnabled

Added in API level 1
open fun isEnabled(): Boolean

Deprecated: Deprecated in Java.

Checks whether this Preference should be enabled in the list.

Return
Boolean true if this Preference is enabled, false otherwise

isIconSpaceReserved

Added in API level 26
Deprecated in API level 29
open fun isIconSpaceReserved(): Boolean

Deprecated: Deprecated in Java.

Gets whether the space this preference icon view is reserved.

Return
Boolean true if the space of this preference icon view is reserved

isPersistent

Added in API level 1
open fun isPersistent(): Boolean

Deprecated: Deprecated in Java.

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.

Return
Boolean True if it is persistent.

isRecycleEnabled

Added in API level 26
Deprecated in API level 29
open fun isRecycleEnabled(): Boolean

Deprecated: Deprecated in Java.

Checks whether this Preference has enabled to have its view recycled when used in the list view.

Return
Boolean true if this preference view should be recycled

isSelectable

Added in API level 1
open fun isSelectable(): Boolean

Deprecated: Deprecated in Java.

Checks whether this Preference should be selectable in the list.

Return
Boolean true if it is selectable, false otherwise

isSingleLineTitle

Added in API level 26
Deprecated in API level 29
open fun isSingleLineTitle(): Boolean

Deprecated: Deprecated in Java.

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

Return
Boolean true if the title of this preference is constrained to a single line

notifyDependencyChange

Added in API level 1
open fun notifyDependencyChange(disableDependents: Boolean): Unit

Deprecated: Deprecated in Java.

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

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

onDependencyChanged

Added in API level 1
open fun onDependencyChanged(
    dependency: Preference!, 
    disableDependent: Boolean
): Unit

Deprecated: Deprecated in Java.

Called when the dependency changes.

Parameters
dependency Preference!: The Preference that this Preference depends on.
disableDependent Boolean: Set true to disable this Preference.

onParentChanged

Added in API level 19
Deprecated in API level 29
open fun onParentChanged(
    parent: Preference!, 
    disableChild: Boolean
): Unit

Deprecated: Deprecated in Java.

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 API level 11
Deprecated in API level 29
open fun peekExtras(): Bundle!

Deprecated: Deprecated in Java.

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

persistStringSet

Added in API level 24
Deprecated in API level 29
open fun persistStringSet(values: MutableSet<String!>!): Boolean

Deprecated: Deprecated in Java.

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

Parameters
values MutableSet<String!>!: The values to persist.
Return
Boolean True if this Preference is persistent. (This is not whether the value was persisted, since we may not necessarily commit if there will be a batch commit later.)

restoreHierarchyState

Added in API level 1
open fun restoreHierarchyState(container: Bundle!): Unit

Deprecated: Deprecated in Java.

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

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

saveHierarchyState

Added in API level 1
open fun saveHierarchyState(container: Bundle!): Unit

Deprecated: Deprecated in Java.

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.

setDefaultValue

Added in API level 1
open fun setDefaultValue(defaultValue: Any!): Unit

Deprecated: Deprecated in Java.

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 API level 1
open fun setDependency(dependencyKey: String!): Unit

Deprecated: Deprecated in Java.

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 API level 1
open fun setEnabled(enabled: Boolean): Unit

Deprecated: Deprecated in Java.

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

Parameters
enabled Boolean: set true to enable it

setFragment

Added in API level 11
Deprecated in API level 29
open fun setFragment(fragment: String!): Unit

Deprecated: Deprecated in Java.

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 API level 11
Deprecated in API level 29
open fun setIcon(icon: Drawable!): Unit

Deprecated: Deprecated in Java.

Sets the icon for this Preference with a Drawable. This icon will be placed into the ID android.R.id#icon within the View created by onCreateView(android.view.ViewGroup).

Parameters
icon Drawable!: the optional icon for this Preference

setIcon

Added in API level 11
Deprecated in API level 29
open fun setIcon(iconResId: Int): Unit

Deprecated: Deprecated in Java.

Sets the icon for this Preference with a resource ID.

Parameters
iconResId Int: the icon as a resource ID

setIconSpaceReserved

Added in API level 26
Deprecated in API level 29
open fun setIconSpaceReserved(iconSpaceReserved: Boolean): Unit

Deprecated: Deprecated in Java.

Sets whether to reserve the space of this Preference icon view when no icon is provided.

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

setIntent

Added in API level 1
open fun setIntent(intent: Intent!): Unit

Deprecated: Deprecated in Java.

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

Parameters
intent Intent!: The intent associated with this Preference.

setKey

Added in API level 1
open fun setKey(key: String!): Unit

Deprecated: Deprecated in Java.

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 API level 1
open fun setLayoutResource(layoutResId: Int): Unit

Deprecated: Deprecated in Java.

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 android.R.id#widget_frame to be the parent of the specific widget for this Preference. It should similarly contain android.R.id#title and android.R.id#summary.

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

setOnPreferenceChangeListener

Added in API level 1
open fun setOnPreferenceChangeListener(onPreferenceChangeListener: Preference.OnPreferenceChangeListener!): Unit

Deprecated: Deprecated in Java.

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 API level 1
open fun setOnPreferenceClickListener(onPreferenceClickListener: Preference.OnPreferenceClickListener!): Unit

Deprecated: Deprecated in Java.

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

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

setOrder

Added in API level 1
open fun setOrder(order: Int): Unit

Deprecated: Deprecated in Java.

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 PreferenceGroup#setOrderingAsAdded(boolean) can be used to order Preference objects based on the order they appear in the XML.

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

setPersistent

Added in API level 1
open fun setPersistent(persistent: Boolean): Unit

Deprecated: Deprecated in Java.

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 API level 26
Deprecated in API level 29
open fun setPreferenceDataStore(dataStore: PreferenceDataStore!): Unit

Deprecated: Deprecated in Java.

Sets a PreferenceDataStore to be used by this Preference instead of using android.content.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.

setRecycleEnabled

Added in API level 26
Deprecated in API level 29
open fun setRecycleEnabled(enabled: Boolean): Unit

Deprecated: Deprecated in Java.

Sets whether this Preference has enabled to have its view recycled when used in the list view. By default the recycling is enabled.

The value can be changed only before this preference is added to the preference hierarchy.

If view recycling is not allowed then each time the list view populates this preference the getView(android.view.View,android.view.ViewGroup) method receives a null convert view and needs to recreate the view. Otherwise view gets recycled and only onBindView(android.view.View) gets called.
If you override this method you must call through to the superclass implementation.

Parameters
enabled Boolean: set true if this preference view should be recycled

setSelectable

Added in API level 1
open fun setSelectable(selectable: Boolean): Unit

Deprecated: Deprecated in Java.

Sets whether this Preference is selectable.

Parameters
selectable Boolean: set true to make it selectable

setShouldDisableView

Added in API level 1
open fun setShouldDisableView(shouldDisableView: Boolean): Unit

Deprecated: Deprecated in Java.

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

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

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

setSingleLineTitle

Added in API level 26
Deprecated in API level 29
open fun setSingleLineTitle(singleLineTitle: Boolean): Unit

Deprecated: Deprecated in Java.

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

setSummary

Added in API level 1
open fun setSummary(summary: CharSequence!): Unit

Deprecated: Deprecated in Java.

Sets the summary for this Preference with a CharSequence.

Parameters
summary CharSequence!: the summary for the preference

setSummary

Added in API level 1
open fun setSummary(summaryResId: Int): Unit

Deprecated: Deprecated in Java.

Sets the summary for this Preference with a resource ID.

Parameters
summaryResId Int: the summary as a resource

setTitle

Added in API level 1
open fun setTitle(title: CharSequence!): Unit

Deprecated: Deprecated in Java.

Sets the title for this Preference with a CharSequence. This title will be placed into the ID android.R.id#title within the View created by onCreateView(android.view.ViewGroup).

Parameters
title CharSequence!: the title for this Preference

setTitle

Added in API level 1
open fun setTitle(titleResId: Int): Unit

Deprecated: Deprecated in Java.

Sets the title for this Preference with a resource ID.

Parameters
titleResId Int: the title as a resource ID

setWidgetLayoutResource

Added in API level 1
open fun setWidgetLayoutResource(widgetLayoutResId: Int): Unit

Deprecated: Deprecated in Java.

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.

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

shouldCommit

Added in API level 1
open fun shouldCommit(): Boolean

Deprecated: Deprecated in Java.

Returns whether the Preference should commit its saved value(s) in getEditor(). This may return false in situations where batch committing is being done (by the manager) to improve performance.

If this preference is using PreferenceDataStore this value is irrelevant.

Return
Boolean Whether the Preference should commit its saved value(s).

See Also

shouldDisableDependents

Added in API level 1
open fun shouldDisableDependents(): Boolean

Deprecated: Deprecated in Java.

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

Return
Boolean True if the dependents should be disabled, otherwise false.

toString

Added in API level 1
open fun toString(): String

Deprecated: Deprecated in Java.

Return
String a string representation of the object.

Protected methods

callChangeListener

Added in API level 1
protected open fun callChangeListener(newValue: Any!): Boolean

Deprecated: Deprecated in Java.

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.
Return
Boolean True if the user value should be set as the preference value (and persisted).

findPreferenceInHierarchy

Added in API level 1
protected open fun findPreferenceInHierarchy(key: String!): Preference!

Deprecated: Deprecated in Java.

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

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

Parameters
key String!: The key of the Preference to find.
Return
Preference! The Preference that uses the given key.

getPersistedBoolean

Added in API level 1
protected open fun getPersistedBoolean(defaultReturnValue: Boolean): Boolean

Deprecated: Deprecated in Java.

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 present.
Return
Boolean The value from the data store or the default return value.

getPersistedFloat

Added in API level 1
protected open fun getPersistedFloat(defaultReturnValue: Float): Float

Deprecated: Deprecated in Java.

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 present.
Return
Float The value from the data store or the default return value.

getPersistedInt

Added in API level 1
protected open fun getPersistedInt(defaultReturnValue: Int): Int

Deprecated: Deprecated in Java.

Attempts to get a persisted int 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 present.
Return
Int The value from the data store or the default return value.

getPersistedLong

Added in API level 1
protected open fun getPersistedLong(defaultReturnValue: Long): Long

Deprecated: Deprecated in Java.

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 present.
Return
Long The value from the data store or the default return value.

getPersistedString

Added in API level 1
protected open fun getPersistedString(defaultReturnValue: String!): String!

Deprecated: Deprecated in Java.

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

Parameters
defaultReturnValue String!: The default value to return if either this Preference is not persistent or this Preference is not present.
Return
String! The value from the data store or the default return value.

notifyChanged

Added in API level 1
protected open fun notifyChanged(): Unit

Deprecated: Deprecated in Java.

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

notifyHierarchyChanged

Added in API level 1
protected open fun notifyHierarchyChanged(): Unit

Deprecated: Deprecated in Java.

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

onAttachedToActivity

Added in API level 1
protected open fun onAttachedToActivity(): Unit

Deprecated: Deprecated in Java.

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

onAttachedToHierarchy

Added in API level 1
protected open fun onAttachedToHierarchy(preferenceManager: PreferenceManager!): Unit

Deprecated: Deprecated in Java.

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.

onBindView

Added in API level 1
protected open fun onBindView(view: View!): Unit

Deprecated: Deprecated in Java.

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.
If you override this method you must call through to the superclass implementation.

Parameters
view View!: The View that shows this Preference.

onClick

Added in API level 1
protected open fun onClick(): Unit

Deprecated: Deprecated in Java.

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

onCreateView

Added in API level 1
protected open fun onCreateView(parent: ViewGroup!): View!

Deprecated: Deprecated in Java.

Creates the View to be shown for this Preference in the PreferenceActivity. The default behavior is to inflate the main layout of this Preference (see setLayoutResource(int). If changing this behavior, please specify a ViewGroup with ID android.R.id#widget_frame.

Make sure to call through to the superclass's implementation.
If you override this method you must call through to the superclass implementation.

Parameters
parent ViewGroup!: The parent that this View will eventually be attached to.
Return
View! The View that displays this Preference.

onGetDefaultValue

Added in API level 1
protected open fun onGetDefaultValue(
    a: TypedArray!, 
    index: Int
): Any!

Deprecated: Deprecated in Java.

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 TypedArray#getString(int).

Parameters
a TypedArray!: The set of attributes.
index Int: The index of the default value attribute.
Return
Any! The default value of this preference type.

onPrepareForRemoval

Added in API level 1
protected open fun onPrepareForRemoval(): Unit

Deprecated: Deprecated in Java.

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.
If you override this method you must call through to the superclass implementation.

onRestoreInstanceState

Added in API level 1
protected open fun onRestoreInstanceState(state: Parcelable!): Unit

Deprecated: Deprecated in Java.

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.

onSaveInstanceState

Added in API level 1
protected open fun onSaveInstanceState(): Parcelable!

Deprecated: Deprecated in Java.

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.

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

onSetInitialValue

Added in API level 1
protected open fun onSetInitialValue(
    restorePersistedValue: Boolean, 
    defaultValue: Any!
): Unit

Deprecated: Deprecated in Java.

Implement this to set the initial value of the Preference.

If restorePersistedValue is true, you should restore the Preference value from the android.content.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 API level 1
protected open fun persistBoolean(value: Boolean): Boolean

Deprecated: Deprecated in Java.

Attempts to persist a boolean if this Preference is persistent.

Parameters
value Boolean: The value to persist.
Return
Boolean True if this Preference is persistent. (This is not whether the value was persisted, since we may not necessarily commit if there will be a batch commit later.)

persistFloat

Added in API level 1
protected open fun persistFloat(value: Float): Boolean

Deprecated: Deprecated in Java.

Attempts to persist a long if this Preference is persistent.

Parameters
value Float: The value to persist.
Return
Boolean True if this Preference is persistent. (This is not whether the value was persisted, since we may not necessarily commit if there will be a batch commit later.)

persistInt

Added in API level 1
protected open fun persistInt(value: Int): Boolean

Deprecated: Deprecated in Java.

Attempts to persist an int if this Preference is persistent.

Parameters
value Int: The value to persist.
Return
Boolean True if this Preference is persistent. (This is not whether the value was persisted, since we may not necessarily commit if there will be a batch commit later.)

persistLong

Added in API level 1
protected open fun persistLong(value: Long): Boolean

Deprecated: Deprecated in Java.

Attempts to persist a long if this Preference is persistent.

Parameters
value Long: The value to persist.
Return
Boolean True if this Preference is persistent. (This is not whether the value was persisted, since we may not necessarily commit if there will be a batch commit later.)

persistString

Added in API level 1
protected open fun persistString(value: String!): Boolean

Deprecated: Deprecated in Java.

Attempts to persist a String if this Preference is persistent.

Parameters
value String!: The value to persist.
Return
Boolean True if this Preference is persistent. (This is not whether the value was persisted, since we may not necessarily commit if there will be a batch commit later.)

shouldPersist

Added in API level 1
protected open fun shouldPersist(): Boolean

Deprecated: Deprecated in Java.

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.

Return
Boolean True if it should persist the value.