com.yworks.yfiles.layout.router

Class StraightLineEdgeRouterData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.router.StraightLineEdgeRouterData

public class StraightLineEdgeRouterData
extends LayoutData

Specifies custom data for the StraightLineEdgeRouter.

Constructor Summary

Constructors

Constructor and Description
StraightLineEdgeRouterData()

Method Summary

Modifier and Type	Method and Description
void	apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph) Applies this layout data to the specified layoutGraphAdapter.
DpKeyItemCollection<IEdge>	getAffectedEdges() Gets the collection of affected edges.
DpKeyItemCollection<INode>	getAffectedNodes() Gets the collection of affected nodes.
ItemMapping<IEdge,PortConstraint>	getSourcePortConstraints() Gets a mapping from edges to their source PortConstraint.
ItemMapping<IEdge,PortConstraint>	getTargetPortConstraints() Gets a mapping from edges to their target PortConstraint.
void	setAffectedEdges(DpKeyItemCollection<IEdge> value) Sets the collection of affected edges.
void	setAffectedNodes(DpKeyItemCollection<INode> value) Sets the collection of affected nodes.
void	setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value) Sets a mapping from edges to their source PortConstraint.
void	setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value) Sets a mapping from edges to their target PortConstraint.

Methods inherited from class java.lang.Object

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

Constructor Detail

StraightLineEdgeRouterData

public StraightLineEdgeRouterData()

Method Detail

apply

public void apply(LayoutGraphAdapter adapter,
                  ILayoutAlgorithm layout,
                  CopiedLayoutGraph layoutGraph)

Description copied from class: LayoutData

Applies this layout data to the specified layoutGraphAdapter.

Specified by:

apply in class LayoutData

Parameters:

adapter - The adapter to add the layout data to.

layout - The layout that shall use this layout data.

layoutGraph - The layout graph used for the layout calculation.

getAffectedEdges

public final DpKeyItemCollection<IEdge> getAffectedEdges()

Gets the collection of affected edges.

This collection is only used by the router if the Scope is set to Scope.ROUTE_AFFECTED_EDGES.

Returns:

The AffectedEdges.

See Also:

StraightLineEdgeRouter.getAffectedEdgesDpKey(), setAffectedEdges(DpKeyItemCollection)

getAffectedNodes

public final DpKeyItemCollection<INode> getAffectedNodes()

Gets the collection of affected nodes.

This collection is only used by the router if the Scope is set to Scope.ROUTE_EDGES_AT_AFFECTED_NODES.

Returns:

The AffectedNodes.

See Also:

StraightLineEdgeRouter.getAffectedNodesDpKey(), setAffectedNodes(DpKeyItemCollection)

getSourcePortConstraints

public final ItemMapping<IEdge,PortConstraint> getSourcePortConstraints()

Gets a mapping from edges to their source PortConstraint.

Returns:

The SourcePortConstraints.

See Also:

PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, setSourcePortConstraints(ItemMapping)

getTargetPortConstraints

public final ItemMapping<IEdge,PortConstraint> getTargetPortConstraints()

Gets a mapping from edges to their target PortConstraint.

Returns:

The TargetPortConstraints.

See Also:

PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, setTargetPortConstraints(ItemMapping)

setAffectedEdges

public final void setAffectedEdges(DpKeyItemCollection<IEdge> value)

Sets the collection of affected edges.

This collection is only used by the router if the Scope is set to Scope.ROUTE_AFFECTED_EDGES.

Parameters:

value - The AffectedEdges to set.

See Also:

StraightLineEdgeRouter.getAffectedEdgesDpKey(), getAffectedEdges()

setAffectedNodes

public final void setAffectedNodes(DpKeyItemCollection<INode> value)

Sets the collection of affected nodes.

This collection is only used by the router if the Scope is set to Scope.ROUTE_EDGES_AT_AFFECTED_NODES.

Parameters:

value - The AffectedNodes to set.

See Also:

StraightLineEdgeRouter.getAffectedNodesDpKey(), getAffectedNodes()

setSourcePortConstraints

public final void setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value)

Sets a mapping from edges to their source PortConstraint.

Parameters:

value - The SourcePortConstraints to set.

See Also:

PortConstraintKeys.SOURCE_PORT_CONSTRAINT_DPKEY, getSourcePortConstraints()

setTargetPortConstraints

public final void setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value)

Sets a mapping from edges to their target PortConstraint.

Parameters:

value - The TargetPortConstraints to set.

See Also:

PortConstraintKeys.TARGET_PORT_CONSTRAINT_DPKEY, getTargetPortConstraints()