Model extensions

Identifier:

org.eclipse.e4.ui.workbench.model

Since:

4.2

Description:

This is not an API. The schema for this extension point is not frozen and might change in a non-backward compatible way in the future.

This extension point provides extensibility for the UI model of the running application. Modifications can be done in a declarative manner by using XML model fragments, or programmatically by supplying model processors.

Whenever possible, the model extensions of dependent bundles are processed before the extensions of bundles that depend on them.

Configuration Markup:

<!ELEMENT extension (fragment* , processor*)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #REQUIRED

name CDATA #IMPLIED>

<!ELEMENT fragment EMPTY>

<!ATTLIST fragment

uri CDATA #REQUIRED

apply (always|initial|notexists) "always">

The model fragment to be added to the UI model of the running application. The root element of the model fragment is expected to conform to the org.eclipse.e4.ui.model.fragment.MModelFragments interface.

uri - URI describing location of the model fragment. Can be of the form platform:/plugin/bundle.id/...path.
apply - This attribute defines in which case a fragment is merged into the model:
- always: each time the application started potentially replacing existing model elements and loosing information stored
- initial: only when coming from a none persistent state
- notexists: only if the given element does not exist already in the model

<!ELEMENT processor (element*)>

<!ATTLIST processor

class CDATA #REQUIRED

beforefragment (true | false)

apply (always|initial) "always">

Programmatic processor that gets called with the intention of modifying UI model.

class - Java class containing model processor. A class method with the qualifier "org.eclipse.e4.core.di.annotations.Execute" will be invoked as a part of the model processing.
beforefragment - This flag specifies that the processor has to be invoked before model fragments are added.
apply - This attribute defines in which case a processor is run
- always: each time the application started
- initial: only when coming from a none persistent state

<!ELEMENT element EMPTY>

<!ATTLIST element

id CDATA #REQUIRED

contextKey CDATA #IMPLIED>

A model element to be added to the context used to invoke the processor.

id - Identifier of a model element to be added to the context.
contextKey - An optional key under which to store the model element in the context. The value of "id" is used if this value is not specified.

Examples:

The following is an example for the preference extension point:


   <extension
         id="themeContribution"
         point="org.eclipse.e4.workbench.model">
      <processor
            beforefragment="true"
            class="org.eclipse.e4.demo.simpleide.internal.ThemeMenuProcessor">
         <element
               id="simpleide.mainmenu">
         </element>
      </processor>
   </extension>
   <extension
         id="logContribution"
         point="org.eclipse.e4.workbench.model">
      <snippet
            uri="platform:/plugin/org.eclipse.e4.demo.log/xmi/components.e4xmi">
      </snippet>
   </extension>

Copyright (c) 2010, 2014 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0