Package org.eclipse.gmf.runtime.common.ui.dialogs

Provides implementations of various common dialogs.

See:
Description

Interface Summary

IShowRelatedElementsWithDetails	Show Related Elements with details interface.
ShowRelatedElementsPresetHelper.IConversionMethods	Methods for the serializer and deserializer which should be implemented to convert the serialized String into an object and to convert the object into a serialzed String.

Class Summary

ExpansionType	Expansion type enumeration for SRE.
FilterWarningDialog	A dialog class that would be displayed to warn the user when adding an element to the ME while the ME's filtering settings hide such element.
PopupDialog	A simple dialog with a list from which the user can select one item.
PropertiesDialog	A Preference Dialog which has a Close button in place of OK/Cancel buttons, and titled "Properties" in place of "Preferences"
SaveAllDirtyEditorsDialog	Dialog which displays all dirty editors and prompts user if they should be saved
SelectableElement	An element that contains a hint, a serializable String ID, a String label, and an ImageDescriptor label.
SelectedType	Describes how a SelectableElement is selected.
ShowHideRelationshipsDialog	Show Hide Relationships dialog box, called from an action.
ShowRelatedElementsComposite	A composite intended to be used in the Show Related Elements dialog.
ShowRelatedElementsDialog	Show related elements dialog box, called from an action.
ShowRelatedElementsPredefinedComposite	The common Show Related Elements Predefined Queries Composite.
ShowRelatedElementsPreset	Show Related Elements Preset
ShowRelatedElementsPresetHelper	Show Related Elements Presets helper.

Package org.eclipse.gmf.runtime.common.ui.dialogs Description

Provides implementations of various common dialogs. These dialogs include

• Dispatching Progress Monitor dialog
• Show Related Elements and Show Hide Relationships dialogs

and

• Filter Warning dialog
• Popup dialog
• Properties dialog
• Save All Dirty Editors dialog

Dialogs

The use of most of the dialogs in this class is obvious. One of the most commonly used dialogs in this package is the Dispatching Progress Monitor dialog, which will dispatch pending UI events to the display thread whenever its isCanceled() method is called.

Show Related Elements and Show Hide Relationships

Show Related Elements and Show Hide Relationships, also referred to as SRE and SHR, are also commonly used dialogs. Each dialog shows SelectableElement objects, which for our purposes represent relationships. SelectableElement objects are represented as trees, and leaf SelectableElement objects may be either set to selected, unselected, or leave, which are defined by SelectedType. SelectableElement objects are displayed to the user using a label provider, SelectableElementsLabelProvider or SelectableElementsTriStateLabelProvider, and a content provider.

Show Related Elements

The SRE dialog, which implements IShowRelatedElementsWithDetails, is slightly more complex than the SHR dialog in that it also supports presets, and it may be separated into two sides, the ShowRelatedElementsPredefinedComposite for the presets and the ShowRelatedElementsComposite for the user to choose detailed settings.

Package Specification

For more information, please see org.eclipse.jface.dialogs.Dialog