Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: for the plan.

Jump to: navigation, search

Graphical Modeling Framework/Tips

< Graphical Modeling Framework
Revision as of 04:11, 23 March 2015 by Unnamed Poltroon (Talk) (Find Editor in which an EditPart is located)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

A collection of snippets and tips...

Creating New Elements And Corresponding Views

DeviceEditPart selectedElement = ...;

String compartemntsSemanticHint = NetworkVisualIDRegistry.getType(;
Device_ModulesCompartmentEditPart modulesCompartment = (Device_ModulesCompartmentEditPart)selectedElement.getChildBySemanticHint(compartemntsSemanticHint);

IElementType type = NetworkElementTypes.Module_3001;

ViewAndElementDescriptor viewDescriptor = new ViewAndElementDescriptor(
		new CreateElementRequestAdapter(new CreateElementRequest(type)),
		((IHintedType) type).getSemanticHint(), 

CreateViewAndElementRequest req = new CreateViewAndElementRequest(viewDescriptor);
CompoundCommand cmd = new CompoundCommand("Create 10 modules");
for (int i=0; i<10; i++) {

Change Names Of Newly Created Elements

Collection results = DiagramCommandStack.getReturnValues(cmd);
for (Object res: results) {
	if (res instanceof IAdaptable) {
		IAdaptable adapter = (IAdaptable) res;
		View view = (View) adapter.getAdapter(View.class);
		if (view != null) {
			Module newMod = (Module)view.getElement();
			SetRequest reqSet = new SetRequest(selectedElement.getEditingDomain(),
					newMod, NetworkPackage.eINSTANCE.getNamedElement_Name(),
			SetValueCommand operation = new SetValueCommand(reqSet);

Create New Elements Using RecordingCommand and CanonicalEditPolicies

final Device dev = (Device)((View)selectedElement.getModel()).getElement();
TransactionalEditingDomain editingDomain = selectedElement.getEditingDomain();
editingDomain.getCommandStack().execute(new RecordingCommand(editingDomain) {
	protected void doExecute() {
		for (int i = 0; i < 5; i++) {
			Module newMod = NetworkFactory.eINSTANCE.createModule();
			newMod.setName("X26 - " + i);

Remove Property Sheet altogether

Add next method to the generated diagram editor class (usually <ModelName>DiagramEditor)

	public Object getAdapter(Class type) {
		if (type == IPropertySheetPage.class) {
			return null;
		return super.getAdapter(type);

Sharing single EditingDomain instance across several diagrams

NOTE: This problem (and a solution) is also discussed here:

Generated code always creates new (own) instance of EditingDomain for each opened diagram editor. Since EditingDomain owns ResourceSet, different instances of domain model elements will be loaded for each opened diagram editor. Sometimes it is important to share the same domain model instances across several diagram editors (for example to get rid of synchronization problems). This leads us to the question of sharing same instance of EditingDomain across several generated diagram editors. Below you can find step by step description of necessary modifications you have to apply to the generated code to share the same EditingDomain instance between two diagrams of different types.

1. Make sure you have org.eclipse.gmf.bridge.trace plugin installed as a part of GMF SDK. (It is provided with the GMF Experimental SDK.)

2. Create diagram1.gmfmap, diagram2.gmfmap files and generate diagram1.gmfgen, diagram2.gmfgen. Ensure diagram1.trace and diagram2.trace files created.

3. Modify generated diagram1.gmfgen and diagram2.gmfgen files to use different Model IDs, Plugin IDs, Editor IDs. Optionally two different diagrams could has different diagram file extensions as well:

Model ID.PNG Plugin ID.PNG Editor ID.PNG

4. Modify diagram2.trace file to use different visualID values then specified in diagram1.trace file - the easiest way is to replace “"200”-> “"210”, .., “"800” -> “"810” – and regenerate diagram2.gmfgen from diagram2.gmfmap

5. Open diagram2.gmfgen and modify visualID property for GenDiagram to make it different then visualID of GenDiagram in diagram1.gmfgen:

Diagram2Visual ID.PNG

6. Ensure both diagram1.gmfgen and diagram2.gmfgen are using the same EditingDomain ID:

EditingDomain ID.PNG

7. Generate code for both diagram plugins.

8. In both generated ???DocumentProvider classes substitute EditingDomain creation code:

 * @generated
private TransactionalEditingDomain createEditingDomain() {
	TransactionalEditingDomain editingDomain = DiagramEditingDomainFactory.getInstance().createEditingDomain();
	editingDomain.setID("SharedEditingDomain"); //$NON-NLS-1$

with the following call to the central EditingDomain registry:

 * @generated NOT
private TransactionalEditingDomain createEditingDomain() {
	// Modification started
	TransactionalEditingDomain editingDomain;
	editingDomain = TransactionalEditingDomain.Registry.INSTANCE.getEditingDomain("SharedEditingDomain"); //$NON-NLS-1$
	if (editingDomain == null) {
		editingDomain = DiagramEditingDomainFactory.getInstance().createEditingDomain();
		editingDomain.setID("SharedEditingDomain"); //$NON-NLS-1$
	// Continue with the original code.

NOTE-1: If you are using GMF older then 2.0 M5 you have to modify generated ???DiagramEditor.createEditingDomain() instead to simply call the superclass implementation of following method:

 * @generated NOT
protected TransactionalEditingDomain createEditingDomain() {
	return super.createEditingDomain();

NOTE-2: The idea of this step is to let two connected instances of GMF editors using the same instance of EditingDomain. You can easily create your own EditingDomain registry/accessor and call it from the corresponding methods instead of calling TransactionalEditingDomain.Registry.

You can see an example of alternative ???DocumentProvider modification in the following article:

9. Declare EditingDomain with the shared EditingDomain ID (see step 5.) inside plugin.xml for generated for diagram1:

<!-- gmf generator persistent region begin -->
<!-- gmf generator persistent region end -->

NOTE: This step is necessary to initialize TransactionalEditingDomain.Registry used above with the proper EditingDomain id. If you are not using TransactionalEditingDomain.Registry to access/create EditingDomain instance (e.g. following the article: then you should skip this step.

10. Only one metamodelType could be registered for each EClass in scope of one EditingDomain. During this step you have to replace by specializationType declaration all the metamodelType declarations inside plugin.xml for diagram2 duplicating metamodelType declarations inside plugin.xml for diagram1 (having the same eclass attribute). Following part of plugin.xml:

   <param name="semanticHint" value="1001"/>

Should be replaced with:

   <specializes id="shape.diagram1.Diagram_1000"/>
   <param name="semanticHint" value="1001"/>

<specializes> attribute for newly creates specializationTypes should point to the corresponding metamodeType id from plugin.xml generated for diagram1.

11. Patch plugin.xml generated for diagram2 and specify the same clientContext for elementTypeBindings extension point as it is specified for diagram1. Instead of:

<extension point="org.eclipse.gmf.runtime.emf.type.core.elementTypeBindings">
   <clientContext id="Diagram2_IDClientContext">
   <binding context="Diagram2_IDClientContext">


<extension point="org.eclipse.gmf.runtime.emf.type.core.elementTypeBindings">
   <clientContext id="Diagram1_IDClientContext">
   <binding context="Diagram1_IDClientContext">

12. To correctly unload (model) resources associated with diagram you can add method to generated ???DocumentProvider:

protected void disposeElementInfo(Object element, ElementInfo info) {
	super.disposeElementInfo(element, info);
	// Unload all the resources associated with diagram here if necessary.

Making figures sensitive to attributes of semantic elements


Change a diagram editor generated by GMF to make its figures sensitive to changes of semantic elements’ attributes’ values. Changes of attributes’ values should be automatically detected and reflected in figures’ look.


You have to make a little change in *EditPart class. I’m going to change edit part for the semantic model element named Port, so I have to edit class.

1. Add a new method to the PortFigure class, which is a PortEditPart’s inner class:

	public void updateFace() {
		Port port = (Port) ((Node) PortEditPart.this.getModel()).getElement();

		// set line width according to number of some children
		int lineWidth = 1;
		if (port.getLogicalUnits().size() > 1) {
			lineWidth = 2;

		// update tooltip
		String tooltipText;
		if (port.getDescription() != null
				&& port.getDescription().length() > 0) {
			tooltipText = port.getDescription();
		} else {
			tooltipText = port.getName();
		if (getToolTip() == null) {
			setToolTip(new Label(tooltipText));
		} else if (getToolTip() instanceof Label) {
			((Label) getToolTip()).setText(tooltipText);

The updateFace method makes actual changes to the figure’s look. This example implementation sets the line’s width according to the number of Port’s children (port.getLogicalUnits().size()) and sets the tool-tip text to the value of element’s attribute named description.

Then you have to hook up this method in two places: PortFigure’s constructor to update the look when editor starts and the handleNotificationEvent method to react to live changes.

2. Change PortFigure’s constructor to make it use new method.

	 * @generated NOT
	public PortFigure() {

3. Override handleNotificationEvent(Notification notification) method in PortEditPart.

	protected void handleNotificationEvent(Notification notification) {
		if (notification.getNotifier() instanceof Port) {

Without this method you would need to restart editor to reflect element's changes in figure parameters.

Tested on GMF version 2.0. → Original post

Printing multiple diagrams

See this blog posting by Anoop Menon.

Rotating a border item

From a newsgroup posting by Jaap Reitsma on 01/31/08:

I have fond a solution that rotates my bordered triangle (always pointing inwards in a container) as well as being initialized properly when opening the diagram. In my first attempt I used MyTriangleEditPart.refreshBounds() to manipulate the orientation. Although it works when dragging the triangle around the container, it does not get initialized properly as the refreshBounds of the bordered item is called when the layout of the parent has not been done yet.

The seemingly elegant solution is to hook into the layout of the border item container, i.e. the parent of my bordered triangle figure. The code I have used follows below:

/* (non-Javadoc)
* @see 
public void activate() {
    IBorderItemLocator locator = getBorderItemLocator();
    if (locator instanceof BorderItemLocator) {
        ((BorderItemLocator)locator).setBorderItemOffset(new Dimension(8, 
    IFigure figure = getFigure();
    if (figure instanceof BorderedNodeFigure) {
        BorderedNodeFigure bnf = (BorderedNodeFigure)figure;
        IFigure bicf = bnf.getBorderItemContainer();
        bicf.addLayoutListener(new LayoutListener.Stub() {
            public void postLayout(IFigure container) {
                int position = 
                int rotation = 0;
                switch (position) {
                    case PositionConstants.WEST:
                    case PositionConstants.NORTH:
                        rotation = 90;
                    case PositionConstants.EAST:
                        rotation = 180;
                    case PositionConstants.SOUTH:
                        rotation = 270;

The setRotationInDegrees is a method in my custom RotableScalablePolygon which is actually a copy of the implementation of the inner figure generated by GMF when using a scalable polygon as figure.

New-small.gif Different Figures for one Ecore class


You want to have different looking diagram figures but all backed by the same Ecore class.


 Class: CommonClass
 Attribute: CommonClass.type:CommonClassType
 Enumeration: CommonClassType
 Values: TypeA = 0, TypeB = 1

For CommonClass of CommonClassType.TypeA display Figure 'A' if CommonClassType.TypeB disaply Figure B.

   Top Node Reference              Diagram Node Node TypeAFigure
     Node Mapping
       Constraint                  Body self.type = CommonClassType::TypeA, Language ocl
       Feature Seq Initalizer      Element Class CommonClass
         Feature Value Spec        Feature CommonClass.type:CommonClassType
           Value Expression        Body CommonClass.type::TypeA, Language ocl
   Top Node Reference              Diagram Node Node TypeBFigure
     Node Mapping
       Constraint                  Body self.type = CommonClassType::TypeB, Language ocl
       Feature Seq Initalizer      Element Class CommonClass
         Feature Value Spec        Feature CommonClass.type:CommonClassType
           Value Expression        Body CommonClass.type::TypeB, Language ocl

You will of course have to define two figures, two creation tool items, etc..

Setting Initial Position of a Node

TASK: You want to set the initial position of a node, but the user should still be able to move the node.

SOLUTION: There is more than one solution. The following solution overrides activate() in XYZEditPart.

 * @generated NOT
public void activate() {
	AbstractEMFOperation emfOp = new AbstractEMFOperation(getEditingDomain(), "Location setting") {

		protected IStatus doExecute(IProgressMonitor monitor, IAdaptable info) throws ExecutionException {
			Location lc = (Location) ((Node) getModel()).getLayoutConstraint();
			return Status.OK_STATUS;


	IStatus status;

	try {
		status = OperationHistoryFactory.getOperationHistory().execute(emfOp, null, null);
	} catch (ExecutionException e) {
		status = new Status(IStatus.ERROR, Activator.PLUGIN_ID, "Setting location failed", e);

	if (status.getCode() == IStatus.WARNING || status.getCode() == IStatus.ERROR) {

Setting default Routing for connections

TASK: You want to set the routing of the connections to be Rectilinear (90 degrees angles) or Tree style, as default.

SOLUTION: On your connection's EditPart, modify the createConnectionFigure method to:

* @generated NOT
protected Connection createConnectionFigure() {
    XYZFigure figure = new XYZFigure();
    AbstractEMFOperation emfOp = new AbstractEMFOperation(getEditingDomain(), "line routing setting") {
        protected IStatus doExecute(IProgressMonitor monitor, IAdaptable info) throws ExecutionException {
        RoutingStyle style = (RoutingStyle) ((View) getModel()).getStyle(NotationPackage.Literals.ROUTING_STYLE);
        style.setRouting(Routing.RECTILINEAR_LITERAL);   //or Routing.TREE_LITERAL            
        return Status.OK_STATUS;

    try {           
        OperationHistoryFactory.getOperationHistory().execute(emfOp, null, null);
    } catch (ExecutionException e) {}

    return figure;

If you want to set the routing globally for all of your connections you can modify the DiagramConnectionsPreferencePage class in the *.diagram.preferences package with the following code.

* Initializes the default preference values for this preference store.
* @param preferenceStore
*            the preference store
* @generated NOT
public static void initDefaults(IPreferenceStore preferenceStore) {
  preferenceStore.setDefault(IPreferenceConstants.PREF_LINE_STYLE, Routing.RECTILINEAR);

Removing line drawn at top of compartments

TASK: You want to hide the line that is always displayed ontop of a compartment

SOLUTION: Add the following line setBorder(null) to the createFigure method of your compartment's EditPart. It will look like this:

 * @generated NOT
public IFigure createFigure() {
   ResizableCompartmentFigure result = (ResizableCompartmentFigure) super.createFigure();
   //changed code
   return result;

see forums post.

Implicit node in the middle creation

TASK: You want to create ER diagram like connections. This means draw a connection from node A to B and a node C will be automatically created in the middle of the new connection.

SOLUTION: Well, ok then, I am going to post the proposed solution first and then would be happy to discuss at the forum.


As you probably got by now there are no one-line solutions to this use case. The only good news is that I am going to try to push this solution to GMF-tooling, and with a bit of luck it will be possible to define and generate the code below in Indigo. To be honest, it is one of the reason for me to describe this somewhat long story here.

The complete code is available in the public SVN repoistory at

There are 4 plugins, 2 of them are just pure EMF plugins (inthemiddle and inthemiddle.edit, nothing interesting there), + supporting .gmf plugin containing helper code, GMF artifacts and custom templates, and finally the resulting .diagram plugin.

There is very simple diagram definition in the *.gmf/gmf/def/ folder. There is nothing special here, except that we set the incoming link creations to true for both GenLink’s in the gmfgen model, to allow user to start drawing of the link from the Rectangle instead of not-yet-created Rhomb.

Also I was somewhat lazy to play with gmfgraph today, so don’t be surprised that Rhomb model elements are rendered as rounded rectangles at the diagram :).

Proposed solution consists of 2 parts: a) modifying the GraphicalNodeEditPolicy (GNEP) to collect and pass the diagram information into the semantic creation command and b) implementing the composite creation command itself

a) So we are going to replace org.eclipse.gmf.runtime.diagram.ui.editpolicies.GraphicalNodeEditPolicy with tweaked ITMGraphicalNodeEditPolicy from the *.gmf plugin. The changes made are as follows:

- Default GNEP packs the CompositeTransactionalCommand and then uses the ordering to access the different parts of the pack. E.g, lines 508-515 in the default GNEP looks like:

CompositeCommand cc = (CompositeCommand) proxy.getICommand();
Iterator commandItr = cc.iterator();; //0
SetConnectionEndsCommand sceCommand = (SetConnectionEndsCommand); //1
sceCommand.setNewTargetAdaptor(new EObjectAdapter(((IGraphicalEditPart) targetEP).getNotationView()));
SetConnectionAnchorsCommand scaCommand = (SetConnectionAnchorsCommand); //2

This is clearly bad, so the changed code introduces ITMCreateLinkCommand with explicit access to its parts. It also has a code to register the results pack in the parameters of original request, so our semantic command will be able to access the whole pack at the execution time.

The changed code also computes an additional ITMCreateParameters describing the diagram information about the link source and target, but, while useful in general, it may be out of scope of this particular use case.

To register all the ITM* staff above in the generated diagram I used the following custom templates (*.gmf plugin, /gmf/templates/...)

    it is the guard that prevents generation of the new code for unrelated diagrams (I had more than 1): 

helper requiresSpecificGraphicalNodeEditPolicy(diagram : genModel::GenDiagram) : Boolean {


        ' = diagram.editorGen.plugin.iD


This guard allows every other affected template to have something like 

«EXTENSION itm::graphicalnodeep::Guard»


«IF requiresSpecificGraphicalNodeEditPolicy(self.getDiagram())-»

//....some changes 


which, after all, allowed me to find all the affected parts and write this post :)

itm::graphicalnodeep::graphicalNodeEditPolicy.xpt - here comes the code to register the tweaked version of the GNEP aspects::impl::diagram::editparts::LinkEditPart.xpt and aspects::impl::diagram::editparts::NodeEditPart.xpt - just registering the tweaked editpolicies for all nodes and links by calling

«EXPAND itm::graphicalnodeep::graphicalNodeEditPolicy::install-»

finally, if you also have notes at your diagram you also need to replace the NoteEditPart because in its default GMF version it expects the default GNEP. This is done by:


«IF requiresSpecificGraphicalNodeEditPolicy(self)-»
       if (org.eclipse.gmf.runtime.diagram.core.util.ViewType.NOTE.equals(view.getType())) {

return new «EXPAND itm::graphicalnodeep::graphicalNodeEditPolicy::noteEditPartFQN»(view);


«AROUND extensions FOR gmfgen::GenDiagram-»


«IF requiresSpecificGraphicalNodeEditPolicy(self)-»

    «EXPAND noteEditPartProvider»



«DEFINE noteEditPartProvider FOR gmfgen::GenDiagram-»

<extension point="org.eclipse.gmf.runtime.diagram.ui.editpartProviders" id="noteep-provider">

    «EXPAND xpt::Common::xmlGeneratedTag»

    <editpartProvider class="«getEditPartProviderQualifiedClassName()»">

        <Priority name="Low"/>

        <object class="org.eclipse.gmf.runtime.notation.Node" id="generated-note">

            <method name="getType()" value="Note"/>


        <context views="generated-note"/>




Ok, at this point we can regenerate the diagram, and the new one will install the tweaked GNEPs to all the right places. Now its time time to use it:

(*.gmf plugin) is the base class for all creation commands for use cases like that. It does not have dependencies to our diagram and as such prepared to be moved somewhere into GMF runtime., and ElementTypeOnlyAdapter are the helper interface and 2 implementations to describe the concrete element type for node in the middle and links.

and finally the concrete implementation ImplicitRhombCreateCommand (*.diagram plugin, custom-src root) that contains the configuration (what are the visual ids of links, what is the node in the middle, etc) specific for my own diagram.

Finally, this all is bound together by the @generated NOT code in the RectangleItemSemanticEditPolicy -- this is the only place in the code where @generated and custom code lives together:

 * @generated NOT
protected Command getCompleteCreateRelationshipCommand(CreateRelationshipRequest req) {
    if (InthemiddleElementTypes.RhombRight_4002 == req.getElementType() && req.getSource() instanceof Rectangle) {
        return getGEFWrapper(new ImplicitRhombCreateCommand(req, req.getSource(), req.getTarget()));
    // escape to generated code otherwise
    return getCompleteCreateRelationshipCommandGen(req);

Thats it, if you run this code in the helios, in the generated diagram it should be possible to choose the Link tool at palette, draw the link directly from Artist to Song rectangles and have the ‘rhomb’ auto-created in the middle:

Using EEF and GMF

TASK: You want to use EEF and GMF together

Solution: from

GMF does not know which plugin provides the property tabs for the editor, it just declares the contributor ID for someone who wants to provide its contents here. So there is no code in diagram plugin to change. Instead, you need to reference this diagram controbutor ID from EEF plugin:

  • in the diagram plugin. search for: extension, it will be like this:
<extension point="" id="prop-contrib">
 <?gmfgen generated="true"?>
 <propertyCategory category="domain"/>
 <propertyCategory category="visual"/>
 <propertyCategory category="extra"/>
  • note the contributorId (contributorId="org.eclipse.gmf.examples.ocldriven.diagram")
  • note one of the existing categories ( <propertyCategory category="domain"/>)
  • copy/paste the "" and "" extensions from EEF-generated plugin.xml fragment to the real plugin.xml for edit plugin (if you followed the EEF tutorial, you may already have one copy of these 2 extensions there for EMF tree editor)
  • in the BOTH copy/pasted duplicated extensions replace the EEF contributorID to the GMF contributor id (first bold from step1), so in my sample it would be:
<extension point="">
 <propertySections contributorId="org.eclipse.gmf.examples.ocldriven.diagram">
<extension point="">
<propertyTabs contributorId="org.eclipse.gmf.examples.ocldriven.diagram">
  • in the copy/pasted "" extension replace the category="<whatever>" by the actual category from GMF (second bold from step1 -- e.g "domain"):

I just made exactly these steps for GMF-T OCL/driven sample, and that all I needed to get an attached screenshot.


Initialize a diagram from Java code

TASK: You built up a ecore diagram and want to be through e.g. java code or a transformation and want to view it in a graphical editor.

Solution: To do so execute the following code on you model

Diagram diagram = ViewService.createDiagram(

The diagram needs to be added to the same resource as the semantic model root is located at. [semanticRootEObject] is the root model element in the semantic model. [RootEditPart] is the edit part which represents the editor canvas. [XXDiagramEditorPlugin] is the AbstractUIPlugin implementation class that is generated by GMF. This code can also be extracted from the generated XXXNewDiagramFileWizard.performFinish() method.

Write to Model Without Using a Command

TASK: You want to make changes to the notation model or any other model managed by the resource set without having your command on the command stack.

Solution: Start a transaction make your modifications and commit using the editing domain. The following code will help:

InternalTransactionalEditingDomain domain = (InternalTransactionalEditingDomain)TransactionUtil.getEditingDomain([EObject]);

try {
  domain.startTransaction(false, Collections.EMPTY_MAP);

  [put commands here]
} catch (InterruptedException e) {
  [Exception handling]
} catch (RollbackException e) {
 [Exception handling]

[EObject] is any model element of the model you want to edit.

Find Editor in which an EditPart is located

TASK: You want to find the editor in which a edit part is located and cannot use PlatformUI for this task.

Solution: Use the DiagramEditDomain of the edit part to get the editor in which it is located.


Back to the top