de.mrapp.android.preference

Class AbstractTwoStatePreference

java.lang.Object

android.preference.Preference

de.mrapp.android.preference.AbstractTwoStatePreference

All Implemented Interfaces:

java.lang.Comparable<android.preference.Preference>

Direct Known Subclasses:

SwitchPreference

public abstract class AbstractTwoStatePreference
extends android.preference.Preference

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

Since:

1.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTwoStatePreference.SavedState A data structure, which allows to save the internal state of an AbstractTwoStatePreference.

Nested classes/interfaces inherited from class android.preference.Preference

android.preference.Preference.BaseSavedState, android.preference.Preference.OnPreferenceChangeListener, android.preference.Preference.OnPreferenceClickListener

Field Summary

Fields inherited from class android.preference.Preference

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
AbstractTwoStatePreference(android.content.Context context) Creates a new preference, which has two selectable states.
AbstractTwoStatePreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which has two selectable states.
AbstractTwoStatePreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which has two selectable states.
AbstractTwoStatePreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which has two selectable states.

Method Summary

Modifier and Type	Method and Description
boolean	getDisableDependentsState() Returns, whether dependent preferences are disabled when this preference is checked, or when this preference is not checked.
java.lang.CharSequence	getSummary()
java.lang.CharSequence	getSummaryOff() Returns the summary, which is shown when the preference is not checked.
java.lang.CharSequence	getSummaryOn() Returns the summary, which is shown when the preference is checked.
boolean	isChecked() Returns, whether the preference is currently checked, or not.
protected void	onClick()
protected java.lang.Object	onGetDefaultValue(android.content.res.TypedArray typedArray, int index)
protected void	onRestoreInstanceState(android.os.Parcelable state)
protected android.os.Parcelable	onSaveInstanceState()
protected void	onSetInitialValue(boolean restoreValue, java.lang.Object defaultValue)
void	setChecked(boolean checked) Sets, whether the preference should currently be checked, or not.
void	setDisableDependentsState(boolean disableDependentsState) Sets, whether dependent preferences should be disabled when this preference is checked, or when this preference is not checked.
void	setSummaryOff(java.lang.CharSequence summaryOff) Sets the summary, which should be shown when the preference is not checked.
void	setSummaryOff(int resourceId) Sets the summary, which should be shown when the preference is not checked.
void	setSummaryOn(java.lang.CharSequence summaryOn) Sets the summary, which should be shown when the preference is checked.
void	setSummaryOn(int resourceId) Sets the summary, which should be shown when the preference is checked.
boolean	shouldDisableDependents()

Methods inherited from class android.preference.Preference

callChangeListener, compareTo, findPreferenceInHierarchy, getContext, getDependency, getEditor, getExtras, getFragment, getIcon, getIntent, getKey, getLayoutResource, getOnPreferenceChangeListener, getOnPreferenceClickListener, getOrder, getPersistedBoolean, getPersistedFloat, getPersistedInt, getPersistedLong, getPersistedString, getPreferenceManager, getSharedPreferences, getShouldDisableView, getTitle, getTitleRes, getView, getWidgetLayoutResource, hasKey, isEnabled, isPersistent, isSelectable, notifyChanged, notifyDependencyChange, notifyHierarchyChanged, onAttachedToActivity, onAttachedToHierarchy, onBindView, onCreateView, onDependencyChanged, onParentChanged, onPrepareForRemoval, peekExtras, persistBoolean, persistFloat, persistInt, persistLong, persistString, restoreHierarchyState, saveHierarchyState, setDefaultValue, setDependency, setEnabled, setFragment, setIcon, setIcon, setIntent, setKey, setLayoutResource, setOnPreferenceChangeListener, setOnPreferenceClickListener, setOrder, setPersistent, setSelectable, setShouldDisableView, setSummary, setSummary, setTitle, setTitle, setWidgetLayoutResource, shouldCommit, shouldPersist, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractTwoStatePreference

public AbstractTwoStatePreference(android.content.Context context)

Creates a new preference, which has two selectable states.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

AbstractTwoStatePreference

public AbstractTwoStatePreference(android.content.Context context,
                                  android.util.AttributeSet attributeSet)

Creates a new preference, which has two selectable states.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the type AttributeSet or null, if no attributes are available

AbstractTwoStatePreference

public AbstractTwoStatePreference(android.content.Context context,
                                  android.util.AttributeSet attributeSet,
                                  int defaultStyle)

Creates a new preference, which has two selectable states.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the type AttributeSet or null, if no attributes are available

defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond what is included in the theme). This may either be an attribute resource, whose value will be retrieved from the current theme, or an explicit style resource

AbstractTwoStatePreference

public AbstractTwoStatePreference(android.content.Context context,
                                  android.util.AttributeSet attributeSet,
                                  int defaultStyle,
                                  int defaultStyleResource)

Creates a new preference, which has two selectable states.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the type AttributeSet or null, if no attributes are available

defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond what is included in the theme). This may either be an attribute resource, whose value will be retrieved from the current theme, or an explicit style resource

defaultStyleResource - A resource identifier of a style resource that supplies default values for the preference, used only if the default style is 0 or can not be found in the theme. Can be 0 to not look for defaults

Method Detail

isChecked

public final boolean isChecked()

Returns, whether the preference is currently checked, or not.

Returns:

True, if the preference is currently checked, false otherwise.

setChecked

public final void setChecked(boolean checked)

Sets, whether the preference should currently be checked, or not. When setting a value, it will be persisted.

Parameters:

checked - True, if the preference should be checked, false otherwise

getSummaryOn

public final java.lang.CharSequence getSummaryOn()

Returns the summary, which is shown when the preference is checked.

Returns:

The summary, which is shown when the preference is checked, as an instance of the type CharSequence or null, if no dedicated summary is shown when the preference is checked

setSummaryOn

public final void setSummaryOn(java.lang.CharSequence summaryOn)

Sets the summary, which should be shown when the preference is checked.

Parameters:

summaryOn - The summary, which should be set, as an instance of the type CharSequence or null, if no dedicated summary should be shown when the preference is checked

setSummaryOn

public final void setSummaryOn(int resourceId)

Sets the summary, which should be shown when the preference is checked.

Parameters:

resourceId - The resource id of the summary, which should be set, as an Integer value. The resource id must correspond to a valid string resource

getSummaryOff

public final java.lang.CharSequence getSummaryOff()

Returns the summary, which is shown when the preference is not checked.

Returns:

The summary, which is shown when the preference is not checked, as an instance of the type CharSequence or null, if no dedicated summary is shown when the preference is not checked

setSummaryOff

public final void setSummaryOff(int resourceId)

Sets the summary, which should be shown when the preference is not checked.

Parameters:

resourceId - The resource id of the summary, which should be set, as an Integer value. The resource id must correspond to a valid string resource

setSummaryOff

public final void setSummaryOff(java.lang.CharSequence summaryOff)

Sets the summary, which should be shown when the preference is not checked.

Parameters:

summaryOff - The summary, which should be set, as an instance of the type CharSequence or null, if no dedicated summary should be shown when the preference is not checked

getDisableDependentsState

public final boolean getDisableDependentsState()

Returns, whether dependent preferences are disabled when this preference is checked, or when this preference is not checked.

Returns:

True, if dependent preferences are disabled when this preference checked, false, if they are disabled when this preference is not checked

setDisableDependentsState

public final void setDisableDependentsState(boolean disableDependentsState)

Sets, whether dependent preferences should be disabled when this preference is checked, or when this preference is not checked.

Parameters:

disableDependentsState - True, if dependent preferences should be disabled when this preference is checked, false, if they should be disabled when this preference is not checked

shouldDisableDependents

public final boolean shouldDisableDependents()

Overrides:

shouldDisableDependents in class android.preference.Preference

getSummary

public final java.lang.CharSequence getSummary()

Overrides:

getSummary in class android.preference.Preference

onGetDefaultValue

protected final java.lang.Object onGetDefaultValue(android.content.res.TypedArray typedArray,
                                                   int index)

Overrides:

onGetDefaultValue in class android.preference.Preference

onSetInitialValue

protected final void onSetInitialValue(boolean restoreValue,
                                       java.lang.Object defaultValue)

Overrides:

onSetInitialValue in class android.preference.Preference

onClick

protected final void onClick()

Overrides:

onClick in class android.preference.Preference

onSaveInstanceState

protected final android.os.Parcelable onSaveInstanceState()

Overrides:

onSaveInstanceState in class android.preference.Preference

onRestoreInstanceState

protected final void onRestoreInstanceState(android.os.Parcelable state)

Overrides:

onRestoreInstanceState in class android.preference.Preference