Contents

...

Terminology

Layout Graph

• Internal representation of the graph structure of the current diagram, built on the KGraph model.

Layout Algorithm

• An algorithm that takes a layout graph as input and computes positions for all elements of the graph.

Layout Provider

• A component that provides one or more layout algorithms to KIML.

Layout Option

• A customization point for layout algorithms, with a specific data type and optionally a default value.

Layout Configurator

• A component that is responsible for retrieving specific layout option values for each model element.

Layout Data

• Concrete layout data (position and size) and abstract layout data (layout options) attached to elements of the layout graph using the KLayoutData model.

Layout Type

• Classification of layout algorithms depending on their basic approach (e.g. layered, force, etc.).

Diagram Type

• Classification of graphical diagrams used to set default layout option values for all diagrams of a specific type (e.g. state machines, data flow diagrams, etc.).

Diagram Layout Manager

• The central interface for connecting diagram editors with layout algorithms.

User Interface

The main user interface element of KIML is the command to layout the current diagram. This command is availabe in the main KIELER menu, in the toolbar (), or using the Ctrl+R L shortcut. Additionally, an entry in the context menu allows to layout only a selected part of the diagram.

Layout View

The Layout view allows flexible customization of layout options for the selected objects in the diagram. If no object is selected, the view shows the options for the top-level container of the diagram. Options are stored persistently in the notation model of the diagram, so that they are still available after the next Eclipse restart. Of course this requires the diagram to be saved after an option was changed.

The options are grouped according to the function of the selected objects. The group Nodes (respectively Edges, Ports, or Labels) contains options related to the object itself, such as its size or priority, while the group Parents contains options for the elements contained in the selected objects, such as the applied layout algorithm or the spacing between elements. Which layout options are displayed depends on the types of selected objects and the active layout algorithm, since each algorithm supports only a subset of the available options. Furthermore, some options are only visible if the Show Advanced Properties button in the view toolbar is activated. The group types can be hidden using the Show Categories button.

An option can be changed by selecting or entering a new value in the corresponding cell of the Value column. The most important option is Layout Algorithm, which is used to determine the layout algorithm for the contents of the selected element. Here either a specific layout algorithm or a layout type can be chosen; in the latter case, the most suitable layout algorithm of the given type is taken. By changing the active layout algorithm, the content of the layout view is updated to display only those options that are supported by the new layout algorithm.

Selecting Restore Default Value in the context menu or the view toolbar removes any value for the currently selected option that is stored in the current model file, thus resetting the option to its default value. The view menu has an entry Remove all Layout Options which resets all options of the current model by removing persistent data in the model file.

The context menu for a specific layout option has different alternatives to set the currently active value as default value: Set as Default for this Diagram changes the open model file so that the same value is applied to all similar objects of that model. Set as Default for ... in this Context applies the value to all similar objects that are displayed with the same diagram editor (the option is linked to the edit part class of the selected object). Choosing Set as Default for all ... links the option value with the domain model element or diagram type of the selected object (see Figure context_menu). These four alternatives have different priorities: if present, the default value for the current diagram is taken first, then the default value for the edit part is checked, then the default value for the domain model element, and then the default value for the diagram type.

The information button of the view toolbar can be used to display some useful details on the current selection, such as the edit part and domain model classes.

Preference Page

If Set routing style of all edges to oblique is active, all routing styles and smoothness settings of edges are removed when automatic layout is performed. Since most layouters compute the routing of edges as part of their algorithm, these styles usually do not yield the expected results.

The Default Layout Option Values table is used to manage the default setting for layout options, which can also be modified with the context menu of the layout view (see above). All user-defined settings are displayed here, and the buttons on the right of the table serve to create, edit, and remove entries. The Type column shows the type of element the option is linked with: either edit part,model element, or diagram type. The Element column shows the class name for options that relate to edit parts or domain model elements, and the diagram type name for options that relate to diagram types. Option is the name of the layout option, and Value is the currently set value of the option.

Creating a new entry requires the selection of the type of related element and entering its class name or identifier. Class names of edit parts and domain model elements can be explored using the information button of the layout view, while diagram type identifiers can be selected with the Browse button. After that, a layout option has to be selected from the list using the corresponding Browse button. Hitting OK creates an entry, and its value can then be set using the Edit button.

Internal Structure

The primary public interface of KIML is the DiagramLayoutEngine, which is responsible for analyzing diagrams, creating a KGraph structure, configuring and executing the layout algorithms, and writing new position information back to the diagram. The interaction with the diagram editor or viewer is handled by IDiagramLayoutManager implementations. For most diagram editors that are based on GMF the generic GmfDiagramLayoutManager can be used, while for Graphiti there is the generic GraphitiDiagramLayoutManager. However, some customized diagram editors do not work with the generic diagram layout managers and hence require their own specialized implementations, which can be contributed with the extension point de.cau.cs.kieler.kiml.ui.layoutManagers.

The meta layout configuration is done by the LayoutOptionManager, which iterates over all graph elements and applies a set of layout configurators, represented by the interface ILayoutConfig. Layout configurators analyze the context of each graph element and set specific values for some layout options. Layout options are defined with the extension point de.cau.cs.kieler.kiml.layoutProviders. The most relevant layout configurators are listed in the following, with increasing priority.

• DefaultLayoutConfig - fixed default values of layout options and layout algorithms.
• EclipseLayoutConfig - user defined default values for edit parts, domain model elements, or diagram types; contributed by the preference page or the de.cau.cs.kieler.kiml.layoutInfo extension point.
• SemanticLayoutConfig - abstract superclass for configurators that react on specific properties of the domain model.
• GmfLayoutConfig / GraphitiLayoutConfig - option values selected in the Layout view and stored in the notation model file of a diagram.
• VolatileLayoutConfig - key-value mapping created for a single layout run. This is helpful for configuring layout from the view management.

Hierarchically structured graphs are handled by the RecursiveGraphLayoutEngine, which executes layout algorithms separately on each hierarchy level, starting with the innermost levels. The actual layout computations are performed by subclasses of AbstractLayoutProvider, which are registered with the de.cau.cs.kieler.kiml.layoutProviders extension point. The extension point allows to attach information on known layout options, supported diagrams types, and supported graph features to a layout algorithm. The known layout options are those that are offered in the Layout view when the respective algorithm is selected. The supported diagram types are used to automatically select the most suitable algorithm for a specific diagram type: from all algorithms that state to support a given type, the one with the highest priority is taken. The supported graph features are used to state which special features that a graph can contain can be handled by the algorithm; examples for such features are edge labels, ports, or clusters.

The singleton class LayoutDataService is used to access the available layout algorithms, layout options, diagram types, layout types, and stored option values. Similarly, there are other service classes for accessing the meta data managed by KIML.

KIML makes extensive use of the IPropertyHolder interface; a property holder is an object that can give and receive values for specific properties. The key for specifying which property to access is IProperty, which is usually instanced exactly once for each property. The layout data classes KShapeLayout and KEdgeLayout are property holders, which means that they can store layout option values for the graph elements they are connected with.

Connecting Layout Algorithms

Layout algorithms must be connected by extending AbstractLayoutProvider and using the de.cau.cs.kieler.kiml.layoutProviders extension point. The input of AbstractLayoutProvider? is . The input of the doLayout method is an instance of the KGraph, an  EMF based graph structure, together with a progress monitor (IKielerProgressMonitor). The KGraph instance already has attached KLayoutData, which is initially set to the graph is represented by a KNode, which serves as top-level container. The contained graph elements initially have attached KShapeLayout or KEdgeLayout with information on the original layout of the diagram as well as an abstract layout specified by layout options. The layout provider should read consider layout options from the attached layout data, execute a layout algorithm, and write the concrete results back to the layout data. See the documentation of connected layouters. A good example for a layout provider implementation is LayeredLayoutProvider.

The layoutProviders extension The layoutProviders extension point is needed to register layout algorithms; one layout provider class may provide multiple layout algorithms by giving a parameter string in the extension point. Furthermore, the extension point can be used to specify which layout options are understood and which diagram types are supported by the layout algorithm, and to define The extension point allows to attach information on known layout options, supported diagrams types, and supported graph features to a layout algorithm. The known layout options are those that are offered in the Layout view when the respective algorithm is selected. The supported diagram types are used to automatically select the most suitable algorithm for a specific diagram type: from all algorithms that state to support a given type, the one with the highest priority is taken. The supported graph features are used to state which special features that a graph can contain can be handled by the algorithm; examples for such features are edge labels, ports, or clusters. Furthermore, the extension point can be used to specify new layout options, layout types, and categories of layout algorithms. The priority value given with a supported diagram type is used to determine the most suitable layout algorithm for that diagram type; see the documentation of pre-defined diagram types.

Each layout option that is registered in the extension point needs a corresponding constant in Java code, where the most relevant data is replicated with a Property constant for easy use in the implementation of layout providersalgorithms. KIML comes with a large set of built-in layout options, which are all defined in LayoutOptions. If a layout provider wants to override the default value of a layout option, it must set the corresponding properties for itself (which is a property holder) either in the constructor or in the initialization method, and it must use its own instance of the corresponding property. See for example the Properties class for the KLay layered layouter, which defines its own copy of the OBJ_SPACING option using a specific default value. Layout providers can access the layout option values using the IPropertyHolderinterface interface:

Code Block
theme Eclipse language java
KShapeLayout nodeLayout = parentNode.getData(KShapeLayout.class); boolean isInteractive = nodeLayout.getProperty(LayoutOptions.INTERACTIVE);

 

The layout option that is used in this example has a default value, thus it is guaranteed that the option always returns a valid value. This and the fact that properties are type-safe allows us to implicitly cast and unbox the returned value to a boolean without checking forNullPointerExceptions a boolean without checking for NullPointerExceptions or ClassCastExceptions.

Connecting Diagram Editors

The extension point de.cau.cs.kieler.kiml.layoutInfo is point layoutInfo is used to define diagram types and to assign default layout options to specific parts of a diagram. Layout options can be associated with elements of the domain model, where the qualified name of the model element interface must be given, or with edit parts of a specific diagram editor, where the qualified class name of the edit part must be given. The diagram type can be assigned by setting the predefined layout option deoption de.cau.cs.kieler.layout.options.diagramType with diagramType with the diagram type identifier as value. This helps KIML to find a suitable layout algorithm for a part of the diagram editor without the need of referencing a specific algorithm. KIML provides DiagramLayoutManager implementations for GMF and Graphiti. For diagram editors that are not compatible with those layout managers, a new implementation must be made. This includes specialized implementations of IGraphicalFrameworkBridge and ofILayoutConfig. Diagram layout managers have to be registered using the de.cau.cs.kieler.kiml.ui.layoutManagers extension point.For cases when it is not sufficient to bind a layout option value with a domain model class, but the actual value depends on some properties of the runtime domain model instance, the layoutInfo extension point allows to register implementations of SemanticLayoutConfig. This allows to include arbitrary analysis of the domain model in order to derive a layout configuration.

The transformation of input diagrams to KGraph instances as well as the transfer of computed layouts back to the input diagrams is done by IDiagramLayoutManager implementations. For most diagram editors that are based on GMF the generic GmfDiagramLayoutManager can be used, while for Graphiti there is the generic GraphitiDiagramLayoutManager. However, some customized diagram editors do not work with the generic diagram layout managers and hence require their own specialized implementations, which can be contributed with the extension point layoutManagers.

Graph Analysis

KIML offers an interface for graph analysis, available with the  button. Here a selection of analyses can be made, which refer to the structure or to the drawing of the graph. After performing the analyses, the results are shown in a dialog and in the Analysis view. New analyses, which must implement IAnalysis, can be registered using the de.cau.cs.kieler.kiml.grana.analysisProviders extension the analysisProviders extension point.