Most visited

Recently visited

Added in API level 14

TwoStatePreference

public abstract class TwoStatePreference
extends Preference

java.lang.Object
   ↳ android.preference.Preference
     ↳ android.preference.TwoStatePreference
Known Direct Subclasses


具有两种可选状态的首选项的公共基类,在SharedPreferences中保留布尔值,并且可能具有根据当前状态启用/禁用的相关首选项。

Summary

Inherited XML attributes

From class android.preference.Preference

Inherited constants

From class android.preference.Preference

Public constructors

TwoStatePreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
TwoStatePreference(Context context, AttributeSet attrs, int defStyleAttr)
TwoStatePreference(Context context, AttributeSet attrs)
TwoStatePreference(Context context)

Public methods

boolean getDisableDependentsState()

返回此首选项开启时是否禁用家属( true )或此首选项关闭时( false )。

CharSequence getSummaryOff()

返回未选中时显示的摘要。

CharSequence getSummaryOn()

返回选中时显示的摘要。

boolean isChecked()

返回检查的状态。

void setChecked(boolean checked)

设置选中的状态并将其保存到 SharedPreferences

void setDisableDependentsState(boolean disableDependentsState)

设置此首选项开启时是否禁用家属( true )或此首选项关闭时( false )。

void setSummaryOff(CharSequence summary)

设置未选中时显示的摘要。

void setSummaryOff(int summaryResId)
void setSummaryOn(int summaryResId)
void setSummaryOn(CharSequence summary)

设置选中时显示的摘要。

boolean shouldDisableDependents()

检查当前是否应该禁用此首选项的依赖项。

Protected methods

void onClick()

处理点击偏好。

Object onGetDefaultValue(TypedArray a, int index)

当首选项被夸大并且需要读取默认值属性时调用。

void onRestoreInstanceState(Parcelable state)

Hook允许偏好重新应用以前由 onSaveInstanceState()生成的内部状态的表示。

Parcelable onSaveInstanceState()

钩子允许首选项生成其内部状态的表示,稍后可用于创建具有相同状态的新实例。

void onSetInitialValue(boolean restoreValue, Object defaultValue)

执行此操作来设置首选项的初始值。

Inherited methods

From class android.preference.Preference
From class java.lang.Object
From interface java.lang.Comparable

Public constructors

TwoStatePreference

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

Parameters
context Context
attrs AttributeSet
defStyleAttr int
defStyleRes int

TwoStatePreference

Added in API level 14
TwoStatePreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context
attrs AttributeSet
defStyleAttr int

TwoStatePreference

Added in API level 14
TwoStatePreference (Context context, 
                AttributeSet attrs)

Parameters
context Context
attrs AttributeSet

TwoStatePreference

Added in API level 14
TwoStatePreference (Context context)

Parameters
context Context

Public methods

getDisableDependentsState

Added in API level 1
boolean getDisableDependentsState ()

返回当此首选项打开时( true )或此首选项关闭时是否禁用家属( false )。

Returns
boolean Whether dependents are disabled when this preference is on (true) or when this preference is off (false).

getSummaryOff

Added in API level 1
CharSequence getSummaryOff ()

返回未选中时显示的摘要。

Returns
CharSequence The summary.

getSummaryOn

Added in API level 1
CharSequence getSummaryOn ()

返回选中时显示的摘要。

Returns
CharSequence The summary.

isChecked

Added in API level 1
boolean isChecked ()

返回检查的状态。

Returns
boolean The checked state.

setChecked

Added in API level 1
void setChecked (boolean checked)

设置选中状态并将其保存到 SharedPreferences

Parameters
checked boolean: The checked state.

setDisableDependentsState

Added in API level 1
void setDisableDependentsState (boolean disableDependentsState)

设置当此首选项打开时( true )还是此首选项关闭时( false ),是否禁用了依赖 false

Parameters
disableDependentsState boolean: The preference state that should disable dependents.

setSummaryOff

Added in API level 1
void setSummaryOff (CharSequence summary)

设置未选中时显示的摘要。

Parameters
summary CharSequence: The summary to be shown when unchecked.

setSummaryOff

Added in API level 1
void setSummaryOff (int summaryResId)

Parameters
summaryResId int: The summary as a resource.

也可以看看:

setSummaryOn

Added in API level 1
void setSummaryOn (int summaryResId)

Parameters
summaryResId int: The summary as a resource.

也可以看看:

setSummaryOn

Added in API level 1
void setSummaryOn (CharSequence summary)

设置选中时显示的摘要。

Parameters
summary CharSequence: The summary to be shown when checked.

shouldDisableDependents

Added in API level 1
boolean shouldDisableDependents ()

检查当前是否应该禁用此首选项的依赖项。

Returns
boolean True if the dependents should be disabled, otherwise false.

Protected methods

onClick

Added in API level 1
void onClick ()

处理点击偏好。 这包括将值保存到SharedPreferences 但是,重写的方法应该调用callChangeListener(Object)以确保客户端想要用新值更新首选项的状态。

onGetDefaultValue

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

onRestoreInstanceState

Added in API level 1
void onRestoreInstanceState (Parcelable state)

钩子允许偏好重新应用其以前由onSaveInstanceState()生成的内部状态的表示。 这个函数永远不会被调用为null状态。

Parameters
state Parcelable: The saved state that had previously been returned by onSaveInstanceState().

onSaveInstanceState

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

onSetInitialValue

Added in API level 1
void onSetInitialValue (boolean restoreValue, 
                Object defaultValue)

执行此操作来设置首选项的初始值。

如果restorePersistedValue为true,则应从SharedPreferences恢复首选项值。 如果restorePersistedValue为false,则应将Preference值设置为给定的defaultValue(并且如果shouldPersist()为true,则可能shouldPersist()其存储到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.

Hooray!