belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1
MultiSelectListPreference
public
class
MultiSelectListPreference
extends DialogPreference
java.lang.Object | |||
↳ | android.support.v7.preference.Preference | ||
↳ | android.support.v7.preference.DialogPreference | ||
↳ | android.support.v14.preference.MultiSelectListPreference |
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 mValues from the
setEntryValues(CharSequence[])
array.
Summary
Inherited XML attributes | |
---|---|
From
class
android.support.v7.preference.Preference
|
Inherited constants |
---|
From
class
android.support.v7.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 mValues array). |
CharSequence[]
|
getEntries()
The list of entries to be shown in the list in subsequent dialogs. |
CharSequence[]
|
getEntryValues()
Returns the array of mValues 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 | |
---|---|
boolean[]
|
getSelectedItems()
|
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 |
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 | |
---|---|
From
class
android.support.v7.preference.DialogPreference
| |
From
class
android.support.v7.preference.Preference
| |
From
class
java.lang.Object
| |
From
interface
java.lang.Comparable
|
Public constructors
MultiSelectListPreference
MultiSelectListPreference (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
defStyleRes |
int |
MultiSelectListPreference
MultiSelectListPreference (Context context, AttributeSet attrs, int defStyleAttr)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
MultiSelectListPreference
MultiSelectListPreference (Context context, AttributeSet attrs)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
MultiSelectListPreference
MultiSelectListPreference (Context context)
Parameters | |
---|---|
context |
Context |
Public methods
findIndexOfValue
int findIndexOfValue (String value)
Returns the index of the given value (in the entry mValues 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. |
getEntryValues
CharSequence[] getEntryValues ()
Returns the array of mValues to be saved for the preference.
Returns | |
---|---|
CharSequence[] |
The array of mValues. |
getValues
Set<String> getValues ()
Retrieves the current value of the key.
Returns | |
---|---|
Set<String> |
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. |
See also:
setEntries
void setEntries (int entriesResId)
Parameters | |
---|---|
entriesResId |
int : The entries array as a resource.
|
See also:
setEntryValues
void setEntryValues (int entryValuesResId)
Parameters | |
---|---|
entryValuesResId |
int : The entry mValues array as a resource.
|
See also:
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 mValues to save for the preference.
|
setValues
void setValues (Set<String> values)
Sets the value of the key. This should contain entries in
getEntryValues()
.
Parameters | |
---|---|
values |
Set : The mValues to set for the key.
|
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 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.
|
Interfaces
Classes