java.lang.Object | |||
↳ | android.preference.Preference | ||
↳ | android.preference.TwoStatePreference | ||
↳ | android.preference.SwitchPreference |
A Preference
that provides a two-state toggleable option.
This preference will store a boolean into the 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. |
[Expand]
Inherited XML Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.preference.Preference
|
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.preference.Preference
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Construct a new SwitchPreference with the given style options.
| |||||||||||
Construct a new SwitchPreference with the given style options.
| |||||||||||
Construct a new SwitchPreference with the given style options.
| |||||||||||
Construct a new SwitchPreference with default style options.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Set the text displayed on the switch widget in the off state.
| |||||||||||
Set the text displayed on the switch widget in the off state.
| |||||||||||
Set the text displayed on the switch widget in the on state.
| |||||||||||
Set the text displayed on the switch widget in the on state.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Binds the created View to the data for this Preference.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.preference.TwoStatePreference
| |||||||||||
From class
android.preference.Preference
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
|
The state (true for on, or false for off) that causes dependents to be disabled. By default, dependents will be disabled when this is unchecked, so the value of this preference is false.
Must be a boolean value, either "true
" or "false
".
This may also be a reference to a resource (in the form
"@[package:]type:name
") or
theme attribute (in the form
"?[package:][type:]name
")
containing a value of this type.
This corresponds to the global attribute
resource symbol disableDependentsState
.
The summary for the Preference in a PreferenceActivity screen when the SwitchPreference is unchecked. If separate on/off summaries are not needed, the summary attribute can be used instead.
Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.
This may also be a reference to a resource (in the form
"@[package:]type:name
") or
theme attribute (in the form
"?[package:][type:]name
")
containing a value of this type.
This corresponds to the global attribute
resource symbol summaryOff
.
The summary for the Preference in a PreferenceActivity screen when the SwitchPreference is checked. If separate on/off summaries are not needed, the summary attribute can be used instead.
Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.
This may also be a reference to a resource (in the form
"@[package:]type:name
") or
theme attribute (in the form
"?[package:][type:]name
")
containing a value of this type.
This corresponds to the global attribute
resource symbol summaryOn
.
The text used on the switch itself when in the "off" state. This should be a very SHORT string, as it appears in a small space.
Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.
This may also be a reference to a resource (in the form
"@[package:]type:name
") or
theme attribute (in the form
"?[package:][type:]name
")
containing a value of this type.
This corresponds to the global attribute
resource symbol switchTextOff
.
The text used on the switch itself when in the "on" state. This should be a very SHORT string, as it appears in a small space.
Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.
This may also be a reference to a resource (in the form
"@[package:]type:name
") or
theme attribute (in the form
"?[package:][type:]name
")
containing a value of this type.
This corresponds to the global attribute
resource symbol switchTextOn
.
Construct a new SwitchPreference with the given style options.
context | The Context that will style this preference |
---|---|
attrs | Style attributes that differ from the default |
defStyleAttr | 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 | 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. |
Construct a new SwitchPreference with the given style options.
context | The Context that will style this preference |
---|---|
attrs | Style attributes that differ from the default |
defStyleAttr | 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. |
Construct a new SwitchPreference with the given style options.
context | The Context that will style this preference |
---|---|
attrs | Style attributes that differ from the default |
Construct a new SwitchPreference with default style options.
context | The Context that will style this preference |
---|
Set the text displayed on the switch widget in the off state. This should be a very short string; one word if possible.
resId | The text as a string resource ID |
---|
Set the text displayed on the switch widget in the off state. This should be a very short string; one word if possible.
offText | Text to display in the off state |
---|
Set the text displayed on the switch widget in the on state. This should be a very short string; one word if possible.
resId | The text as a string resource ID |
---|
Set the text displayed on the switch widget in the on state. This should be a very short string; one word if possible.
onText | Text to display in the on state |
---|
Binds the created View to the data for this Preference.
This is a good place to grab references to custom Views in the layout and set properties on them.
Make sure to call through to the superclass's implementation.
view | The View that shows this Preference. |
---|