SwitchPreference
public
class
SwitchPreference
extends TwoStatePreference
java.lang.Object | |||
↳ | androidx.preference.Preference | ||
↳ | androidx.preference.TwoStatePreference | ||
↳ | androidx.preference.SwitchPreference |
A Preference
that provides a two-state toggleable option.
This preference will save a boolean value to SharedPreferences
.
Summary
Inherited constants |
---|
Inherited fields |
---|
Public constructors | |
---|---|
SwitchPreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Construct a new SwitchPreference with the given style options. |
|
SwitchPreference(Context context, AttributeSet attrs, int defStyleAttr)
Construct a new SwitchPreference with the given style options. |
|
SwitchPreference(Context context, AttributeSet attrs)
Construct a new SwitchPreference with the given style options. |
|
SwitchPreference(Context context)
Construct a new SwitchPreference with default style options. |
Public methods | |
---|---|
CharSequence
|
getSwitchTextOff()
|
CharSequence
|
getSwitchTextOn()
|
void
|
onBindViewHolder(PreferenceViewHolder holder)
Binds the created View to the data for this preference. |
void
|
setSwitchTextOff(int resId)
Set the text displayed on the switch widget in the off state. |
void
|
setSwitchTextOff(CharSequence offText)
Set the text displayed on the switch widget in the off state. |
void
|
setSwitchTextOn(CharSequence onText)
Set the text displayed on the switch widget in the on state. |
void
|
setSwitchTextOn(int resId)
Set the text displayed on the switch widget in the on state. |
Inherited methods | |
---|---|
Public constructors
SwitchPreference
public SwitchPreference (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Construct a new SwitchPreference with the given style options.
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
public SwitchPreference (Context context, AttributeSet attrs, int defStyleAttr)
Construct a new SwitchPreference with the given style options.
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
public SwitchPreference (Context context, AttributeSet attrs)
Construct a new SwitchPreference with the given style options.
Parameters | |
---|---|
context |
Context : The Context that will style this preference |
attrs |
AttributeSet : Style attributes that differ from the default
|
SwitchPreference
public SwitchPreference (Context context)
Construct a new SwitchPreference with default style options.
Parameters | |
---|---|
context |
Context : The Context that will style this preference
|
Public methods
getSwitchTextOff
public CharSequence getSwitchTextOff ()
Returns | |
---|---|
CharSequence |
The text that will be displayed on the switch widget in the off state |
getSwitchTextOn
public CharSequence getSwitchTextOn ()
Returns | |
---|---|
CharSequence |
The text that will be displayed on the switch widget in the on state |
onBindViewHolder
public void onBindViewHolder (PreferenceViewHolder holder)
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.
Parameters | |
---|---|
holder |
PreferenceViewHolder : The ViewHolder that provides references to the views to fill in. These views
will be recycled, so you should not hold a reference to them after this method
returns.
|
setSwitchTextOff
public void setSwitchTextOff (int resId)
Set the text displayed on the switch widget in the off state. This should be a very short string, one word if possible.
Parameters | |
---|---|
resId |
int : The text as a string resource ID
|
setSwitchTextOff
public void setSwitchTextOff (CharSequence offText)
Set the text displayed on the switch widget in the off state. This should be a very short string, one word if possible.
Parameters | |
---|---|
offText |
CharSequence : Text to display in the off state
|
setSwitchTextOn
public void setSwitchTextOn (CharSequence onText)
Set the text displayed on the switch widget in the on state. This should be a very short string, one word if possible.
Parameters | |
---|---|
onText |
CharSequence : Text to display in the on state
|
setSwitchTextOn
public void setSwitchTextOn (int resId)
Set the text displayed on the switch widget in the on state. This should be a very short string, one word if possible.
Parameters | |
---|---|
resId |
int : The text as a string resource ID
|