Interface IWorkbench


  • public interface IWorkbench
    A running instance of the workbench. This instance is published through: It is possible that there are multiple active IWorkbench instances in one OSGi-Instance
    Since:
    1.0
    Restriction:
    This interface is not intended to be implemented by clients.
    • 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 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 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 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 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
        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 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
      • ON_TOP

        static final 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

        String getId()
        Returns:
        unique id of the instance
      • restart

        boolean restart()
        restart the workbench
        Returns:
        false if the restart is aborted