added in version 24.1.0
belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1

ListPreference

public class ListPreference
extends DialogPreference

java.lang.Object
↳	android.support.v7.preference.Preference
	↳	android.support.v7.preference.DialogPreference
		↳	android.support.v7.preference.ListPreference

Known Direct Subclasses

DropDownPreference

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

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

Summary

Inherited XML attributes

From class


  android.support.v7.preference.Preference

Inherited constants

From class


    android.support.v7.preference.Preference

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 ListPreference.
`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(boolean restoreValue, Object defaultValue)` Implement this to set the initial value of the Preference.

Inherited methods

From class


  
    android.support.v7.preference.DialogPreference

From class


  
    android.support.v7.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.
`Preference`	`findPreferenceInHierarchy(String key)` Finds a Preference in this hierarchy (the whole thing, even above/below your `PreferenceScreen` screen break) 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.

ListPreference

Summary

Inherited XML attributes

Inherited constants

Public constructors

Public methods

Protected methods

Inherited methods