org.csstudio.startup.module
Interface WorkbenchExtPoint

All Superinterfaces:

CSSStartupExtensionPoint

public interface WorkbenchExtPoint
extends CSSStartupExtensionPoint

RunWorkbenchExtPoint defines the actions that are executed during the workbench startup. Only one extension point of this type is allowed per product.

Author:

Jaka Bobnar

NAME

static final java.lang.String NAME

The name of this extension point element

See Also:

Constant Field Values

beforeWorkbenchCreation

java.lang.Object beforeWorkbenchCreation(Display display,
                                         IApplicationContext context,
                                         java.util.Map<java.lang.String,java.lang.Object> parameters)
                                         throws java.lang.Exception

Is called just before the workbench is started. This method can run additional services or sets up whatever is needed for proper running of the workbench.

Parameters:

display - the display of the application

context - the application's context

parameters - contains additional parameters, which can define some special behaviour during the execution of this method (the keys are parameters names and the values are parameters values)

Returns:

the exit code if something happened which requires to exit or restart application or null if everything is alright

Throws:

java.lang.Exception - if an error occurred during the operation

afterWorkbenchCreation

java.lang.Object afterWorkbenchCreation(Display display,
                                        IApplicationContext context,
                                        java.util.Map<java.lang.String,java.lang.Object> parameters)
                                        throws java.lang.Exception

Is called just after the workbench is created. This method can run additional services or destroys/sets up whatever it has for proper application closing.

Parameters:

display - the display of the application

context - the application's context

parameters - contains additional parameters, which can define some special behaviour during the execution of this method (the keys are parameters names and the values are parameters values)

Returns:

the exit code if something happened which requires to exit or restart application or null if everything is alright

Throws:

java.lang.Exception - if an error occurred during the operation

runWorkbench

java.lang.Object runWorkbench(Display display,
                              IApplicationContext context,
                              java.util.Map<java.lang.String,java.lang.Object> parameters)
                              throws java.lang.Exception

Runs the workbench. The implementation should create the workbench with the appropriate advisors and run it.

Parameters:

display - the display of the application

context - the application's context

parameters - contains additional parameters, which can define some special behaviour during the execution of this method (the keys are parameters names and the values are parameters values)

Returns:

the exit code, which defines how the application exited

Throws:

java.lang.Exception - if an error occurred during the operation