Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
STP/BPMN Component/Reusing the modeler
Annotating the stp.bpmn Domain Model
This topic explains how to add to the bpmn diagram custom data. It also describes how to display and interact with that custom data.
Every element of the domain model of the stp.bpmn modeler is an EMF EModelElement. This means that it can be attached arbitrary annotations.
Here are various techniques to use that ability.
Displaying the Value of the Annotation
By default the EAnnotations added to the bpmn objects are displayed in the properties view inside the 'BPMN' tabulation.
EAnnotations are tied to their EModelElement through the source property which is a String. EAnnotations contain a HashMap of Strings to Strings.
The BPMN properties view display a table with two columns: The first column is the source of the EAnnotation concatenated to the key of the Details HashMap.
The second column is the value of the Details HashMap. You can edit this value and it will mark the editor dirty.
Displaying the Annotation on the Diagram
Once the model has annotations it is possible to display in the diagram that the model element associated to a particular shape or connection has been annotated. In order to do this, we have implemented an extension point: org.eclipse.stp.bpmn.diagram.EAnnotationDecorator. You can have a look at it here : http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.stp.bpmn/org.eclipse.stp.bpmn.diagram/schema/EAnnotationDecorator.exsd?cvsroot=STP_Project --Atoulme.intalio.com 15:31, 2 December 2006 (EST) will change to direct link when in documentation
The EAnnotation decorator extension point register a decorator for an annotation source. It then instanciates the IEAnnotation class declared in the extension point. See http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.stp.bpmn/org.eclipse.stp.bpmn.diagram/customsrc/org/eclipse/stp/bpmn/dnd/IEAnnotationDecorator.java?cvsroot=STP_Project
--Atoulme.intalio.com 15:31, 2 December 2006 (EST) will change by direct link when in documentation
Annotating the stp.bpmn: Drag and Drop
It is possible to drag and drop things to attach annotations to the stp.bpmn domain model. Use the extension point: org.eclipse.stp.bpmn.diagram.EAnnotationDragAndDrop, you can have a look at it here: http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.stp.bpmn/org.eclipse.stp.bpmn.diagram/schema/EAnnotationDragAndDrop.exsd?cvsroot=STP_Project
You will have to declare a IGenericEAnnotationDndHandler instance in your extension point that will provide callback method when the drop edit policy on the shape is asked for a command. The javadoc is pretty much explicit there. However, when coding the doPerformDrop method, you will have to use the GMF and GEF standards on the context handling. You are in a read-only context in this case, so you should add commands to the CompoundCommand that is given to you in parameter. If those commands are found to be non-executable, the drop will be canceled.
The object dragged must be "IAdaptable" to an EAnnotation. The implementation of the extension point will define if the drop can execute and will show feedback in a balloon figure.
More on the drag and drop extensibility
A simple implementation is provided in the org.eclipse.stp.bpmn.diagram plugin. An article is being drafted to present it: see https://bugs.eclipse.org/bugs/show_bug.cgi?id=165083
The hardcore way to customize the editor consist of making your own BPMN Editor with its own EditPart factory. All you need to do is extend the stp.bpmn Editor and EditPartFactory.
We have made many packages public for now.
Also GMF validation services are very useful when adding extra rules are to analyze the code.
As we identify implementation of those services that are specialized to the stp.bpmn model they will be exposed as extension points.