com.yworks.yfiles.layout.router

Class StraightLineEdgeRouter

java.lang.Object

com.yworks.yfiles.layout.AbstractLayoutStage

com.yworks.yfiles.layout.router.StraightLineEdgeRouter

All Implemented Interfaces:

ILayoutAlgorithm, ILayoutStage

public class StraightLineEdgeRouter
extends AbstractLayoutStage

This edge routing algorithm routes edges as straight-lines considering the specified PortConstraints.

Layout Style

The edges connect to their ports with straight-lines. This may lead to edges crossing nodes.

Concept

StraightLineEdgeRouter will first invoke the CoreLayout if one exists. Then, it will remove all bends from the edges and will place the ports either on the center of the nodes or at a location specified by a PortConstraint.

Constructor Summary

Constructors

Constructor and Description
StraightLineEdgeRouter() Creates a new instance of StraightLineEdgeRouter with an optional core layout algorithm.
StraightLineEdgeRouter(ILayoutAlgorithm core) Creates a new instance of StraightLineEdgeRouter with an optional core layout algorithm.

Method Summary

Modifier and Type	Method and Description
void	applyLayout(LayoutGraph graph) Routes the edges as straight-lines from their source to their target after invoking the core layout algorithm.
Object	getAffectedEdgesDpKey() Gets the key to register a IDataProvider that provides the selected state of the edges of the graph.
Object	getAffectedNodesDpKey() Gets the key to register a IDataProvider that provides the selected state of the nodes of the graph.
Scope	getScope() Gets the (sub-)set of edges to be routed.
void	setAffectedEdgesDpKey(Object value) Sets the key to register a IDataProvider that provides the selected state of the edges of the graph.
void	setAffectedNodesDpKey(Object value) Sets the key to register a IDataProvider that provides the selected state of the nodes of the graph.
void	setScope(Scope value) Sets the (sub-)set of edges to be routed.

Methods inherited from class com.yworks.yfiles.layout.AbstractLayoutStage

applyLayoutCore, getCoreLayout, setCoreLayout

Methods inherited from class java.lang.Object

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

Constructor Detail

StraightLineEdgeRouter

public StraightLineEdgeRouter()

Creates a new instance of StraightLineEdgeRouter with an optional core layout algorithm.

StraightLineEdgeRouter

public StraightLineEdgeRouter(ILayoutAlgorithm core)

Creates a new instance of StraightLineEdgeRouter with an optional core layout algorithm.

Parameters:

core - The core layout algorithm.

Method Detail

applyLayout

public void applyLayout(LayoutGraph graph)

Routes the edges as straight-lines from their source to their target after invoking the core layout algorithm.

Specified by:

applyLayout in interface ILayoutAlgorithm

Specified by:

applyLayout in class AbstractLayoutStage

Parameters:

graph - the input graph

getAffectedEdgesDpKey

public Object getAffectedEdgesDpKey()

Gets the key to register a IDataProvider that provides the selected state of the edges of the graph.

If the scope only includes selected edges, only edges of the nodes marked in this IDataProvider are routed while all other edges are considered to have fixed routes.

Throws:

IllegalArgumentException - if the specified key is null

Returns:

the key to register a IDataProvider for the edge selection

See Also:

getScope(), setAffectedEdgesDpKey(Object)

getAffectedNodesDpKey

public Object getAffectedNodesDpKey()

Gets the key to register a IDataProvider that provides the selected state of the nodes of the graph.

If the scope only includes edges at selected nodes, only edges of the nodes marked in this IDataProvider are routed while all other edges are considered to have fixed routes.

Throws:

IllegalArgumentException - if the specified key is null

Default Value:

The default value is LayoutKeys.AFFECTED_NODES_DPKEY

Returns:

the key to register a IDataProvider for the node selection

See Also:

getScope(), setAffectedNodesDpKey(Object)

getScope

public Scope getScope()

Gets the (sub-)set of edges to be routed.

StraightLineEdgeRouter will only route those edges and leave the remaining edges unchanged.

Throws:

IllegalArgumentException - if the given argument is an unknown specifier

Default Value:

The default value is Scope.ROUTE_ALL_EDGES

Returns:

one of the valid scope specifiers

See Also:

getAffectedEdgesDpKey(), getAffectedNodesDpKey(), setScope(Scope)

setAffectedEdgesDpKey

public void setAffectedEdgesDpKey(Object value)

Sets the key to register a IDataProvider that provides the selected state of the edges of the graph.

If the scope only includes selected edges, only edges of the nodes marked in this IDataProvider are routed while all other edges are considered to have fixed routes.

Throws:

IllegalArgumentException - if the specified key is null

Parameters:

value - the key to register a IDataProvider for the edge selection

See Also:

getScope(), getAffectedEdgesDpKey()

setAffectedNodesDpKey

public void setAffectedNodesDpKey(Object value)

Sets the key to register a IDataProvider that provides the selected state of the nodes of the graph.

If the scope only includes edges at selected nodes, only edges of the nodes marked in this IDataProvider are routed while all other edges are considered to have fixed routes.

Throws:

IllegalArgumentException - if the specified key is null

Default Value:

The default value is LayoutKeys.AFFECTED_NODES_DPKEY

Parameters:

value - the key to register a IDataProvider for the node selection

See Also:

getScope(), getAffectedNodesDpKey()

setScope

public void setScope(Scope value)

Sets the (sub-)set of edges to be routed.

StraightLineEdgeRouter will only route those edges and leave the remaining edges unchanged.

Throws:

IllegalArgumentException - if the given argument is an unknown specifier

Default Value:

The default value is Scope.ROUTE_ALL_EDGES

Parameters:

value - one of the valid scope specifiers

See Also:

getAffectedEdgesDpKey(), getAffectedNodesDpKey(), getScope()