MultiSelectListPreference


public class MultiSelectListPreference
extends DialogPreference

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


This class was deprecated in API level 29.
Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.

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(java.lang.CharSequence[]) array.

Summary

XML attributes

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. 

Inherited XML attributes

Inherited constants

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

Inherited methods

XML attributes

android:entries

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

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

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.

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

Public constructors

MultiSelectListPreference

Added in API level 21
public MultiSelectListPreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

defStyleRes int

MultiSelectListPreference

Added in API level 21
public MultiSelectListPreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

MultiSelectListPreference

Added in API level 11
public MultiSelectListPreference (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

MultiSelectListPreference

Added in API level 11
public MultiSelectListPreference (Context context)

Parameters
context Context

Public methods

findIndexOfValue

Added in API level 11
public 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

Added in API level 11
public CharSequence[] getEntries ()

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

Returns
CharSequence[] The list as an array.

getEntryValues

Added in API level 11
public CharSequence[] getEntryValues ()

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

Returns
CharSequence[] The array of values.

getValues

Added in API level 11
public Set<String> getValues ()

Retrieves the current value of the key.

Returns
Set<String>

setEntries

Added in API level 11
public 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(java.lang.CharSequence[]).

Parameters
entries CharSequence: The entries.

setEntries

Added in API level 11
public void setEntries (int entriesResId)

Parameters
entriesResId int: The entries array as a resource.

setEntryValues

Added in API level 11
public void setEntryValues (int entryValuesResId)

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

setEntryValues

Added in API level 11
public 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.

setValues

Added in API level 11
public void setValues (Set<String> values)

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

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

Protected methods

onDialogClosed

Added in API level 11
protected void onDialogClosed (boolean positiveResult)

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

onGetDefaultValue

Added in API level 11
protected 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.

onPrepareDialogBuilder

Added in API level 11
protected void onPrepareDialogBuilder (AlertDialog.Builder builder)

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

Do not AlertDialog.Builder#create() or AlertDialog.Builder#show().

Parameters
builder AlertDialog.Builder

onSaveInstanceState

Added in API level 11
protected 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

Added in API level 11
protected 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.