|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.application.WorkbenchWindowAdvisor
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
):
preWindowOpen
- called as the window is being opened;
use to configure aspects of the window other than actions barspostWindowRestore
- called after the window has been
recreated from a previously saved state; use to adjust the restored
windowpostWindowCreate
- called after the window has been created,
either from an initial state or from a restored state; used to adjust the
windowopenIntro
- called immediately before the window is opened in
order to create the introduction component, if any.postWindowOpen
- called after the window has been
opened; use to hook window listeners, etc.preWindowShellClose
- called when the window's shell
is closed by the user; use to pre-screen window closings
Constructor Summary | |
---|---|
WorkbenchWindowAdvisor(IWorkbenchWindowConfigurer configurer)
Creates a new workbench window advisor for configuring a workbench window via the given workbench window configurer. |
Method Summary | |
---|---|
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. |
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 |
public WorkbenchWindowAdvisor(IWorkbenchWindowConfigurer configurer)
configurer
- an object for configuring the workbench windowMethod Detail |
protected IWorkbenchWindowConfigurer getWindowConfigurer()
public void preWindowOpen()
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.
public ActionBarAdvisor createActionBarAdvisor(IActionBarConfigurer configurer)
ActionBarAdvisor
.
configurer
- the action bar configurer for the window
public void postWindowRestore() throws WorkbenchException
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.
WorkbenchException
- thrown if there are any errors to report
from post-restoration of the windowpublic void openIntro()
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.
public void postWindowCreate()
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.
public void postWindowOpen()
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.
public boolean preWindowShellClose()
This method is called from a ShellListener associated with the 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). 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.
true
to allow the window to close, and
false
to prevent the window from closingIWorkbenchWindow.close()
public void postWindowClose()
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.
public void createWindowContents(Shell shell)
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
.
shell
- the window's shellIWorkbenchWindowConfigurer.createMenuBar()
,
IWorkbenchWindowConfigurer.createCoolBarControl(org.eclipse.swt.widgets.Composite)
,
IWorkbenchWindowConfigurer.createStatusLineControl(org.eclipse.swt.widgets.Composite)
,
IWorkbenchWindowConfigurer.createPageComposite(org.eclipse.swt.widgets.Composite)
public Control createEmptyWindowContents(Composite parent)
null
is returned, the default window background is shown.
The default implementation returns null
.
Subclasses may override.
parent
- the parent composite
null
public void dispose()
public IStatus saveState(IMemento memento)
memento
- the storage area for object's state
public IStatus restoreState(IMemento memento)
memento
- the storage area for object's state
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.