Package org.eclipse.e4.ui.model.application

Interface MApplication

All Superinterfaces:
MApplicationElement, MBindings, MBindingTableContainer, MContext, MElementContainer<MWindow>, MHandlerContainer, MLocalizable, MMenuContributions, MPartDescriptorContainer, MSnippetContainer, MToolBarContributions, MTrimContributions, MUIElement
All Known Implementing Classes:
ApplicationImpl
public interface MApplication extends MElementContainer<MWindow>, MContext, MHandlerContainer, MBindingTableContainer, MPartDescriptorContainer, MBindings, MMenuContributions, MToolBarContributions, MTrimContributions, MSnippetContainer
A representation of the model object 'Application'.

The MApplication acts as the root of the UI Model. It's children are the MWindows representing the UI for this application. It also owns the application's context (which is hooked to the OSGI context, allowing access not only to its own runtime information but also to any registered OSGI service.

It also owns a number of caches which, while independent of the UI itself are used by the application to populate new windows or to define state that is expected to be the same for all windows:

  • Keybindings, Handlers, Commands
  • Part Descriptors (to support a 'Show View' dialog...)
  • Snippets of model (such as saved perspectives...)
Since:
1.0
Restriction:
This interface is not intended to be implemented by clients.

The following features are supported:

  • Method Details

    • getCommands

      List<MCommand> getCommands()
      Returns the value of the 'Commands' containment reference list. The list contents are of type MCommand.

      This is the list of MCommand elements available in the application. Commands represent some logical operation. The actual implementation of the operation is determined by the MHandler chosen by the system based on the current execution context.

      Returns:
      the value of the 'Commands' containment reference list.

    • getAddons

      List<MAddon> getAddons()
      Returns the value of the 'Addons' containment reference list. The list contents are of type MAddon.

      This is the ordered list of MAddons for this model. The individual addons will be created through injection after the model loads but before it is rendered.

      Returns:
      the value of the 'Addons' containment reference list.

    • getCategories

      List<MCategory> getCategories()
      Returns the value of the 'Categories' containment reference list. The list contents are of type MCategory.

      Developers: Add more detailed documentation by editing this comment in org.eclipse.ui.model.workbench/model/UIElements.ecore. There is a GenModel/documentation node under each type and attribute.

      Returns:
      the value of the 'Categories' containment reference list.

    • getCommand

      MCommand getCommand(String elementId)
      Returns the model element for the command identified via the elementId or null if the element cannot be found.
      Parameters:
      elementId - the ID of the command.
      Returns:
      the model element for the command identified via the elementId or null if the element cannot be found.
      Since:
      1.2