Android 2.3 Gingerbread

Package android.preference

Provides classes that manage application preferences and implement the preferences UI.

See:
          Description

Interface Summary
GenericInflater.Factory<T>  
GenericInflater.Parent<T>  
OnDependencyChangeListener Interface definition for a callback to be invoked when this Preference changes with respect to enabling/disabling dependents.
Preference.OnPreferenceChangeInternalListener Interface definition for a callback to be invoked when this Preference is changed or, if this is a group, there is an addition/removal of Preference(s).
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.
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.
PreferenceManager.OnPreferenceTreeClickListener Interface definition for a callback to be invoked when a Preference in the hierarchy rooted at this PreferenceScreen is clicked.
 

Class Summary
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.
GenericInflater<T,P extends GenericInflater.Parent> Generic XML inflater.
ListPreference 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 Shows a hierarchy of Preference objects as lists, possibly spanning multiple screens.
PreferenceCategory Used to group Preference objects and provide a disabled title above the group.
PreferenceGroup A container for multiple Preference objects.
PreferenceGroupAdapter An adapter that returns the Preference contained in this group.
PreferenceInflater The PreferenceInflater is used to inflate preference hierarchies from XML files.
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.
SeekBarPreference  
VolumePreference  
VolumePreference.VolumeStore  
 

Package android.preference Description

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 Preference.getSharedPreferences().

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


Android 2.3 Gingerbread