ListPreference

Kotlin |Java

public class ListPreference
extends DialogPreference

java.lang.Object
↳	androidx.preference.Preference
	↳	androidx.preference.DialogPreference
		↳	androidx.preference.ListPreference

Known direct subclasses

DropDownPreference

DropDownPreference A ListPreference that presents the options in a drop down menu rather than a dialog.

A Preference that displays a list of entries as a dialog.

This preference saves a string value. This string will be the value from the setEntryValues(CharSequence[]) array.

Summary

Nested classes
`class`	`ListPreference.SimpleSummaryProvider` A simple `Preference.SummaryProvider` implementation for a `ListPreference`.

Inherited constants

From class androidx.preference.Preference

int

DEFAULT_ORDER

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

Public constructors
`ListPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)`
`ListPreference(Context context, AttributeSet attrs, int defStyleAttr)`
`ListPreference(Context context, AttributeSet attrs)`
`ListPreference(Context context)`

Public methods
`int`	`findIndexOfValue(String value)` Returns the index of the given value (in the entry values array).
`CharSequence[]`	`getEntries()` The list of entries to be shown in the list in subsequent dialogs.
`CharSequence`	`getEntry()` Returns the entry corresponding to the current value.
`CharSequence[]`	`getEntryValues()` Returns the array of values to be saved for the preference.
`CharSequence`	`getSummary()` Returns the summary of this preference.
`String`	`getValue()` Returns the value of the key.
`void`	`setEntries(CharSequence[] entries)` Sets the human-readable entries to be shown in the list.
`void`	`setEntries(int entriesResId)`
`void`	`setEntryValues(int entryValuesResId)`
`void`	`setEntryValues(CharSequence[] entryValues)` The array to find the value to save for a preference when an entry from entries is selected.
`void`	`setSummary(CharSequence summary)` Sets the summary for this preference with a CharSequence.
`void`	`setValue(String value)` Sets the value of the key.
`void`	`setValueIndex(int index)` Sets the value to the given index from the entry values.

Protected methods
`Object`	`onGetDefaultValue(TypedArray a, int index)` Called when a preference is being inflated and the default value attribute needs to be read.
`void`	`onRestoreInstanceState(Parcelable state)` 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.
`void`	`onSetInitialValue(Object defaultValue)` Implement this to set the initial value of the preference.

Inherited methods

From class


        
          androidx.preference.DialogPreference

`Drawable`	`getDialogIcon()` Returns the icon to be shown on subsequent dialogs.
`int`	`getDialogLayoutResource()` Returns the layout resource that is used as the content view for subsequent dialogs.
`CharSequence`	`getDialogMessage()` Returns the message to be shown on subsequent dialogs.
`CharSequence`	`getDialogTitle()` Returns the title to be shown on subsequent dialogs.
`CharSequence`	`getNegativeButtonText()` Returns the text of the negative button to be shown on subsequent dialogs.
`CharSequence`	`getPositiveButtonText()` Returns the text of the positive button to be shown on subsequent dialogs.
`void`	`onClick()` Processes a click on the preference.
`void`	`setDialogIcon(int dialogIconRes)` Sets the icon (resource ID) of the dialog.
`void`	`setDialogIcon(Drawable dialogIcon)` Sets the icon of the dialog.
`void`	`setDialogLayoutResource(int dialogLayoutResId)` Sets the layout resource that is inflated as the `View` to be shown as the content view of subsequent dialogs.
`void`	`setDialogMessage(CharSequence dialogMessage)` Sets the message of the dialog.
`void`	`setDialogMessage(int dialogMessageResId)`
`void`	`setDialogTitle(int dialogTitleResId)`
`void`	`setDialogTitle(CharSequence dialogTitle)` Sets the title of the dialog.
`void`	`setNegativeButtonText(CharSequence negativeButtonText)` Sets the text of the negative button of the dialog.
`void`	`setNegativeButtonText(int negativeButtonTextResId)`
`void`	`setPositiveButtonText(int positiveButtonTextResId)`
`void`	`setPositiveButtonText(CharSequence positiveButtonText)` Sets the text of the positive button of the dialog.

From class


        
          androidx.preference.Preference

`boolean`	`callChangeListener(Object newValue)` Call this method after the user changes the preference, but before the internal state is set.
`int`	`compareTo(Preference another)` Compares preference objects based on order (if set), otherwise alphabetically on the titles.
`<T extends Preference> T`	`findPreferenceInHierarchy(String key)` Finds a preference in the entire hierarchy (above or below this preference) with the given key.
`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`.
`final 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.
`boolean`	`getPersistedBoolean(boolean defaultReturnValue)` Attempts to get a persisted `Boolean` if this preference is persistent.
`float`	`getPersistedFloat(float defaultReturnValue)` Attempts to get a persisted `Float` if this preference is persistent.
`int`	`getPersistedInt(int defaultReturnValue)` Attempts to get a persisted `Integer` if this preference is persistent.
`long`	`getPersistedLong(long defaultReturnValue)` Attempts to get a persisted `Long` if this preference is persistent.
`String`	`getPersistedString(String defaultReturnValue)` Attempts to get a persisted set of Strings if this preference is persistent.
`Set<String>`	`getPersistedStringSet(Set<String> defaultReturnValue)` 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.
`final SummaryProvider`	`getSummaryProvider()` Returns the `Preference.SummaryProvider` used to configure the summary of this preference.
`CharSequence`	`getTitle()` Returns the title of this preference.
`final 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.
`final 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.
`final boolean`	`isVisible()` Checks whether this preference should be visible to the user.
`void`	`notifyChanged()` Should be called when the data of this `Preference` has changed.
`void`	`notifyDependencyChange(boolean disableDependents)` Notifies any listening dependents of a change that affects the dependency.
`void`	`notifyHierarchyChanged()` Should be called when a preference has been added/removed from this group, or the ordering should be re-evaluated.
`void`	`onAttached()` Called when the preference hierarchy has been attached to the list of preferences.
`void`	`onAttachedToHierarchy(PreferenceManager preferenceManager)` Called when this preference has been attached to a preference hierarchy.
`void`	`onBindViewHolder(PreferenceViewHolder holder)` Binds the created View to the data for this preference.
`void`	`onClick()` Processes a click on the preference.
`void`	`onDependencyChanged(Preference dependency, boolean disableDependent)` Called when the dependency changes.
`void`	`onDetached()` Called when the preference hierarchy has been detached from the list of preferences.
`Object`	`onGetDefaultValue(TypedArray a, int index)` Called when a preference is being inflated and the default value attribute needs to be read.
`void`	`onInitializeAccessibilityNodeInfo(AccessibilityNodeInfoCompat info)` This method is deprecated. Preferences aren't views. They should not need any accessibility changes, unless the view hierarchy is customized. In this situation, please add Accessibility information in `onBindViewHolder(PreferenceViewHolder)`.
`void`	`onParentChanged(Preference parent, boolean disableChild)` Called when the implicit parent dependency changes.
`void`	`onPrepareForRemoval()` Called when this preference is being removed from the hierarchy.
`void`	`onRestoreInstanceState(Parcelable state)` 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.
`void`	`onSetInitialValue(Object defaultValue)` Implement this to set the initial value of the preference.
`void`	`onSetInitialValue(boolean restorePersistedValue, Object defaultValue)` This method is deprecated. Use `onSetInitialValue(Object)` instead.
`Bundle`	`peekExtras()` Return the extras Bundle object associated with this preference, returning `null` if there is not currently one.
`boolean`	`persistBoolean(boolean value)` Attempts to persist a `Boolean` if this preference is persistent.
`boolean`	`persistFloat(float value)` Attempts to persist a `Float` if this preference is persistent.
`boolean`	`persistInt(int value)` Attempts to persist an `Integer` if this preference is persistent.
`boolean`	`persistLong(long value)` Attempts to persist a `Long` if this preference is persistent.
`boolean`	`persistString(String value)` Attempts to persist a `String` if this preference is persistent.
`boolean`	`persistStringSet(Set<String> values)` Attempts to persist a set of Strings if this preference is persistent.
`void`	`restoreHierarchyState(Bundle container)` Restore this preference hierarchy's previously saved state from the given container.
`void`	`saveHierarchyState(<a`

ListPreference

Summary

Nested classes

Inherited constants

Public constructors

Public methods

Protected methods

Inherited methods