public class ListPreference
extends DialogPreference
java.lang.Object | |||
↳ | android.support.v7.preference.Preference | ||
↳ | android.support.v7.preference.DialogPreference | ||
↳ | android.support.v7.preference.ListPreference |
Known Direct Subclasses |
一个 Preference
,显示作为对话框的条目列表。
这个首选项会将一个字符串存储到SharedPreferences中。 该字符串将是来自setEntryValues(CharSequence[])
阵列的值。
Inherited constants |
---|
From class android.support.v7.preference.Preference
|
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) 返回给定值的索引(在条目值数组中)。 |
CharSequence[] |
getEntries() 要在后续对话框中显示在列表中的条目列表。 |
CharSequence |
getEntry() 返回对应于当前值的条目。 |
CharSequence[] |
getEntryValues() 返回要为首选项保存的值数组。 |
CharSequence |
getSummary() 返回此ListPreference的摘要。 |
String |
getValue() 返回键的值。 |
void |
setEntries(CharSequence[] entries) 设置人类可读条目以显示在列表中。 |
void |
setEntries(int entriesResId) |
void |
setEntryValues(int entryValuesResId) |
void |
setEntryValues(CharSequence[] entryValues) 选择条目中的条目时查找要保存的首选项的值的数组。 |
void |
setSummary(CharSequence summary) 使用CharSequence设置此首选项的摘要。 |
void |
setValue(String value) 设置密钥的值。 |
void |
setValueIndex(int index) 将值设置为来自条目值的给定索引。 |
Protected methods |
|
---|---|
Object |
onGetDefaultValue(TypedArray a, int index) 当首选项被夸大并且需要读取默认值属性时调用。 |
void |
onRestoreInstanceState(Parcelable state) 允许偏好的吊钩重新应用先前由 |
Parcelable |
onSaveInstanceState() 钩子允许首选项生成其内部状态的表示,稍后可用于创建具有相同状态的新实例。 |
void |
onSetInitialValue(boolean restoreValue, Object defaultValue) 执行此操作来设置首选项的初始值。 |
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
|
ListPreference (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Parameters | |
---|---|
context |
Context
|
attrs |
AttributeSet
|
defStyleAttr |
int
|
defStyleRes |
int
|
ListPreference (Context context, AttributeSet attrs, int defStyleAttr)
Parameters | |
---|---|
context |
Context
|
attrs |
AttributeSet
|
defStyleAttr |
int
|
ListPreference (Context context, AttributeSet attrs)
Parameters | |
---|---|
context |
Context
|
attrs |
AttributeSet
|
int findIndexOfValue (String value)
返回给定值的索引(在条目值数组中)。
Parameters | |
---|---|
value |
String : The value whose index should be returned. |
Returns | |
---|---|
int |
The index of the value, or -1 if not found. |
CharSequence[] getEntries ()
要在后续对话框中显示在列表中的条目列表。
Returns | |
---|---|
CharSequence[] |
The list as an array. |
CharSequence getEntry ()
返回对应于当前值的条目。
Returns | |
---|---|
CharSequence |
The entry corresponding to the current value, or null. |
CharSequence[] getEntryValues ()
返回要为首选项保存的值数组。
Returns | |
---|---|
CharSequence[] |
The array of values. |
CharSequence getSummary ()
返回此ListPreference的摘要。 如果摘要中有String formatting标记(即“%s”或“%1 $ s”),则当前输入值将替换它的位置。
Returns | |
---|---|
CharSequence |
the summary with appropriate string substitution |
void setEntries (CharSequence[] entries)
设置人类可读条目以显示在列表中。 这将在随后的对话框中显示。
每个条目必须在 setEntryValues(CharSequence[])
有相应的索引。
Parameters | |
---|---|
entries |
CharSequence : The entries. |
void setEntries (int entriesResId)
Parameters | |
---|---|
entriesResId |
int : The entries array as a resource. |
也可以看看:
void setEntryValues (int entryValuesResId)
Parameters | |
---|---|
entryValuesResId |
int : The entry values array as a resource. |
void setEntryValues (CharSequence[] entryValues)
选择条目中的条目时查找要保存的首选项的值的数组。 如果用户单击条目中的第二项,则此数组中的第二项将保存到首选项。
Parameters | |
---|---|
entryValues |
CharSequence : The array to be used as values to save for the preference. |
void setSummary (CharSequence summary)
使用CharSequence设置此首选项的摘要。 如果汇总中包含String formatting标记(即“%s”或“%1 $ s”),则当检索到当前条目值时将替换它的位置。
Parameters | |
---|---|
summary |
CharSequence : The summary for the preference. |
void setValue (String value)
设置密钥的值。 这应该是getEntryValues()
中的条目之一。
Parameters | |
---|---|
value |
String : The value to set for the key. |
void setValueIndex (int index)
将值设置为来自条目值的给定索引。
Parameters | |
---|---|
index |
int : The index of the value to set. |
Object onGetDefaultValue (TypedArray a, int index)
当首选项被夸大并且需要读取默认值属性时调用。 由于不同的首选项类型具有不同的值类型,因此子类应获取并返回默认值,该默认值将是其值类型。
例如,如果值类型为String,则方法的主体将代理到 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. |
void onRestoreInstanceState (Parcelable state)
允许偏好的钩子重新应用先前由onSaveInstanceState()
生成的其内部状态的表示。 这个函数永远不会被调用为null状态。
Parameters | |
---|---|
state |
Parcelable : The saved state that had previously been returned by onSaveInstanceState() . |
Parcelable onSaveInstanceState ()
钩子允许首选项生成其内部状态的表示,稍后可用于创建具有相同状态的新实例。 这个状态应该只包含不持久的或者稍后可以重建的信息。
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. |
void onSetInitialValue (boolean restoreValue, Object defaultValue)
执行此操作来设置首选项的初始值。
如果restorePersistedValue为true,则应从SharedPreferences
恢复首选项值。 如果restorePersistedValue为false,则应将Preference值设置为给定的defaultValue(并且如果shouldPersist()
为true,则可能存储到SharedPreferences)。
这可能并不总是被称为。 一个例子是,如果它不应该坚持,但没有给出默认值。
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. |