belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1
TwoStatePreference
public
abstract
class
TwoStatePreference
extends Preference
java.lang.Object | ||
↳ | android.support.v7.preference.Preference | |
↳ | android.support.v7.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.
Summary
Inherited XML attributes | |
---|---|
From
class
android.support.v7.preference.Preference
|
Inherited constants |
---|
From
class
android.support.v7.preference.Preference
|
Fields | |
---|---|
protected
boolean |
mChecked
|
Public constructors | |
---|---|
TwoStatePreference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
|
|
TwoStatePreference(Context context, AttributeSet attrs, int defStyleAttr)
|
|
TwoStatePreference(Context context, AttributeSet attrs)
|
|
TwoStatePreference(Context context)
|
Public methods | |
---|---|
boolean
|
getDisableDependentsState()
Returns whether dependents are disabled when this preference is on ( |
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 |
void
|
setDisableDependentsState(boolean disableDependentsState)
Sets whether dependents are disabled when this preference is on ( |
void
|
setSummaryOff(CharSequence summary)
Sets the summary to be shown when unchecked. |
void
|
setSummaryOff(int summaryResId)
|
void
|
setSummaryOn(int summaryResId)
|
void
|
setSummaryOn(CharSequence summary)
Sets the summary to be shown when checked. |
boolean
|
shouldDisableDependents()
Checks whether this preference's dependents should currently be disabled. |
Protected methods | |
---|---|
void
|
onClick()
Processes a click on the preference. |
Object
|
onGetDefaultValue(TypedArray a, int index)
Called when a 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 |
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. |
void
|
syncSummaryView(PreferenceViewHolder holder)
Sync a summary holder contained within holder's subhierarchy with the correct summary text. |
Inherited methods | |
---|---|
From
class
android.support.v7.preference.Preference
| |
From
class
java.lang.Object
| |
From
interface
java.lang.Comparable
|
Fields
Public constructors
TwoStatePreference
TwoStatePreference (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
defStyleRes |
int |
TwoStatePreference
TwoStatePreference (Context context, AttributeSet attrs, int defStyleAttr)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
TwoStatePreference
TwoStatePreference (Context context, AttributeSet attrs)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
TwoStatePreference
TwoStatePreference (Context context)
Parameters | |
---|---|
context |
Context |
Public methods
getDisableDependentsState
boolean getDisableDependentsState ()
Returns whether dependents are disabled when this preference is on (true
)
or when this preference is off (false
).
Returns | |
---|---|
boolean |
Whether dependents are disabled when this preference is on (true )
or when this preference is off (false ).
|
getSummaryOff
CharSequence getSummaryOff ()
Returns the summary to be shown when unchecked.
Returns | |
---|---|
CharSequence |
The summary. |
getSummaryOn
CharSequence getSummaryOn ()
Returns the summary to be shown when checked.
Returns | |
---|---|
CharSequence |
The summary. |
isChecked
boolean isChecked ()
Returns the checked state.
Returns | |
---|---|
boolean |
The checked state. |
setChecked
void setChecked (boolean checked)
Sets the checked state and saves it to the SharedPreferences
.
Parameters | |
---|---|
checked |
boolean : The checked state.
|
setDisableDependentsState
void setDisableDependentsState (boolean disableDependentsState)
Sets whether dependents are disabled when this preference is on (true
)
or when this preference is off (false
).
Parameters | |
---|---|
disableDependentsState |
boolean : The preference state that should disable dependents.
|
setSummaryOff
void setSummaryOff (CharSequence summary)
Sets the summary to be shown when unchecked.
Parameters | |
---|---|
summary |
CharSequence : The summary to be shown when unchecked.
|
setSummaryOff
void setSummaryOff (int summaryResId)
Parameters | |
---|---|
summaryResId |
int : The summary as a resource.
|
See also:
setSummaryOn
void setSummaryOn (int summaryResId)
Parameters | |
---|---|
summaryResId |
int : The summary as a resource.
|
See also:
setSummaryOn
void setSummaryOn (CharSequence summary)
Sets the summary to be shown when checked.
Parameters | |
---|---|
summary |
CharSequence : The summary to be shown when checked.
|
shouldDisableDependents
boolean shouldDisableDependents ()
Checks whether this preference's dependents should currently be disabled.
Returns | |
---|---|
boolean |
True if the dependents should be disabled, otherwise false. |
Protected methods
onClick
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.
onGetDefaultValue
Object onGetDefaultValue (TypedArray a, int index)
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)
.
Parameters | |
---|---|
a |
TypedArray : The set of attributes. |
index |
int : The index of the default value attribute. |
Returns | |
---|---|
Object |
The default value of this preference type. |
onRestoreInstanceState
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 state.
Parameters | |
---|---|
state |
Parcelable : The saved state that had previously been returned by
onSaveInstanceState() . |
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. This state should only contain information that is not persistent or can be reconstructed later.
Returns | |
---|---|
Parcelable |
A Parcelable object containing the current dynamic state of this Preference, or null if there is nothing interesting to save. The default implementation returns null. |
onSetInitialValue
void onSetInitialValue (boolean restoreValue, Object defaultValue)
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).
In case of using PreferenceDataStore
, the restorePersistedValue is
always true
but the default value (if provided) is set.
This may not always be called. One example is if it should not persist but there is no default value given.
Parameters | |
---|---|
restoreValue |
boolean : True to restore the persisted value;
false to use the given defaultValue. |
defaultValue |
Object : The default value for this Preference. Only use this
if restorePersistedValue is false.
|
syncSummaryView
void syncSummaryView (PreferenceViewHolder holder)
Sync a summary holder contained within holder's subhierarchy with the correct summary text.
Parameters | |
---|---|
holder |
PreferenceViewHolder : PreferenceViewHolder which holds a reference to the summary view
|
Interfaces
- DialogPreference.TargetFragment
- Preference.OnPreferenceChangeListener
- Preference.OnPreferenceClickListener
- PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback
- PreferenceFragmentCompat.OnPreferenceStartFragmentCallback
- PreferenceFragmentCompat.OnPreferenceStartScreenCallback
- PreferenceGroup.PreferencePositionCallback
- PreferenceManager.OnDisplayPreferenceDialogListener
- PreferenceManager.OnNavigateToScreenListener
- PreferenceManager.OnPreferenceTreeClickListener
Classes
- CheckBoxPreference
- DialogPreference
- DropDownPreference
- EditTextPreference
- EditTextPreferenceDialogFragmentCompat
- ListPreference
- ListPreferenceDialogFragmentCompat
- MultiSelectListPreferenceDialogFragmentCompat
- Preference
- Preference.BaseSavedState
- PreferenceCategory
- PreferenceDataStore
- PreferenceDialogFragmentCompat
- PreferenceFragmentCompat
- PreferenceGroup
- PreferenceManager
- PreferenceManager.PreferenceComparisonCallback
- PreferenceManager.SimplePreferenceComparisonCallback
- PreferenceScreen
- PreferenceViewHolder
- R
- R.anim
- R.attr
- R.bool
- R.color
- R.dimen
- R.drawable
- R.id
- R.integer
- R.layout
- R.string
- R.style
- R.styleable
- SeekBarPreference
- SwitchPreferenceCompat
- TwoStatePreference