public class SwitchPreference
extends TwoStatePreference
java.lang.Object | |||
↳ | android.preference.Preference | ||
↳ | android.preference.TwoStatePreference | ||
↳ | android.preference.SwitchPreference |
一个 Preference
,它提供了一个双态切换选项。
这个首选项会将一个布尔值存储到SharedPreferences中。
XML attributes |
|
---|---|
android:disableDependentsState |
The state (true for on, or false for off) that causes dependents to be disabled. |
android:summaryOff |
The summary for the Preference in a PreferenceActivity screen when the SwitchPreference is unchecked. |
android:summaryOn |
The summary for the Preference in a PreferenceActivity screen when the SwitchPreference is checked. |
android:switchTextOff |
The text used on the switch itself when in the "off" state. |
android:switchTextOn |
The text used on the switch itself when in the "on" state. |
Inherited XML attributes |
|
---|---|
From class android.preference.Preference
|
Inherited constants |
---|
From class android.preference.Preference
|
Public constructors |
|
---|---|
SwitchPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) 使用给定的样式选项构建一个新的SwitchPreference。 |
|
SwitchPreference(Context context, AttributeSet attrs, int defStyleAttr) 使用给定的样式选项构建一个新的SwitchPreference。 |
|
SwitchPreference(Context context, AttributeSet attrs) 使用给定的样式选项构建一个新的SwitchPreference。 |
|
SwitchPreference(Context context) 使用默认样式选项构建一个新的SwitchPreference。 |
Public methods |
|
---|---|
CharSequence |
getSwitchTextOff() |
CharSequence |
getSwitchTextOn() |
void |
setSwitchTextOff(int resId) 将交换机小部件上显示的文本设置为关闭状态。 |
void |
setSwitchTextOff(CharSequence offText) 将交换机小部件上显示的文本设置为关闭状态。 |
void |
setSwitchTextOn(CharSequence onText) 将开关小部件上显示的文本设置为开启状态。 |
void |
setSwitchTextOn(int resId) 将开关小部件上显示的文本设置为开启状态。 |
Protected methods |
|
---|---|
void |
onBindView(View view) 将创建的视图绑定到此首选项的数据。 |
Inherited methods |
|
---|---|
From class android.preference.TwoStatePreference
|
|
From class android.preference.Preference
|
|
From class java.lang.Object
|
|
From interface java.lang.Comparable
|
导致家属被禁用的状态(对于打开为true,或对于关闭为false)。 默认情况下,取消选中时,依赖项将被禁用,因此此首选项的值为false。
必须是布尔值,可以是“ true
”或“ false
”。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 disableDependentsState
。
未选中SwitchPreference时PreferenceActivity屏幕中的首选项摘要。 如果不需要单独的开/关摘要,则可以使用摘要属性。
必须是字符串值,使用'\\;' 转义字符如'\\ n'或'\\ uxxxx'作为unicode字符。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 summaryOff
。
当选择SwitchPreference时,首选活动屏幕中的首选项摘要。 如果不需要单独的开/关摘要,则可以使用摘要属性。
必须是字符串值,使用'\\;' 转义字符如'\\ n'或'\\ uxxxx'作为unicode字符。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 summaryOn
。
处于“关闭”状态时,交换机本身使用的文本。 这应该是一个非常短的字符串,因为它出现在一个小空间中。
必须是字符串值,使用'\\;' 转义字符如'\\ n'或'\\ uxxxx'作为unicode字符。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 switchTextOff
。
处于“开启”状态时,交换机本身使用的文本。 这应该是一个非常短的字符串,因为它出现在一个小空间中。
必须是字符串值,使用'\\;' 转义字符如'\\ n'或'\\ uxxxx'作为unicode字符。
这也可能是对包含此类型值的资源(形式为“ @[package:]type:name
”)或主题属性(形式为“ ?[package:][type:]name
”)的 ?[package:][type:]name
。
这对应于全局属性资源符号 switchTextOn
。
SwitchPreference (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
使用给定的样式选项构建一个新的SwitchPreference。
Parameters | |
---|---|
context |
Context : The Context that will style this preference |
attrs |
AttributeSet : Style attributes that differ from the default |
defStyleAttr |
int : An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults. |
defStyleRes |
int : A resource identifier of a style resource that supplies default values for the view, used only if defStyleAttr is 0 or can not be found in the theme. Can be 0 to not look for defaults. |
SwitchPreference (Context context, AttributeSet attrs, int defStyleAttr)
使用给定的样式选项构建一个新的SwitchPreference。
Parameters | |
---|---|
context |
Context : The Context that will style this preference |
attrs |
AttributeSet : Style attributes that differ from the default |
defStyleAttr |
int : An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults. |
SwitchPreference (Context context, AttributeSet attrs)
使用给定的样式选项构建一个新的SwitchPreference。
Parameters | |
---|---|
context |
Context : The Context that will style this preference |
attrs |
AttributeSet : Style attributes that differ from the default |
SwitchPreference (Context context)
使用默认样式选项构建一个新的SwitchPreference。
Parameters | |
---|---|
context |
Context : The Context that will style this preference |
CharSequence getSwitchTextOff ()
Returns | |
---|---|
CharSequence |
The text that will be displayed on the switch widget in the off state |
CharSequence getSwitchTextOn ()
Returns | |
---|---|
CharSequence |
The text that will be displayed on the switch widget in the on state |
void setSwitchTextOff (int resId)
将交换机小部件上显示的文本设置为关闭状态。 这应该是一个很短的字符串; 如果可能的话一个字。
Parameters | |
---|---|
resId |
int : The text as a string resource ID |
void setSwitchTextOff (CharSequence offText)
将交换机小部件上显示的文本设置为关闭状态。 这应该是一个很短的字符串; 如果可能的话一个字。
Parameters | |
---|---|
offText |
CharSequence : Text to display in the off state |
void setSwitchTextOn (CharSequence onText)
将开关小部件上显示的文本设置为开启状态。 这应该是一个很短的字符串; 如果可能的话一个字。
Parameters | |
---|---|
onText |
CharSequence : Text to display in the on state |
void setSwitchTextOn (int resId)
将开关小部件上显示的文本设置为开启状态。 这应该是一个很短的字符串; 如果可能的话一个字。
Parameters | |
---|---|
resId |
int : The text as a string resource ID |
void onBindView (View view)
将创建的视图绑定到此首选项的数据。
这是抓取对布局和自定义属性的自定义视图的引用的好地方。
确保调用超类的实现。
Parameters | |
---|---|
view |
View : The View that shows this Preference. |