Last modified by msp on 2025/01/30 12:03
<
From version < 6.1 >
edited by msp
on 2012/11/06 15:16
To version < 7.1 >
edited by msp
on 2012/11/06 16:47
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Graphical Editors with Graphiti
1 +Graphical Modeling with Graphiti
Content
... ... @@ -6,7 +6,7 @@
6 6  
7 7  {{toc maxLevel="2"/}}
8 8  
9 -= Defining the Diagram Type =
9 += Defining a Diagram Type =
10 10  
11 11  The main documentation of Graphiti is found in the [[Eclipse online help>>url:http://help.eclipse.org/juno/nav/23||shape="rect"]], which is also found in the Eclipse application (//Help// → //Help Contents//). If you don't have Graphiti yet, install it from the Juno release update site, //Modeling// category. The first step of this tutorial consists of defining a diagram type for Turing Machines and adding a wizard dialog for the creation of new diagrams.
12 12  
... ... @@ -55,7 +55,7 @@
55 55   org.eclipse.graphiti.ui.editor.DiagramEditor.DIAGRAM_EDITOR_ID);
56 56  {{/code}}
57 57  
58 -Diagrams are stored in two separate files, one containing the actual Turing Machine model and one containing the specific graphical elements used to represent the model. Here it is assumed that {{code language="none"}}"turing"{{/code}} is the file extension for Turing Machine models (this depends on how you configured your EMF model), while {{code language="none"}}"tudi"{{/code}} will be the file extension for diagrams.
58 +Diagrams are stored in two separate files, one containing the actual Turing Machine model and one containing the specific graphical elements used to represent the model. Here it is assumed that {{code language="none"}}"turing"{{/code}} is the file extension for Turing Machine models (this depends on how you configured your EMF model), while {{code language="none"}}"tudi"{{/code}} will be the file extension for diagrams. //Hint~:// by selecting {{code language="none"}}"tuxt"{{/code}} as domain model file extension your models will be stored in the textual format instead of XMI. However, this requires the created models to always be in a serializable state.
59 59  )))
60 60  1*. Implement the {{code language="none"}}createModel{{/code}} method by creating and returning an instance of the top-level element of your Turing Machines, e.g. {{code language="none"}}TuringMachine{{/code}}.
61 61  1*. Register the new wizard class in your plugin.xml using a //wizard// extension for org.eclipse.ui.newWizards (you only need to choose an id and name and set the correct class name).
... ... @@ -62,4 +62,159 @@
62 62  1. Include the new plugin in your Eclipse run configuration and start it. Create a Turing Machine diagram with your new wizard: //File//→ //New//→ //Other...//→ //Other//→ //Turing Machine//. This opens a Graphiti diagram editor for the new file, but you cannot do anything in that editor, since the palette is still empty.
63 63  1. In order to open a previously created {{code language="none"}}tudi{{/code}} file, right-click it → //Open With//→ //Other...//→ //Graphiti Diagram Editor//. This setting for {{code language="none"}}tudi{{/code}} files will be saved in your workspace preferences.
64 64  
65 -
65 += Creating and Adding Elements =
66 +
67 +The next step is to write so-called //features// for creating and adding elements to the diagrams. Each type of graphical element requires a //create// feature for the creation of corresponding meta model (//business model//) elements, and an //add// feature for adding a specific graphical representation to the diagram. A graphical representation is modeled with a so-called //pictogram element//, which contains a structure of //graphics algorithms// that specify how the element is rendered.
68 +
69 +1. (((
70 +Add the following feature class to your plugin, adapting references to meta model elements to your Turing Machine definition:
71 +
72 +{{code theme="Eclipse" language="java"}}
73 +import java.util.List;
74 +import org.eclipse.emf.ecore.EObject;
75 +import org.eclipse.graphiti.features.IFeatureProvider;
76 +import org.eclipse.graphiti.features.context.ICreateContext;
77 +import org.eclipse.graphiti.features.impl.AbstractCreateFeature;
78 +import org.eclipse.graphiti.mm.pictograms.Diagram;
79 +
80 +import de.cau.cs.rtprak.login.turingmodel.State;
81 +import de.cau.cs.rtprak.login.turingmodel.TuringFactory;
82 +import de.cau.cs.rtprak.login.turingmodel.TuringMachine;
83 +
84 +/**
85 + * A create feature for Turing Machine states.
86 + *
87 + * @author msp
88 + */
89 +public class StateCreateFeature extends AbstractCreateFeature {
90 +
91 + /**
92 + * Constructor for a state create feature.
93 + *
94 + * @param fp the feature provider for which the feature is created
95 + */
96 + public StateCreateFeature(IFeatureProvider fp) {
97 + super(fp, "State", "Create a State");
98 + }
99 +
100 + /**
101 + * {@inheritDoc}
102 + */
103 + public boolean canCreate(ICreateContext context) {
104 + return context.getTargetContainer() instanceof Diagram;
105 + }
106 +
107 + /**
108 + * {@inheritDoc}
109 + */
110 + public Object[] create(ICreateContext context) {
111 + // get the container business element
112 + List<EObject> containerObjects = context.getTargetContainer().getLink().getBusinessObjects();
113 + if (containerObjects.isEmpty() || !(containerObjects.get(0) instanceof TuringMachine)) {
114 + throw new IllegalStateException("The diagram does not contain a Turing Machine.");
115 + }
116 + TuringMachine machine = (TuringMachine) containerObjects.get(0);
117 +
118 + // create a new state
119 + State state = TuringFactory.eINSTANCE.createState();
120 + machine.getStates().add(state);
121 +
122 + // add the corresponding graphical representation
123 + addGraphicalRepresentation(context, state);
124 +
125 + return new Object[] { state };
126 + }
127 +
128 +}
129 +{{/code}}
130 +)))
131 +1. (((
132 +Add the following method to TuringFeatureProvider{{code language="none"}}{{/code}}, defining the content of the diagram editor's palette:
133 +
134 +{{code theme="Eclipse" language="java"}}
135 +/**
136 + * {@inheritDoc}
137 + */
138 +@Override
139 +public ICreateFeature[] getCreateFeatures() {
140 + return new ICreateFeature[] { new StateCreateFeature(this) };
141 +}
142 +{{/code}}
143 +)))
144 +1. (((
145 +Add the following feature class to your plugin and implement the {{code language="none"}}add{{/code}} method:
146 +
147 +{{code theme="Eclipse" language="java"}}
148 +import org.eclipse.graphiti.features.IFeatureProvider;
149 +import org.eclipse.graphiti.features.context.IAddContext;
150 +import org.eclipse.graphiti.features.impl.AbstractAddShapeFeature;
151 +import org.eclipse.graphiti.mm.pictograms.ContainerShape;
152 +import org.eclipse.graphiti.mm.pictograms.Diagram;
153 +import org.eclipse.graphiti.mm.pictograms.PictogramElement;
154 +import org.eclipse.graphiti.services.Graphiti;
155 +import org.eclipse.graphiti.services.IGaService;
156 +
157 +import de.cau.cs.rtprak.login.turingmodel.State;
158 +
159 +/**
160 + * An add feature for Turing Machine states.
161 + *
162 + * @author msp
163 + */
164 +public class StateAddFeature extends AbstractAddShapeFeature {
165 +
166 + /**
167 + * Constructor for a state add feature.
168 + *
169 + * @param fp the feature provider for which the feature is created
170 + */
171 + public StateAddFeature(IFeatureProvider fp) {
172 + super(fp);
173 + }
174 +
175 + /**
176 + * {@inheritDoc}
177 + */
178 + public boolean canAdd(IAddContext context) {
179 + return context.getNewObject() instanceof State
180 + && context.getTargetContainer() instanceof Diagram;
181 + }
182 +
183 + /**
184 + * {@inheritDoc}
185 + */
186 + public PictogramElement add(IAddContext context) {
187 + // create a pictogram element for the state
188 + ContainerShape containerShape = Graphiti.getPeCreateService().createContainerShape(
189 + context.getTargetContainer(), true);
190 +  
191 + // TODO specify the concrete representation by adding at least one graphics algorithm
192 +
193 + link(containerShape, context.getNewObject());
194 + return containerShape;
195 + }
196 +
197 +}
198 +{{/code}}
199 +
200 +Use {{code language="none"}}Graphiti.getGaService(){{/code}} to get a service class for creating graphics algorithms and modifying their properties. You are free to design your model elements as you like. Find more information on how to solve this task in the official [[Graphiti Tutorial>>url:http://help.eclipse.org/juno/nav/23_1||shape="rect"]].
201 +)))
202 +1. (((
203 +Add the following method to TuringFeatureProvider{{code language="none"}}{{/code}}:
204 +
205 +{{code theme="Eclipse" language="java"}}
206 +private IAddFeature stateAddFeature = new StateAddFeature(this);
207 +
208 +/**
209 + * {@inheritDoc}
210 + */
211 +@Override
212 +public IAddFeature getAddFeature(IAddContext context) {
213 + if (stateAddFeature.canAdd(context)) {
214 + return stateAddFeature;
215 + }
216 + return super.getAddFeature(context);
217 +}
218 +{{/code}}
219 +)))
220 +1. Test the features in the diagram editor. You should now be able to select "State" in the editor's palette. Use this to create a few states. Note that if you create a state and later change the graphical representation in StateAddFeature, the previously created state will still look the same, since the add feature code is only applied to new states created from the palette.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -3604579
1 +3604581
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/WS12EclPract/pages/3604579/Graphical Editors with Graphiti
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/WS12EclPract/pages/3604581/Graphical Modeling with Graphiti

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage