added in version 24.1.0
belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1

SwitchPreferenceCompat

public class SwitchPreferenceCompat
extends TwoStatePreference

java.lang.Object
↳	android.support.v7.preference.Preference
	↳	android.support.v7.preference.TwoStatePreference
		↳	android.support.v7.preference.SwitchPreferenceCompat

A Preference that provides a two-state toggleable option.

This preference will store a boolean into the SharedPreferences.

Summary

Inherited XML attributes

From class


  android.support.v7.preference.Preference

Inherited constants

From class


    android.support.v7.preference.Preference

Inherited fields

From class


    android.support.v7.preference.TwoStatePreference

Public constructors
`SwitchPreferenceCompat(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)` Construct a new SwitchPreference with the given style options.
`SwitchPreferenceCompat(Context context, AttributeSet attrs, int defStyleAttr)` Construct a new SwitchPreference with the given style options.
`SwitchPreferenceCompat(Context context, AttributeSet attrs)` Construct a new SwitchPreference with the given style options.
`SwitchPreferenceCompat(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

From class


  
    android.support.v7.preference.TwoStatePreference

`boolean`	`getDisableDependentsState()` Returns whether dependents are disabled when this preference is on (`true`) or when this preference is off (`false`).
`CharSequence`	`getSummaryOff()` Returns the summary to be shown when unchecked.
`CharSequence`	`getSummaryOn()` Returns the summary to be shown when checked.
`boolean`	`isChecked()` Returns the checked state.
`void`	`onClick()` Processes a click on the preference.
`Object`	`onGetDefaultValue(TypedArray a, int index)` Called when a Preference is being inflated and the default value attribute needs to be read.
`void`	`onRestoreInstanceState(Parcelable state)` Hook allowing a Preference to re-apply a representation of its internal state that had previously been generated by `onSaveInstanceState()`.
`Parcelable`	`onSaveInstanceState()` Hook allowing a Preference to generate a representation of its internal state that can later be used to create a new instance with that same state.
`void`	`onSetInitialValue(boolean restoreValue, Object defaultValue)` Implement this to set the initial value of the Preference.
`void`	`setChecked(boolean checked)` Sets the checked state and saves it to the `SharedPreferences`.
`void`	`setDisableDependentsState(boolean disableDependentsState)` Sets whether dependents are disabled when this preference is on (`true`) or when this preference is off (`false`).
`void`	`setSummaryOff(CharSequence summary)` Sets the summary to be shown when unchecked.
`void`	`setSummaryOff(int summaryResId)`
`void`	`setSummaryOn(int summaryResId)`
`void`	`setSummaryOn(CharSequence summary)` Sets the summary to be shown when checked.
`boolean`	`shouldDisableDependents()` Checks whether this preference's dependents should currently be disabled.
`void`	`syncSummaryView(PreferenceViewHolder holder)` Sync a summary holder contained within holder's subhierarchy with the correct summary text.

From class


  
    android.support.v7.preference.Preference

`boolean`	`callChangeListener(Object newValue)` Call this method after the user changes the preference, but before the internal state is set.
`int`	`compareTo(Preference another)` Compares Preference objects based on order (if set), otherwise alphabetically on the titles.
`Preference`	`findPreferenceInHierarchy(String key)` Finds a Preference in this hierarchy (the whole thing, even above/below your `PreferenceScreen` screen break) with the given key.
`Context`	`getContext()` Returns the `Context` of this Preference.
`String`	`getDependency()` Returns the key of the dependency on this Preference.
`Bundle`	`getExtras()` Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.
`String`	`getFragment()` Return the fragment class name associated with this Preference.
`Drawable`	`getIcon()` Returns the icon of this Preference.
`Intent`	`getIntent()` Return the `Intent` associated with this Preference.
`String`	`getKey()` Gets the key for this Preference, which is also the key used for storing values into `SharedPreferences` or `PreferenceDataStore`.
`final int`	`getLayoutResource()` Gets the layout resource that will be shown as the `View` for this Preference.
`Preference.OnPreferenceChangeListener`	`getOnPreferenceChangeListener()` Returns the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).
`Preference.OnPreferenceClickListener`	`getOnPreferenceClickListener()` Returns the callback to be invoked when this Preference is clicked.
`int`	`getOrder()` Gets the order of this Preference with respect to other Preference objects on the same level.
`PreferenceGroup`	`getParent()` Returns the `PreferenceGroup` which is this Preference assigned to or null if this preference is not assigned to any group or is a root Preference.
`boolean`	`getPersistedBoolean(boolean defaultReturnValue)` Attempts to get a persisted `Boolean` if this Preference is persistent.
`float`	`getPersistedFloat(float defaultReturnValue)` Attempts to get a persisted `Float` if this Preference is persistent.
`int`	`getPersistedInt(int defaultReturnValue)` Attempts to get a persisted `Integer` if this Preference is persistent.
`long`	`getPersistedLong(long defaultReturnValue)` Attempts to get a persisted `Long` if this Preference is persistent.
`String`	`getPersistedString(String defaultReturnValue)` Attempts to get a persisted set of Strings if this Preference is persistent.
`Set<String>`	`getPersistedStringSet(Set<String> defaultReturnValue)` Attempts to get a persisted set of Strings if this Preference is persistent.
`PreferenceDataStore`	`getPreferenceDataStore()` Returns `PreferenceDataStore` used by this Preference.
`PreferenceManager`	`getPreferenceManager()` Gets the `PreferenceManager` that manages this Preference object's tree.
`SharedPreferences`	`getSharedPreferences()` Returns the `SharedPreferences` where this Preference can read its value(s).
`boolean`	`getShouldDisableView()` Checks whether this Preference should disable its view when it's action is disabled.
`CharSequence`	`getSummary()` Returns the summary of this Preference.
`CharSequence`	`getTitle()` Returns the title of this Preference.
`final int`	`getWidgetLayoutResource()` Gets the layout resource for the controllable widget portion of this Preference.
`boolean`	`hasKey()` Checks whether this Preference has a valid key.
`boolean`	`isEnabled()` Checks whether this Preference should be enabled in the list.
`boolean`	`isIconSpaceReserved()` Returns whether the space of this preference icon view is reserved.
`boolean`	`isPersistent()` Checks whether this Preference is persistent.
`boolean`	`isSelectable()` Checks whether this Preference should be selectable in the list.
`boolean`	`isSingleLineTitle()` Gets whether the title of this preference is constrained to a single line.
`final boolean`

SwitchPreferenceCompat

Summary

Inherited XML attributes

Inherited constants

Inherited fields

Public constructors

Public methods

Inherited methods