Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> ui >> [ application overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.eclipse.ui.application
Class WorkbenchAdvisor  

java.lang.Object
  org.eclipse.ui.application.WorkbenchAdvisor

---

public abstract class WorkbenchAdvisor

extends java.lang.Object

Public base class for configuring the workbench.

Note that the workbench advisor object is created in advance of creating the workbench. However, by the time the workbench starts calling methods on this class, PlatformUI.getWorkbench is guaranteed to have been properly initialized.

Example of creating and running a workbench (in an IPlatformRunnable):

 
 public class MyApplication implements IPlatformRunnable {
   public Object run(Object args) {
     WorkbenchAdvisor workbenchAdvisor = new MyWorkbenchAdvisor();
     Display display = PlatformUI.createDisplay();
     int returnCode = PlatformUI.createAndRunWorkbench(display, workbenchAdvisor);
     if (returnCode == PlatformUI.RETURN_RESTART) {
        return IPlatformRunnable.EXIT_RESTART;
     } else {
        return IPlatformRunnable.EXIT_OK;
   }
 }
 
 

An application should declare a subclass of WorkbenchAdvisor and override methods to configure the workbench to suit the needs of the particular application.

The following advisor methods are called at strategic points in the workbench's lifecycle (all occur within the dynamic scope of the call to PlatformUI.createAndRunWorkbench 55 ):

• initialize - called first; before any windows; use to register things
• preStartup - called second; after initialize but before first window is opened; use to temporarily disable things during startup or restore
• postStartup - called third; after first window is opened; use to reenable things temporarily disabled in previous step
• postRestore - called after the workbench and its windows has been recreated from a previously saved state; use to adjust the restored workbench
• preWindowOpen - called as each window is being opened; use to configure aspects of the window other than actions bars
• fillActionBars - called after preWindowOpen to configure a window's action bars
• postWindowRestore - called after a window has been recreated from a previously saved state; use to adjust the restored window
• postWindowCreate - called after a window has been created, either from an initial state or from a restored state; used to adjust the window
• openIntro - called immediately before a window is opened in order to create the introduction component, if any.
• postWindowOpen - called after a window has been opened; use to hook window listeners, etc.
• preWindowShellClose - called when a window's shell is closed by the user; use to pre-screen window closings
• eventLoopException - called to handle the case where the event loop has crashed; use to inform the user that things are not well
• eventLoopIdle - called when there are currently no more events to be processed; use to perform other work or to yield until new events enter the queue
• preShutdown - called just after event loop has terminated but before any windows have been closed; use to deregister things registered during initialize
• postShutdown - called last; after event loop has terminated and all windows have been closed; use to deregister things registered during initialize

Since:

3.0

---

Field Summary
static int	FILL_COOL_BAR           Bit flag for fillActionBars 55 indicating that the operation is supposed to fill (or describe) the workbench window's cool bar.
static int	FILL_MENU_BAR           Bit flag for fillActionBars 55 indicating that the operation is supposed to fill (or describe) the workbench window's menu bar.
static int	FILL_PROXY           Bit flag for fillActionBars 55 indicating that the operation is not filling the action bars of an actual workbench window, but rather a proxy (used for perspective customization).
static int	FILL_STATUS_LINE           Bit flag for fillActionBars 55 indicating that the operation is supposed to fill (or describe) the workbench window's status line.
private  boolean	introOpened
private  IWorkbenchConfigurer	workbenchConfigurer           The workbench configurer.

 

Constructor Summary
protected	WorkbenchAdvisor()           Creates and initializes a new workbench advisor instance.

 

Method Summary
void	createWindowContents(IWorkbenchWindowConfigurer configurer, org.eclipse.swt.widgets.Shell shell)           Creates the contents of the window.
void	eventLoopException(java.lang.Throwable exception)           Performs arbitrary actions when the event loop crashes (the code that handles a UI event throws an exception that is not caught).
void	eventLoopIdle(org.eclipse.swt.widgets.Display display)           Performs arbitrary work or yields when there are no events to be processed.
void	fillActionBars(org.eclipse.ui.IWorkbenchWindow window, IActionBarConfigurer configurer, int flags)           Configures the action bars using the given action bar configurer.
org.eclipse.core.runtime.IAdaptable	getDefaultPageInput()           Returns the default input for newly created workbench pages.
abstract  java.lang.String	getInitialWindowPerspectiveId()           Returns the id of the perspective to use for the initial workbench window.
java.lang.String	getMainPreferencePageId()           Returns the id of the preference page that should be presented most prominently.
protected  IWorkbenchConfigurer	getWorkbenchConfigurer()           Returns the workbench configurer for the advisor.
void	initialize(IWorkbenchConfigurer configurer)           Performs arbitrary initialization before the workbench starts running.
void	internalBasicInitialize(IWorkbenchConfigurer configurer)           Remembers the configurer and calls initialize.
boolean	isApplicationMenu(IWorkbenchWindowConfigurer configurer, java.lang.String menuId)           Returns whether the menu with the given id is an application menu of the given window.
void	openIntro(IWorkbenchWindowConfigurer configurer)           Opens the introduction componenet.
boolean	openWindows()           Opens the workbench windows on startup.
void	postShutdown()           Performs arbitrary finalization after the workbench stops running.
void	postStartup()           Performs arbitrary actions after the workbench windows have been opened (or restored), but before the main event loop is run.
void	postWindowClose(IWorkbenchWindowConfigurer configurer)           Performs arbitrary actions after the given workbench window is closed.
void	postWindowCreate(IWorkbenchWindowConfigurer configurer)           Performs arbitrary actions after the given workbench window has been created (possibly after being restored), but has not yet been opened.
void	postWindowOpen(IWorkbenchWindowConfigurer configurer)           Performs arbitrary actions after the given workbench window has been opened (possibly after being restored).
void	postWindowRestore(IWorkbenchWindowConfigurer configurer)           Performs arbitrary actions after the given workbench window has been restored, but before it is opened.
boolean	preShutdown()           Performs arbitrary finalization before the workbench is about to shut down.
void	preStartup()           Performs arbitrary actions just before the first workbench window is opened (or restored).
void	preWindowOpen(IWorkbenchWindowConfigurer configurer)           Performs arbitrary actions before the given workbench window is opened.
boolean	preWindowShellClose(IWorkbenchWindowConfigurer configurer)           Performs arbitrary actions as the given workbench window's shell is being closed directly, and possibly veto the close.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

FILL_PROXY

public static final int FILL_PROXY

Bit flag for fillActionBars 55 indicating that the operation is not filling the action bars of an actual workbench window, but rather a proxy (used for perspective customization).

See Also:

Constant Field Values

---

FILL_MENU_BAR

public static final int FILL_MENU_BAR

Bit flag for fillActionBars 55 indicating that the operation is supposed to fill (or describe) the workbench window's menu bar.

See Also:

Constant Field Values

---

FILL_COOL_BAR

public static final int FILL_COOL_BAR

Bit flag for fillActionBars 55 indicating that the operation is supposed to fill (or describe) the workbench window's cool bar.

See Also:

Constant Field Values

---

FILL_STATUS_LINE

public static final int FILL_STATUS_LINE

Bit flag for fillActionBars 55 indicating that the operation is supposed to fill (or describe) the workbench window's status line.

See Also:

Constant Field Values

---

workbenchConfigurer

private IWorkbenchConfigurer workbenchConfigurer

The workbench configurer.

---

introOpened

private boolean introOpened

Constructor Detail

WorkbenchAdvisor

protected WorkbenchAdvisor()

Creates and initializes a new workbench advisor instance.

Method Detail

internalBasicInitialize

public final void internalBasicInitialize(IWorkbenchConfigurer configurer)

Remembers the configurer and calls initialize.

For internal use by the workbench only.

---

initialize

public void initialize(IWorkbenchConfigurer configurer)

Performs arbitrary initialization before the workbench starts running.

This method is called during workbench initialization prior to any windows being opened. Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override. Typical clients will use the configurer passed in to tweak the workbench. If further tweaking is required in the future, the configurer may be obtained using getWorkbenchConfigurer.

---

getWorkbenchConfigurer

protected IWorkbenchConfigurer getWorkbenchConfigurer()

Returns the workbench configurer for the advisor. Can be null if the advisor is not initialized yet.

---

preStartup

public void preStartup()

Performs arbitrary actions just before the first workbench window is opened (or restored).

This method is called after the workbench has been initialized and just before the first window is about to be opened. Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override.

---

postStartup

public void postStartup()

Performs arbitrary actions after the workbench windows have been opened (or restored), but before the main event loop is run.

This method is called just after the windows have been opened. Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override. It is okay to call IWorkbench.close() from this method.

---

preShutdown

public boolean preShutdown()

Performs arbitrary finalization before the workbench is about to shut down.

This method is called immediately prior to workbench shutdown before any windows have been closed. Clients must not call this method directly (although super calls are okay). The default implementation returns true. Subclasses may override.

The advisor may veto a regular shutdown by returning false, although this will be ignored if the workbench is being forced to shut down.

---

postShutdown

public void postShutdown()

Performs arbitrary finalization after the workbench stops running.

This method is called during workbench shutdown after all windows have been closed. Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override.

---

eventLoopException

public void eventLoopException(java.lang.Throwable exception)

Performs arbitrary actions when the event loop crashes (the code that handles a UI event throws an exception that is not caught).

This method is called when the code handling a UI event throws an exception. In a perfectly functioning application, this method would never be called. In practice, it comes into play when there are bugs in the code that trigger unchecked runtime exceptions. It is also activated when the system runs short of memory, etc. Fatal errors (ThreadDeath) are not passed on to this method, as there is nothing that could be done.

Clients must not call this method directly (although super calls are okay). The default implementation logs the problem so that it does not go unnoticed. Subclasses may override or extend this method. It is generally a bad idea to override with an empty method, and you should be especially careful when handling Errors.

---

eventLoopIdle

public void eventLoopIdle(org.eclipse.swt.widgets.Display display)

Performs arbitrary work or yields when there are no events to be processed.

This method is called when there are currently no more events on the queue to be processed at the moment.

Clients must not call this method directly (although super calls are okay). The default implementation yields until new events enter the queue. Subclasses may override or extend this method. It is generally a bad idea to override with an empty method. It is okay to call IWorkbench.close() from this method.

---

preWindowOpen

public void preWindowOpen(IWorkbenchWindowConfigurer configurer)

Performs arbitrary actions before the given workbench window is opened.

This method is called before the window's controls have been created. Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override. Typical clients will use the configurer passed in to tweak the workbench window in an application-specific way; however, filling the window's menu bar, tool bar, and status line must be done in fillActionBars 55 , which is called immediately after this method is called.

---

fillActionBars

public void fillActionBars(org.eclipse.ui.IWorkbenchWindow window,
                           IActionBarConfigurer configurer,
                           int flags)

Configures the action bars using the given action bar configurer. Under normal circumstances, flags does not include FILL_PROXY, meaning this is a request to fill the actions\ bars of the given workbench window; the remaining flags indicate which combination of the menu bar (FILL_MENU_BAR), the tool bar (FILL_COOL_BAR), and the status line (FILL_STATUS_LINE) are to be filled.

If flags does include FILL_PROXY, then this is a request to describe the actions bars of the given workbench window (which will already have been filled); again, the remaining flags indicate which combination of the menu bar, the tool bar, and the status line are to be described. The actions included in the proxy action bars can be the same instances as in the actual window's action bars. Calling ActionFactory to create new action instances is not recommended, because these actions internally register listeners with the window and there is no opportunity to dispose of these actions.

This method is called just after preWindowOpen 55 . Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override.

---

postWindowRestore

public void postWindowRestore(IWorkbenchWindowConfigurer configurer)
                       throws org.eclipse.ui.WorkbenchException

Performs arbitrary actions after the given workbench window has been restored, but before it is opened.

This method is called after a previously-saved window have been recreated. This method is not called when a new window is created from scratch. This method is never called when a workbench is started for the very first time, or when workbench state is not saved or restored. Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override. It is okay to call IWorkbench.close() from this method.

---

openIntro

public void openIntro(IWorkbenchWindowConfigurer configurer)

Opens the introduction componenet.

Clients must not call this method directly (although super calls are okay). The default implementation opens the intro in the first window provided the preference IWorkbenchPreferences.SHOW_INTRO is true. If an intro is shown then this preference will be set to false. Subsequently, and intro will be shown only if WorkbenchConfigurer.getSaveAndRestore() returns true and the introduction was visible on last shutdown. Subclasses may override.

---

postWindowCreate

public void postWindowCreate(IWorkbenchWindowConfigurer configurer)

Performs arbitrary actions after the given workbench window has been created (possibly after being restored), but has not yet been opened.

This method is called after a new window has been created from scratch, or when a previously-saved window has been restored. In the latter case, this method is called after postWindowRestore. Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override.

---

postWindowOpen

public void postWindowOpen(IWorkbenchWindowConfigurer configurer)

Performs arbitrary actions after the given workbench window has been opened (possibly after being restored).

This method is called after a window has been opened. This method is called after a new window has been created from scratch, or when a previously-saved window has been restored. Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override.

---

preWindowShellClose

public boolean preWindowShellClose(IWorkbenchWindowConfigurer configurer)

Performs arbitrary actions as the given workbench window's shell is being closed directly, and possibly veto the close.

This method is called from a ShellListener associated with the workbench window. It is not called when the window is being closed for other reasons. Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override. Typical clients may use the configurer passed in to access the workbench window being closed. If this method returns false, then the user's request to close the shell is ignored. This gives the workbench advisor an opportunity to query the user and/or veto the closing of a window under some circumstances.

---

postWindowClose

public void postWindowClose(IWorkbenchWindowConfigurer configurer)

Performs arbitrary actions after the given workbench window is closed.

This method is called after the window's controls have been disposed. Clients must not call this method directly (although super calls are okay). The default implementation does nothing. Subclasses may override. Typical clients will use the configurer passed in to tweak the workbench window in an application-specific way.

---

isApplicationMenu

public boolean isApplicationMenu(IWorkbenchWindowConfigurer configurer,
                                 java.lang.String menuId)

Returns whether the menu with the given id is an application menu of the given window. This is used during OLE "in place" editing. Application menus should be preserved during menu merging. All other menus may be removed from the window.

The default implementation returns false. Subclasses may override.

---

getDefaultPageInput

public org.eclipse.core.runtime.IAdaptable getDefaultPageInput()

Returns the default input for newly created workbench pages.

The default implementation returns null. Subclasses may override.

---

getInitialWindowPerspectiveId

public abstract java.lang.String getInitialWindowPerspectiveId()

Returns the id of the perspective to use for the initial workbench window.

This method is called during startup when the workbench is creating the first new window. Subclasses must implement.

If the IWorkbenchPreferenceConstants.DEFAULT_PERSPECTIVE_ID>IWorkbenchPreferenceConstants.DEFAULT_PERSPECTIVE_ID 55 preference is specified, it supercedes the perspective specified here.

---

getMainPreferencePageId

public java.lang.String getMainPreferencePageId()

Returns the id of the preference page that should be presented most prominently.

The default implementation returns null. Subclasses may override.

---

createWindowContents

public void createWindowContents(IWorkbenchWindowConfigurer configurer,
                                 org.eclipse.swt.widgets.Shell shell)

Creates the contents of the window.

The default implementation adds a menu bar, a cool bar, a status line, a perspective bar, and a fast view bar. The visibility of these controls can be configured using the setShow* methods on IWorkbenchWindowConfigurer.

Subclasses may override to define custom window contents and layout, but must call IWorkbenchWindowConfigurer.createPageComposite.

---

openWindows

public boolean openWindows()

Opens the workbench windows on startup. The default implementation tries to restore the previously saved workbench state using IWorkbenchConfigurer.restoreWorkbenchState(). If there was no previously saved state, or if the restore failed, then a first-time window is opened using IWorkbenchConfigurer.openFirstTimeWindow.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> eclipse >> ui >> [ application overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---