| org.eclipse.ui.application.IWorkbenchWindowConfigurer
All known Subclasses: org.eclipse.ui.internal.WorkbenchWindowConfigurer,
| IWorkbenchWindowConfigurer | | public interface IWorkbenchWindowConfigurer (Code) | | Interface providing special access for configuring workbench windows.
Window configurer objects are in 1-1 correspondence with the workbench
windows they configure. Clients may use get/setData to
associate arbitrary state with the window configurer object.
Note that these objects are only available to the main application
(the plug-in that creates and owns the workbench).
This interface is not intended to be implemented by clients.
See Also: IWorkbenchConfigurer.getWindowConfigurer
See Also: WorkbenchAdvisor.preWindowOpen
since:
3.0 |
| Method Summary | |
| public void | addEditorAreaTransfer(Transfer transfer)
Adds the given drag and drop Transfer 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. | | public void | configureEditorAreaDropListener(DropTargetListener dropTargetListener)
Configures the drop target listener for the editor area of this workbench window. | | public Control | createCoolBarControl(Composite parent)
Creates the cool bar control. | | public Menu | createMenuBar()
Creates the menu bar for the window's shell.
This should only be called if the advisor is defining custom window contents
in createWindowContents, and may only be called once.
The caller must set it in the shell using Shell.setMenuBar(Menu)
but must not make add, remove or change items in the result.
The menu bar is populated by the window's menu manager. | | public Control | createPageComposite(Composite parent)
Creates the page composite, in which the window's pages, and their
views and editors, appear.
This should only be called if the advisor is defining custom window contents
in createWindowContents, and may only be called once.
The caller must lay out the page composite appropriately within the parent,
but must not add, remove or change items in the result (hence the
return type of Control).
The page composite is populated by the workbench. | | public Control | createStatusLineControl(Composite parent)
Creates the status line control. | | public IActionBarConfigurer | getActionBarConfigurer()
Returns the action bar configurer for this workbench
window. | | public Object | getData(String key)
Returns the data associated with this workbench window at the given key. | | public Point | getInitialSize()
Returns the size to use for the window's shell when it is created. | | public AbstractPresentationFactory | getPresentationFactory()
Returns the presentation factory for this window. | | public int | getShellStyle()
Returns the style bits to use for the window's shell when it is created. | | public boolean | getShowCoolBar()
Returns whether the underlying workbench window has a cool bar. | | public boolean | getShowFastViewBars()
Returns whether the underlying workbench window has fast view bars. | | public boolean | getShowMenuBar()
Returns whether the underlying workbench window has a menu bar. | | public boolean | getShowPerspectiveBar()
Returns whether the underlying workbench window has a perspective bar (the
perspective bar provides buttons to quickly switch between perspectives). | | public boolean | getShowProgressIndicator()
Returns whether the underlying workbench window has a progress indicator. | | public boolean | getShowStatusLine()
Returns whether the underlying workbench window has a status line. | | public String | getTitle()
Returns the title of the underlying workbench window. | | public IWorkbenchWindow | getWindow()
Returns the underlying workbench window. | | public IWorkbenchConfigurer | getWorkbenchConfigurer()
Returns the workbench configurer. | | public IStatus | saveState(IMemento memento)
Saves the current state of the window using the specified memento. | | public void | setData(String key, Object data)
Sets the data associated with this workbench window at the given key. | | public void | setInitialSize(Point initialSize)
Sets the size to use for the window's shell when it is created. | | public void | setPresentationFactory(AbstractPresentationFactory factory)
Sets the presentation factory. | | public void | setShellStyle(int shellStyle)
Sets the style bits to use for the window's shell when it is created. | | public void | setShowCoolBar(boolean show)
Sets whether the underlying workbench window has a cool bar. | | public void | setShowFastViewBars(boolean enable)
Sets whether the underlying workbench window has fast view bars. | | public void | setShowMenuBar(boolean show)
Sets whether the underlying workbench window has a menu bar. | | public void | setShowPerspectiveBar(boolean show)
Sets whether the underlying workbench window has a perspective bar (the
perspective bar provides buttons to quickly switch between perspectives). | | public void | setShowProgressIndicator(boolean show)
Sets whether the underlying workbench window has a progress indicator. | | public void | setShowStatusLine(boolean show)
Sets whether the underlying workbench window has a status line. | | public void | setTitle(String title)
Sets the title of the underlying workbench window. |
| addEditorAreaTransfer | | public void addEditorAreaTransfer(Transfer transfer)(Code) | | Adds the given drag and drop Transfer 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. Adding EditorInputTransfer.getInstance()
enables IEditorInputs 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
(with configureEditorAreaDropListener)
capable of handling any of those transfer types.
Parameters:
transfer - a drag and drop transfer object
See Also: IWorkbenchWindowConfigurer.configureEditorAreaDropListener
See Also: org.eclipse.ui.part.EditorInputTransfer |
| configureEditorAreaDropListener | | public void configureEditorAreaDropListener(DropTargetListener dropTargetListener)(Code) | | 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
(with configureEditorAreaDropListener)
capable of handling any of those transfer types.
Parameters:
dropTargetListener - the drop target listener that will handlerequests to drop an object on to the editor area of this window
See Also: IWorkbenchWindowConfigurer.addEditorAreaTransfer |
| createCoolBarControl | | public Control createCoolBarControl(Composite parent)(Code) | | Creates the cool bar control.
This should only be called if the advisor is defining custom window contents
in createWindowContents, and may only be called once.
The caller must lay out the cool bar appropriately within the parent,
but must not add, remove or change items in the result (hence the
return type of Control).
The cool bar is populated by the window's cool bar manager.
The application can add to the cool bar manager in the advisor's
fillActionBars method instead.
Parameters:
parent - the parent composite the cool bar control, suitable for laying out in the parent |
| createMenuBar | | public Menu createMenuBar()(Code) | | Creates the menu bar for the window's shell.
This should only be called if the advisor is defining custom window contents
in createWindowContents, and may only be called once.
The caller must set it in the shell using Shell.setMenuBar(Menu)
but must not make add, remove or change items in the result.
The menu bar is populated by the window's menu manager.
The application can add to the menu manager in the advisor's
fillActionBars method instead.
the menu bar, suitable for setting in the shell |
| createPageComposite | | public Control createPageComposite(Composite parent)(Code) | | Creates the page composite, in which the window's pages, and their
views and editors, appear.
This should only be called if the advisor is defining custom window contents
in createWindowContents, and may only be called once.
The caller must lay out the page composite appropriately within the parent,
but must not add, remove or change items in the result (hence the
return type of Control).
The page composite is populated by the workbench.
Parameters:
parent - the parent composite the page composite, suitable for laying out in the parent |
| createStatusLineControl | | public Control createStatusLineControl(Composite parent)(Code) | | Creates the status line control.
This should only be called if the advisor is defining custom window contents
in createWindowContents, and may only be called once.
The caller must lay out the status line appropriately within the parent,
but must not add, remove or change items in the result (hence the
return type of Control).
The status line is populated by the window's status line manager.
The application can add to the status line manager in the advisor's
fillActionBars method instead.
Parameters:
parent - the parent composite the status line control, suitable for laying out in the parent |
| getActionBarConfigurer | | public IActionBarConfigurer getActionBarConfigurer()(Code) | | Returns the action bar configurer for this workbench
window.
the action bar configurer |
| getData | | public Object getData(String key)(Code) | | Returns the data associated with this workbench window at the given key.
Parameters:
key - the key the data, or null if there is no data at the givenkey |
| getInitialSize | | public Point getInitialSize()(Code) | | Returns the size to use for the window's shell when it is created.
the initial size to use for the shell |
| getPresentationFactory | | public AbstractPresentationFactory getPresentationFactory()(Code) | | Returns the presentation factory for this window. The window consults its presentation
factory for the presentation aspects of views, editors, status lines, and other components
of the window.
If no presentation factory has been set, a default one is returned.
the presentation factory used for this window |
| getShellStyle | | public int getShellStyle()(Code) | | Returns the style bits to use for the window's shell when it is created.
The default is SWT.SHELL_TRIM.
the shell style bits |
| getShowCoolBar | | public boolean getShowCoolBar()(Code) | | Returns whether the underlying workbench window has a cool bar.
The initial value is true.
true for a cool bar, and falsefor no cool bar |
| getShowFastViewBars | | public boolean getShowFastViewBars()(Code) | | Returns whether the underlying workbench window has fast view bars.
The initial value is false.
true for fast view bars, and false for no fast view bars |
| getShowMenuBar | | public boolean getShowMenuBar()(Code) | | Returns whether the underlying workbench window has a menu bar.
The initial value is true.
true for a menu bar, and falsefor no menu bar |
| getShowPerspectiveBar | | public boolean getShowPerspectiveBar()(Code) | | 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.
true for a perspective bar, and falsefor no perspective bar |
| getShowProgressIndicator | | public boolean getShowProgressIndicator()(Code) | | Returns whether the underlying workbench window has a progress indicator.
The initial value is false.
true for a progress indicator, and falsefor no progress indicator |
| getShowStatusLine | | public boolean getShowStatusLine()(Code) | | Returns whether the underlying workbench window has a status line.
The initial value is true.
true for a status line, and falsefor no status line |
| getTitle | | public String getTitle()(Code) | | Returns the title of the underlying workbench window.
the window title |
| getWindow | | public IWorkbenchWindow getWindow()(Code) | | Returns the underlying workbench window.
the workbench window |
| getWorkbenchConfigurer | | public IWorkbenchConfigurer getWorkbenchConfigurer()(Code) | | Returns the workbench configurer.
the workbench configurer |
| setData | | public void setData(String key, Object data)(Code) | | Sets the data associated with this workbench window at the given key.
Parameters:
key - the key
Parameters:
data - the data, or null to delete existing data |
| setInitialSize | | public void setInitialSize(Point initialSize)(Code) | | 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 the preWindowOpen
callback on WorkbenchAdvisor.
Parameters:
initialSize - the initial size to use for the shell |
| setPresentationFactory | | public void setPresentationFactory(AbstractPresentationFactory factory)(Code) | | Sets the presentation factory. The window consults its presentation
factory for the presentation aspects of views, editors, status lines, and other components
of the window.
This must be called before the window's controls are created, for example
in preWindowOpen.
Parameters:
factory - the presentation factory to use for this window |
| setShellStyle | | public void setShellStyle(int shellStyle)(Code) | | 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 the preWindowOpen
callback on WorkbenchAdvisor.
For more details on the applicable shell style bits, see the
documentation for
org.eclipse.swt.widgets.Shell .
Parameters:
shellStyle - the shell style bits |
| setShowCoolBar | | public void setShowCoolBar(boolean show)(Code) | | Sets whether the underlying workbench window has a cool bar.
Parameters:
show - true for a cool bar, and falsefor no cool bar |
| setShowFastViewBars | | public void setShowFastViewBars(boolean enable)(Code) | | Sets whether the underlying workbench window has fast view bars.
Parameters:
enable - true for fast view bars, and false for no fast view bars |
| setShowMenuBar | | public void setShowMenuBar(boolean show)(Code) | | Sets whether the underlying workbench window has a menu bar.
Parameters:
show - true for a menu bar, and falsefor no menu bar |
| setShowPerspectiveBar | | public void setShowPerspectiveBar(boolean show)(Code) | | Sets whether the underlying workbench window has a perspective bar (the
perspective bar provides buttons to quickly switch between perspectives).
Parameters:
show - true for a perspective bar, andfalse for no perspective bar |
| setShowProgressIndicator | | public void setShowProgressIndicator(boolean show)(Code) | | Sets whether the underlying workbench window has a progress indicator.
Parameters:
show - true for a progress indicator, and falsefor no progress indicator |
| setShowStatusLine | | public void setShowStatusLine(boolean show)(Code) | | Sets whether the underlying workbench window has a status line.
Parameters:
show - true for a status line, and falsefor no status line |
| setTitle | | public void setTitle(String title)(Code) | | Sets the title of the underlying workbench window.
Parameters:
title - the window title |
|
|