Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
Added in API level 1
package

android.preference

Provides classes that manage application preferences and implement the preferences UI. Using these ensures that all the preferences within each application are maintained in the same manner and the user experience is consistent with that of the system and other applications.

The preferences portion of an application should be ran as a separate Activity that extends the PreferenceActivity class. In the PreferenceActivity, a PreferenceScreen object should be the root element of the layout. The PreferenceScreen contains Preference elements such as a CheckBoxPreference , EditTextPreference , ListPreference , PreferenceCategory , or RingtonePreference .

All settings made for a given Preference will be automatically saved to the application's instance of SharedPreferences . Access to the SharedPreferences is simple with getSharedPreferences() .

Note that saved preferences are accessible only to the application that created them.

Interfaces

Preference.OnPreferenceChangeListener Interface definition for a callback to be invoked when the value of this Preference 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. 
PreferenceFragment.OnPreferenceStartFragmentCallback Interface that PreferenceFragment's containing activity should implement to be able to process preference items that wish to switch to a new fragment. 
PreferenceManager.OnActivityDestroyListener Interface definition for a class that will be called when the container's activity is destroyed. 
PreferenceManager.OnActivityResultListener Interface definition for a class that will be called when the container's activity receives an activity result. 
PreferenceManager.OnActivityStopListener Interface definition for a class that will be called when the container's activity is stopped. 

Classes

CheckBoxPreference A Preference that provides checkbox widget functionality. 
DialogPreference A base class for Preference objects that are dialog-based. 
EditTextPreference A Preference that allows for string input. 
ListPreference A Preference that displays a list of entries as a dialog. 
MultiSelectListPreference A Preference that displays a list of entries as a dialog. 
Preference Represents the basic Preference UI building block displayed by a PreferenceActivity in the form of a ListView . 
Preference.BaseSavedState A base class for managing the instance state of a Preference . 
PreferenceActivity This is the base class for an activity to show a hierarchy of preferences to the user. 
PreferenceActivity.Header Description of a single Header item that the user can select. 
PreferenceCategory Used to group Preference objects and provide a disabled title above the group. 
PreferenceFragment Shows a hierarchy of Preference objects as lists. 
PreferenceGroup A container for multiple Preference objects. 
PreferenceManager Used to help create Preference hierarchies from activities or XML. 
PreferenceScreen Represents a top-level Preference that is the root of a Preference hierarchy. 
RingtonePreference A Preference that allows the user to choose a ringtone from those on the device. 
SwitchPreference A Preference that provides a two-state toggleable option. 
TwoStatePreference 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.