SwitchPreference

public class SwitchPreference
extends TwoStatePreference

java.lang.Object
   ↳ android.preference.Preference
     ↳ android.preference.TwoStatePreference
       ↳ android.preference.SwitchPreference


This class was deprecated in API level 29.
Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.

A Preference that provides a two-state toggleable option.

This preference will store a boolean into the SharedPreferences.

Summary

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

Inherited constants

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 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.

Protected methods

void onBindView(View view)

Binds the created View to the data for this Preference.

Inherited methods

XML attributes

android:disableDependentsState

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.

May be a boolean value, such as "true" or "false".

android:summaryOff

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.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:summaryOn

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.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:switchTextOff

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.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

android:switchTextOn

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.

May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character;

Public constructors

SwitchPreference

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

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

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

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

Added in API level 14
public CharSequence getSwitchTextOff ()

Returns
CharSequence The text that will be displayed on the switch widget in the off state

getSwitchTextOn

Added in API level 14
public CharSequence getSwitchTextOn ()

Returns
CharSequence The text that will be displayed on the switch widget in the on state

setSwitchTextOff

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

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

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

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

Protected methods

onBindView

Added in API level 14
protected void onBindView (View view)

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.
If you override this method you must call through to the superclass implementation.

Parameters
view View: The View that shows this Preference.