Eclipse Platform
Release 3.7

org.eclipse.ui.application
Class WorkbenchWindowAdvisor

java.lang.Object
  extended by org.eclipse.ui.application.WorkbenchWindowAdvisor

public class WorkbenchWindowAdvisor
extends Object

Public base class for configuring a workbench window.

The workbench window advisor object is created in response to a workbench window being created (one per window), and is used to configure the window.

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

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

Since:
3.1

Constructor Summary
WorkbenchWindowAdvisor(IWorkbenchWindowConfigurer configurer)
          Creates a new workbench window advisor for configuring a workbench window via the given workbench window configurer.
 
Method Summary
protected  void cleanUpEditorArea()
          Close any empty editor stacks that may have been left open when the Workbench Window shut down.
 ActionBarAdvisor createActionBarAdvisor(IActionBarConfigurer configurer)
          Creates a new action bar advisor to configure the action bars of the window via the given action bar configurer.
 Control createEmptyWindowContents(Composite parent)
          Creates and returns the control to be shown when the window has no open pages.
 void createWindowContents(Shell shell)
          Creates the contents of the window.
 void dispose()
          Disposes any resources allocated by this window advisor.
protected  IWorkbenchWindowConfigurer getWindowConfigurer()
          Returns the workbench window configurer.
 boolean isDurableFolder(String perspectiveId, String folderId)
          Returns true if the given folder in the given perspective should remain visible even after all parts in it have been closed by the user.
 void openIntro()
          Opens the introduction componenet.
 void postWindowClose()
          Performs arbitrary actions after the window is closed.
 void postWindowCreate()
          Performs arbitrary actions after the window has been created (possibly after being restored), but has not yet been opened.
 void postWindowOpen()
          Performs arbitrary actions after the window has been opened (possibly after being restored).
 void postWindowRestore()
          Performs arbitrary actions after the window has been restored, but before it is opened.
 void preWindowOpen()
          Performs arbitrary actions before the window is opened.
 boolean preWindowShellClose()
          Performs arbitrary actions as the window's shell is being closed directly, and possibly veto the close.
 IStatus restoreState(IMemento memento)
          Restores arbitrary application specific state information.
 IStatus saveState(IMemento memento)
          Saves arbitrary application specific state information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkbenchWindowAdvisor

public WorkbenchWindowAdvisor(IWorkbenchWindowConfigurer configurer)
Creates a new workbench window advisor for configuring a workbench window via the given workbench window configurer.

Parameters:
configurer - an object for configuring the workbench window
Method Detail

getWindowConfigurer

protected IWorkbenchWindowConfigurer getWindowConfigurer()
Returns the workbench window configurer.

Returns:
the workbench window configurer

preWindowOpen

public void preWindowOpen()
Performs arbitrary actions before the 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 window configurer 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 ActionBarAdvisor.fillActionBars(int), which is called immediately after this method is called.


createActionBarAdvisor

public ActionBarAdvisor createActionBarAdvisor(IActionBarConfigurer configurer)
Creates a new action bar advisor to configure the action bars of the window via the given action bar configurer. The default implementation returns a new instance of ActionBarAdvisor.

Parameters:
configurer - the action bar configurer for the window
Returns:
the action bar advisor for the window

postWindowRestore

public void postWindowRestore()
                       throws WorkbenchException
Performs arbitrary actions after the window has been restored, but before it is opened.

This method is called after a previously-saved window has 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.

Throws:
WorkbenchException - thrown if there are any errors to report from post-restoration of the window

cleanUpEditorArea

protected void cleanUpEditorArea()
Close any empty editor stacks that may have been left open when the Workbench Window shut down. May be called from postWindowRestore() in the subclass but is not called by default.

Since:
3.7

openIntro

public void openIntro()
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 if 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()
Performs arbitrary actions after the window has been created (possibly after being restored), but has not yet been opened.

This method is called after the window has been created from scratch, or when it has been restored from a previously-saved window. 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()
Performs arbitrary actions after the window has been opened (possibly after being restored).

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


preWindowShellClose

public boolean preWindowShellClose()
Performs arbitrary actions as the window's shell is being closed directly, and possibly veto the close.

This method is called from a ShellListener associated with the window, for example when the user clicks the window's close button. It is not called when the window is being closed for other reasons, such as if the user exits the workbench via the ActionFactory.QUIT action. Clients must not call this method directly (although super calls are okay). 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.

Returns:
true to allow the window to close, and false to prevent the window from closing
See Also:
IWorkbenchWindow.close(), WorkbenchAdvisor.preShutdown()

postWindowClose

public void postWindowClose()
Performs arbitrary actions after the 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.


createWindowContents

public void createWindowContents(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.

Parameters:
shell - the window's shell
See Also:
IWorkbenchWindowConfigurer.createMenuBar(), IWorkbenchWindowConfigurer.createCoolBarControl(org.eclipse.swt.widgets.Composite), IWorkbenchWindowConfigurer.createStatusLineControl(org.eclipse.swt.widgets.Composite), IWorkbenchWindowConfigurer.createPageComposite(org.eclipse.swt.widgets.Composite)

createEmptyWindowContents

public Control createEmptyWindowContents(Composite parent)
Creates and returns the control to be shown when the window has no open pages. If null is returned, the default window background is shown.

The default implementation returns null. Subclasses may override.

Parameters:
parent - the parent composite
Returns:
the control or null

isDurableFolder

public boolean isDurableFolder(String perspectiveId,
                               String folderId)
Returns true if the given folder in the given perspective should remain visible even after all parts in it have been closed by the user. The default is false. The return value for a certain combination of perspective id and folder id must not change over time.

Parameters:
perspectiveId - the perspective id
folderId - the folder id
Returns:
true if the given folder should be durable
Since:
3.5

dispose

public void dispose()
Disposes any resources allocated by this window advisor. This is the last method called on this window advisor by the workbench. The default implementation does nothing. Subclasses may extend.


saveState

public IStatus saveState(IMemento memento)
Saves arbitrary application specific state information.

Parameters:
memento - the storage area for object's state
Returns:
a status object indicating whether the save was successful
Since:
3.1

restoreState

public IStatus restoreState(IMemento memento)
Restores arbitrary application specific state information.

Parameters:
memento - the storage area for object's state
Returns:
a status object indicating whether the restore was successful
Since:
3.1

Eclipse Platform
Release 3.7

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.