java.lang.Object | ||
android.preference.Preference | Comparable<T> |
The Preference class represents the basic preference UI building block that is displayed by a PreferenceActivity in the form of a ListView. This class provides the View to be displayed in the activity and associates with a SharedPreferences to store/retrieve the preference data.
When specifying a preference hierarchy in XML, each tag name 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.
Preference.BaseSavedState | |
Preference.OnPreferenceChangeListener | Interface definition for a callback to be invoked when this Preference's value has been changed by the user and is about to be set and/or persisted. |
Preference.OnPreferenceClickListener | Interface definition for a callback to be invoked when a preference is clicked. |
Attribute name | Related methods | |
---|---|---|
android:defaultValue | The default value for the preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage. | |
android:dependency | The key of another Preference that this Preference will depend on. | |
android:enabled | Whether the Preference is enabled. | |
android:key | The key to store the Preference value. | |
android:layout | The layout for the Preference in a PreferenceActivity screen. | |
android:order | The order for the Preference (lower values are to be ordered first). | |
android:persistent | Whether the Preference stores its value to the shared preferences. | |
android:selectable | Whether the Preference is selectable. | |
android:shouldDisableView | Whether the view of this Preference should be disabled when this Preference is disabled. | |
android:summary | The summary for the Preference in a PreferenceActivity screen. | |
android:title | The title for the Preference in a PreferenceActivity screen. | |
android:widgetLayout | The layout for the controllable widget portion of a Preference. |
Value | ||||
---|---|---|---|---|
int | DEFAULT_ORDER | Specify for setOrder(int) if a specific order is not required. | 2147483647 | 0x7fffffff |
Preference(Context context, AttributeSet attrs, int defStyle) | ||||||
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. |
int | compareTo(Preference another) | |||||
Compares preferences based on order (if set), otherwise alphabetically on title. | ||||||
Context | getContext() | |||||
Returns the context of this preference. | ||||||
String | getDependency() | |||||
Returns the key of the dependency on this preference. | ||||||
SharedPreferences.Editor | getEditor() | |||||
Returns an SharedPreferences.Editor where this preference can save its value(s). | ||||||
Intent | getIntent() | |||||
Return the Intent associated with this preference. | ||||||
String | getKey() | |||||
Gets the key for the preference, which is also the key used for storing values into SharedPreferences. | ||||||
int | getLayoutResource() | |||||
Gets the layout resource that will be shown as the View for this preference. | ||||||
Preference.OnPreferenceChangeListener | getOnPreferenceChangeListener() | |||||
Gets the callback to be invoked when this preference is changed by the user (but before the internal state has been updated). | ||||||
Preference.OnPreferenceClickListener | getOnPreferenceClickListener() | |||||
Gets the callback to be invoked when this preference is clicked. | ||||||
int | getOrder() | |||||
Gets the order of this Preference. | ||||||
PreferenceManager | getPreferenceManager() | |||||
Gets the PreferenceManager that manages this preference's tree. | ||||||
SharedPreferences | getSharedPreferences() | |||||
Returns the SharedPreferences where this preference can read its value(s). | ||||||
boolean | getShouldDisableView() | |||||
CharSequence | getSummary() | |||||
Returns the summary of the preference. | ||||||
CharSequence | getTitle() | |||||
Returns the title of the preference. | ||||||
View | getView(View convertView, ViewGroup parent) | |||||
Gets the View that will be shown in the PreferenceActivity. | ||||||
int | getWidgetLayoutResource() | |||||
Gets the layout resource for the controllable widget portion of a preference. | ||||||
boolean | hasKey() | |||||
Returns whether this Preference has a valid key. | ||||||
boolean | isEnabled() | |||||
Whether this Preference should be enabled in the list. | ||||||
boolean | isPersistent() | |||||
Returns whether this Preference is persistent. | ||||||
boolean | isSelectable() | |||||
Whether this Preference should be selectable in the list. | ||||||
void | notifyDependencyChange(boolean disableDependents) | |||||
Notifies any listening dependents of a change that affects the dependency. | ||||||
void | onDependencyChanged(Preference dependency, boolean disableDependent) | |||||
Called when the dependency changes. | ||||||
void | restoreHierarchyState(Bundle container) | |||||
Restore this preference hierarchy's frozen 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 the 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 | setIntent(Intent intent) | |||||
Sets an Intent to be used for startActivity(Intent) when the preference is clicked. | ||||||
void | setKey(String key) | |||||
Sets the key for the preference which is used as a key to the SharedPreferences. | ||||||
void | setLayoutResource(int layoutResId) | |||||
Sets the layout resource that is inflated as the View to be shown for this preference. | ||||||
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 on the same level. | ||||||
void | setPersistent(boolean persistent) | |||||
Sets whether this Preference is persistent. | ||||||
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 | setSummary(int summaryResId) | |||||
void | setSummary(CharSequence summary) | |||||
Sets the summary for the preference. | ||||||
void | setTitle(int titleResId) | |||||
void | setTitle(CharSequence title) | |||||
Sets the title for the preference. | ||||||
void | setWidgetLayoutResource(int widgetLayoutResId) | |||||
Sets The layout for the controllable widget portion of a preference. | ||||||
boolean | shouldCommit() | |||||
Returns whether the Preference should commit its saved value(s) in getEditor(). | ||||||
boolean | shouldDisableDependents() | |||||
Should return whether this preference's dependents should currently be disabled. | ||||||
String | toString() | |||||
Returns a string containing a concise, human-readable description of the receiver. |
boolean | callChangeListener(Object newValue) | |||||
Call this method after the user changes the preference, but before the internal state is set. | ||||||
Preference | findPreferenceInHierarchy(String key) | |||||
Find a Preference in this hierarchy (the whole thing, even above/below your PreferenceScreen screen break) with the given key. | ||||||
boolean | getPersistedBoolean(boolean defaultReturnValue) | |||||
Attempts to get a persisted boolean from the SharedPreferences. | ||||||
float | getPersistedFloat(float defaultReturnValue) | |||||
Attempts to get a persisted float from the SharedPreferences. | ||||||
int | getPersistedInt(int defaultReturnValue) | |||||
Attempts to get a persisted int from the SharedPreferences. | ||||||
long | getPersistedLong(long defaultReturnValue) | |||||
Attempts to get a persisted long from the SharedPreferences. | ||||||
String | getPersistedString(String defaultReturnValue) | |||||
Attempts to get a persisted String from the SharedPreferences. | ||||||
void | notifyChanged() | |||||
Should be called when the data of this Preference has changed. | ||||||
void | notifyHierarchyChanged() | |||||
Should be called this is a group a Preference has been added/removed from this group, or the ordering should be re-evaluated. | ||||||
void | onAttachedToActivity() | |||||
Called when the preference hierarchy has been attached to the PreferenceActivity. | ||||||
void | onAttachedToHierarchy(PreferenceManager preferenceManager) | |||||
Called when this preference has been attached to a preference hierarchy. | ||||||
void | onBindView(View view) | |||||
Binds the created View to the data for the preference. | ||||||
void | onClick() | |||||
Processes a click on the preference. | ||||||
View | onCreateView(ViewGroup parent) | |||||
Creates the View to be shown for this preference in the PreferenceActivity. | ||||||
Object | onGetDefaultValue(TypedArray a, int index) | |||||
Called when 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 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 restorePersistedValue, Object defaultValue) | |||||
Implement this to set the initial value of the Preference. | ||||||
boolean | persistBoolean(boolean value) | |||||
Attempts to persist a boolean to the SharedPreferences. | ||||||
boolean | persistFloat(float value) | |||||
Attempts to persist a float to the SharedPreferences. | ||||||
boolean | persistInt(int value) | |||||
Attempts to persist an int to the SharedPreferences. | ||||||
boolean | persistLong(long value) | |||||
Attempts to persist a long to the SharedPreferences. | ||||||
boolean | persistString(String value) | |||||
Attempts to persist a String to the SharedPreferences. | ||||||
boolean | shouldPersist() | |||||
Convenience method of whether at the given time this method is called, the Preference should store/restore its value(s) into the SharedPreferences. |
May be a reference to another resource, in the form "@[+][package:]type:name
"
or to a theme attribute in the form "?[package:][type:]name
".
May be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.
May be an integer value, such as "100
".
May be a boolean value, either "true
" or "false
".
May be a floating point value, such as "1.2
".
This corresponds to the global attribute resource symbol defaultValue.
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 dependency.
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 enabled.
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 key.
Must be a reference to another resource, in the form "@[+][package:]type:name
"
or to a theme attribute in the form "?[package:][type:]name
".
This corresponds to the global attribute resource symbol layout.
Must be an integer value, such as "100
".
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 order.
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 persistent.
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 selectable.
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 shouldDisableView.
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 summary.
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 title.
Must be a reference to another resource, in the form "@[+][package:]type:name
"
or to a theme attribute in the form "?[package:][type:]name
".
This corresponds to the global attribute resource symbol widgetLayout.
android.R.attr.checkBoxPreferenceStyle
for defStyle;
this allows the theme's checkbox preference style to modify all of the base
preference attributes as well as the CheckBoxPreference class's
attributes.
context | The Context this is associated with, through which it can access the current theme, resources, SharedPreferences, etc. |
---|---|
attrs | The attributes of the XML tag that is inflating the preference. |
defStyle | 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. |
context | The Context this is associated with, through which it can access the current theme, resources, SharedPreferences, etc. |
---|---|
attrs | The attributes of the XML tag that is inflating the preference. |
context | The context to store preference values. |
---|
In some cases, writes to this will not be committed right away and hence not show up in the shared preferences, this is intended behavior to improve performance.
In some cases, writes to the getEditor() will not be committed right away and hence not show up in the returned SharedPreferences, this is intended behavior to improve performance.
convertView | The old view to reuse, if possible. Note: You should check that this view is non-null and of an appropriate type before using. If it is not possible to convert this view to display the correct data, this method can create a new view. |
---|---|
parent | The parent that this view will eventually be attached to. |
disableDependents | Whether this Preference should disable its dependents. |
---|
dependency | The preference that this preference depends on. |
---|---|
disableDependent | Whether to disable this preference. |
container | The Bundle which holds previously frozen icicles. |
---|
container | The Bundle in which to save the preference's icicles. |
---|
defaultValue | The default value. |
---|
dependencyKey | The key of the Preference that this depends on. |
---|
enabled | Whether the preference is enabled. |
---|
intent | The intent associated with the preference. |
---|
key | The key for the preference. |
---|
This layout should contain a ViewGroup with ID widget_frame to be the parent of the specific widget for this preference. It should similarly contain title and summary.
layoutResId | The layout resource ID to be inflated and returned as a View. |
---|
onPreferenceChangeListener | The callback to be invoked. |
---|
onPreferenceClickListener | The callback to be invoked. |
---|
order | The order for this preference. A lower value will be shown first. Use DEFAULT_ORDER to sort alphabetically or allow ordering from XML. |
---|
persistent | Whether it should store its value(s) into the SharedPreferences. |
---|
selectable | Whether the preference is selectable. |
---|
For example, set this and setEnabled(boolean) to false for preferences that are only displaying information and 1) should not be clickable 2) should not have the view set to the disabled state.
shouldDisableView | Whether this preference should disable its view when the preference is disabled. |
---|
summaryResId | The summary as a resource. |
---|
summary | The summary of the preference. |
---|
titleResId | The title as a resource ID. |
---|
title | The title of the preference. |
---|
widgetLayoutResId | The layout resource ID to be inflated into the main layout. |
---|
newValue | The new value of the preference. |
---|
This only functions after we have been attached to a hierarchy.
key | The key of the Preference to find. |
---|
defaultReturnValue | The default value to return if either the Preference is not persistent or the Preference is not in the shared preferences. |
---|
defaultReturnValue | The default value to return if either the Preference is not persistent or the Preference is not in the shared preferences. |
---|
defaultReturnValue | The default value to return if either the Preference is not persistent or the Preference is not in the shared preferences. |
---|
defaultReturnValue | The default value to return if either the Preference is not persistent or the Preference is not in the shared preferences. |
---|
This will check if the Preference is persistent, get the shared preferences from the preference manager, get the value.
defaultReturnValue | The default value to return if either the Preference is not persistent or the Preference is not in the shared preferences. |
---|
preferenceManager | The preference manager of the hierarchy. |
---|
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.
view | The View that shows this preference. |
---|
Make sure to call through to the superclass's implementation.
parent | The parent that this view will eventually be attached to. |
---|
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. |
state | The frozen state that had previously been returned by onSaveInstanceState(). |
---|
This may not always be called. One example is if it should not persist but there is no default value given.
restorePersistedValue | Whether to restore the persisted value (true), or use the given default value (false). |
---|---|
defaultValue | The default value. Only use if restoreValue is false. |
value | The value to persist. |
---|
value | The value to persist. |
---|
value | The value to persist. |
---|
value | The value to persist. |
---|
This will check if the Preference is persistent, get an editor from the preference manager, put the string, check if we should commit (and commit if so).
value | The value to persist. |
---|
Copyright 2007 Google Inc. | Build 0.9_r1-98467 - 14 Aug 2008 18:56 |