TwoStatePreference


public abstract class TwoStatePreference
extends Preference

java.lang.Object
   ↳ android.preference.Preference
     ↳ android.preference.TwoStatePreference
CheckBoxPreference This class was deprecated in API level 29. Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings. 
SwitchPreference This class was deprecated in API level 29. Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings. 


This class was deprecated in API level 29.
Use the AndroidX Preference Library for consistent behavior across all devices. For more information on using the AndroidX Preference Library see Settings.

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

Summary

Inherited XML attributes

android:defaultValue The default value for the preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage. 
android:dependency The key of another Preference that this Preference will depend on. 
android:enabled Whether the Preference is enabled. 
android:fragment When used inside of a modern PreferenceActivity, this declares a new PreferenceFragment to be shown when the user selects this item. 
android:icon The optional icon for the preference. 
android:iconSpaceReserved Whether the space for the preference icon view will be reserved. 
android:key The key to store the Preference value. 
android:layout The layout for the Preference in a PreferenceActivity screen. 
android:order The order for the Preference (lower values are to be ordered first). 
android:persistent Whether the Preference stores its value to the storage. 
android:recycleEnabled Whether the preference has enabled to have its view recycled when used in the list view. 
android:selectable Whether the Preference is selectable. 
android:shouldDisableView Whether the view of this Preference should be disabled when this Preference is disabled. 
android:singleLineTitle Whether to use single line for the preference title text. 
android:summary The summary for the Preference. 
android:title The title for the Preference. 
android:widgetLayout The layout for the controllable widget portion of a Preference. 

Inherited constants

int DEFAULT_ORDER

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

Public constructors

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

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 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.

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

Implement this to set the initial value of the Preference.

Inherited methods

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.

SharedPreferences.Editor getEditor()

Returns an SharedPreferences.Editor where this Preference can save its value(s).

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.

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 int 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 String 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.

int getTitleRes()

Returns the title resource ID of this Preference.

View getView(View convertView, ViewGroup parent)

Gets the View that will be shown in the PreferenceActivity.

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

Gets whether the space this preference icon view is reserved.

boolean isPersistent()

Checks whether this Preference is persistent.

boolean isRecycleEnabled()

Checks whether this Preference has enabled to have its view recycled when used in the list view.

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.

void notifyChanged()

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

void notifyDependencyChange(boolean disableDependents)

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

void notifyHierarchyChanged()

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

void onAttachedToActivity()

Called when the Preference hierarchy has been attached to the PreferenceActivity.

void onAttachedToHierarchy(PreferenceManager preferenceManager)

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

void onBindView(View view)

Binds the created View to the data for this Preference.

void onClick()

Processes a click on the preference.

View onCreateView(ViewGroup parent)

Creates the View to be shown for this Preference in the PreferenceActivity.

void onDependencyChanged(Preference dependency, boolean disableDependent)

Called when the dependency changes.

Object onGetDefaultValue(TypedArray a, int index)

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

void onParentChanged(Preference parent, boolean disableChild)

Called when the implicit parent dependency changes.

void onPrepareForRemoval()

Called when this Preference is being removed from the hierarchy.

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 restorePersistedValue, Object defaultValue)

Implement this to set the initial value of the Preference.

Bundle peekExtras()

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

boolean persistBoolean(boolean value)

Attempts to persist a boolean if this Preference is persistent.

boolean persistFloat(float value)

Attempts to persist a long if this Preference is persistent.

boolean persistInt(int value)

Attempts to persist an int if this Preference is persistent.

boolean persistLong(long value)

Attempts to persist a long if this Preference is persistent.

boolean persistString(String value)

Attempts to persist a String if this Preference is persistent.

boolean persistStringSet(Set<String> values)

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

void restoreHierarchyState(Bundle container)

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

void saveHierarchyState(Bundle container)

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

void setDefaultValue(Object defaultValue)

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.

void setDependency(String dependencyKey)

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

void setEnabled(boolean enabled)

Sets whether this Preference is enabled.

void setFragment(String fragment)

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

void setIcon(Drawable icon)

Sets the icon for this Preference with a Drawable.

void setIcon(int iconResId)

Sets the icon for this Preference with a resource ID.

void setIconSpaceReserved(boolean iconSpaceReserved)

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

void setIntent(Intent intent)

Sets an Intent to be used for Context.startActivity(Intent) when this Preference is clicked.

void setKey(String key)

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

void setLayoutResource(int layoutResId)

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

void setOnPreferenceChangeListener(Preference.OnPreferenceChangeListener onPreferenceChangeListener)

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

void setOnPreferenceClickListener(Preference.OnPreferenceClickListener onPreferenceClickListener)

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

void setOrder(int order)

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

void setPersistent(boolean persistent)

Sets whether this Preference is persistent.

void setPreferenceDataStore(PreferenceDataStore dataStore)

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

void setRecycleEnabled(boolean enabled)

Sets whether this Preference has enabled to have its view recycled when used in the list view.

void setSelectable(boolean selectable)

Sets whether this Preference is selectable.

void setShouldDisableView(boolean shouldDisableView)

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

void setSingleLineTitle(boolean singleLineTitle)

Sets whether to constrain the title of this Preference to a single line instead of letting it wrap onto multiple lines.

void setSummary(CharSequence summary)

Sets the summary for this Preference with a CharSequence.

void setSummary(int summaryResId)

Sets the summary for this Preference with a resource ID.

void setTitle(CharSequence title)

Sets the title for this Preference with a CharSequence.

void setTitle(int titleResId)

Sets the title for this Preference with a resource ID.

void setWidgetLayoutResource(int widgetLayoutResId)

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

boolean shouldCommit()

Returns whether the Preference should commit its saved value(s) in getEditor().

boolean shouldDisableDependents()

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

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.

String toString()

Returns a string representation of the object.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract int compareTo(Preference o)

Compares this object with the specified object for order.

Public constructors

TwoStatePreference

Added in API level 14
public TwoStatePreference (Context context)

Parameters
context Context

TwoStatePreference

Added in API level 14
public TwoStatePreference (Context context, 
                AttributeSet attrs)

Parameters
context Context

attrs AttributeSet

TwoStatePreference

Added in API level 14
public TwoStatePreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

TwoStatePreference

Added in API level 21
public TwoStatePreference (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
context Context

attrs AttributeSet

defStyleAttr int

defStyleRes int

Public methods

getDisableDependentsState

Added in API level 14
public boolean getDisableDependentsState ()

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 API level 14
public CharSequence getSummaryOff ()

Returns the summary to be shown when unchecked.

Returns
CharSequence The summary.

getSummaryOn

Added in API level 14
public CharSequence getSummaryOn ()

Returns the summary to be shown when checked.

Returns
CharSequence The summary.

isChecked

Added in API level 14
public boolean isChecked ()

Returns the checked state.

Returns
boolean The checked state.

setChecked

Added in API level 14
public void setChecked (boolean checked)

Sets the checked state and saves it to the SharedPreferences.

Parameters
checked boolean: The checked state.

setDisableDependentsState

Added in API level 14
public void setDisableDependentsState (boolean disableDependentsState)

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 API level 14
public void setSummaryOff (CharSequence summary)

Sets the summary to be shown when unchecked.

Parameters
summary CharSequence: The summary to be shown when unchecked.

setSummaryOff

Added in API level 14
public void setSummaryOff (int summaryResId)

Parameters
summaryResId int: The summary as a resource.

setSummaryOn

Added in API level 14
public void setSummaryOn (int summaryResId)

Parameters
summaryResId int: The summary as a resource.

setSummaryOn

Added in API level 14
public void setSummaryOn (CharSequence summary)

Sets the summary to be shown when checked.

Parameters
summary CharSequence: The summary to be shown when checked.

shouldDisableDependents

Added in API level 14
public boolean shouldDisableDependents ()

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

Returns
boolean True if the dependents should be disabled, otherwise false.

Protected methods

onClick

Added in API level 14
protected void onClick ()

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

onGetDefaultValue

Added in API level 14
protected Object onGetDefaultValue (TypedArray a, 
                int index)

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 TypedArray.getString(int).

Parameters
a TypedArray: The set of attributes.

index int: The index of the default value attribute.

Returns
Object The default value of this preference type.

onRestoreInstanceState

Added in API level 14
protected void onRestoreInstanceState (Parcelable state)

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

Added in API level 14
protected 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. 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

Added in API level 14
protected void onSetInitialValue (boolean restoreValue, 
                Object defaultValue)

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.

Parameters
restoreValue boolean: True to restore the persisted value; false to use the given defaultValue.

defaultValue Object: The default value for this Preference. Only use this if restorePersistedValue is false.