IWorkbench

All Known Implementing Classes:

E4Workbench
```
public interface IWorkbench
```
A running instance of the workbench. This instance is published through:
- the IEclipseContext of the application
- the OSGi-Service-Registry
It is possible that there are multiple active IWorkbench instances in one OSGi-Instance
Since:

1.0

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPLICATION_CONTEXT_KEY` Context key to retrieve the application context in most applications (like e.g., e4).
`static java.lang.String`	`CLEAR_PERSISTED_STATE` The argument for whether the persisted state should be cleared on startup Value is: `clearPersistedState`
`static java.lang.String`	`CSS_RESOURCE_URI_ARG` The argument for the `URI` of the resources referenced from the application CSS file Value is: `applicationCSSResources`
`static java.lang.String`	`CSS_URI_ARG` The argument for the `URI` of the application CSS file Value is: `applicationCSS`
`static java.lang.String`	`LIFE_CYCLE_URI_ARG` The argument for the `URI` of the life-cycle manager Value is: `lifeCycleURI`
`static java.lang.String`	`MODEL_RESOURCE_HANDLER` The argument for the resource handler to use Value is: `modelResourceHandler`
`static java.lang.String`	`ON_TOP` This named context parameter is used to specify whether a `MPart` or a `MPlaceholder` are shown on top, which means the contents of it can be seen by the user in the UI.
`static java.lang.String`	`PERSIST_STATE` The argument for whether the workbench should save and restore its state < Value is: `persistState`
`static java.lang.String`	`PRESENTATION_URI_ARG` The argument for the `URI` of the application presentation Value is: `presentationURI`
`static java.lang.String`	`XMI_URI_ARG` The argument for the `URI` of the applicaton.xmi file Value is: `applicationXMI`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`close()` Close the workbench instance
`MApplication`	`getApplication()`
`java.lang.String`	`getId()`
`boolean`	`restart()` restart the workbench

- Field Detail
  - CLEAR_PERSISTED_STATE
```
static final java.lang.String CLEAR_PERSISTED_STATE
```
    The argument for whether the persisted state should be cleared on startup
    
    Value is: clearPersistedState
    
    See Also:
    
    Constant Field Values
  - CSS_RESOURCE_URI_ARG
```
static final java.lang.String CSS_RESOURCE_URI_ARG
```
    The argument for the URI of the resources referenced from the application CSS file
    
    Value is: applicationCSSResources
    
    Since:
    
    0.12.0
    
    See Also:
    
    Constant Field Values
  - CSS_URI_ARG
```
static final java.lang.String CSS_URI_ARG
```
    The argument for the URI of the application CSS file
    
    Value is: applicationCSS
    
    Since:
    
    0.12.0
    
    See Also:
    
    Constant Field Values
  - LIFE_CYCLE_URI_ARG
```
static final java.lang.String LIFE_CYCLE_URI_ARG
```
    The argument for the URI of the life-cycle manager
    
    Value is: lifeCycleURI
    
    Since:
    
    0.12.0
    
    See Also:
    
    Constant Field Values
  - MODEL_RESOURCE_HANDLER
```
static final java.lang.String MODEL_RESOURCE_HANDLER
```
    The argument for the resource handler to use
    
    Value is: modelResourceHandler
    
    See Also:
    
    Constant Field Values
  - PERSIST_STATE
```
static final java.lang.String PERSIST_STATE
```
    The argument for whether the workbench should save and restore its state
    <
    Value is: persistState
    
    See Also:
    
    Constant Field Values
  - PRESENTATION_URI_ARG
```
static final java.lang.String PRESENTATION_URI_ARG
```
    The argument for the URI of the application presentation
    
    Value is: presentationURI
    
    Since:
    
    0.12.0
    
    See Also:
    
    Constant Field Values
  - XMI_URI_ARG
```
static final java.lang.String XMI_URI_ARG
```
    The argument for the URI of the applicaton.xmi file
    
    Value is: applicationXMI
    
    Since:
    
    0.12.0
    
    See Also:
    
    Constant Field Values
  - APPLICATION_CONTEXT_KEY
```
static final java.lang.String APPLICATION_CONTEXT_KEY
```
    Context key to retrieve the application context in most applications (like e.g., e4). This context is the direct child of the root context which is retrieved from EclipseContextFactory#getServiceContext(org.osgi.framework.BundleContext)
    
    Since:
    
    1.4
    
    See Also:
    
    Constant Field Values
  - ON_TOP
```
static final java.lang.String ON_TOP
```
    This named context parameter is used to specify whether a MPart or a MPlaceholder are shown on top, which means the contents of it can be seen by the user in the UI.
    This means clients can obtain the state of being on top by asking the part's context for the ON_TOP key.
    
    Note that also objects created with a parts' context can obtain this ON_TOP key, e.g., MToolControl.
```
 @Inject
 @Optional
 private void onTop(@Named(IWorkbench.ON_TOP) Boolean onTop) {
        if (onTop != null && onTop.booleanValue()) {
                // ... do something when element is on top
        }
 }
 
```
    Since:
    
    1.5
    
    See Also:
    
    Constant Field Values
- Method Detail
  - close
```
boolean close()
```
    Close the workbench instance
    
    Returns:
    
    true if the shutdown succeeds
  - getApplication
```
MApplication getApplication()
```
    Returns:
    
    the application model driving the workbench
  - getId
```
java.lang.String getId()
```
    Returns:
    
    unique id of the instance
  - restart
```
boolean restart()
```
    restart the workbench
    
    Returns:
    
    false if the restart is aborted

Interface IWorkbench

Field Summary

Method Summary

Field Detail

CLEAR_PERSISTED_STATE

CSS_RESOURCE_URI_ARG

CSS_URI_ARG

LIFE_CYCLE_URI_ARG

MODEL_RESOURCE_HANDLER

PERSIST_STATE

PRESENTATION_URI_ARG

XMI_URI_ARG

APPLICATION_CONTEXT_KEY

ON_TOP

Method Detail

close

getApplication

getId

restart