Class WorkbenchWindowConfigurer
- All Implemented Interfaces:
IWorkbenchWindowConfigurer
Note that these objects are only available to the main application (the plug-in that creates and owns the workbench).
This class is not intended to be instantiated or subclassed by clients.
- Since:
- 3.0
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addEditorAreaTransfer
(Transfer tranfer) Adds the given drag and dropTransfer
type to the ones supported for drag and drop on the editor area of this workbench window.void
configureEditorAreaDropListener
(DropTargetListener dropTargetListener) Configures the drop target listener for the editor area of this workbench window.void
createDefaultContents
(Shell shell) Creates the default window contents.Returns the action bar configurer for this workbench window.Returns the data associated with this workbench window at the given key.Returns the size to use for the window's shell when it is created.int
Returns the style bits to use for the window's shell when it is created.boolean
Returns whether the underlying workbench window has a cool bar.boolean
Returns whether the underlying workbench window has a menu bar.boolean
Returns whether the underlying workbench window has a perspective bar (the perspective bar provides buttons to quickly switch between perspectives).boolean
Returns whether the underlying workbench window has a progress indicator.boolean
Returns whether the underlying workbench window has a status line.getTitle()
Returns the title of the underlying workbench window.Returns the underlying workbench window.Returns the workbench configurer.Saves the current state of the window using the specified memento.void
Sets the data associated with this workbench window at the given key.void
setInitialSize
(Point size) Sets the size to use for the window's shell when it is created.void
setShellStyle
(int shellStyle) Sets the style bits to use for the window's shell when it is created.void
setShowCoolBar
(boolean show) Sets whether the underlying workbench window has a cool bar.void
setShowMenuBar
(boolean show) Sets whether the underlying workbench window has a menu bar.void
setShowPerspectiveBar
(boolean show) Sets whether the underlying workbench window has a perspective bar (the perspective bar provides buttons to quickly switch between perspectives).void
setShowProgressIndicator
(boolean show) Sets whether the underlying workbench window has a progress indicator.void
setShowStatusLine
(boolean show) Sets whether the underlying workbench window has a status line.void
Sets the title of the underlying workbench window.
-
Method Details
-
getWindow
Description copied from interface:IWorkbenchWindowConfigurer
Returns the underlying workbench window.- Specified by:
getWindow
in interfaceIWorkbenchWindowConfigurer
- Returns:
- the workbench window
-
getWorkbenchConfigurer
Description copied from interface:IWorkbenchWindowConfigurer
Returns the workbench configurer.- Specified by:
getWorkbenchConfigurer
in interfaceIWorkbenchWindowConfigurer
- Returns:
- the workbench configurer
-
getTitle
Description copied from interface:IWorkbenchWindowConfigurer
Returns the title of the underlying workbench window.- Specified by:
getTitle
in interfaceIWorkbenchWindowConfigurer
- Returns:
- the window title
-
setTitle
Description copied from interface:IWorkbenchWindowConfigurer
Sets the title of the underlying workbench window.- Specified by:
setTitle
in interfaceIWorkbenchWindowConfigurer
- Parameters:
title
- the window title
-
getShowMenuBar
public boolean getShowMenuBar()Description copied from interface:IWorkbenchWindowConfigurer
Returns whether the underlying workbench window has a menu bar.The initial value is
true
.- Specified by:
getShowMenuBar
in interfaceIWorkbenchWindowConfigurer
- Returns:
true
for a menu bar, andfalse
for no menu bar
-
setShowMenuBar
public void setShowMenuBar(boolean show) Description copied from interface:IWorkbenchWindowConfigurer
Sets whether the underlying workbench window has a menu bar.- Specified by:
setShowMenuBar
in interfaceIWorkbenchWindowConfigurer
- Parameters:
show
-true
for a menu bar, andfalse
for no menu bar
-
getShowCoolBar
public boolean getShowCoolBar()Description copied from interface:IWorkbenchWindowConfigurer
Returns whether the underlying workbench window has a cool bar.The initial value is
true
.- Specified by:
getShowCoolBar
in interfaceIWorkbenchWindowConfigurer
- Returns:
true
for a cool bar, andfalse
for no cool bar
-
setShowCoolBar
public void setShowCoolBar(boolean show) Description copied from interface:IWorkbenchWindowConfigurer
Sets whether the underlying workbench window has a cool bar.- Specified by:
setShowCoolBar
in interfaceIWorkbenchWindowConfigurer
- Parameters:
show
-true
for a cool bar, andfalse
for no cool bar
-
getShowPerspectiveBar
public boolean getShowPerspectiveBar()Description copied from interface:IWorkbenchWindowConfigurer
Returns whether the underlying workbench window has a perspective bar (the perspective bar provides buttons to quickly switch between perspectives).The initial value is
false
.- Specified by:
getShowPerspectiveBar
in interfaceIWorkbenchWindowConfigurer
- Returns:
true
for a perspective bar, andfalse
for no perspective bar
-
setShowPerspectiveBar
public void setShowPerspectiveBar(boolean show) Description copied from interface:IWorkbenchWindowConfigurer
Sets whether the underlying workbench window has a perspective bar (the perspective bar provides buttons to quickly switch between perspectives).- Specified by:
setShowPerspectiveBar
in interfaceIWorkbenchWindowConfigurer
- Parameters:
show
-true
for a perspective bar, andfalse
for no perspective bar
-
getShowStatusLine
public boolean getShowStatusLine()Description copied from interface:IWorkbenchWindowConfigurer
Returns whether the underlying workbench window has a status line.The initial value is
true
.- Specified by:
getShowStatusLine
in interfaceIWorkbenchWindowConfigurer
- Returns:
true
for a status line, andfalse
for no status line
-
setShowStatusLine
public void setShowStatusLine(boolean show) Description copied from interface:IWorkbenchWindowConfigurer
Sets whether the underlying workbench window has a status line.- Specified by:
setShowStatusLine
in interfaceIWorkbenchWindowConfigurer
- Parameters:
show
-true
for a status line, andfalse
for no status line
-
getShowProgressIndicator
public boolean getShowProgressIndicator()Description copied from interface:IWorkbenchWindowConfigurer
Returns whether the underlying workbench window has a progress indicator.The initial value is
false
.- Specified by:
getShowProgressIndicator
in interfaceIWorkbenchWindowConfigurer
- Returns:
true
for a progress indicator, andfalse
for no progress indicator
-
setShowProgressIndicator
public void setShowProgressIndicator(boolean show) Description copied from interface:IWorkbenchWindowConfigurer
Sets whether the underlying workbench window has a progress indicator.- Specified by:
setShowProgressIndicator
in interfaceIWorkbenchWindowConfigurer
- Parameters:
show
-true
for a progress indicator, andfalse
for no progress indicator
-
getData
Description copied from interface:IWorkbenchWindowConfigurer
Returns the data associated with this workbench window at the given key.- Specified by:
getData
in interfaceIWorkbenchWindowConfigurer
- Parameters:
key
- the key- Returns:
- the data, or
null
if there is no data at the given key
-
setData
Description copied from interface:IWorkbenchWindowConfigurer
Sets the data associated with this workbench window at the given key.- Specified by:
setData
in interfaceIWorkbenchWindowConfigurer
- Parameters:
key
- the keydata
- the data, ornull
to delete existing data
-
addEditorAreaTransfer
Description copied from interface:IWorkbenchWindowConfigurer
Adds the given drag and dropTransfer
type to the ones supported for drag and drop on the editor area of this workbench window.The workbench advisor would ordinarily call this method from the
preWindowOpen
callback. A newly-created workbench window supports no drag and drop transfer types. AddingEditorInputTransfer.getInstance()
enablesIEditorInput
s to be transferred.Note that drag and drop to the editor area requires adding one or more transfer types (using
addEditorAreaTransfer
) and configuring a drop target listener (withconfigureEditorAreaDropListener
) capable of handling any of those transfer types.- Specified by:
addEditorAreaTransfer
in interfaceIWorkbenchWindowConfigurer
- Parameters:
tranfer
- a drag and drop transfer object- See Also:
-
configureEditorAreaDropListener
Description copied from interface:IWorkbenchWindowConfigurer
Configures the drop target listener for the editor area of this workbench window.The workbench advisor ordinarily calls this method from the
preWindowOpen
callback. A newly-created workbench window has no configured drop target listener for its editor area.Note that drag and drop to the editor area requires adding one or more transfer types (using
addEditorAreaTransfer
) and configuring a drop target listener (withconfigureEditorAreaDropListener
) capable of handling any of those transfer types.- Specified by:
configureEditorAreaDropListener
in interfaceIWorkbenchWindowConfigurer
- Parameters:
dropTargetListener
- the drop target listener that will handle requests to drop an object on to the editor area of this window- See Also:
-
getActionBarConfigurer
Description copied from interface:IWorkbenchWindowConfigurer
Returns the action bar configurer for this workbench window.- Specified by:
getActionBarConfigurer
in interfaceIWorkbenchWindowConfigurer
- Returns:
- the action bar configurer
-
getShellStyle
public int getShellStyle()Description copied from interface:IWorkbenchWindowConfigurer
Returns the style bits to use for the window's shell when it is created. The default isSWT.SHELL_TRIM
.- Specified by:
getShellStyle
in interfaceIWorkbenchWindowConfigurer
- Returns:
- the shell style bits
-
setShellStyle
public void setShellStyle(int shellStyle) Description copied from interface:IWorkbenchWindowConfigurer
Sets the style bits to use for the window's shell when it is created. This method has no effect after the shell is created. That is, it must be called within thepreWindowOpen
callback onWorkbenchAdvisor
.For more details on the applicable shell style bits, see the documentation for
Shell
.- Specified by:
setShellStyle
in interfaceIWorkbenchWindowConfigurer
- Parameters:
shellStyle
- the shell style bits
-
getInitialSize
Description copied from interface:IWorkbenchWindowConfigurer
Returns the size to use for the window's shell when it is created.- Specified by:
getInitialSize
in interfaceIWorkbenchWindowConfigurer
- Returns:
- the initial size to use for the shell
-
setInitialSize
Description copied from interface:IWorkbenchWindowConfigurer
Sets the size to use for the window's shell when it is created. This method has no effect after the shell is created. That is, it must be called within thepreWindowOpen
callback onWorkbenchAdvisor
.- Specified by:
setInitialSize
in interfaceIWorkbenchWindowConfigurer
- Parameters:
size
- the initial size to use for the shell
-
createDefaultContents
Creates the default window contents.- Parameters:
shell
- the shell
-
saveState
Description copied from interface:IWorkbenchWindowConfigurer
Saves the current state of the window using the specified memento.- Specified by:
saveState
in interfaceIWorkbenchWindowConfigurer
- Parameters:
memento
- the memento in which to save the window's state- Returns:
- a status object indicating whether the save was successful
- See Also:
-