TwoStatePreference

abstract class TwoStatePreference : Preference

Known direct subclasses
CheckBoxPreference

A Preference that provides checkbox widget functionality.

SwitchPreferenceCompat

A Preference that provides a two-state toggleable option.

SwitchPreference

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

Public constructors

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

Public functions

Boolean

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

CharSequence?

Returns the summary to be shown when unchecked.

CharSequence?

Returns the summary to be shown when checked.

Boolean

Returns the checked state.

Unit
setChecked(checked: Boolean)

Sets the checked state and saves it.

Unit
setDisableDependentsState(disableDependentsState: Boolean)

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

Unit

Sets the summary to be shown when unchecked.

Unit
setSummaryOff(summaryResId: Int)
Unit

Sets the summary to be shown when checked.

Unit
setSummaryOn(summaryResId: Int)
Boolean

Checks whether this preference's dependents should currently be disabled.

Protected functions

Unit

Processes a click on the preference.

Any?

Called when a preference is being inflated and the default value attribute needs to be read.

Unit

Hook allowing a preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState.

Parcelable?

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.

Unit
onSetInitialValue(defaultValue: Any!)

Implement this to set the initial value of the preference.

Unit

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

Protected properties

Boolean

Inherited Constants

From androidx.preference.Preference
const Int
DEFAULT_ORDER = 2147483647

Specify for setOrder if a specific order is not required.

Inherited functions

From java.lang.Comparable
abstract Int
compareTo(p: T!)
From androidx.preference.Preference
Boolean
callChangeListener(newValue: Any!)

Call this method after the user changes the preference, but before the internal state is set.

Int

Compares preference objects based on order (if set), otherwise alphabetically on the titles.

T?

Finds a preference in the entire hierarchy (above or below this preference) with the given key.

Context

Returns the Context of this preference.

String?

Returns the key of the dependency on this preference.

Bundle

Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one.

String?

Return the fragment class name associated with this preference.

Drawable?

Returns the icon of this preference.

Intent?

Return the Intent associated with this preference.

String!

Gets the key for this preference, which is also the key used for storing values into SharedPreferences or PreferenceDataStore.

Int

Gets the layout resource that will be shown as the View for this preference.

Preference.OnPreferenceChangeListener?

Returns the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).

Preference.OnPreferenceClickListener?

Returns the callback to be invoked when this preference is clicked.

Int

Gets the order of this preference with respect to other preference objects on the same level.

PreferenceGroup?

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(defaultReturnValue: Boolean)

Attempts to get a persisted Boolean if this preference is persistent.

Float
getPersistedFloat(defaultReturnValue: Float)

Attempts to get a persisted Float if this preference is persistent.

Int
getPersistedInt(defaultReturnValue: Int)

Attempts to get a persisted Integer if this preference is persistent.

Long
getPersistedLong(defaultReturnValue: Long)

Attempts to get a persisted Long if this preference is persistent.

String!
getPersistedString(defaultReturnValue: String!)

Attempts to get a persisted set of Strings if this preference is persistent.

(Mutable)Set<String!>!
getPersistedStringSet(defaultReturnValue: (Mutable)Set<String!>!)

Attempts to get a persisted set of Strings if this preference is persistent.

PreferenceDataStore?

Returns PreferenceDataStore used by this preference.

PreferenceManager!

Gets the PreferenceManager that manages this preference object's tree.

SharedPreferences?

Returns the SharedPreferences where this preference can read its value(s).

Boolean

Checks whether this preference should disable its view when it's action is disabled.

CharSequence?

Returns the summary of this preference.

Preference.SummaryProvider?

Returns the SummaryProvider used to configure the summary of this preference.

CharSequence?

Returns the title of this preference.

Int

Gets the layout resource for the controllable widget portion of this preference.

Boolean

Checks whether this preference has a valid key.

Boolean

Returns whether the summary of this preference can be copied to the clipboard by long pressing on the preference.

Boolean

Checks whether this preference should be enabled in the list.

Boolean

Returns whether the space of this preference icon view is reserved.

Boolean

Checks whether this preference is persistent.

Boolean

Checks whether this preference should be selectable in the list.

Boolean

Checks whether this preference is shown to the user in the hierarchy.

Boolean

Gets whether the title of this preference is constrained to a single line.

Boolean

Checks whether this preference should be visible to the user.

Unit

Should be called when the data of this Preference has changed.

Unit
notifyDependencyChange(disableDependents: Boolean)

Notifies any listening dependents of a change that affects the dependency.

Unit

Should be called when a preference has been added/removed from this group, or the ordering should be re-evaluated.

Unit

Called when the preference hierarchy has been attached to the list of preferences.

Unit

Called when this preference has been attached to a preference hierarchy.

Unit

Binds the created View to the data for this preference.

Unit
onDependencyChanged(dependency: Preference, disableDependent: Boolean)

Called when the dependency changes.

Unit

Called when the preference hierarchy has been detached from the list of preferences.

Unit

This function is deprecated.

Preferences aren't views.

Unit
onParentChanged(parent: Preference, disableChild: Boolean)

Called when the implicit parent dependency changes.

Unit

Called when this preference is being removed from the hierarchy.

Unit
onSetInitialValue(restorePersistedValue: Boolean, defaultValue: Any!)

This function is deprecated.

Use onSetInitialValue instead.

Bundle?

Return the extras Bundle object associated with this preference, returning null if there is not currently one.

Boolean

Attempts to persist a Boolean if this preference is persistent.

Boolean

Attempts to persist a Float if this preference is persistent.

Boolean
persistInt(value: Int)

Attempts to persist an Integer if this preference is persistent.

Boolean
persistLong(value: Long)

Attempts to persist a Long if this preference is persistent.

Boolean

Attempts to persist a String if this preference is persistent.

Boolean

Attempts to persist a set of Strings if this preference is persistent.

Unit

Restore this preference hierarchy's previously saved state from the given container.

Unit

Store this preference hierarchy's frozen state into the given container.

Unit

Sets whether the summary of this preference can be copied to the clipboard by long pressing on the preference.

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.

Unit
setDependency(dependencyKey: String?)

Sets the key of a preference that this preference will depend on.

Unit
setEnabled(enabled: Boolean)

Sets whether this preference is enabled.

Unit
setFragment(fragment: String?)

Sets the class name of a fragment to be shown when this preference is clicked.

Unit
setIcon(icon: Drawable?)

Sets the icon for this preference with a Drawable.

Unit
setIcon(iconResId: Int)

Sets the icon for this preference with a resource ID.

Unit
setIconSpaceReserved(iconSpaceReserved: Boolean)

Sets whether to reserve the space of this preference icon view when no icon is provided.

Unit
setIntent(intent: Intent?)

Sets an Intent to be used for startActivity when this preference is clicked.

Unit
setKey(key: String!)

Sets the key for this preference, which is used as a key to the SharedPreferences or PreferenceDataStore.

Unit
setLayoutResource(layoutResId: Int)

Sets the layout resource that is inflated as the View to be shown for this preference.

Unit

Sets the callback to be invoked when this preference is changed by the user (but before the internal state has been updated).

Unit

Sets the callback to be invoked when this preference is clicked.

Unit
setOrder(order: Int)

Sets the order of this preference with respect to other preference objects on the same level.

Unit
setPersistent(persistent: Boolean)

Sets whether this preference is persistent.

Unit

Sets a PreferenceDataStore to be used by this preference instead of using SharedPreferences.

Unit
setSelectable(selectable: Boolean)

Sets whether this preference is selectable.

Unit
setShouldDisableView(shouldDisableView: Boolean)

Sets whether this preference should disable its view when it gets disabled.

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

Sets the summary for this preference with a CharSequence.

Unit
setSummary(summaryResId: Int)

Sets the summary for this preference with a resource ID.

Unit

Set a SummaryProvider that will be invoked whenever the summary of this preference is requested.

Unit

Sets the title for this preference with a CharSequence.

Unit
setTitle(titleResId: Int)

Sets the title for this preference with a resource ID.

Unit
setViewId(viewId: Int)

Set the ID that will be assigned to the overall View representing this preference, once bound.

Unit
setVisible(visible: Boolean)

Sets whether this preference should be visible to the user.

Unit
setWidgetLayoutResource(widgetLayoutResId: Int)

Sets the layout for the controllable widget portion of this preference.

Boolean

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.

String

Public constructors

TwoStatePreference

Added in 1.0.0
TwoStatePreference(context: Context)

TwoStatePreference

Added in 1.0.0
TwoStatePreference(context: Context, attrs: AttributeSet?)

TwoStatePreference

Added in 1.0.0
TwoStatePreference(
    context: Context,
    attrs: AttributeSet?,
    defStyleAttr: Int
)

TwoStatePreference

Added in 1.0.0
TwoStatePreference(
    context: Context,
    attrs: AttributeSet?,
    defStyleAttr: Int,
    defStyleRes: Int
)

Public functions

getDisableDependentsState

Added in 1.0.0
fun getDisableDependentsState(): Boolean

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

Returns
Boolean

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

getSummaryOff

Added in 1.0.0
fun getSummaryOff(): CharSequence?

Returns the summary to be shown when unchecked.

Returns
CharSequence?

The summary

getSummaryOn

Added in 1.0.0
fun getSummaryOn(): CharSequence?

Returns the summary to be shown when checked.

Returns
CharSequence?

The summary

isChecked

Added in 1.0.0
fun isChecked(): Boolean

Returns the checked state.

Returns
Boolean

The checked state

setChecked

Added in 1.0.0
fun setChecked(checked: Boolean): Unit

Sets the checked state and saves it.

Parameters
checked: Boolean

The checked state

setDisableDependentsState

Added in 1.0.0
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

setSummaryOff

Added in 1.0.0
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

Added in 1.0.0
fun setSummaryOff(summaryResId: Int): Unit
Parameters
summaryResId: Int

The summary as a resource

See also
setSummaryOff

setSummaryOn

Added in 1.0.0
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

Added in 1.0.0
fun setSummaryOn(summaryResId: Int): Unit
Parameters
summaryResId: Int

The summary as a resource

See also
setSummaryOn

shouldDisableDependents

fun shouldDisableDependents(): Boolean

Checks whether this preference's dependents should currently be disabled.

Returns
Boolean

true if the dependents should be disabled, otherwise false

Protected functions

onClick

protected fun onClick(): Unit

Processes a click on the preference. This includes saving the value to the SharedPreferences. However, the overridden method should call callChangeListener to make sure the client wants to update the preference's state with the new value.

onGetDefaultValue

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

Called when a preference is being inflated and the default value attribute needs to be read. Since different preference types have different value types, the subclass should get and return the default value which will be its value type.

For example, if the value type is String, the body of the method would proxy to getString.

Parameters
a: TypedArray

The set of attributes

index: Int

The index of the default value attribute

Returns
Any?

The default value of this preference type

onRestoreInstanceState

protected fun onRestoreInstanceState(state: Parcelable?): Unit

Hook allowing a preference to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState. This function will never be called with a null state.

Parameters
state: Parcelable?

The saved state that had previously been returned by onSaveInstanceState.

onSaveInstanceState

protected fun onSaveInstanceState(): Parcelable?

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. This state should only contain information that is not persistent or can be reconstructed later.

Returns
Parcelable?

A Parcelable object containing the current dynamic state of this preference, or null if there is nothing interesting to save. The default implementation returns null.

onSetInitialValue

protected fun onSetInitialValue(defaultValue: Any!): Unit

Implement this to set the initial value of the preference.

If you are persisting values to SharedPreferences or a PreferenceDataStore you should restore the saved value for the preference.

If you are not persisting values, or there is no value saved for the preference, you should set the value of the preference to defaultValue.

Parameters
defaultValue: Any!

The default value for the preference if set, otherwise null.

syncSummaryView

Added in 1.0.0
protected 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

Protected properties

mChecked

Added in 1.0.0
protected val mCheckedBoolean