preference/androidx.preference/Preference

Preference

open class Preference : Comparable<T> (source)

(SESL variant) 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.

Inheritors

SeslRingtonePreference

SeslRingtonePreference

Constructors

Preference

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int, defStyleRes: Int)

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

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int)

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

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)

Constructor that is called when inflating a preference from XML.

constructor(@NonNull context: Context)

Constructor to create a preference.

Types

BaseSavedState

open class BaseSavedState : AbsSavedState

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

OnPreferenceChangeListener

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

OnPreferenceClickListener

interface OnPreferenceClickListener

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

SummaryProvider

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

Properties

DEFAULT_ORDER

val DEFAULT_ORDER: Int = 2147483647

Specify for setOrder if a specific order is not required.

Functions

callChangeListener

open fun callChangeListener(newValue: Any): Boolean

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

compareTo

open fun compareTo(@NonNull another: Preference): Int

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

getContext

@NonNull

open fun getContext(): Context

Returns the Context of this preference.

getDependency

@Nullable

open fun getDependency(): String

Returns the key of the dependency on this preference.

getDotContentDescription

fun getDotContentDescription(): String

getDotVisibility

fun getDotVisibility(): Boolean

getExtras

@NonNull

open fun getExtras(): Bundle

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

getFragment

@Nullable

open fun getFragment(): String

Return the fragment class name associated with this preference.

getIcon

@Nullable

open fun getIcon(): Drawable

Returns the icon of this preference.

getIntent

@Nullable

open fun getIntent(): Intent

Return the Intent associated with this preference.

getKey

open fun getKey(): String

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

getLayoutResource

fun getLayoutResource(): Int

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

getOnPreferenceChangeListener

@Nullable

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

getOnPreferenceClickListener

@Nullable

open fun getOnPreferenceClickListener(): Preference.OnPreferenceClickListener

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

getOrder

open fun getOrder(): Int

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

getParent

@Nullable

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

getPersistedStringSet

open fun getPersistedStringSet(defaultReturnValue: Set<String>): Set<String>

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

getPreferenceDataStore

@Nullable

open fun getPreferenceDataStore(): PreferenceDataStore

Returns PreferenceDataStore used by this preference.

getPreferenceManager

open fun getPreferenceManager(): PreferenceManager

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

getSharedPreferences

@Nullable

open fun getSharedPreferences(): SharedPreferences

Returns the SharedPreferences where this preference can read its value(s).

getShouldDisableView

open fun getShouldDisableView(): Boolean

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

getSummary

@Nullable

open fun getSummary(): CharSequence

Returns the summary of this preference.

getSummaryProvider

@Nullable

fun getSummaryProvider(): Preference.SummaryProvider

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

getTitle

@Nullable

open fun getTitle(): CharSequence

Returns the title of this preference.

getWidgetLayoutResource

fun getWidgetLayoutResource(): Int

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

hasKey

open fun hasKey(): Boolean

Checks whether this preference has a valid key.

isCopyingEnabled

open fun isCopyingEnabled(): Boolean

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

isEnabled

open fun isEnabled(): Boolean

Checks whether this preference should be enabled in the list.

isIconSpaceReserved

open fun isIconSpaceReserved(): Boolean

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

isPersistent

open fun isPersistent(): Boolean

Checks whether this preference is persistent.

isSelectable

open fun isSelectable(): Boolean

Checks whether this preference should be selectable in the list.

isShown

fun isShown(): Boolean

Checks whether this preference is shown to the user in the hierarchy.

isSingleLineTitle

open fun isSingleLineTitle(): Boolean

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

isVisible

fun isVisible(): Boolean

Checks whether this preference should be visible to the user.

notifyDependencyChange

open fun notifyDependencyChange(disableDependents: Boolean)

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

onAttached

open fun onAttached()

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

onBindViewHolder

open fun onBindViewHolder(@NonNull holder: PreferenceViewHolder)

Binds the created View to the data for this preference.

onDependencyChanged

open fun onDependencyChanged(@NonNull dependency: Preference, disableDependent: Boolean)

Called when the dependency changes.

onDetached

open fun onDetached()

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

onInitializeAccessibilityNodeInfo

@CallSuper

open fun ~~onInitializeAccessibilityNodeInfo~~(info: AccessibilityNodeInfoCompat)

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

onParentChanged

open fun onParentChanged(@NonNull parent: Preference, disableChild: Boolean)

Called when the implicit parent dependency changes.

peekExtras

@Nullable

open fun peekExtras(): Bundle

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

performClick

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun performClick()

Called when a click should be performed.

persistStringSet

open fun persistStringSet(values: Set<String>): Boolean

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

restoreHierarchyState

open fun restoreHierarchyState(@NonNull container: Bundle)

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

saveHierarchyState

open fun saveHierarchyState(@NonNull container: Bundle)

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

seslGetPreferenceBounds

open fun seslGetPreferenceBounds(bounds: Rect)

seslSetRoundedBg

open fun seslSetRoundedBg(where: Int)

seslSetSubheaderColor

open fun seslSetSubheaderColor(@ColorInt color: Int)

seslSetSubheaderRoundedBackground

open fun seslSetSubheaderRoundedBackground(where: Int)

seslSetSummaryColor

open fun seslSetSummaryColor(color: ColorStateList)

open fun seslSetSummaryColor(@ColorInt color: Int)

setCopyingEnabled

open fun setCopyingEnabled(enabled: Boolean)

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

setDefaultValue

open fun 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.

setDependency