| org.eclipse.jface.dialogs |
Package-level Javadoc
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.
|
| Java Source File Name | Type | Comment |
| AnimatorFactory.java | Class | Factory for control animators used by JFace to animate the display of an SWT
Control. |
| ControlAnimator.java | Class | ControlAnimator provides a simple implementation to display or hide a control
at the bottom of the parent composite. |
| ControlEnableState.java | Class | Helper class to save the enable/disable state of a control including all its
descendent controls. |
| Dialog.java | Class | A dialog is a specialized window used for narrow-focused communication with
the user.
Dialogs are usually modal. |
| DialogMessageArea.java | Class | The DialogMessageArea is a resusable component for adding an accessible
message area to a dialog. |
| DialogPage.java | Class | Abstract base implementation of a dialog page. |
| DialogSettings.java | Class | Concrete implementation of a dialog settings (IDialogSettings)
using a hash table and XML. |
| DialogTray.java | Class |
This class is the abstract superclass of all dialog trays. |
| ErrorDialog.java | Class | A dialog to display one or more errors to the user, as contained in an
IStatus object. |
| ErrorSupportProvider.java | Class | A ErrorSupportProvider defines the area to be shown in an error dialog for extra support information. |
| IconAndMessageDialog.java | Class | The IconAndMessageDialog is the abstract superclass of dialogs that have an
icon and a message as the first two widgets. |
| IDialogBlockedHandler.java | Interface | The IDialogBlockedHandler is the handler used by
JFace to provide extra information when a
blocking has occured. |
| IDialogConstants.java | Interface | IDialogConstants is the interface for common dialog strings and ids
used throughout JFace. |
| IDialogPage.java | Interface | Interface for a page in a multi-page dialog. |
| IDialogSettings.java | Interface | An interface to a storage mechanism for making dialog settings persistent.
The store manages a collection of key/value pairs. |
| IInputValidator.java | Interface | The IInputValidator is the interface for simple validators. |
| ImageAndMessageArea.java | Class | Instances of this class provide a message area to display a message and an
associated image. |
| IMessageProvider.java | Interface | Minimal interface to a message provider. |
| InputDialog.java | Class | A simple input dialog for soliciting an input string from the user. |
| IPageChangedListener.java | Interface | A listener which is notified when the current page of the multi-page dialog
is changed. |
| IPageChangeProvider.java | Interface | Minimal interface to a page change provider. |
| IPageChangingListener.java | Interface | A listener which is notified when the current page of a multi-page dialog is
changing. |
| MessageDialog.java | Class | A dialog for showing messages to the user. |
| MessageDialogWithToggle.java | Class |
A message dialog which also allows the user to adjust a toggle setting. |
| PageChangedEvent.java | Class | Event object describing a page selection change. |
| PageChangingEvent.java | Class | Event object describing an IDialogPage in the midst of changing. |
| PopupDialog.java | Class | A lightweight, transient dialog that is popped up to show contextual or
temporal information and is easily dismissed. |
| ProgressIndicator.java | Class | A control for showing progress feedback for a long running operation. |
| ProgressMonitorDialog.java | Class | A modal dialog that displays progress during a long running operation.
This concrete dialog class can be instantiated as is, or further subclassed
as required.
Typical usage is:
try {
IRunnableWithProgress op = ...;
new ProgressMonitorDialog(activeShell).run(true, true, op);
} catch (InvocationTargetException e) {
// handle exception
} catch (InterruptedException e) {
// handle cancelation
}
Note that the ProgressMonitorDialog is not intended to be used with multiple
runnables - this dialog should be discarded after completion of one
IRunnableWithProgress and a new one instantiated for use by a second or
sebsequent IRunnableWithProgress to ensure proper initialization.
Note that not forking the process will result in it running in the UI which
may starve the UI. |
| StatusDialog.java | Class | An abstract base class for dialogs with a status bar and OK/CANCEL buttons.
The status message is specified in an IStatus which can be of severity ERROR,
WARNING, INFO or OK. |
| TitleAreaDialog.java | Class | 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.java | Class | A TrayDialog is a specialized Dialog that can contain
a tray on its side. |