Eclipse Platform
2.0

org.eclipse.ui
Interface IWorkbench


public interface IWorkbench

A workbench is the root object for the Eclipse Platform user interface.

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. A workbench usually starts with a single open window, and automatically closes when its last window closes.

Each workbench window has a collection of pages; the active page is the one that is being presented to the end user; at most one page is active in a window at a time.

Each workbench page has a collection of workbench parts, of which there are two kinds: views and editors. A page's parts are arranged (tiled or stacked) for presentation on the screen. The arrangement is not fixed; the user can arrange the parts as they see fit. A perspective is a template for a page, capturing a collection of parts and their arrangement.

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.

This interface is not intended to be implemented by clients.

See Also:
org.eclipse.ui.plugin.IAbstractUIPlugin#getWorkbench

Method Summary
 void addWindowListener(IWindowListener listener)
          Adds a window listener.
 boolean close()
          Closes this workbench and all its open windows.
 IWorkbenchWindow getActiveWorkbenchWindow()
          Returns the currently active window for this workbench (if any).
 IDecoratorManager getDecoratorManager()
          Returns the decorator manager.
 IEditorRegistry getEditorRegistry()
          Returns the editor registry for the workbench.
 IMarkerHelpRegistry getMarkerHelpRegistry()
          Returns the marker help registry for the workbench.
 IPerspectiveRegistry getPerspectiveRegistry()
          Returns the perspective registry for the workbench.
 PreferenceManager getPreferenceManager()
          Returns the preference manager for the workbench.
 IPreferenceStore getPreferenceStore()
          Returns the preference store for the workbench.
 ISharedImages getSharedImages()
          Returns the shared images for the workbench.
 IWorkbenchWindow[] getWorkbenchWindows()
          Returns a list of the open main windows associated with this workbench.
 IWorkingSetManager getWorkingSetManager()
          Returns the working set manager for the workbench.
 IWorkbenchWindow openWorkbenchWindow(IAdaptable input)
          Creates and opens a new workbench window with one page.
 IWorkbenchWindow openWorkbenchWindow(String perspID, IAdaptable input)
          Creates and opens a new workbench window with one page.
 void removeWindowListener(IWindowListener l)
          Removes a window listener.
 boolean restart()
          Closes then restarts this workbench.
 IWorkbenchPage showPerspective(String perspectiveId, IWorkbenchWindow window)
          Shows the specified perspective to the user.
 IWorkbenchPage showPerspective(String perspectiveId, IWorkbenchWindow window, IAdaptable input)
          Shows the specified perspective to the user.
 

Method Detail

addWindowListener

public void addWindowListener(IWindowListener listener)
Adds a window listener.

Parameters:
listener - the window listener to add
Since:
2.0

removeWindowListener

public void removeWindowListener(IWindowListener l)
Removes a window listener.

Since:
2.0

close

public boolean close()
Closes this workbench and all its open windows.

If the workbench has an open editor with unsaved content, the user will be given the opportunity to save it.

Returns:
true if the workbench was successfully closed, and false if it is still open

getActiveWorkbenchWindow

public IWorkbenchWindow getActiveWorkbenchWindow()
Returns the currently active window for this workbench (if any).

Returns:
the active workbench window, or null if the currently active window is not a workbench window

getEditorRegistry

public IEditorRegistry getEditorRegistry()
Returns the editor registry for the workbench.

Returns:
the workbench editor registry

getPerspectiveRegistry

public IPerspectiveRegistry getPerspectiveRegistry()
Returns the perspective registry for the workbench.

Returns:
the workbench perspective registry

getPreferenceManager

public PreferenceManager getPreferenceManager()
Returns the preference manager for the workbench.

Returns:
the workbench preference manager

getPreferenceStore

public IPreferenceStore getPreferenceStore()
Returns the preference store for the workbench.

Returns:
the workbench preference store
Since:
2.0

getSharedImages

public ISharedImages getSharedImages()
Returns the shared images for the workbench.

Returns:
the shared image manager

getMarkerHelpRegistry

public IMarkerHelpRegistry getMarkerHelpRegistry()
Returns the marker help registry for the workbench.

Returns:
the marker help registry
Since:
2.0

getWorkbenchWindows

public IWorkbenchWindow[] getWorkbenchWindows()
Returns a list of the open main windows associated with this workbench. Note that wizards and dialogs are not included in this list since they are not considered main windows.

Returns:
a list of open windows

getWorkingSetManager

public IWorkingSetManager getWorkingSetManager()
Returns the working set manager for the workbench.

Returns:
the working set manager
Since:
2.0

openWorkbenchWindow

public IWorkbenchWindow openWorkbenchWindow(String perspID,
                                            IAdaptable input)
                                     throws WorkbenchException
Creates and opens a new workbench window with one page. The perspective of the new page is defined by the specified perspective ID. The new window and new page become active.

Note: The caller is responsible to ensure the action using this method will explicitly inform the user a new window will be opened. Otherwise, callers are strongly recommended to use the openPerspective APIs to programmatically show a perspective to avoid confusing the user.

In most cases where this method is used the caller is tightly coupled to a particular perspective. They define it in the registry and contribute some user interface action to open or activate it. In situations like this a static variable is often used to identify the perspective Id.

The workbench also defines a number of menu items to activate or open each registered perspective. A complete list of these perspectives is available from the perspective registry found on IWorkbench.

Parameters:
input - the page input, or null if there is no current input. This is used to seed the input for the new page's views.
Returns:
the new workbench window
Throws:
WorkbenchException - if a new window and page could not be opened
See Also:
showPerspective(java.lang.String, org.eclipse.ui.IWorkbenchWindow)

openWorkbenchWindow

public IWorkbenchWindow openWorkbenchWindow(IAdaptable input)
                                     throws WorkbenchException
Creates and opens a new workbench window with one page. The perspective of the new page is defined by the default perspective ID. The new window and new page become active.

Note: The caller is responsible to ensure the action using this method will explicitly inform the user a new window will be opened. Otherwise, callers are strongly recommended to use the openPerspective APIs to programmatically show a perspective to avoid confusing the user.

The workbench also defines a number of menu items to activate or open each registered perspective. A complete list of these perspectives is available from the perspective registry found on IWorkbench.

Parameters:
input - the page input, or null if there is no current input. This is used to seed the input for the new page's views.
Returns:
the new workbench window
Throws:
WorkbenchException - if a new window and page could not be opened
See Also:
showPerspective(java.lang.String, org.eclipse.ui.IWorkbenchWindow)

restart

public boolean restart()
Closes then restarts this workbench.

If the workbench has an open editor with unsaved content, the user will be given the opportunity to save it.

Returns:
true if the workbench was successfully closed, and false if it could not be closed
Since:
2.0

showPerspective

public IWorkbenchPage showPerspective(String perspectiveId,
                                      IWorkbenchWindow window)
                               throws WorkbenchException
Shows the specified perspective to the user. The caller should use this method when the perspective to be shown is not dependent on the page's input. That is, the perspective can open in any page depending on user preferences.

The perspective may be shown in the specified window, in another existing window, or in a new window depending on user preferences. The exact policy is controlled by the workbench to ensure consistency to the user. The policy is subject to change. The current policy is as follows:

The workbench also defines a number of menu items to activate or open each registered perspective. A complete list of these perspectives is available from the perspective registry found on IWorkbench.

Parameters:
perspectiveId - the perspective ID to show
window - the workbench window of the action calling this method.
Returns:
the workbench page that the perspective was shown
Throws:
WorkbenchException - if the perspective could not be shown
Since:
2.0

showPerspective

public IWorkbenchPage showPerspective(String perspectiveId,
                                      IWorkbenchWindow window,
                                      IAdaptable input)
                               throws WorkbenchException
Shows the specified perspective to the user. The caller should use this method when the perspective to be shown is dependent on the page's input. That is, the perspective can only open in any page with the specified input.

The perspective may be shown in the specified window, in another existing window, or in a new window depending on user preferences. The exact policy is controlled by the workbench to ensure consistency to the user. The policy is subject to change. The current policy is as follows:

The workbench also defines a number of menu items to activate or open each registered perspective. A complete list of these perspectives is available from the perspective registry found on IWorkbench.

Parameters:
perspectiveId - the perspective ID to show
window - the workbench window of the action calling this method.
input - the page input, or null if there is no current input. This is used to seed the input for the page's views
Returns:
the workbench page that the perspective was shown
Throws:
WorkbenchException - if the perspective could not be shown
Since:
2.0

getDecoratorManager

public IDecoratorManager getDecoratorManager()
Returns the decorator manager.

Any client using the decorator manager should come up with the text and image for the element (including any of the part's own decorations) before calling the decorator manager. It should also add a listener to be notified when decorations change.

Note that if the element implements IAdaptable, decorators may use this mechanism to obtain an adapter (for example an IResource), and derive the decoration from the adapter rather than the element. Since the adapter may differ from the original element, those using the decorator manager should be prepared to handle notification that the decoration for the adapter has changed, in addition to handling notification that the decoration for the element has changed. That is, it needs to be able to map back from the adapter to the element.

Returns:
the decorator manager

NOTE: This is experimental API, which may be changed or removed at any point in time. This API should not be called, overridden or otherwise used in production code.


Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.