SwitchPreferenceCompat

Kotlin |Java

open class SwitchPreferenceCompat : TwoStatePreference

kotlin.Any
↳	androidx.preference.Preference
	↳	androidx.preference.TwoStatePreference
		↳	androidx.preference.SwitchPreferenceCompat

A Preference that provides a two-state toggleable option.

This preference will save a boolean value to android.content.SharedPreferences.

Summary

Inherited constants

From class Preference

Int

DEFAULT_ORDER

Specify for setOrder(int) if a specific order is not required.

Public constructors
`<init>(context: Context!, attrs: AttributeSet!, defStyleAttr: Int, defStyleRes: Int)` Construct a new SwitchPreference with the given style options.
`<init>(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)` Construct a new SwitchPreference with the given style options.
`<init>(context: Context!, attrs: AttributeSet!)` Construct a new SwitchPreference with the given style options.
`<init>(context: Context!)` Construct a new SwitchPreference with default style options.

Public methods
open CharSequence!	`getSwitchTextOff()`
open CharSequence!	`getSwitchTextOn()`
open Unit	`onBindViewHolder(holder: PreferenceViewHolder!)`
open Unit	`setSwitchTextOff(offText: CharSequence!)` Set the text displayed on the switch widget in the off state.
open Unit	`setSwitchTextOff(resId: Int)` Set the text displayed on the switch widget in the off state.
open Unit	`setSwitchTextOn(onText: CharSequence!)` Set the text displayed on the switch widget in the on state.
open Unit	`setSwitchTextOn(resId: Int)` Set the text displayed on the switch widget in the on state.

Inherited functions

From class Preference

`Boolean`	`callChangeListener(newValue: Any!)` Call this method after the user changes the preference, but before the internal state is set. This allows the client to ignore the user value.
`Int`	`compareTo(@NonNull other: Preference)` Compares preference objects based on order (if set), otherwise alphabetically on the titles.
`T?`	`findPreferenceInHierarchy(@NonNull key: String)` Finds a preference in the entire hierarchy (above or below this preference) with the given key. Returns `null` if no preference could be found with the given key. This only works after this preference has been attached to a hierarchy.
`Context!`	`getContext()` Returns the `Context` of this preference. Each preference in a preference hierarchy can be from different Context (for example, if multiple activities provide preferences into a single `PreferenceFragmentCompat`). This Context will be used to save the preference values.
`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. You can use this to get and set individual extra key/value pairs.
`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`.
`Int`	`getLayoutResource()` Gets the layout resource that will be shown as the `View</`