TwoStatePreference

abstract class TwoStatePreference : Preference

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

Known Direct Subclasses

CheckBoxPreference, SwitchPreference, SwitchPreferenceCompat

CheckBoxPreference	A `Preference` that provides checkbox widget functionality.
SwitchPreference	A `Preference` that provides a two-state toggleable option.
SwitchPreferenceCompat	A `Preference` that provides a two-state toggleable option.

Common base class for preferences that have two selectable states, save a boolean value, and may have dependent preferences that are enabled/disabled based on the current state.

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)`
`<init>(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)`
`<init>(context: Context!, attrs: AttributeSet!)`
`<init>(context: Context!)`

Public methods
open CharSequence!	`getSummaryOn()` Returns the summary to be shown when checked.
open Boolean	`getDisableDependentsState()` Returns whether dependents are disabled when this preference is on (`true`) or when this preference is off (`false`).
open Unit	`setSummaryOff(summary: CharSequence!)` Sets the summary to be shown when unchecked.
open Unit	`setSummaryOff(summaryResId: Int)`
open Unit	`setChecked(checked: Boolean)` Sets the checked state and saves it.
open Unit	`setDisableDependentsState(disableDependentsState: Boolean)` Sets whether dependents are disabled when this preference is on (`true`) or when this preference is off (`false`).
open CharSequence!	`getSummaryOff()` Returns the summary to be shown when unchecked.
open Boolean	`isChecked()` Returns the checked state.
open Unit	`setSummaryOn(summary: CharSequence!)` Sets the summary to be shown when checked.
open Unit	`setSummaryOn(summaryResId: Int)`
open Boolean	`shouldDisableDependents()`

Protected methods
open Unit	`onClick()`
open Parcelable!	`onSaveInstanceState()`
open Unit	`syncSummaryView(holder: PreferenceViewHolder!)` Sync a summary holder contained within holder's sub-hierarchy with the correct summary text.
open Unit	`onRestoreInstanceState(state: Parcelable!)`
open Any!	`onGetDefaultValue(a: TypedArray!, index: Int)`
open Unit	`onSetInitialValue(defaultValue: Any?)`

Inherited functions

From class Preference

`Boolean`	`isSelectable()` Checks whether this preference should be selectable in the list.
`Boolean`	`getPersistedBoolean(defaultReturnValue: Boolean)` Attempts to get a persisted `Boolean` if this preference is persistent.
`Preference.OnPreferenceClickListener!`	`getOnPreferenceClickListener()` Returns the callback to be invoked when this preference is clicked.
`Boolean`	`isSingleLineTitle()` Gets whether the title of this preference is constrained to a single line.
`Unit`	`notifyChanged()` Should be called when the data of this `Preference` has changed.
`Boolean`	`persistLong(value: Long)` Attempts to persist a `Long` if this preference is persistent. The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.
`Boolean`	`persistBoolean(value: Boolean)` Attempts to persist a `Boolean` if this preference is persistent. The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.
`Unit`	`setFragment(fragment: String!)` Sets the class name of a fragment to be shown when this preference is clicked.
`Preference.SummaryProvider<Preference!>?`	`getSummaryProvider()` Returns the `SummaryProvider` used to configure the summary of this 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.
`Unit`	`setEnabled(enabled: Boolean)` Sets whether this preference is enabled. If disabled, it will not handle clicks.
`Boolean`	`persistString(value: String!)` Attempts to persist a `String` if this preference is persistent. The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.
`Boolean`	`shouldPersist()` Checks whether, at the given time this method is called, this preference should store/restore its value(s) into the `SharedPreferences` or into `PreferenceDataStore` if assigned. This, at minimum, checks whether this preference is persistent and it currently has a key. Before you save/restore from the storage, check this first.
`SharedPreferences!`	`getSharedPreferences()` Returns the `SharedPreferences` where this preference can read its value(s). Usually, it's easier to use one of the helper read methods: `getPersistedBoolean(boolean)`, `getPersistedFloat(float)`, `getPersistedInt(int)`, `getPersistedLong(long)`, `getPersistedString(String)`.
`Unit`	`onAttached()` Called when the preference hierarchy has been attached to the list of preferences. This can also be called when this preference has been attached to a group that was already attached to the list of preferences.
`Unit`	`setSummaryProvider(@Nullable summaryProvider: Preference.SummaryProvider<Preference!>?)` Set a `SummaryProvider` that will be invoked whenever the summary of this preference is requested. Set `null` to remove the existing SummaryProvider.
`Intent!`	`getIntent()` Return the `Intent` associated with this preference.
`String!`	`getPersistedString(defaultReturnValue: String!)` Attempts to get a persisted set of Strings if this preference is persistent.
`Unit`	`onDependencyChanged(dependency: Preference!, disableDependent: Boolean)` Called when the dependency changes.
`Unit`	`setLayoutResource(layoutResId: Int)` Sets the layout resource that is inflated as the `View` to be shown for this preference. In most cases, the default layout is sufficient for custom preference objects and only the widget layout needs to be changed. This layout should contain a `ViewGroup` with ID `android.R.id#widget_frame` to be the parent of the specific widget for this preference. It should similarly contain `android.R.id#title` and `android.R.id#summary`. It is an error to change the layout after adding the preference to a `PreferenceGroup`.
`Boolean`	`isVisible()` Checks whether this preference should be visible to the user. If this preference is visible, but one or more of its ancestors are not visible, then this preference will not be shown until its ancestors are all visible.
`Boolean`	`persistInt(value: Int)` Attempts to persist an `Integer` if this preference is persistent. The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.
`Unit`	`setWidgetLayoutResource(widgetLayoutResId: Int)` Sets the layout for the controllable widget portion of this preference. This is inflated into the main layout. For example, a `CheckBoxPreference` would specify a custom layout (consisting of just the CheckBox) here, instead of creating its own main layout. It is an error to change the layout after adding the preference to a `PreferenceGroup`.
`Unit`	`setIcon(icon: Drawable!)` Sets the icon for this preference with a Drawable. This icon will be placed into the ID `android.R.id#icon` within the View created by `onBindViewHolder(PreferenceViewHolder)`.
`Unit`	`setIcon(iconResId: Int)` Sets the icon for this preference with a resource ID.
`Unit`	`setKey(key: String!)` Sets the key for this preference, which is used as a key to the `SharedPreferences` or `PreferenceDataStore`. This should be unique for the package.
`Unit`	`setOrder(order: Int)` Sets the order of this preference with respect to other preference objects on the same level. If this is not specified, the default behavior is to sort alphabetically. The `PreferenceGroup#setOrderingAsAdded(boolean)` can be used to order preference objects based on the order they appear in the XML.
`Unit`	`setDefaultValue(defaultValue: Any!)` Sets the default value for this preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.
`Drawable!`	`getIcon()` Returns the icon of this preference.
`Boolean`	`isPersistent()` Checks whether this preference is persistent. If it is, it stores its value(s) into the persistent `SharedPreferences` storage by default or into `PreferenceDataStore` if assigned.
`Int`	`compareTo(@NonNull other: Preference)` Compares preference objects based on order (if set), otherwise alphabetically on the titles.
`Int`	`getPersistedInt(defaultReturnValue: Int)` Attempts to get a persisted `Integer` if this preference is persistent.
`Unit`	`onBindViewHolder(holder: PreferenceViewHolder!)` 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.
`Unit`	`setOnPreferenceClickListener(onPreferenceClickListener: Preference.OnPreferenceClickListener!)` Sets the callback to be invoked when this preference is clicked.
`Float`	`getPersistedFloat(defaultReturnValue: Float)` Attempts to get a persisted `Float` if this preference is persistent.
`Unit`	`setOnPreferenceChangeListener(onPreferenceChangeListener: Preference.OnPreferenceChangeListener!)` Sets the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).
`String!`	`getKey()` Gets the key for this preference, which is also the key used for storing values into `SharedPreferences` or `PreferenceDataStore`.
`Boolean`	`isCopyingEnabled()` Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference.
`Boolean`	`persistFloat(value: Float)` Attempts to persist a `Float` if this preference is persistent. The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.
`PreferenceManager!`	`getPreferenceManager()` Gets the `PreferenceManager` that manages this preference object's tree.
`Boolean`	`isShown()` Checks whether this preference is shown to the user in the hierarchy. For a preference to be shown in the hierarchy, it and all of its ancestors must be visible and attached to the root `PreferenceScreen`.
`Unit`	`notifyHierarchyChanged()` Should be called when a preference has been added/removed from this group, or the ordering should be re-evaluated.
`Boolean`	`getShouldDisableView()` Checks whether this preference should disable its view when it's action is disabled.
`Int`	`getLayoutResource()` Gets the layout resource that will be shown as the `View` for this preference.
`Unit`	`setSelectable(selectable: Boolean)` Sets whether this preference is selectable.
`Unit`	`saveHierarchyState(container: Bundle!)` Store this preference hierarchy's frozen state into the given container.
`Unit`	`setShouldDisableView(shouldDisableView: Boolean)` Sets whether this preference should disable its view when it gets disabled. For example, set this and `setEnabled(boolean)` to false for preferences that are only displaying information and 1) should not be clickable 2) should not have the view set to the disabled state.
`Unit`	`setTitle(title: CharSequence!)` Sets the title for this preference with a CharSequence. This title will be placed into the ID `android.R.id#title` within the View bound by `onBindViewHolder(PreferenceViewHolder)`.
`Unit`	`setTitle(titleResId: Int)` Sets the title for this preference with a resource ID.
`Unit`	`onDetached()` Called when the preference hierarchy has been detached from the list of preferences. This can also be called when this preference has been removed from a group that was attached to the list of preferences.
`T`	`findPreferenceInHierarchy(key: String!)` Finds a preference in this hierarchy (the whole thing, even above/below your `PreferenceScreen` screen break) with the given key. This only functions after we have been attached to a hierarchy.
`CharSequence!`	`getTitle()` Returns the title of this preference.
`PreferenceDataStore?`	`getPreferenceDataStore()` Returns `PreferenceDataStore` used by this preference. Returns `null` if `SharedPreferences` is used instead. By default preferences always use `SharedPreferences`. To make this preference to use the `PreferenceDataStore` you need to assign your implementation to the preference itself via `setPreferenceDataStore(PreferenceDataStore)` or to its `PreferenceManager` via `PreferenceManager#setPreferenceDataStore(PreferenceDataStore)`.
`Unit`	`notifyDependencyChange(disableDependents: Boolean)` Notifies any listening dependents of a change that affects the dependency.
`Int`	`getOrder()` Gets the order of this preference with respect to other preference objects on the same level.
`String!`	`getDependency()` Returns the key of the dependency on this preference.
`Boolean`	`isIconSpaceReserved()` Returns whether the space of this preference icon view is reserved.
`Unit`	`setPersistent(persistent: Boolean)` Sets whether this preference is persistent. When persistent, it stores its value(s) into the persistent `SharedPreferences` storage by default or into `PreferenceDataStore` if assigned.
`String`	`toString()`
`Long`	`getPersistedLong(defaultReturnValue: Long)` Attempts to get a persisted `Long` if this preference is persistent.
`Unit`	`setCopyingEnabled(enabled: Boolean)` Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference.
`Unit`	`setVisible(visible: Boolean)` Sets whether this preference should be visible to the user. If false, it is excluded from the adapter, but can still be retrieved using `PreferenceFragmentCompat#findPreference(CharSequence)`. To show this preference to the user, its ancestors must also all be visible. If you make a `PreferenceGroup` invisible, none of its children will be shown to the user until the group is visible.
`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.
`Boolean`	`isEnabled()` Checks whether this preference should be enabled in the list.
`Unit`	`onAttachedToHierarchy(preferenceManager: PreferenceManager!)` Called when this preference has been attached to a preference hierarchy. Make sure to call the super implementation.
`Bundle!`	`peekExtras()` Return the extras Bundle object associated with this preference, returning `null` if there is not currently one.
`Unit`	`setPreferenceDataStore(dataStore: PreferenceDataStore!)` Sets a `PreferenceDataStore` to be used by this preference instead of using `SharedPreferences`. The data store will remain assigned even if the preference is moved around the preference hierarchy. It will also override a data store propagated from the `PreferenceManager` that owns this preference.
`Unit`	`restoreHierarchyState(container: Bundle!)` Restore this preference hierarchy's previously saved state from the given container.
`Unit`	`setSummary(summary: CharSequence!)` Sets the summary for this preference with a CharSequence. You can also use a `SummaryProvider` to dynamically configure the summary of this preference.
`Unit`	`setSummary(summaryResId: Int)` Sets the summary for this preference with a resource ID. You can also use a `SummaryProvider` to dynamically configure the summary of this preference.
`Boolean`	`hasKey()` Checks whether this preference has a valid key.
`Unit`	`onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfoCompat!)` Initializes an `android.view.accessibility.AccessibilityNodeInfo` with information about the View for this preference.
`Int`	`getWidgetLayoutResource()` Gets the layout resource for the controllable widget portion of this preference.
`MutableSet<String!>!`	`getPersistedStringSet(defaultReturnValue: MutableSet<String!>!)` Attempts to get a persisted set of Strings if this preference is persistent.
`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.
`Unit`	`onParentChanged(parent: Preference!, disableChild: Boolean)` Called when the implicit parent dependency changes.
`Unit`	`setViewId(viewId: Int)` Set the ID that will be assigned to the overall View representing this preference, once bound.
`Unit`	`setIntent(intent: Intent!)` Sets an `Intent` to be used for `Context#startActivity(Intent)` when this preference is clicked.
`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).
`String!`	`getFragment()` Return the fragment class name associated with this preference.
`Unit`	`setIconSpaceReserved(iconSpaceReserved: Boolean)` Sets whether to reserve the space of this preference icon view when no icon is provided. If set to true, the preference will be offset as if it would have the icon and thus aligned with other preferences having icons.
`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`	`persistStringSet(values: MutableSet<String!>!)` Attempts to persist a set of Strings if this preference is persistent. The returned value doesn't reflect whether the given value was persisted, since we may not necessarily commit if there will be a batch commit later.
`Unit`	`onPrepareForRemoval()` Called when this preference is being removed from the hierarchy. You should remove any references to this preference that you know about. Make sure to call through to the superclass implementation.
`Unit`	`setSingleLineTitle(singleLineTitle: Boolean)` Sets whether to constrain the title of this preference to a single line instead of letting it wrap onto multiple lines.
`Unit`	`setDependency(dependencyKey: String!)` Sets the key of a preference that this preference will depend on. If that preference is not set or is off, this preference will be disabled.
`CharSequence!`	`getSummary()` Returns the summary of this preference. If a `SummaryProvider` has been set for this preference, it will be used to provide the summary returned by this method.
`Unit`	`onSetInitialValue(restorePersistedValue: Boolean, defaultValue: Any!)` Implement this to set the initial value of the preference. If restorePersistedValue is true, you should restore the preference value from the `SharedPreferences`. If restorePersistedValue is false, you should set the preference value to defaultValue that is given (and possibly store to SharedPreferences if `shouldPersist()` is true). In case of using `PreferenceDataStore`, the restorePersistedValue is always `true` but the default value (if provided) is set. This may not always be called. One example is if it should not persist but there is no default value given.

Properties
Boolean	`mChecked`

Public constructors

<init>

TwoStatePreference(context: Context!, attrs: AttributeSet!, defStyleAttr: Int, defStyleRes: Int)

<init>

TwoStatePreference(context: Context!, attrs: AttributeSet!, defStyleAttr: Int)

<init>

TwoStatePreference(context: Context!, attrs: AttributeSet!)

<init>

TwoStatePreference(context: Context!)

Public methods

getSummaryOn

open fun getSummaryOn(): CharSequence!

Returns the summary to be shown when checked.

Return
CharSequence!: The summary

getDisableDependentsState

open fun getDisableDependentsState(): Boolean

Returns whether dependents are disabled when this preference is on (true) or when this preference is off (false).

Return
Boolean: Whether dependents are disabled when this preference is on (`true`) or when this preference is off (`false`).

setSummaryOff

open fun setSummaryOff(summary: CharSequence!): Unit

Sets the summary to be shown when unchecked.

For more complex configuration of this preference's summary, you should use a Preference.SummaryProvider

Parameters
`summary`	CharSequence!: The summary to be shown when unchecked

setSummaryOff

open fun setSummaryOff(summaryResId: Int): Unit

Parameters
`summaryResId`	Int: The summary as a resource

See Also

#setSummaryOff(CharSequence)

setChecked

open fun setChecked(checked: Boolean): Unit

Sets the checked state and saves it.

Parameters
`checked`	Boolean: The checked state

setDisableDependentsState

open fun setDisableDependentsState(disableDependentsState: Boolean): Unit

Sets whether dependents are disabled when this preference is on (true) or when this preference is off (false).

Parameters
`disableDependentsState`	Boolean: The preference state that should disable dependents

getSummaryOff

open fun getSummaryOff(): CharSequence!

Returns the summary to be shown when unchecked.

Return
CharSequence!: The summary

isChecked

open fun isChecked(): Boolean

Returns the checked state.

Return
Boolean: The checked state

setSummaryOn

open fun setSummaryOn(summary: CharSequence!): Unit

Sets the summary to be shown when checked.

For more complex configuration of this preference's summary, you should use a Preference.SummaryProvider

Parameters
`summary`	CharSequence!: The summary to be shown when checked

setSummaryOn

open fun setSummaryOn(summaryResId: Int): Unit

Parameters
`summaryResId`	Int: The summary as a resource

See Also

#setSummaryOn(CharSequence)

shouldDisableDependents

open fun shouldDisableDependents(): Boolean

Protected methods

onClick

protected open fun onClick(): Unit

onSaveInstanceState

protected open fun onSaveInstanceState(): Parcelable!

syncSummaryView

protected open fun syncSummaryView(holder: PreferenceViewHolder!): Unit

Sync a summary holder contained within holder's sub-hierarchy with the correct summary text.

Parameters
`holder`	PreferenceViewHolder!: A `PreferenceViewHolder` which holds a reference to the summary view

onRestoreInstanceState

protected open fun onRestoreInstanceState(state: Parcelable!): Unit

onGetDefaultValue

protected open fun onGetDefaultValue(a: TypedArray!, index: Int): Any!

onSetInitialValue

protected open fun onSetInitialValue(defaultValue: Any?): Unit

Properties

mChecked

protected var mChecked: Boolean