y.layout.hierarchic.incremental
Class RoutingStyle

java.lang.Object
  y.layout.hierarchic.incremental.RoutingStyle

public class RoutingStyle
extends Object

This class is used by EdgeLayoutDescriptor to specify the routing style for different edge types.

See Also:

EdgeLayoutDescriptor.setRoutingStyle(RoutingStyle)

Field Summary

static byte	EDGE_STYLE_OCTILINEAR Routing style constant.
static byte	EDGE_STYLE_ORTHOGONAL Routing style constant.
static byte	EDGE_STYLE_POLYLINE Routing style constant.

Constructor Summary

RoutingStyle(byte routingStyle)
Sets the routing style for each edge type to the specified value.

Method Summary

byte	getBackloopRoutingStyle() Returns the routing style for back-loops.
byte	getDefaultEdgeRoutingStyle() Returns the default routing style.
byte	getEdgeGroupRoutingStyle() Returns the routing style for grouped edges at the common segments.
byte	getSameLayerEdgeRoutingStyle() Returns the routing style for same layer edges (i.e., edges whose source/target are assigned to the same layer).
byte	getSelfloopRoutingStyle() Returns the routing style for self-loops.
void	setBackloopRoutingStyle(byte backloopRoutingStyle) Specifies the routing style for back-loops.
void	setDefaultEdgeRoutingStyle(byte defaultEdgeRoutingStyle) Specifies the default routing style.
void	setEdgeGroupRoutingStyle(byte edgeGroupRoutingStyle) Specifies the routing style for grouped edges at the common segments.
void	setSameLayerEdgeRoutingStyle(byte sameLayerEdgeRoutingStyle) Specifies the routing style for same layer edges (i.e., edges whose source/target are assigned to the same layer).
void	setSelfloopRoutingStyle(byte selfloopRoutingStyle) Specifies the routing style for self-loops.

Methods inherited from class java.lang.Object

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

Field Detail

EDGE_STYLE_ORTHOGONAL

public static final byte EDGE_STYLE_ORTHOGONAL

Routing style constant.

This constant specifies that the route should be orthogonal, i.e., the route only consists of vertical and horizontal segments.

See Also:

Constant Field Values

EDGE_STYLE_OCTILINEAR

public static final byte EDGE_STYLE_OCTILINEAR

Routing style constant.

This constant specifies that the route should be octilinear, i.e., the route consists of vertical and horizontal segments as well as segments with slope -1 and 1.

See Also:

Constant Field Values

EDGE_STYLE_POLYLINE

public static final byte EDGE_STYLE_POLYLINE

Routing style constant.

This constant specifies that the route should be polyline.

See Also:

Constant Field Values

Constructor Detail

RoutingStyle

public RoutingStyle(byte routingStyle)

Sets the routing style for each edge type to the specified value.

Parameters:

routingStyle - the routing style.

Method Detail

getBackloopRoutingStyle

public byte getBackloopRoutingStyle()

Returns the routing style for back-loops.
This style is used for routing u-turns of common edges (i.e., edges that are neither self-loops nor same layer edges). A u-turn is a non-monotonic part of the edge route that is required for reversed edges if option IncrementalHierarchicLayouter.setBackloopRoutingEnabled(boolean) is enabled or in some other scenarios with port constraints/candidates.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.

Returns:

the routing style for back-loops.

setBackloopRoutingStyle

public void setBackloopRoutingStyle(byte backloopRoutingStyle)

Specifies the routing style for back-loops.
This style is used for routing u-turns of common edges (i.e., edges that are neither self-loops nor same layer edges). A u-turn is a non-monotonic part of the edge route that is required for reversed edges if option IncrementalHierarchicLayouter.setBackloopRoutingEnabled(boolean) is enabled or in some other scenarios with port constraints/candidates.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.

Parameters:

backloopRoutingStyle - the routing style for back-loops.

getEdgeGroupRoutingStyle

public byte getEdgeGroupRoutingStyle()

Returns the routing style for grouped edges at the common segments.
More precisely, grouped edges are routed in bus-style (i.e., the paths of the edges will share a common edge segment) and this option allows to specify the routing style at the bus.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.

Returns:

the routing style for grouped edges at the common segments.

setEdgeGroupRoutingStyle

public void setEdgeGroupRoutingStyle(byte edgeGroupRoutingStyle)

Specifies the routing style for grouped edges at the common segments.
More precisely, grouped edges are routed in bus-style (i.e., the paths of the edges will share a common edge segment) and this option allows to specify the routing style at the bus.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.

Parameters:

edgeGroupRoutingStyle - the routing style for grouped edges at the common segments.

getDefaultEdgeRoutingStyle

public byte getDefaultEdgeRoutingStyle()

Returns the default routing style. This style is used for edges or part of edges for which no other routing style applies.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.

Returns:

the routing style for common edges.

setDefaultEdgeRoutingStyle

public void setDefaultEdgeRoutingStyle(byte defaultEdgeRoutingStyle)

Specifies the default routing style. This style is used for edges or part of edges for which no other routing style applies.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.

Parameters:

defaultEdgeRoutingStyle - the routing style for common edges.

getSameLayerEdgeRoutingStyle

public byte getSameLayerEdgeRoutingStyle()

Returns the routing style for same layer edges (i.e., edges whose source/target are assigned to the same layer).

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.

Returns:

the routing style for same layer edges.

setSameLayerEdgeRoutingStyle

public void setSameLayerEdgeRoutingStyle(byte sameLayerEdgeRoutingStyle)

Specifies the routing style for same layer edges (i.e., edges whose source/target are assigned to the same layer).

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.

Parameters:

sameLayerEdgeRoutingStyle - the routing style for same layer edges.

getSelfloopRoutingStyle

public byte getSelfloopRoutingStyle()

Returns the routing style for self-loops.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.

Returns:

the routing style for self-loops.

setSelfloopRoutingStyle

public void setSelfloopRoutingStyle(byte selfloopRoutingStyle)

Specifies the routing style for self-loops.

Possible values are EDGE_STYLE_OCTILINEAR, EDGE_STYLE_ORTHOGONAL and EDGE_STYLE_POLYLINE.

Parameters:

selfloopRoutingStyle - the routing style for self-loops.