Android APIs
public class

ListPreference

extends DialogPreference
java.lang.Object
   ↳ android.preference.Preference
     ↳ android.preference.DialogPreference
       ↳ android.preference.ListPreference

Class Overview

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

XML Attributes
Attribute Name Related Method Description
android:entries The human-readable array to present as a list. 
android:entryValues The array to find the value to save for a preference when an entry from entries is selected. 
[Expand]
Inherited XML Attributes
From class android.preference.DialogPreference
From class android.preference.Preference
[Expand]
Inherited Constants
From class android.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(int entriesResId)
void setEntries(CharSequence[] entries)
Sets the human-readable entries to be shown in the list.
void setEntryValues(CharSequence[] entryValues)
The array to find the value to save for a preference when an entry from entries is selected.
void setEntryValues(int entryValuesResId)
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
void onDialogClosed(boolean positiveResult)
Called when the dialog is dismissed and should be used to save data to the SharedPreferences.
Object onGetDefaultValue(TypedArray a, int index)
Called when a Preference is being inflated and the default value attribute needs to be read.
void onPrepareDialogBuilder(AlertDialog.Builder builder)
Prepares the dialog builder to be shown when the preference is clicked.
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.
[Expand]
Inherited Methods
From class android.preference.DialogPreference
From class android.preference.Preference
From class java.lang.Object
From interface android.content.DialogInterface.OnClickListener
From interface android.content.DialogInterface.OnDismissListener
From interface android.preference.PreferenceManager.OnActivityDestroyListener
From interface java.lang.Comparable

XML Attributes

android:entries

The human-readable array to present as a list. Each entry must have a corresponding index in entryValues.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol entries.

Related Methods

android: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.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol entryValues.

Related Methods

Public Constructors

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

Added in API level 21

Parameters
context Context
attrs AttributeSet
defStyleAttr int
defStyleRes int

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

Added in API level 21

Parameters
context Context
attrs AttributeSet
defStyleAttr int

public ListPreference (Context context, AttributeSet attrs)

Added in API level 1

Parameters
context Context
attrs AttributeSet

public ListPreference (Context context)

Added in API level 1

Parameters
context Context

Public Methods

public int findIndexOfValue (String value)

Added in API level 1

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.

public CharSequence[] getEntries ()

Added in API level 1

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

Returns
CharSequence[] The list as an array.

public CharSequence getEntry ()

Added in API level 1

Returns the entry corresponding to the current value.

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

public CharSequence[] getEntryValues ()

Added in API level 1

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

Returns
CharSequence[] The array of values.

public CharSequence getSummary ()

Added in API level 1

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

public String getValue ()

Added in API level 1

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

Returns
String The value of the key.

public void setEntries (int entriesResId)

Added in API level 1

Parameters
entriesResId int: The entries array as a resource.

public void setEntries (CharSequence[] entries)

Added in API level 1

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.

public void setEntryValues (CharSequence[] entryValues)

Added in API level 1

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.

public void setEntryValues (int entryValuesResId)

Added in API level 1

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

public void setSummary (CharSequence summary)

Added in API level 1

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.

public void setValue (String value)

Added in API level 1

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.

public void setValueIndex (int index)

Added in API level 1

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

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

Protected Methods

protected void onDialogClosed (boolean positiveResult)

Added in API level 1

Called when the dialog is dismissed and should be used to save data to the SharedPreferences.

Parameters
positiveResult boolean: Whether the positive button was clicked (true), or the negative button was clicked or the dialog was canceled (false).

protected Object onGetDefaultValue (TypedArray a, int index)

Added in API level 1

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

protected void onPrepareDialogBuilder (AlertDialog.Builder builder)

Added in API level 1

Prepares the dialog builder to be shown when the preference is clicked. Use this to set custom properties on the dialog.

Do not create() or show().

Parameters
builder AlertDialog.Builder

protected void onRestoreInstanceState (Parcelable state)

Added in API level 1

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

protected Parcelable onSaveInstanceState ()

Added in API level 1

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.

protected void onSetInitialValue (boolean restoreValue, Object defaultValue)

Added in API level 1

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

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.