Summary

• Page properties (2 modified, 0 added, 0 removed)
• Objects (1 modified, 0 added, 0 removed)
  • Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Parent

...	...	@@ -1,0 +1,1 @@
	1	+Infrastructure for Meta Layout (KIML)

Content

...	...	@@ -273,10 +273,8 @@
273	273
274	274	== Adding Support for the Layout View ==
275	275
276		-The Layout View empowers users to directly modify the layout configuration for the currently viewed diagram. This power, however, comes with a price. Tool developers implementing a [[IDiagramLayoutManager>>url:http://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml.service/src/de/cau/cs/kieler/kiml/service/IDiagramLayoutManager.java||shape="rect"]] additionally have to provide an implementation of [[IMutableLayoutConfig>>url:http://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml/src/de/cau/cs/kieler/kiml/config/IMutableLayoutConfig.java||shape="rect"]] that loads and saves layout option values in a way that they can be stored persistently with the respective diagram. Good examples of such configurators are [[GmfLayoutConfig>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml.gmf/src/de/cau/cs/kieler/kiml/gmf/GmfLayoutConfig.java||shape="rect"]] and [[GraphitiLayoutConfig>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml.graphiti/src/de/cau/cs/kieler/kiml/graphiti/GraphitiLayoutConfig.java||shape="rect"]] for GMF and Graphiti diagrams, respectively. The GMF implementation stores option values as //styles// in the GMF //Notation// model, while the Graphiti implementation stores the values as //properties// in the Graphiti //Pictogram// model. If you are developing an editor based on GMF or Graphiti, simply reuse these implementations and you're fine. Otherwise, read this section.
	276	+The Layout View empowers users to directly modify the layout configuration for the currently viewed diagram. This power, however, comes with a price. Tool developers implementing a [[IDiagramLayoutManager>>url:http://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml.service/src/de/cau/cs/kieler/kiml/service/IDiagramLayoutManager.java||shape="rect"]] additionally have to provide an implementation of [[IMutableLayoutConfig>>url:http://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml/src/de/cau/cs/kieler/kiml/config/IMutableLayoutConfig.java||shape="rect"]] that loads and saves layout option values in a way that they can be stored persistently with the respective diagram. Good examples of such configurators are [[GmfLayoutConfig>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml.gmf/src/de/cau/cs/kieler/kiml/gmf/GmfLayoutConfig.java||shape="rect"]] and [[GraphitiLayoutConfig>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml.graphiti/src/de/cau/cs/kieler/kiml/graphiti/GraphitiLayoutConfig.java||shape="rect"]] for GMF and Graphiti diagrams, respectively. The GMF implementation stores option values as //styles// in the GMF //Notation// model, while the Graphiti implementation stores the values as //properties// in the Graphiti //Pictogram// model. If you are developing an editor based on GMF or Graphiti, simply reuse these implementations and you're fine. Otherwise, read this section to learn how to implement a suitable configurator.
277	277
278		-=== Step 1: Implement a Mutable Layout Configurator ===
279		-
280	280	A //mutable// layout configurator is one that can not only read option values, but also write them. Most interface methods are rather self-explanatory, therefore we will consider only the {{code language="none"}}getContextValue(IProperty, LayoutContext){{/code}} method here. This method receives a [[LayoutContext>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml/src/de/cau/cs/kieler/kiml/config/LayoutContext.java||shape="rect"]] and should return a value that corresponds to the given property, if possible, and {{code language="none"}}null{{/code}} otherwise. The starting point is usually the current value of {{code language="none"}}LayoutContext.DIAGRAM_PART{{/code}} in the given context, called the //diagram part//, which refers to the currently selected diagram element in the viewer (the abstract syntax element). From this the method should extract more information considering the following other context properties:
281	281
282	282	* {{code language="none"}}LayoutContext.DOMAIN_MODEL{{/code}} – The domain model element linked to the current diagram part.
...	...	@@ -286,13 +286,6 @@
286	286	* {{code language="none"}}DefaultLayoutConfig.HAS_PORTS{{/code}} – If the current diagram part is a node, the returned value for this property should be {{code language="none"}}true{{/code}} or {{code language="none"}}false{{/code}} depending on whether the node has any ports or not. Ports are explicit connection points for edges; they occur frequently in data flow diagrams.
287	287	* {{code language="none"}}DefaultLayoutConfig.CONTENT_HINT{{/code}} – If the diagram contains an annotation about which layout algorithm to use for the content of the current diagram part, the returned value for this property should be the identifier of that algorithm. This is the same kind of annotation that is accessed through {{code language="none"}}getOptionValue({{/code}}…{{code language="none"}}){{/code}}, i.e. a value set by the user with the Layout View.
288	288	* {{code language="none"}}DefaultLayoutConfig.CONTAINER_HINT{{/code}} – The same as for CONTENT_HINT{{code language="none"}}{{/code}}, but referring to the container.
	287	+* {{code language="none"}}EclipseLayoutConfig.EDITING_DOMAIN{{/code}} – If your diagram editor needs an EMF editing domain in order to modify annotations of layout options, then such an editing domain should be returned for this property.
289	289
290		-=== Step 2: Add the Configurator to the Layout Mapping ===
291		-
292		-This is simple. In the {{code language="none"}}buildLayoutGraph({{/code}}…{{code language="none"}}){{/code}} method of your diagram layout manager, add an instance of your self-made configurator to the list of configurators of the created [[LayoutMapping>>url:http://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml.service/src/de/cau/cs/kieler/kiml/service/LayoutMapping.java||shape="rect"]]. This makes sure that the options configured in the layout view are actually applied in the layout process.
293		-
294		-=== Step 3: Implement the Adapter Factory Pattern ===
295		-
296		-[[IDiagramLayoutManager>>url:http://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml.service/src/de/cau/cs/kieler/kiml/service/IDiagramLayoutManager.java||shape="rect"]] is a subinterface of IAdapterFactory, an interface provided by Eclipse. As such, your diagram layout manager must implement {{code language="none"}}getAdapter(Object, Class){{/code}}.
297		-
298		-
	289	+An instance of your self-made configurator should be returned by the {{code language="none"}}getDiagramConfig(){{/code}} method of your diagram layout manager.

Confluence.Code.ConfluencePageClass[0]

Id

...	...	@@ -1,1 +1,1 @@
1		-9470002
	1	+7700944

URL

...	...	@@ -1,1 +1,1 @@
1		-https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470002/Configuring Automatic Layout
	1	+https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/7700944/Configuring Automatic Layout