java.lang.Object | ||
↳ | android.preference.Preference | |
↳ | android.preference.TwoStatePreference |
Known Direct Subclasses |
Common base class for preferences that have two selectable states, persist a boolean value in SharedPreferences, and may have dependent preferences that are enabled/disabled based on the current state.
[Expand]
Inherited XML Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.preference.Preference
|
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.preference.Preference
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
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.
| |||||||||||
Returns the checked state.
| |||||||||||
Sets the checked state and saves it to the
SharedPreferences . | |||||||||||
Sets whether dependents are disabled when this preference is on (
true )
or when this preference is off (false ). | |||||||||||
Sets the summary to be shown when unchecked.
| |||||||||||
Sets the summary to be shown when checked.
| |||||||||||
Checks whether this preference's dependents should currently be
disabled.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Processes a click on the preference.
| |||||||||||
Called when a Preference is being inflated and the default value
attribute needs to be read.
| |||||||||||
Hook allowing a Preference to re-apply a representation of its internal
state that had previously been generated by
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.
| |||||||||||
Implement this to set the initial value of the Preference.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.preference.Preference
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
|
Returns whether dependents are disabled when this preference is on (true
)
or when this preference is off (false
).
true
)
or when this preference is off (false
).
Returns the summary to be shown when unchecked.
Returns the summary to be shown when checked.
Returns the checked state.
Sets the checked state and saves it to the SharedPreferences
.
checked | The checked state. |
---|
Sets whether dependents are disabled when this preference is on (true
)
or when this preference is off (false
).
disableDependentsState | The preference state that should disable dependents. |
---|
Sets the summary to be shown when unchecked.
summary | The summary to be shown when unchecked. |
---|
Sets the summary to be shown when checked.
summary | The summary to be shown when checked. |
---|
Checks whether this preference's dependents should currently be disabled.
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.
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)
.
a | The set of attributes. |
---|---|
index | The index of the default value attribute. |
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.
state | The saved state that had previously been returned by
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.
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.
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. |