TwoStatePreference

public abstract class TwoStatePreference
extends Preference

java.lang.Object
   ↳ androidx.preference.Preference
     ↳ androidx.preference.TwoStatePreference


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

Fields

protected boolean mChecked

Public constructors

TwoStatePreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
TwoStatePreference(Context context, AttributeSet attrs, int defStyleAttr)
TwoStatePreference(Context context, AttributeSet attrs)
TwoStatePreference(Context context)

Public methods

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 setChecked(boolean checked)

Sets the checked state and saves it.

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.

Protected methods

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(Object defaultValue)

Implement this to set the initial value of the preference.

void syncSummaryView(PreferenceViewHolder holder)

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

Inherited methods