public class

CheckBoxPreference

extends Preference

java.lang.Object
↳	android.preference.Preference
	↳	android.preference.CheckBoxPreference

Class Overview

A Preference that provides checkbox widget functionality.

This preference will store a boolean into the SharedPreferences.

Summary

XML Attributes
Attribute Name	Related Method	Description
android:disableDependentsState		The state (true for on, or false for off) that causes dependents to be disabled.
android:summaryOff		The summary for the Preference in a PreferenceActivity screen when the CheckBoxPreference is unchecked.
android:summaryOn		The summary for the Preference in a PreferenceActivity screen when the CheckBoxPreference is checked.

[Expand]

Inherited XML Attributes

From class android.preference.Preference

[Expand]

Inherited Constants

From class android.preference.Preference

Public Constructors
	CheckBoxPreference(Context context, AttributeSet attrs, int defStyle)
	CheckBoxPreference(Context context, AttributeSet attrs)
	CheckBoxPreference(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 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(CharSequence summary) Sets the summary to be shown when checked.
void	setSummaryOn(int summaryResId)
boolean	shouldDisableDependents() Checks whether this preference's dependents should currently be disabled.

Protected Methods
void	onBindView(View view) Binds the created View to the data for this Preference.
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.

[Expand]

Inherited Methods

From class android.preference.Preference

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).
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.
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.
boolean	getPersistedBoolean(boolean defaultReturnValue) Attempts to get a persisted boolean from the SharedPreferences.
float	getPersistedFloat(float defaultReturnValue) Attempts to get a persisted float from the SharedPreferences.
int	getPersistedInt(int defaultReturnValue) Attempts to get a persisted int from the SharedPreferences.
long	getPersistedLong(long defaultReturnValue) Attempts to get a persisted long from the SharedPreferences.
String	getPersistedString(String defaultReturnValue) Attempts to get a persisted String from the SharedPreferences.
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.
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	isPersistent() Checks whether this Preference is persistent.
boolean	isSelectable() Checks whether this Preference should be selectable in the list.
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	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.
boolean	persistBoolean(boolean value) Attempts to persist a boolean to the SharedPreferences.
boolean	persistFloat(float value) Attempts to persist a float to the SharedPreferences.
boolean	persistInt(int value) Attempts to persist an int to the SharedPreferences.
boolean	persistLong(long value) Attempts to persist a long to the SharedPreferences.
boolean	persistString(String value) Attempts to persist a String to the SharedPreferences.
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	setIntent(Intent intent) Sets an Intent to be used for 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.
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	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	setSummary(int summaryResId) Sets the summary for this Preference with a resource ID.
void	setSummary(CharSequence summary) Sets the summary for this Preference with a CharSequence.
void	setTitle(int titleResId) Sets the title for this Preference with a resource ID.
void	setTitle(CharSequence title) Sets the title for this Preference with a CharSequence.
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.
String	toString() Returns a string containing a concise, human-readable description of this object.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of Class which represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

From interface java.lang.Comparable

XML Attributes

android:disableDependentsState

The state (true for on, or false for off) that causes dependents to be disabled. By default, dependents will be disabled when this is unchecked, so the value of this preference is false.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol disableDependentsState.

Related Methods

android:summaryOff

The summary for the Preference in a PreferenceActivity screen when the CheckBoxPreference is unchecked. If separate on/off summaries are not needed, the summary attribute can be used instead.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol summaryOff.

Related Methods

android:summaryOn

The summary for the Preference in a PreferenceActivity screen when the CheckBoxPreference is checked. If separate on/off summaries are not needed, the summary attribute can be used instead.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol summaryOn.

Related Methods

Public Constructors

public CheckBoxPreference (Context context, AttributeSet attrs, int defStyle)

public CheckBoxPreference (Context context, AttributeSet attrs)

public CheckBoxPreference (Context context)

Public Methods

public boolean getDisableDependentsState ()

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

Returns

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

public CharSequence getSummaryOff ()

Returns the summary to be shown when unchecked.

Returns

The summary.

public CharSequence getSummaryOn ()

Returns the summary to be shown when checked.

Returns

The summary.

public boolean isChecked ()

Returns the checked state.

Returns

The checked state.

public void setChecked (boolean checked)

Sets the checked state and saves it to the SharedPreferences.

Parameters

checked	The checked state.

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	The preference state that should disable dependents.

public void setSummaryOff (CharSequence summary)

Sets the summary to be shown when unchecked.

Parameters

summary	The summary to be shown when unchecked.

public void setSummaryOff (int summaryResId)

Parameters

summaryResId	The summary as a resource.

public void setSummaryOn (CharSequence summary)

Sets the summary to be shown when checked.

Parameters

summary	The summary to be shown when checked.

public void setSummaryOn (int summaryResId)

Parameters

summaryResId	The summary as a resource.

public boolean shouldDisableDependents ()

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

Returns

True if the dependents should be disabled, otherwise false.

Protected Methods

protected void onBindView (View view)

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.

Parameters

view	The View that shows this Preference.

protected void onClick ()

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

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

Parameters

a	The set of attributes.
index	The index of the default value attribute.

Returns

The default value of this preference type.

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	The saved state that had previously been returned by onSaveInstanceState().

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

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.

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

This may not always be called. One example is if it should not persist but there is no default value given.

Parameters

restoreValue	True to restore the persisted value; false to use the given `defaultValue`.
defaultValue	The default value for this Preference. Only use this if `restorePersistedValue` is false.

Interfaces

Classes

CheckBoxPreference

Class Overview

Summary

XML Attributes

android:disableDependentsState

Related Methods

android:summaryOff

Related Methods

android:summaryOn

Related Methods

Public Constructors

public CheckBoxPreference (Context context, AttributeSet attrs, int defStyle)

public CheckBoxPreference (Context context, AttributeSet attrs)

public CheckBoxPreference (Context context)

Public Methods

public boolean getDisableDependentsState ()

Returns

public CharSequence getSummaryOff ()

Returns

public CharSequence getSummaryOn ()

Returns

public boolean isChecked ()

Returns

public void setChecked (boolean checked)

Parameters

public void setDisableDependentsState (boolean disableDependentsState)

Parameters

public void setSummaryOff (CharSequence summary)

Parameters

public void setSummaryOff (int summaryResId)

Parameters

See Also

public void setSummaryOn (CharSequence summary)

Parameters

public void setSummaryOn (int summaryResId)

Parameters

See Also

public boolean shouldDisableDependents ()

Returns

Protected Methods

protected void onBindView (View view)

Parameters

protected void onClick ()

protected Object onGetDefaultValue (TypedArray a, int index)

Parameters

Returns

protected void onRestoreInstanceState (Parcelable state)

Parameters

protected Parcelable onSaveInstanceState ()

Returns

protected void onSetInitialValue (boolean restoreValue, Object defaultValue)

Parameters