java.lang.Object | |||
↳ | android.preference.Preference | ||
↳ | android.preference.DialogPreference | ||
↳ | android.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 values from the
setEntryValues(CharSequence[])
array.
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. |
[Expand]
Inherited XML Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.preference.DialogPreference
| |||||||||||
From class
android.preference.Preference
|
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.preference.Preference
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the index of the given value (in the entry values array).
| |||||||||||
The list of entries to be shown in the list in subsequent dialogs.
| |||||||||||
Returns the array of values to be saved for the preference.
| |||||||||||
Retrieves the current value of the key.
| |||||||||||
Sets the human-readable entries to be shown in the list.
| |||||||||||
The array to find the value to save for a preference when an entry from
entries is selected.
| |||||||||||
Sets the value of the key.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Called when the dialog is dismissed and should be used to save data to
the
SharedPreferences . | |||||||||||
Called when a Preference is being inflated and the default value
attribute needs to be read.
| |||||||||||
Prepares the dialog builder to be shown when the preference is clicked.
| |||||||||||
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.
| |||||||||||
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
|
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
.
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
.
Returns the index of the given value (in the entry values array).
value | The value whose index should be returned. |
---|
The list of entries to be shown in the list in subsequent dialogs.
Returns the array of values to be saved for the preference.
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[])
.
entries | The entries. |
---|
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.
entryValues | The array to be used as values to save for the preference. |
---|
entryValuesResId | The entry values array as a resource. |
---|
Sets the value of the key. This should contain entries in
getEntryValues()
.
values | The values to set for the key. |
---|
Called when the dialog is dismissed and should be used to save data to
the SharedPreferences
.
positiveResult | Whether the positive button was clicked (true), or the negative button was clicked or the dialog was canceled (false). |
---|
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)
.
a | The set of attributes. |
---|---|
index | The index of the default value attribute. |
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.
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.
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. |