|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IWorkbenchWindowConfigurer
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 org.eclipse.jface.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.
IWorkbenchConfigurer.getWindowConfigurer(org.eclipse.ui.IWorkbenchWindow)
,
WorkbenchAdvisor.preWindowOpen(org.eclipse.ui.application.IWorkbenchWindowConfigurer)
Method Summary | |
---|---|
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 org.eclipse.jface.window. |
Control |
createPageComposite(Composite parent)
Creates the page composite, in which the org.eclipse.jface.window's pages, and their views and editors, appear. |
Control |
createStatusLineControl(Composite parent)
Creates the status line control. |
java.lang.Object |
getData(java.lang.String key)
Returns the data associated with this workbench org.eclipse.jface.window at the given key. |
Point |
getInitialSize()
Returns the size to use for the org.eclipse.jface.window's shell when it is created. |
int |
getShellStyle()
Returns the style bits to use for the org.eclipse.jface.window's shell when it is created. |
boolean |
getShowFastViewBars()
Returns whether the underlying workbench org.eclipse.jface.window has fast view bars. |
boolean |
getShowProgressIndicator()
Returns whether the underlying workbench org.eclipse.jface.window has a progress indicator. |
boolean |
getShowStatusLine()
Returns whether the underlying workbench org.eclipse.jface.window has a status line. |
java.lang.String |
getTitle()
Returns the title of the underlying workbench org.eclipse.jface.window. |
IWorkbenchWindow |
getWindow()
Returns the underlying workbench org.eclipse.jface.window. |
IWorkbenchConfigurer |
getWorkbenchConfigurer()
Returns the workbench configurer. |
void |
setData(java.lang.String key,
java.lang.Object data)
Sets the data associated with this workbench org.eclipse.jface.window at the given key. |
void |
setInitialSize(Point initialSize)
Sets the size to use for the org.eclipse.jface.window's shell when it is created. |
void |
setShellStyle(int shellStyle)
Sets the style bits to use for the org.eclipse.jface.window's shell when it is created. |
void |
setShowFastViewBars(boolean enable)
Sets whether the underlying workbench org.eclipse.jface.window has fast view bars. |
void |
setShowProgressIndicator(boolean show)
Sets whether the underlying workbench org.eclipse.jface.window has a progress indicator. |
void |
setShowStatusLine(boolean show)
Sets whether the underlying workbench org.eclipse.jface.window has a status line. |
void |
setTitle(java.lang.String title)
Sets the title of the underlying workbench org.eclipse.jface.window. |
Method Detail |
---|
IWorkbenchWindow getWindow()
IWorkbenchConfigurer getWorkbenchConfigurer()
java.lang.String getTitle()
void setTitle(java.lang.String title)
title
- the org.eclipse.jface.window titleboolean getShowStatusLine()
The initial value is true
.
true
for a status line, and false
for no status linevoid setShowStatusLine(boolean show)
show
- true
for a status line, and false
for no status lineboolean getShowFastViewBars()
The initial value is false
.
true
for fast view bars, and
false
for no fast view barsvoid setShowFastViewBars(boolean enable)
enable
- true
for fast view bars, and
false
for no fast view barsboolean getShowProgressIndicator()
The initial value is false
.
true
for a progress indicator, and false
for no progress indicatorvoid setShowProgressIndicator(boolean show)
show
- true
for a progress indicator, and false
for no progress indicatorint getShellStyle()
SWT.SHELL_TRIM
.
void setShellStyle(int shellStyle)
preWindowOpen
callback on WorkbenchAdvisor
.
shellStyle
- the shell style bitsPoint getInitialSize()
void setInitialSize(Point initialSize)
preWindowOpen
callback on WorkbenchAdvisor
.
initialSize
- the initial size to use for the shelljava.lang.Object getData(java.lang.String key)
key
- the key
null
if there is no data at the given
keyvoid setData(java.lang.String key, java.lang.Object data)
key
- the keydata
- the data, or null
to delete existing datavoid addEditorAreaTransfer(Transfer transfer)
Transfer
type to the ones
supported for drag and drop on the editor area of this workbench org.eclipse.jface.window.
The workbench advisor would ordinarily call this method from the
preWindowOpen
callback.
A newly-created workbench org.eclipse.jface.window supports no drag and drop transfer
types. Adding EditorInputTransfer.getInstance()
enables IEditorInput
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
(with configureEditorAreaDropListener
)
capable of handling any of those transfer types.
transfer
- a drag and drop transfer object#configureEditorAreaDropListener
,
EditorInputTransfer
Control createStatusLineControl(Composite parent)
This should only be called if the advisor is defining custom org.eclipse.jface.window contents
in createWindowContents
.
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 org.eclipse.jface.window's status line manager.
The application can add to the status line manager in the advisor's
fillActionBars
method instead.
parent
- the parent composite
Control createPageComposite(Composite parent)
This should only be called if the advisor is defining custom org.eclipse.jface.window contents
in createWindowContents
.
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.
parent
- the parent composite
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |