ListPreference
public
class
ListPreference
extends DialogPreference
java.lang.Object | |||
↳ | android.preference.Preference | ||
↳ | android.preference.DialogPreference | ||
↳ | android.preference.ListPreference |
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 string into the SharedPreferences. This string will be the value
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 | |
---|---|
ListPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
|
|
ListPreference(Context context, AttributeSet attrs, int defStyleAttr)
|
|
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(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
|
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 |
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 |
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 on 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
ListPreference
public ListPreference (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
defStyleRes |
int |
ListPreference
public ListPreference (Context context, AttributeSet attrs, int defStyleAttr)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
ListPreference
public ListPreference (Context context, AttributeSet attrs)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
ListPreference
public ListPreference (Context context)
Parameters | |
---|---|
context |
Context |
Public methods
findIndexOfValue
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
public CharSequence[] getEntries ()
The list of entries to be shown in the list in subsequent dialogs.
Returns | |
---|---|
CharSequence[] |
The list as an array. |
getEntry
public CharSequence getEntry ()
Returns the entry corresponding to the current value.
Returns | |
---|---|
CharSequence |
The entry corresponding to the current value, or null. |
getEntryValues
public CharSequence[] getEntryValues ()
Returns the array of values to be saved for the preference.
Returns | |
---|---|
CharSequence[] |
The array of values. |
getSummary
public CharSequence getSummary ()
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 | |
---|---|
CharSequence |
the summary with appropriate string substitution |
getValue
public String getValue ()
Returns the value of the key. This should be one of the entries in
getEntryValues()
.
Returns | |
---|---|
String |
The value of the key. |
setEntries
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. |
See also:
setEntries
public void setEntries (int entriesResId)
Parameters | |
---|---|
entriesResId |
int : The entries array as a resource. |
See also:
setEntryValues
public void setEntryValues (int entryValuesResId)
Parameters | |
---|---|
entryValuesResId |
int : The entry values array as a resource. |
See also:
setEntryValues
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. |
setSummary
public void setSummary (CharSequence summary)
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 |
CharSequence : The summary for the preference. |
setValue
public void setValue (String value)
Sets the value of the key. This should be one of the entries in
getEntryValues()
.
Parameters | |
---|---|
value |
String : The value to set for the key. |
setValueIndex
public void setValueIndex (int index)
Sets the value to the given index from the entry values.
Parameters | |
---|---|
index |
int : The index of the value to set. |
Protected methods
onDialogClosed
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
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
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 |
onRestoreInstanceState
protected 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
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
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. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.