Preference

Kotlin |Java

open class Preference : Comparable<Preference!>

kotlin.Any
↳	androidx.preference.Preference

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.
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, SwitchPreference, SwitchPreferenceCompat

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.
SwitchPreference	A `Preference` that provides a two-state toggleable option.
SwitchPreferenceCompat	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.

Summary

Nested classes
open	`BaseSavedState` A base class for managing the instance state of a `Preference`.
abstract	`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.
abstract	`OnPreferenceClickListener` Interface definition for a callback to be invoked when a `Preference` is clicked.
abstract	`SummaryProvider` 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
static Int	`DEFAULT_ORDER` Specify for `setOrder(int)` if a specific order is not required.

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

Public methods
open Boolean	`callChangeListener(newValue: Any!)` Call this method after the user changes the preference, but before the internal state is set.
open Int	`compareTo(@NonNull other: Preference)` Compares preference objects based on order (if set), otherwise alphabetically on the titles.
open Context!	`getContext()` Returns the `Context` of this preference.
open String!	`getDependency()` Returns the key of the dependency on this preference.
open Bundle!	`getExtras()` Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.
open String!	`getFragment()` Return the fragment class name associated with this preference.
open Drawable!	`getIcon()` Returns the icon of this preference.
open Intent!	`getIntent()` Return the `Intent` associated with this preference.
open 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.
open 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).
open Preference.OnPreferenceClickListener!	`getOnPreferenceClickListener()` Returns the callback to be invoked when this preference is clicked.
open Int	`getOrder()` Gets the order of this preference with respect to other preference objects on the same level.
open 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.
open MutableSet<String!>!	`getPersistedStringSet(defaultReturnValue: MutableSet<String!>!)` Attempts to get a persisted set of Strings if this preference is persistent.
open PreferenceDataStore?	`getPreferenceDataStore()` Returns `PreferenceDataStore` used by this preference.
open PreferenceManager!	`getPreferenceManager()` Gets the `PreferenceManager` that manages this preference object's tree.
open SharedPreferences!	`getSharedPreferences()` Returns the `SharedPreferences` where this preference can read its value(s).
open Boolean	`getShouldDisableView()` Checks whether this preference should disable its view when it's action is disabled.
open CharSequence!	`getSummary()` Returns the summary of this preference.
Preference.SummaryProvider<Preference!>?	`getSummaryProvider()` Returns the `SummaryProvider` used to configure the summary of this preference.
open CharSequence!	`getTitle()` Returns the title of this preference.
Int	`getWidgetLayoutResource()` Gets the layout resource for the controllable widget portion of this preference.
open Boolean	`hasKey()` Checks whether this preference has a valid key.
open Boolean	`isCopyingEnabled()` Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference.
open Boolean	`isEnabled()` Checks whether this preference should be enabled in the list.
open Boolean	`isIconSpaceReserved()` Returns whether the space of this preference icon view is reserved.
open Boolean	`isPersistent()` Checks whether this preference is persistent.
open 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.
open 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.
open Unit	`notifyDependencyChange(disableDependents: Boolean)` Notifies any listening dependents of a change that affects the dependency.
open Unit	`onAttached()` Called when the preference hierarchy has been attached to the list of preferences.
open Unit	`onBindViewHolder(holder: PreferenceViewHolder!)` Binds the created View to the data for this preference.
open Unit	`onDependencyChanged(dependency: Preference!, disableDependent: Boolean)` Called when the dependency changes.
open Unit	`onDetached()` Called when the preference hierarchy has been detached from the list of preferences.
open Unit	`onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfoCompat!)` Initializes an `android.view.accessibility.AccessibilityNodeInfo` with information about the View for this preference.
open Unit	`onParentChanged(parent: Preference!, disableChild: Boolean)` Called when the implicit parent dependency changes.
open Bundle!	`peekExtras()` Return the extras Bundle object associated with this preference, returning `null` if there is not currently one.
open