Android APIs
public class

MultiSelectListPreference

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

Class Overview

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

This preference will store a set of strings into the SharedPreferences. This set will contain one or more values 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
MultiSelectListPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
MultiSelectListPreference(Context context, AttributeSet attrs, int defStyleAttr)
MultiSelectListPreference(Context context, AttributeSet attrs)
MultiSelectListPreference(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[] getEntryValues()
Returns the array of values to be saved for the preference.
Set<String> getValues()
Retrieves the current 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 setValues(Set<String> values)
Sets the value of the key.
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.
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 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 MultiSelectListPreference (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

Added in API level 21

Parameters
context Context
attrs AttributeSet
defStyleAttr int
defStyleRes int

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

Added in API level 21

Parameters
context Context
attrs AttributeSet
defStyleAttr int

public MultiSelectListPreference (Context context, AttributeSet attrs)

Added in API level 11

Parameters
context Context
attrs AttributeSet

public MultiSelectListPreference (Context context)

Added in API level 11

Parameters
context Context

Public Methods

public int findIndexOfValue (String value)

Added in API level 11

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 11

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

Returns
CharSequence[] The list as an array.

public CharSequence[] getEntryValues ()

Added in API level 11

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

Returns
CharSequence[] The array of values.

public Set<String> getValues ()

Added in API level 11

Retrieves the current value of the key.

Returns
Set<String>

public void setEntries (int entriesResId)

Added in API level 11

Parameters
entriesResId int: The entries array as a resource.

public void setEntries (CharSequence[] entries)

Added in API level 11

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 11

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 11

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

public void setValues (Set<String> values)

Added in API level 11

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

Parameters
values Set: The values to set for the key.

Protected Methods

protected void onDialogClosed (boolean positiveResult)

Added in API level 11

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 11

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 11

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 Parcelable onSaveInstanceState ()

Added in API level 11

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 11

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.