Summary

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

Details

Page properties

Content

...	...	@@ -5,6 +5,7 @@
5	5	This page describes how automatic layout can be configured for a given application. This includes how layout options can be set on graph elements, and how they are applied by KIML during the layout process. After having read this, you should be able to answer the following questions:
6	6
7	7	* What are //layout options//?
	8	+* How do layout algorithms support layout options?
8	8	* How do layout options end up in KGraph elements?
9	9	* How can I set layout options on elements programmatically?
10	10
...	...	@@ -80,7 +80,7 @@
80	80	(% style="line-height: 1.4285715;" %)By now, we have an idea of what layout options do and why they are important in the first place. However, we haven't looked at how layout options end up on KGraph elements yet. This is where the [[{{code language="none"}}LayoutOptionsManager{{/code}}>>url:http://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/pragmatics/browse/plugins/de.cau.cs.kieler.kiml.ui/src/de/cau/cs/kieler/kiml/ui/service/LayoutOptionManager.java||shape="rect"]] comes in.
81	81
82	82	{{tip}}
83		-The [[KIML page>>doc:Infrastructure for Meta Layout (KIML)]] has a high-level explanation of what happens when during the layout process. To take a look at it if you haven't already – it will make the following concepts easier to understand.
	84	+The [[KIML page>>doc:Infrastructure for Meta Layout (KIML)]] has a high-level explanation of what happens when during the layout process. To take a look at it if you haven't already – it will make the following concepts easier to understand. Plus, there's a nice picture that took Miro quite some time to create.
84	84	{{/tip}}
85	85
86	86	(% style="line-height: 1.4285715;" %)After a layout manager has finished turning a given diagram into its KGraph representation, the layout options manager is asked to enrich the KGraph elements with layout options. The option values can come from different sources: the user might have set some using the layout view; there might be some defaults for certain kinds of diagrams; or the programmer might have decided to attach some layout options to certain elements for just this one layout run. Whatever the source, the options manager is in charge of collecting all these layout option values and making sure they find their way to the correct KGraph element. To start off with a clean plate, it first makes sure there are no layout options attached to the KGraph elements. It then does two things: collect every eligible source of layout options, and transfer layout options to the correct KGraph elements. Sounds easy enough.
...	...	@@ -106,28 +106,29 @@
106	106	{{code language="java"}}
107	107	public interface ILayoutConfig {
108	108	int getPriority();
109		-
110	110	void enrich(LayoutContext context);
111		-
112	112	Object getValue(LayoutOptionData<?> optionData, LayoutContext context);
113		-
114	114	void transferValues(KLayoutData layoutData, LayoutContext context);
115	115	}
116	116	{{/code}}
117	117
118		-It is not hard to guess what {{code language="none"}}getPriority(){{/code}} does: it returns the priority a given layout configuration has. If two layout configurations set a layout option to different values on a given graph element, the value set by the configuration with lower priority gets overwritten. The other three methods look a bit more obscure, so we have to provide more details on what the options manager does, exactly.
	116	+It is not hard to guess what {{code language="none"}}getPriority(){{/code}} does: it returns the priority a given layout configuration has. If two layout configurations set a layout option to different values on a given graph element, the value set by the configuration with higher priority wins. The other three methods look a bit more obscure, so we have to provide more details on what the options manager does, exactly.
119	119
120	120	ENRICHING (+ WHAT IS A LAYOUT CONTEXT)
121	121
122		-TRANSFERRING
	120	+The {{code language="none"}}transferValues(...){{/code}} method is the main workhorse of the interface. This is where a KGraph element, identified by the given layout context, is equipped with the layout option values a layout configuration deems necessary. It thus becomes the most important part of a layout configuration that you absolutely have to implement, no excuses. If for example every {{code language="none"}}KNode{{/code}} should have its port constraints set to {{code language="none"}}FIXED_POS{{/code}}, this is the place to do it.
123	123
124		-GETVALUE (for the layout view?)
	122	+With all these layout configurations active, it's by no means clear which layout option values KGraph elements will end up with during the layout process. Enter the {{code language="none"}}getValue(...){{/code}} method. For a given element and layout option, it returns the value it would set on the element if {{code language="none"}}transferValues(...){{/code}} was called. This method is mainly used by the Layout view to inform the user about the layout option values of whatever graph element he (or she) has clicked on. It is also the method you can safely neglect to implement if your final product won't include the layout view anyway.
125	125
126	126	== (% style="line-height: 1.4285715;" %)Implementing a Layout Configuration(%%) ==
127	127
128		-(% style="line-height: 1.4285715;" %)deciding what options are applicable depending on the context object; setting the options;
	126	+{{warning title="ToDo"}}
	127	+deciding what options are applicable depending on the context object; setting the options;
	128	+{{/warning}}
129	129
	130	+(% style="line-height: 1.4285715;" %)
130	130
	132	+
131	131	= (% style="line-height: 1.4285715;" %)Programmatically Setting Layout Options(%%) =
132	132
133	133	{{warning title="ToDo"}}

Confluence.Code.ConfluencePageClass[0]

Id

...	...	@@ -1,1 +1,1 @@
1		-7700958
	1	+7701011

URL

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