belongs to Maven artifact androidx.preference:preference:1.0.0-alpha1

ListPreference

public class ListPreference
extends DialogPreference

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


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

Inherited constants

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

Public constructors

ListPreference

ListPreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

defStyleRes int

ListPreference

ListPreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

ListPreference

ListPreference (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

ListPreference

ListPreference (Context context)

Parameters
context Context

Public methods

findIndexOfValue

int findIndexOfValue (String value)

Returns the index of the given value (in the entry values array).

Parameters
value String: The value whose index should be returned.

Returns
int The index of the value, or -1 if not found.

getEntries

CharSequence[] getEntries ()

The list of entries to be shown in the list in subsequent dialogs.

Returns
CharSequence[] The list as an array.

getEntry

CharSequence getEntry ()

Returns the entry corresponding to the current value.

Returns
CharSequence The entry corresponding to the current value, or null.

getEntryValues

CharSequence[] getEntryValues ()

Returns the array of values to be saved for the preference.

Returns
CharSequence[] The array of values.

getSummary

CharSequence getSummary ()

Returns the summary of this ListPreference. If the summary has a String formatting marker in it (i.e. "%s" or "%1$s"), then the current entry value will be substituted in its place.

Returns
CharSequence the summary with appropriate string substitution

getValue

String getValue ()

Returns the value of the key. This should be one of the entries in getEntryValues().

Returns
String The value of the key.

setEntries

void setEntries (CharSequence[] entries)

Sets the human-readable entries to be shown in the list. This will be shown in subsequent dialogs.

Each entry must have a corresponding index in setEntryValues(CharSequence[]).

Parameters
entries CharSequence: The entries.

setEntries

void setEntries (int entriesResId)

Parameters
entriesResId int: The entries array as a resource.

setEntryValues

void setEntryValues (int entryValuesResId)

Parameters
entryValuesResId int: The entry values array as a resource.

setEntryValues

void setEntryValues (CharSequence[] entryValues)

The array to find the value to save for a preference when an entry from entries is selected. If a user clicks on the second item in entries, the second item in this array will be saved to the preference.

Parameters
entryValues CharSequence: The array to be used as values to save for the preference.

setSummary

void setSummary (CharSequence summary)

Sets the summary for this Preference with a CharSequence. If the summary has a String formatting marker in it (i.e. "%s" or "%1$s"), then the current entry value will be substituted in its place when it's retrieved.

Parameters
summary CharSequence: The summary for the preference.

setValue

void setValue (String value)

Sets the value of the key. This should be one of the entries in getEntryValues().

Parameters
value String: The value to set for the key.

setValueIndex

void setValueIndex (int index)

Sets the value to the given index from the entry values.

Parameters
index int: The index of the value to set.

Protected methods

onGetDefaultValue

Object onGetDefaultValue (TypedArray a, 
                int index)

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.

Returns
Object The default value of this preference type.

onRestoreInstanceState

void onRestoreInstanceState (Parcelable state)

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

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. This state should only contain information that is not persistent or can be reconstructed later.

Returns
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

void onSetInitialValue (boolean restoreValue, 
                Object defaultValue)

Implement this to set the initial value of the Preference.

If restorePersistedValue is true, you should restore the Preference value from the 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
restoreValue boolean: True to restore the persisted value; false to use the given defaultValue.

defaultValue Object: The default value for this Preference. Only use this if restorePersistedValue is false.