Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

CheckBoxPreference

extends TwoStatePreference
java.lang.Object
   ↳ android.preference.Preference
     ↳ android.preference.TwoStatePreference
       ↳ 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)
Protected Methods
void onBindView ( View view)
Binds the created View to the data for this Preference.
[Expand]
Inherited Methods
From class android.preference.TwoStatePreference
From class android.preference.Preference
From class java.lang.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)

Added in API level 1

public CheckBoxPreference ( Context context, AttributeSet attrs)

Added in API level 1

public CheckBoxPreference ( Context context)

Added in API level 1

Protected Methods

protected void onBindView ( View view)

Added in API level 1

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.