Package SpecificationA preference manager (class
PreferenceManager) maintains a tree of preference nodes. Preferences are presented to the end user in a preference dialog consisting of preference pages. A preference page consists of multiple preference fields, which can be displayed and modified though field editors. The framework contains an abstract base class for preference dialogs (
PreferenceDialog), and an abstract preference page class (
FieldEditorPreferencePage) for hosting these field editors.
The individual preference values are maintained in a preference store
IPreferenceStore). Each preference has a current value and a
default value use to (re-)initialize it. The framework provides a concrete
preference store implementation (
PreferenceStore) based on an
java.util.Properties object, with support for persisting
the non-default preference values to files or streams.
A field editor presents the value of a single preference to the end user. The value is loaded from the preference store; if modified by the end user, the value is validated and eventually stored back to the preference store.
This package contains ready-to-use field editors for various types of preferences:
StringFieldEditor- text strings
ColorFieldEditor- RGB colors
FieldEditor; the framework allows new kinds of field editors to be defined by subclassing this class or one of its subclasses.
Note: None of the classes in this package maintain global state.
Interface Summary Interface Description IPersistentPreferenceStoreIPersistentPreferenceStore is a preference store that can be saved. IPreferenceNodeInterface to a node in a preference dialog. IPreferencePageAn interface for a preference page. IPreferencePageContainerAn interface used by a preference page to talk to its dialog. IPreferenceStoreThe
IPreferenceStoreinterface represents a table mapping named preferences to values.
Class Summary Class Description BooleanFieldEditorA field editor for a boolean type preference. BooleanPropertyActionThe BooleanPropertyAction is an action that set the values of a boolean property in the preference store. ColorFieldEditorA field editor for a color type preference. ColorSelectorThe
ColorSelectoris a wrapper for a button that displays a selected
Colorand allows the user to change the selection.
ComboFieldEditorA field editor for a combo box that allows the drop-down selection of one of a list of items. DirectoryFieldEditorA field editor for a directory path type preference. FieldEditorAbstract base class for all field editors. FieldEditorPreferencePageA special abstract preference page to host field editors. FileFieldEditorA field editor for a file path type preference. FontFieldEditorA field editor for a font type preference. IntegerFieldEditorA field editor for an integer type preference. JFacePreferencesJFacePreferences is a class used to administer the preferences used by JFace objects. ListEditorAn abstract field editor that manages a list of input values. PathEditorA field editor to edit directory paths. PreferenceContentProviderProvides a tree model for
PreferenceConverterA utility class for dealing with preferences whose values are common SWT objects (color, points, rectangles, and font data). PreferenceDialogA preference dialog is a hierarchical presentation of preference pages. PreferenceLabelProviderProvides labels for
PreferenceManagerA preference manager maintains a hierarchy of preference nodes and associated preference pages. PreferenceMementoA utility to change and remember preference values and later restore there original value. PreferenceNodeA concrete implementation of a node in a preference dialog tree. PreferencePageAbstract base implementation for all preference page implementations. PreferenceStoreA concrete preference store implementation based on an internal
java.util.Propertiesobject, with support for persisting the non-default preference values to files or streams.
RadioGroupFieldEditorA field editor for an enumeration type preference. ScaleFieldEditorA field editor for an integer type preference. StringButtonFieldEditorAn abstract field editor for a string type preference that presents a string input field with a change button to its right to edit the input field's content. StringFieldEditorA field editor for a string type preference.