to top

fullscreen Use Tree Navigation

Added in API level 1

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

Attribute Name	Related Method	Description
android:defaultValue		The default value for the preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
android:dependency		The key of another Preference that this Preference will depend on.
android:enabled		Whether the Preference is enabled.
android:fragment		When used inside of a modern PreferenceActivity, this declares a new PreferenceFragment to be shown when the user selects this item.
android:icon		The optional icon for 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`".
android:key		The key to store the Preference value.
android:layout		The layout for the Preference in a PreferenceActivity screen.
android:order		The order for the Preference (lower values are to be ordered first).
android:persistent		Whether the Preference stores its value to the shared preferences.
android:selectable		Whether the Preference is selectable.
android:shouldDisableView		Whether the view of this Preference should be disabled when this Preference is disabled.
android:summary		The summary for the Preference in a PreferenceActivity screen.
android:title		The title for the Preference in a PreferenceActivity screen.
android:widgetLayout		The layout for the controllable widget portion of a Preference.

[Expand]

Inherited Constants

From class android.preference.Preference

Public Constructors
	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

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.
SharedPreferences.Editor	getEditor() Returns an `SharedPreferences.Editor` where this Preference can save its value(s).
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.
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.
boolean	getPersistedBoolean(boolean defaultReturnValue) Attempts to get a persisted boolean from the `SharedPreferences`.
float	getPersistedFloat(float defaultReturnValue) Attempts to get a persisted float from the `SharedPreferences`.
int	getPersistedInt(int defaultReturnValue) Attempts to get a persisted int from the `SharedPreferences`.
long	getPersistedLong(long defaultReturnValue) Attempts to get a persisted long from the `SharedPreferences`.
String	getPersistedString(String defaultReturnValue) Attempts to get a persisted String from the `SharedPreferences`.
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.
CharSequence	getTitle() Returns the title of this Preference.
int	getTitleRes() Returns the title resource ID of this Preference.
View	getView(View convertView, ViewGroup parent) Gets the View that will be shown in the `PreferenceActivity`.
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	isEnabled() Checks whether this Preference should be enabled in the list.
boolean	isPersistent() Checks whether this Preference is persistent.
boolean	isSelectable() Checks whether this Preference should be selectable in the list.
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	onAttachedToActivity() Called when the Preference hierarchy has been attached to the `PreferenceActivity`.
void	onAttachedToHierarchy(PreferenceManager preferenceManager) Called when this Preference has been attached to a Preference hierarchy.
void	onBindView(View view) Binds the created View to the data for this Preference.
void	onClick() Processes a click on the preference.
View	onCreateView(ViewGroup parent) Creates the View to be shown for this Preference in the `PreferenceActivity`.
void	onDependencyChanged(Preference dependency, boolean disableDependent) Called when the dependency changes.
Object	onGetDefaultValue(TypedArray a, int index) Called when a Preference is being inflated and the default value attribute needs to be read.
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(boolean restorePersistedValue, Object defaultValue) Implement this to set the initial value of the Preference.
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 to the `SharedPreferences`.
boolean	persistFloat(float value) Attempts to persist a float to the `SharedPreferences`.
boolean	persistInt(int value) Attempts to persist an int to the `SharedPreferences`.
boolean	persistLong(long value) Attempts to persist a long to the `SharedPreferences`.
boolean	persistString(String value) Attempts to persist a String to the `SharedPreferences`.
void	restoreHierarchyState(Bundle container) Restore this Preference hierarchy's previously saved state from the given container.
void	saveHierarchyState(Bundle container) Store this Preference hierarchy's frozen state into the given container.
void	setDefaultValue(Object defaultValue) Sets the default value for this Preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
void	setDependency(String dependencyKey) Sets the key of a Preference that this Preference will depend on.
void	setEnabled(boolean enabled) Sets whether this Preference is enabled.
void	setFragment(String fragment) Sets the class name of a fragment to be shown when this Preference is clicked.
void	setIcon(Drawable icon) Sets the icon for this Preference with a Drawable.
void	setIcon(int iconResId) Sets the icon for this Preference with a resource ID.
void	setIntent(Intent intent) Sets an `Intent` to be used for `startActivity(Intent)` when this Preference is clicked.
void	setKey(String key) Sets the key for this Preference, which is used as a key to the `SharedPreferences`.
void	setLayoutResource(int layoutResId) Sets the layout resource that is inflated as the `View` to be shown for this Preference.
void	setOnPreferenceChangeListener(Preference.OnPreferenceChangeListener onPreferenceChangeListener) Sets the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).
void	setOnPreferenceClickListener(Preference.OnPreferenceClickListener onPreferenceClickListener) Sets the callback to be invoked when this Preference is clicked.
void	setOrder(int order) Sets the order of this Preference with respect to other Preference objects on the same level.
void	setPersistent(boolean persistent) Sets whether this Preference is persistent.
void	setSelectable(boolean selectable) Sets whether this Preference is selectable.
void	setShouldDisableView(boolean shouldDisableView) Sets whether this Preference should disable its view when it gets disabled.
void	setSummary(int summaryResId) Sets the summary for this Preference with a resource ID.
void	setSummary(CharSequence summary) Sets the summary for this Preference with a CharSequence.
void	setTitle(int titleResId) Sets the title for this Preference with a resource ID.
void	setTitle(CharSequence title) Sets the title for this Preference with a CharSequence.
void	setWidgetLayoutResource(int widgetLayoutResId) Sets The layout for the controllable widget portion of this Preference.
boolean	shouldCommit() Returns whether the `Preference` should commit its saved value(s) in `getEditor()`.
boolean	shouldDisableDependents() Checks whether this preference's dependents should currently be disabled.
boolean	shouldPersist() Checks whether, at the given time this method is called, this Preference should store/restore its value(s) into the `SharedPreferences`.
String	toString() Returns a string containing a concise, human-readable description of this object.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

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)

Added in API level 1

public ListPreference (Context context)

Added in API level 1

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	The value whose index should be returned.

Returns

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

The list as an array.

public CharSequence getEntry ()

Added in API level 1

Returns the entry corresponding to the current value.

Returns

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

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

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

The value of the key.

public void setEntries (int entriesResId)

Added in API level 1

Parameters

entriesResId	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	The entries.

public void setEntryValues (CharSequence[] entryValues)

Added in API level 1

Parameters

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

public void setEntryValues (int entryValuesResId)

Added in API level 1

Parameters

entryValuesResId	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	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	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	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	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	The set of attributes.
index	The index of the default value attribute.

Returns

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

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

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	True to restore the persisted value; false to use the given `defaultValue`.
defaultValue	The default value for this Preference. Only use this if `restorePersistedValue` is false.

Results

Interfaces

Classes

ListPreference

Class Overview

Summary

XML Attributes

android:entries

Related Methods

android:entryValues

Related Methods

Public Constructors

public ListPreference (Context context, AttributeSet attrs)

public ListPreference (Context context)

Public Methods

public int findIndexOfValue (String value)

Parameters

Returns

public CharSequence[] getEntries ()

Returns

public CharSequence getEntry ()

Returns

public CharSequence[] getEntryValues ()

Returns

public CharSequence getSummary ()

Returns

public String getValue ()

Returns

public void setEntries (int entriesResId)

Parameters

See Also

public void setEntries (CharSequence[] entries)

Parameters

See Also

public void setEntryValues (CharSequence[] entryValues)

Parameters

public void setEntryValues (int entryValuesResId)

Parameters

See Also

public void setSummary (CharSequence summary)

Parameters

public void setValue (String value)

Parameters

public void setValueIndex (int index)

Parameters

Protected Methods

protected void onDialogClosed (boolean positiveResult)

Parameters

protected Object onGetDefaultValue (TypedArray a, int index)

Parameters

Returns

protected void onPrepareDialogBuilder (AlertDialog.Builder builder)

protected void onRestoreInstanceState (Parcelable state)

Parameters

protected Parcelable onSaveInstanceState ()

Returns

protected void onSetInitialValue (boolean restoreValue, Object defaultValue)

Parameters