belongs to Maven artifact com.android.support:preference-v7:28.0.0-alpha1
Preference
public
class
Preference
extends Object
implements
Comparable<Preference>
java.lang.Object | |
↳ | android.support.v7.preference.Preference |
![]() |
![]() |
Represents the basic Preference UI building
block displayed by a PreferenceFragmentCompat
in the form of a
RecyclerView
. This class provides data for the
View
to be displayed
in the list and associates with a SharedPreferences
to
store/retrieve the preference data.
When specifying a preference hierarchy in XML, each element can point to a
subclass of Preference
, similar to the view hierarchy and layouts.
This class contains a key
that will be used as the key into the
SharedPreferences
. It is up to the subclass to decide how to store
the value.
Developer Guides
For information about building a settings UI with Preferences, read the Settings guide.
Summary
Nested classes | |
---|---|
class |
Preference.BaseSavedState
A base class for managing the instance state of a |
interface |
Preference.OnPreferenceChangeListener
Interface definition for a callback to be invoked when the value of this
|
interface |
Preference.OnPreferenceClickListener
Interface definition for a callback to be invoked when a |
XML attributes | |
---|---|
Preference_android_iconSpaceReserved |
|
Preference_android_singleLineTitle |
Constants | |
---|---|
int |
DEFAULT_ORDER
Specify for |
Public constructors | |
---|---|
Preference(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Perform inflation from XML and apply a class-specific base style. |
|
Preference(Context context, AttributeSet attrs, int defStyleAttr)
Perform inflation from XML and apply a class-specific base style. |
|
Preference(Context context, AttributeSet attrs)
Constructor that is called when inflating a Preference from XML. |
|
Preference(Context context)
Constructor to create a Preference. |
Public methods | |
---|---|
boolean
|
callChangeListener(Object newValue)
Call this method after the user changes the preference, but before the internal state is set. |
int
|
compareTo(Preference another)
Compares Preference objects based on order (if set), otherwise alphabetically on the titles. |
Context
|
getContext()
Returns the |
String
|
getDependency()
Returns the key of the dependency on this Preference. |
Bundle
|
getExtras()
Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one. |
String
|
getFragment()
Return the fragment class name associated with this Preference. |
Drawable
|
getIcon()
Returns the icon of this Preference. |
Intent
|
getIntent()
Return the |
String
|
getKey()
Gets the key for this Preference, which is also the key used for storing values into
|
final
int
|
getLayoutResource()
Gets the layout resource that will be shown as the |
Preference.OnPreferenceChangeListener
|
getOnPreferenceChangeListener()
Returns the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated). |
Preference.OnPreferenceClickListener
|
getOnPreferenceClickListener()
Returns the callback to be invoked when this Preference is clicked. |
int
|
getOrder()
Gets the order of this Preference with respect to other Preference objects on the same level. |
PreferenceGroup
|
getParent()
Returns the |
Set<String>
|
getPersistedStringSet(Set<String> defaultReturnValue)
Attempts to get a persisted set of Strings if this Preference is persistent. |
PreferenceDataStore
|
getPreferenceDataStore()
Returns |
PreferenceManager
|
getPreferenceManager()
Gets the |
SharedPreferences
|
getSharedPreferences()
Returns the |
boolean
|
getShouldDisableView()
Checks whether this Preference should disable its view when it's action is disabled. |
CharSequence
|
getSummary()
Returns the summary of this Preference. |
CharSequence
|
getTitle()
Returns the title of this Preference. |
final
int
|
getWidgetLayoutResource()
Gets the layout resource for the controllable widget portion of this Preference. |
boolean
|
hasKey()
Checks whether this Preference has a valid key. |
boolean
|
isEnabled()
Checks whether this Preference should be enabled in the list. |
boolean
|
isIconSpaceReserved()
Returns whether the space of this preference icon view is reserved. |
boolean
|
isPersistent()
Checks whether this Preference is persistent. |
boolean
|
isSelectable()
Checks whether this Preference should be selectable in the list. |
boolean
|
isSingleLineTitle()
Gets whether the title of this preference is constrained to a single line. |
final
boolean
|
isVisible()
Checks whether this preference should be visible to the user in the list. |
void
|
notifyDependencyChange(boolean disableDependents)
Notifies any listening dependents of a change that affects the dependency. |
void
|
onAttached()
Called when the Preference hierarchy has been attached to the list of preferences. |
void
|
onBindViewHolder(PreferenceViewHolder holder)
Binds the created View to the data for this Preference. |
void
|
onDependencyChanged(Preference dependency, boolean disableDependent)
Called when the dependency changes. |
void
|
onDetached()
Called when the Preference hierarchy has been detached from the list of preferences. |
void
|
onInitializeAccessibilityNodeInfo(AccessibilityNodeInfoCompat info)
Initializes an |
void
|
onParentChanged(Preference parent, boolean disableChild)
Called when the implicit parent dependency changes. |
Bundle
|
peekExtras()
Return the extras Bundle object associated with this preference, returning null if there is not currently one. |
boolean
|
persistStringSet(Set<String> values)
Attempts to persist a set of Strings if this Preference is persistent. |
void
|
restoreHierarchyState(Bundle container)
Restore this Preference hierarchy's previously saved state from the given container. |
void
|
saveHierarchyState(Bundle container)
Store this Preference hierarchy's frozen state into the given container. |
void
|
setDefaultValue(Object defaultValue)
Sets the default value for this Preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage. |
void
|
setDependency(String dependencyKey)
Sets the key of a Preference that this Preference will depend on. |
void
|
setEnabled(boolean enabled)
Sets whether this Preference is enabled. |
void
|
setFragment(String fragment)
Sets the class name of a fragment to be shown when this Preference is clicked. |
void
|
setIcon(Drawable icon)
Sets the icon for this Preference with a Drawable. |
void
|
setIcon(int iconResId)
Sets the icon for this Preference with a resource ID. |
void
|
setIconSpaceReserved(boolean iconSpaceReserved)
Sets whether to reserve the space of this Preference icon view when no icon is provided. |
void
|
setIntent(Intent intent)
Sets an |
void
|
setKey(String key)
Sets the key for this Preference, which is used as a key to the |
void
|
setLayoutResource(int layoutResId)
Sets the layout resource that is inflated as the |
void
|
setOnPreferenceChangeListener(Preference.OnPreferenceChangeListener onPreferenceChangeListener)
Sets the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated). |
void
|
setOnPreferenceClickListener(Preference.OnPreferenceClickListener onPreferenceClickListener)
Sets the callback to be invoked when this Preference is clicked. |
void
|
setOrder(int order)
Sets the order of this Preference with respect to other Preference objects on the same level. |
void
|
setPersistent(boolean persistent)
Sets whether this Preference is persistent. |
void
|
setPreferenceDataStore(PreferenceDataStore dataStore)
Sets a |
void
|
setSelectable(boolean selectable)
Sets whether this Preference is selectable. |
void
|
setShouldDisableView(boolean shouldDisableView)
Sets whether this Preference should disable its view when it gets disabled. |
void
|
setSingleLineTitle(boolean singleLineTitle)
Sets whether to constrain the title of this Preference to a single line instead of letting it wrap onto multiple lines. |
void
|
setSummary(CharSequence summary)
Sets the summary for this Preference with a CharSequence. |
void
|
setSummary(int summaryResId)
Sets the summary for this Preference with a resource ID. |
void
|
setTitle(CharSequence title)
Sets the title for this Preference with a CharSequence. |
void
|
setTitle(int titleResId)
Sets the title for this Preference with a resource ID. |
void
|
setViewId(int viewId)
Set the ID that will be assigned to the overall View representing this preference, once bound. |
final
void
|
setVisible(boolean visible)
Sets whether this preference should be visible in the list. |
void
|
setWidgetLayoutResource(int widgetLayoutResId)
Sets the layout for the controllable widget portion of this Preference. |
boolean
|
shouldDisableDependents()
Checks whether this preference's dependents should currently be disabled. |
String
|
toString()
|
Protected methods | |
---|---|
Preference
|
findPreferenceInHierarchy(String key)
Finds a Preference in this hierarchy (the whole thing,
even above/below your |
boolean
|
getPersistedBoolean(boolean defaultReturnValue)
Attempts to get a persisted |
float
|
getPersistedFloat(float defaultReturnValue)
Attempts to get a persisted |
int
|
getPersistedInt(int defaultReturnValue)
Attempts to get a persisted |
long
|
getPersistedLong(long defaultReturnValue)
Attempts to get a persisted |
String
|
getPersistedString(String defaultReturnValue)
Attempts to get a persisted set of Strings if this Preference is persistent. |
void
|
notifyChanged()
Should be called when the data of this |
void
|
notifyHierarchyChanged()
Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated. |
void
|
onAttachedToHierarchy(PreferenceManager preferenceManager)
Called when this Preference has been attached to a Preference hierarchy. |
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
|
onPrepareForRemoval()
Called when this Preference is being removed from the hierarchy. |
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 restorePersistedValue, Object defaultValue)
Implement this to set the initial value of the Preference. |
boolean
|
persistBoolean(boolean value)
Attempts to persist a |
boolean
|
persistFloat(float value)
Attempts to persist a |
boolean
|
persistInt(int value)
Attempts to persist an |
boolean
|
persistLong(long value)
Attempts to persist a |
boolean
|
persistString(String value)
Attempts to persist a |
boolean
|
shouldPersist()
Checks whether, at the given time this method is called, this Preference should store/restore
its value(s) into the |
Inherited methods | |
---|---|
![]()
java.lang.Object
| |
![]()
java.lang.Comparable
|
XML attributes
Preference_android_iconSpaceReserved
Related methods:
Preference_android_singleLineTitle
Related methods: