com.yworks.yfiles.layout.hierarchic

Class RoutingStyle

java.lang.Object

com.yworks.yfiles.layout.hierarchic.RoutingStyle

public class RoutingStyle
extends Object

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

See Also:

EdgeLayoutDescriptor.setRoutingStyle(RoutingStyle), IEdgeData.getType()

Constructor Summary

Constructors

Constructor and Description
RoutingStyle(EdgeRoutingStyle routingStyle) Creates a new RoutingStyle instance with the given routing style for each edge.

Method Summary

Modifier and Type	Method and Description
EdgeRoutingStyle	getBackLoopRoutingStyle() Gets the routing style for back-loop edges.
EdgeRoutingStyle	getDefaultEdgeRoutingStyle() Gets the default routing style for edges that have no individual routing style.
EdgeRoutingStyle	getEdgeGroupRoutingStyle() Gets the routing style for grouped edges at the common segments.
EdgeRoutingStyle	getSameLayerEdgeRoutingStyle() Gets the routing style for same-layer edges.
EdgeRoutingStyle	getSelfLoopRoutingStyle() Gets the routing style for self-loops.
void	setBackLoopRoutingStyle(EdgeRoutingStyle value) Sets the routing style for back-loop edges.
void	setDefaultEdgeRoutingStyle(EdgeRoutingStyle value) Sets the default routing style for edges that have no individual routing style.
void	setEdgeGroupRoutingStyle(EdgeRoutingStyle value) Sets the routing style for grouped edges at the common segments.
void	setSameLayerEdgeRoutingStyle(EdgeRoutingStyle value) Sets the routing style for same-layer edges.
void	setSelfLoopRoutingStyle(EdgeRoutingStyle value) Sets the routing style for self-loops.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoutingStyle

public RoutingStyle(EdgeRoutingStyle routingStyle)

Creates a new RoutingStyle instance with the given routing style for each edge.

Throws:

IllegalArgumentException - if an unknown routing style is given

Parameters:

routingStyle - one of the predefined routing styles

Method Detail

getBackLoopRoutingStyle

public EdgeRoutingStyle getBackLoopRoutingStyle()

Gets the routing style for back-loop edges.

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 BackLoopRoutingEnabled is enabled or in some other scenarios with port constraints/candidates.

Throws:

IllegalArgumentException - if an unknown routing style is given

Returns:

one of the predefined routing styles

See Also:

setBackLoopRoutingStyle(EdgeRoutingStyle)

getDefaultEdgeRoutingStyle

public EdgeRoutingStyle getDefaultEdgeRoutingStyle()

Gets the default routing style for edges that have no individual routing style.

Throws:

IllegalArgumentException - if an unknown routing style is given

Returns:

one of the predefined routing styles

See Also:

setDefaultEdgeRoutingStyle(EdgeRoutingStyle)

getEdgeGroupRoutingStyle

public EdgeRoutingStyle getEdgeGroupRoutingStyle()

Gets the routing style for grouped edges at the common segments.

More precisely, grouped edges are routed in a bus-style fashion (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.

Throws:

IllegalArgumentException - if an unknown routing style is given

Returns:

one of the predefined routing styles

See Also:

setEdgeGroupRoutingStyle(EdgeRoutingStyle)

getSameLayerEdgeRoutingStyle

public EdgeRoutingStyle getSameLayerEdgeRoutingStyle()

Gets the routing style for same-layer edges.

A same-layer edge is an edge whose source/target are assigned to the same layer.

Throws:

IllegalArgumentException - if an unknown routing style is given

Returns:

one of the predefined routing styles

See Also:

setSameLayerEdgeRoutingStyle(EdgeRoutingStyle)

getSelfLoopRoutingStyle

public EdgeRoutingStyle getSelfLoopRoutingStyle()

Gets the routing style for self-loops.

Throws:

IllegalArgumentException - if an unknown routing style is given

Returns:

one of the predefined routing styles

See Also:

setSelfLoopRoutingStyle(EdgeRoutingStyle)

setBackLoopRoutingStyle

public void setBackLoopRoutingStyle(EdgeRoutingStyle value)

Sets the routing style for back-loop edges.

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 BackLoopRoutingEnabled is enabled or in some other scenarios with port constraints/candidates.

Throws:

IllegalArgumentException - if an unknown routing style is given

Parameters:

value - one of the predefined routing styles

See Also:

getBackLoopRoutingStyle()

setDefaultEdgeRoutingStyle

public void setDefaultEdgeRoutingStyle(EdgeRoutingStyle value)

Sets the default routing style for edges that have no individual routing style.

Throws:

IllegalArgumentException - if an unknown routing style is given

Parameters:

value - one of the predefined routing styles

See Also:

getDefaultEdgeRoutingStyle()

setEdgeGroupRoutingStyle

public void setEdgeGroupRoutingStyle(EdgeRoutingStyle value)

Sets the routing style for grouped edges at the common segments.

More precisely, grouped edges are routed in a bus-style fashion (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.

Throws:

IllegalArgumentException - if an unknown routing style is given

Parameters:

value - one of the predefined routing styles

See Also:

getEdgeGroupRoutingStyle()

setSameLayerEdgeRoutingStyle

public void setSameLayerEdgeRoutingStyle(EdgeRoutingStyle value)

Sets the routing style for same-layer edges.

A same-layer edge is an edge whose source/target are assigned to the same layer.

Throws:

IllegalArgumentException - if an unknown routing style is given

Parameters:

value - one of the predefined routing styles

See Also:

getSameLayerEdgeRoutingStyle()

setSelfLoopRoutingStyle

public void setSelfLoopRoutingStyle(EdgeRoutingStyle value)

Sets the routing style for self-loops.

Throws:

IllegalArgumentException - if an unknown routing style is given

Parameters:

value - one of the predefined routing styles

See Also:

getSelfLoopRoutingStyle()