Package org.eclipse.e4.ui.workbench
Interface IWorkbench
-
public interface IWorkbenchA running instance of the workbench. This instance is published through:- the
IEclipseContextof the application - the OSGi-Service-Registry
IWorkbenchinstances in one OSGi-Instance- Since:
- 1.0
- Restriction:
- This interface is not intended to be implemented by clients.
- the
-
-
Field Summary
Fields Modifier and Type Field Description static StringAPPLICATION_CONTEXT_KEYContext key to retrieve the application context in most applications (like e.g., e4).static StringCLEAR_PERSISTED_STATEThe argument for whether the persisted state should be cleared on startup
Value is:clearPersistedStatestatic StringCSS_RESOURCE_URI_ARGThe argument for theURIof the resources referenced from the application CSS file
Value is:applicationCSSResourcesstatic StringCSS_URI_ARGstatic StringLIFE_CYCLE_URI_ARGstatic StringMODEL_RESOURCE_HANDLERThe argument for the resource handler to use
Value is:modelResourceHandlerstatic StringON_TOPThis named context parameter is used to specify whether aMPartor aMPlaceholderare shown on top, which means the contents of it can be seen by the user in the UI.static StringPERSIST_STATEThe argument for whether the workbench should save and restore its state
Individual model elements can add it to their persistedState with the value of "false" to declare that they should not be persisted.static StringPRESENTATION_URI_ARGstatic StringXMI_URI_ARG
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanclose()Close the workbench instanceMApplicationgetApplication()StringgetId()booleanrestart()restart the workbench
-
-
-
Field Detail
-
CLEAR_PERSISTED_STATE
static final 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 String CSS_RESOURCE_URI_ARG
The argument for theURIof 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 String CSS_URI_ARG
- Since:
- 0.12.0
- See Also:
- Constant Field Values
-
LIFE_CYCLE_URI_ARG
static final String LIFE_CYCLE_URI_ARG
- Since:
- 0.12.0
- See Also:
- Constant Field Values
-
MODEL_RESOURCE_HANDLER
static final String MODEL_RESOURCE_HANDLER
The argument for the resource handler to use
Value is:modelResourceHandler- See Also:
- Constant Field Values
-
PERSIST_STATE
static final String PERSIST_STATE
The argument for whether the workbench should save and restore its state
Individual model elements can add it to their persistedState with the value of "false" to declare that they should not be persisted.
Value is:persistState- See Also:
- Constant Field Values
-
PRESENTATION_URI_ARG
static final String PRESENTATION_URI_ARG
- Since:
- 0.12.0
- See Also:
- Constant Field Values
-
XMI_URI_ARG
static final String XMI_URI_ARG
- Since:
- 0.12.0
- See Also:
- Constant Field Values
-
APPLICATION_CONTEXT_KEY
static final 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 fromEclipseContextFactory.getServiceContext(org.osgi.framework.BundleContext)- Since:
- 1.4
- See Also:
- Constant Field Values
-
ON_TOP
static final String ON_TOP
This named context parameter is used to specify whether aMPartor aMPlaceholderare 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_TOPkey.Note that also objects created with a parts' context can obtain this
ON_TOPkey, 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:
trueif the shutdown succeeds
-
getApplication
MApplication getApplication()
- Returns:
- the application model driving the workbench
-
getId
String getId()
- Returns:
- unique id of the instance
-
restart
boolean restart()
restart the workbench- Returns:
falseif the restart is aborted
-
-