Package org.eclipse.jface.dialogs

Provides support for dialogs.

Package Specification

A dialog is a specialized window, typically consisting of a dialog area and a button bar, designed for narrow-focussed communication with the user.

The dialog framework consists of an abstract base class (Dialog), along with more concrete dialog subclasses for displaying messages (MessageDialog), soliciting text input (InputDialog), and displaying progress during a long-running operation (ProgressMonitorDialog).

Dialog stores (IDialogStore, DialogStore) provide a general framework for organizing a dialog's settings into key/value pairs. Multi-page dialogs are made easier through the use of dialog pages (IDialogPage, DialogPage).

Note: None of the classes in this package maintain global state.

Interface Summary

Interface	Description
IDialogBlockedHandler	The IDialogBlockedHandler is the handler used by JFace to provide extra information when a blocking has occured.
IDialogConstants	IDialogConstants is the interface for common dialog strings and ids used throughout JFace.
IDialogLabelKeys	IDialogLabelKeys contains publicly accessible keys to the common dialog labels used throughout JFace.
IDialogPage	Interface for a page in a multi-page dialog.
IDialogSettings	An interface to a storage mechanism for making dialog settings persistent.
IDialogSettingsProvider	Provides dialog settings without assumption on how the dialog settings should be saved or restored.
IInputValidator	The IInputValidator is the interface for simple validators.
IMessageProvider	Minimal interface to a message provider.
IPageChangedListener	A listener which is notified when the current page of the multi-page dialog is changed.
IPageChangeProvider	Minimal interface to a page change provider.
IPageChangingListener	A listener which is notified when the current page of a multi-page dialog is changing.

Class Summary

Class	Description
AbstractSelectionDialog<T>	The abstract implementation of a selection dialog.
AnimatorFactory	Deprecated. as of 3.3, this class is no longer used.
ControlAnimator	ControlAnimator provides a simple implementation to display or hide a control at the bottom of the parent composite.
ControlEnableState	Helper class to save the enable/disable state of a control including all its descendent controls.
Dialog	A dialog is a specialized window used for narrow-focused communication with the user.
DialogMessageArea	The DialogMessageArea is a resusable component for adding an accessible message area to a dialog.
DialogPage	Abstract base implementation of a dialog page.
DialogSettings	Concrete implementation of a dialog settings (IDialogSettings) using a hash table and XML.
DialogTray	This class is the abstract superclass of all dialog trays.
ErrorDialog	A dialog to display one or more errors to the user, as contained in an IStatus object.
ErrorSupportProvider	A ErrorSupportProvider defines the area to be shown in an error dialog for extra support information.
IconAndMessageDialog	The IconAndMessageDialog is the abstract superclass of dialogs that have an icon and a message as the first two widgets.
InputDialog	A simple input dialog for soliciting an input string from the user.
MessageDialog	A dialog for showing messages to the user.
MessageDialogWithToggle	A message dialog which also allows the user to adjust a toggle setting.
MessageLine	A message line displaying a status.
PageChangedEvent	Event object describing a page selection change.
PageChangingEvent	Event object describing an IDialogPage in the midst of changing.
PlainMessageDialog	The PlainMessageDialog represents a message dialog with a clear, simple API to create dialogs with message, buttons and image.
PlainMessageDialog.Builder	The Builder to create PlainMessageDialog instances.
PopupDialog	A lightweight, transient dialog that is popped up to show contextual or temporal information and is easily dismissed.
ProgressIndicator	A control for showing progress feedback for a long running operation.
ProgressMonitorDialog	A modal dialog that displays progress during a long running operation.
StatusDialog	An abstract base class for dialogs with a status bar and OK/CANCEL buttons.
TitleAreaDialog	A dialog that has a title area for displaying a title and an image as well as a common area for displaying a description, a message, or an error message.
TrayDialog	A TrayDialog is a specialized Dialog that can contain a tray on its side.