com.yworks.yfiles.layout

Class Swimlanes

java.lang.Object

com.yworks.yfiles.layout.Swimlanes

public final class Swimlanes
extends Object

Swimlanes provides helper classes and methods to handle swimlanes.

It is used by HierarchicLayout to arrange the nodes in lanes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Swimlanes.SwimlaneRepresentative A SwimlaneRepresentative represents the position and arrangement mode for a swimlane.

Method Summary

Modifier and Type	Method and Description
static void	arrangeSwimlanes(Graph graph, IDataProvider node2Swimlane) Calculates an ordering of the swimlanes.
static void	arrangeSwimlanes(Graph graph, IDataProvider node2Swimlane, int iterations, SwimlanesMode mode) Calculates an ordering of the swimlanes considering the specified ordering mode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

arrangeSwimlanes

public static final void arrangeSwimlanes(Graph graph,
                                          IDataProvider node2Swimlane)

Calculates an ordering of the swimlanes.

The ordering will try to reduce:

1. the number of swimlanes traversed by edges
2. the number of swimlanes spanned by group nodes

A group node can span a swimlane without having a descendant in it.

Parameters:

graph - the input graph

node2Swimlane - the assignment of nodes to swimlanes

See Also:

Swimlanes.SwimlaneRepresentative, GroupingSupport

arrangeSwimlanes

public static final void arrangeSwimlanes(Graph graph,
                                          IDataProvider node2Swimlane,
                                          int iterations,
                                          SwimlanesMode mode)

Calculates an ordering of the swimlanes considering the specified ordering mode.

Depending on the swimlane mode, the ordering will try to reduce:

1. the number of swimlanes traversed by edges
2. the number of swimlanes spanned by group nodes

A group node can span a swimlane without having a descendant in it.

Parameters:

graph - the input graph

node2Swimlane - the assignment of nodes to swimlanes

iterations - the number of iterations performed by the heuristic.

mode - one of the valid swimlane ordering mode specifier

See Also:

Swimlanes.SwimlaneRepresentative, GroupingSupport