android.preference.CheckBoxPreference
The CheckBoxPreference is a preference that provides checkbox widget
functionality.
This preference will store a boolean into the SharedPreferences.
Summary
XML Attributes
Attribute name |
Related methods |
|
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. |
android:defaultValue,
android:dependency,
android:enabled,
android:key,
android:layout,
android:order,
android:persistent,
android:selectable,
android:shouldDisableView,
android:summary,
android:title,
android:widgetLayout
Attribute name |
Related methods |
|
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: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 shared preferences. |
android:selectable |
|
Whether the Preference is selectable. |
android:shouldDisableView |
|
Whether the view of this Preference should be disabled when
this Preference is disabled. |
android:summary |
|
The summary for the Preference in a PreferenceActivity screen. |
android:title |
|
The title for the Preference in a PreferenceActivity screen. |
android:widgetLayout |
|
The layout for the controllable widget portion of a Preference. |
Public Constructors
Public Methods
Protected Methods
callChangeListener,
compareTo,
findPreferenceInHierarchy,
getContext,
getDependency,
getEditor,
getIntent,
getKey,
getLayoutResource,
getOnPreferenceChangeListener,
getOnPreferenceClickListener,
getOrder,
getPersistedBoolean,
getPersistedFloat,
getPersistedInt,
getPersistedLong,
getPersistedString,
getPreferenceManager,
getSharedPreferences,
getShouldDisableView,
getSummary,
getTitle,
getView,
getWidgetLayoutResource,
hasKey,
isEnabled,
isPersistent,
isSelectable,
notifyChanged,
notifyDependencyChange,
notifyHierarchyChanged,
onAttachedToActivity,
onAttachedToHierarchy,
onBindView,
onClick,
onCreateView,
onDependencyChanged,
onGetDefaultValue,
onPrepareForRemoval,
onRestoreInstanceState,
onSaveInstanceState,
onSetInitialValue,
persistBoolean,
persistFloat,
persistInt,
persistLong,
persistString,
restoreHierarchyState,
saveHierarchyState,
setDefaultValue,
setDependency,
setEnabled,
setIntent,
setKey,
setLayoutResource,
setOnPreferenceChangeListener,
setOnPreferenceClickListener,
setOrder,
setPersistent,
setSelectable,
setShouldDisableView,
setSummary,
setSummary,
setTitle,
setTitle,
setWidgetLayoutResource,
shouldCommit,
shouldDisableDependents,
shouldPersist,
toString
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
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.
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.
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.
Public Constructors
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
).
Returns the summary to be shown when unchecked.
Returns the summary to be shown when checked.
public
boolean
isChecked()
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()
Should return 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 the 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
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 icicle.
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
- Returns a Parcelable object containing the preference's current
dynamic state, 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 the
restoreValue flag is true, you should restore the value from the shared
preferences. If false, you should set (and possibly store to shared
preferences if
shouldPersist()) to defaultValue.
This may not always be called. One example is if it should not persist
but there is no default value given.
Parameters
restoreValue
| Whether to restore the persisted value
(true), or use the given default value (false). |
defaultValue
| The default value. Only use if restoreValue is false.
|