Android
android.preference
public class

android.preference.CheckBoxPreference

java.lang.Object
android.preference.Preference Comparable<T>
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. 
XML Attributes inherited from class android.preference.Preference
Constants inherited 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()
Should return whether this preference's dependents should currently be disabled.

Protected Methods

          void  onBindView(View view)
Binds the created View to the data for the preference.
          void  onClick()
Processes a click on the preference.
          Object  onGetDefaultValue(TypedArray a, int index)
Called when 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.
Methods inherited from class android.preference.Preference
Methods inherited from class java.lang.Object
Methods inherited from interface java.lang.Comparable

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.

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

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.

Parameters

state The frozen 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

  • 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.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48