y.layout.router
Class EdgeGroupRouterStage

java.lang.Object
  y.layout.AbstractLayoutStage
      y.layout.router.EdgeGroupRouterStage

All Implemented Interfaces:

Layouter, LayoutStage

public class EdgeGroupRouterStage
extends AbstractLayoutStage

Layout stage for OrthogonalEdgeRouter that adds support for a bus-like routing style. Edges that connect to a common node can be marked as grouped by using the data provider keys PortConstraintKeys.SOURCE_GROUPID_KEY or PortConstraintKeys.TARGET_GROUPID_KEY. This stage tries to route grouped edges on a vertical or horizontal bus. The edges will connect to their common node at the same port coordinate. There are some limitations to this stage:

• If at least one edge of a specific edge group is part of the sphere of action of OrthogonalEdgeRouter, then all of the edges belonging to that group will be part of the sphere of action of the router.
• Edges can either be source or target grouped but not both at the same time.
• Not all edges belonging to a group will be placed on a common bus. Only edges that connect to nodes which lie in the same direction relative to their common node will be routed on a bus.

Field Summary

Fields inherited from interface y.layout.Layouter

EDGE_ID_DPKEY, NODE_ID_DPKEY, SELECTED_EDGES, SELECTED_NODES

Constructor Summary

EdgeGroupRouterStage(Layouter coreLayouter)

Method Summary

boolean	canLayout(LayoutGraph graph) Returns true iff the given graph can be laid out by this algorithm.
void	doLayout(LayoutGraph graph) Main layout routine that assigns new layout information to the given graph.
double	getMinimalBusDistance() Returns the minimal distance between a bus formed by an edge group and the nodes the grouped edges connect to.
void	setMinimalBusDistance(double minimalBusDistance) Sets the minimal distance between a bus formed by an edge group and the nodes the grouped edges connect to.

Methods inherited from class y.layout.AbstractLayoutStage

canLayoutCore, doLayoutCore, getCoreLayouter, setCoreLayouter

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeGroupRouterStage

public EdgeGroupRouterStage(Layouter coreLayouter)

Method Detail

getMinimalBusDistance

public double getMinimalBusDistance()

Returns the minimal distance between a bus formed by an edge group and the nodes the grouped edges connect to. By default this value is set to 15.0.

setMinimalBusDistance

public void setMinimalBusDistance(double minimalBusDistance)

Sets the minimal distance between a bus formed by an edge group and the nodes the grouped edges connect to. By default this value is set to 15.0.

canLayout

public boolean canLayout(LayoutGraph graph)

Description copied from interface: Layouter

Returns true iff the given graph can be laid out by this algorithm. Calling doLayout with the given graph as its argument will only success if this method returns true.

doLayout

public void doLayout(LayoutGraph graph)

Description copied from interface: Layouter

Main layout routine that assigns new layout information to the given graph.