org.eclipse.ui

Package Specification

The PlatformUI class provides access to a single workbench.  A workbench is the root object for the UI and has one or more workbench windows.  Each workbench window has a collection of workbench pages, only one of which is active and visible to the end user.  Each workbench page has a collection of workbench parts.  A page's parts are arranged (tiled or stacked) for presentation on the screen.  Within a page and its parts the user can interact with and modify a model (typically resources in a workspace).   There are two kinds of workbench parts: views and editors.  An editor is typically used to edit or browse a document or input object.  A view is typically used to navigate a hierarchy of information (like the workspace), open an editor, or display properties for the active editor.

The platform creates a workbench when the workbench plug-in is activated.  Since this happens at most once during the life of the running platform, there is only one workbench instance. Due to its singular nature, it is commonly referred to as the workbench.

Within a workbench the user will interact with many different resource types.  Because different tools are required for each, the workbench defines a number of extension points which allow for the integration of new tools.  There are extension points for views, editors, action sets, import wizards, export wizards, etc.
 

An implementation of ISourceProvider that provides listener support.

An expression that checks the active shell variable.

The executable extension format for this class is as follows:
<workingSet elementAdapterClass="org.eclipse.ui.BasicWorkingSetElementAdapter:class1.to.adapt.to[;option1=value1][;option2=value2],class2.to.adapt.to[;option1=value1][;option2=value2],..."> ...

This interface should be implemented by clients who need to contribute actions via an extension point.

An action delegate that implements this interface will have its runWithEvent(IAction, Event) called instead of its run(IAction) method.

Clients should implement this interface, in addition to IActionDelegate or sub-interfaces, if interested in the triggering event or in the lifecycle of the delegate object.

Clients can choose to subclass the provided abstract implementation org.

Within the workbench a plugin may extend the actions which appear in the context menu for any object.

Clients should implement this interface to define a new type of editor launcher.

An editor can be created in one of two ways:

• An editor can be defined by an extension to the workbench.
• The user manually associates an editor with a given resource extension type.

The name and extension can never empty or null.

Clients implementing this editor input interface should override Object.equals(Object) to answer true for two inputs that are the same.

Mementos were designed with the following requirements in mind:

1. Certain objects need to be saved and restored across platform sessions.
2. When an object is restored, an appropriate class for an object might not be available.

A service that is capable of nesting other services within itself.

This interface should be implemented by selection listeners that want to be notified when the selection becomes null. It has no methods.

This interface is not intended to be implemented by clients.

When a perspective is opened, it creates a new page layout with a single editor area.

Clients implementing this editor input interface should override Object.equals(Object) to answer true for two inputs that are the same.

This interface is typically included in interfaces where persistance is required.

When the workbench is shutdown objects which implement this interface will be persisted.

When a new page is created in the workbench a perspective is used to define the initial page layout.

Note that if a part implements this interface, it is excluded from the common "prompt to save" dialog, and instead opens its own dialog.

This class provides Image and ImageDescriptors for each named image in the interface.

A provider of notifications for when a change has occurred to a particular type of source.

A listener to changes in a particular source of information.

A source is type of event change that can occur within the workbench.

A workbench has one or more main windows which present to the end user information based on some underlying model, typically on resources in an underlying workspace.

This interface contains constants only; it is not intended to be implemented or extended.

Standard menus

• File menu (M_FILE)
• Edit menu (M_EDIT)
• Window menu (M_WINDOW)
• Help menu (M_HELP)

Standard group for adding top level menus

• Extra top level menu group (MB_ADDITIONS)

Global actions

• Undo (UNDO)
• Redo (REDO)
• Cut (CUT)
• Copy (COPY)
• Paste (PASTE)
• Delete (DELETE)
• Find (FIND)
• Select All (SELECT_ALL)
• Add Bookmark (BOOKMARK)

Standard File menu actions

• Start group (FILE_START)
• End group (FILE_END)
• New action (NEW)
• Extra New-like action group (NEW_EXT)
• Close action (CLOSE)
• Close All action (CLOSE_ALL)
• Extra Close-like action group (CLOSE_EXT)
• Save action (SAVE)
• Save As action (SAVE_AS)
• Save All action (SAVE_ALL)
• Extra Save-like action group (SAVE_EXT)
• Import action (IMPORT)
• Export action (EXPORT)
• Extra Import-like action group (IMPORT_EXT)
• Quit action (QUIT)

Standard Edit menu actions

• Start group (EDIT_START)
• End group (EDIT_END)
• Undo global action (UNDO)
• Redo global action (REDO)
• Extra Undo-like action group (UNDO_EXT)
• Cut global action (CUT)
• Copy global action (COPY)
• Paste global action (PASTE)
• Extra Cut-like action group (CUT_EXT)
• Delete global action (DELETE)
• Find global action (FIND)
• Select All global action (SELECT_ALL)
• Bookmark global action (BOOKMARK)

Standard Perspective menu actions

• Extra Perspective-like action group (VIEW_EXT)

Standard Workbench menu actions

• Start group (WB_START)
• End group (WB_END)
• Extra Build-like action group (BUILD_EXT)
• Build action (BUILD)
• Rebuild All action (REBUILD_ALL)

Standard Window menu actions

• Extra Window-like action group (WINDOW_EXT)

Standard Help menu actions

• Start group (HELP_START)
• End group (HELP_END)
• About action (ABOUT)

Standard pop-up menu groups

• Managing group (GROUP_MANAGING)
• Reorganize group (GROUP_REORGANIZE)
• Add group (GROUP_ADD)
• File group (GROUP_FILE)

To hook a global action handler, a view should use the following code: IAction copyHandler = ...; view.getSite().getActionBars().setGlobalActionHandler( IWorkbenchActionConstants.COPY, copyHandler); For editors, this should be done in the IEditorActionBarContributor.

A page can contain 0 or more views and 0 or more editors.

The workbench site supports a few IServiceLocator services by default.

Interface that describes a mechanism that may be provided by working set extensions to help manage the addition of elements to working sets.

An expression encapsulating all of the information from legacy handler submissions.