com.yworks.yfiles.layout

Class ParallelEdgeRouterData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.ParallelEdgeRouterData

public class ParallelEdgeRouterData
extends LayoutData

Specifies custom data for the ParallelEdgeRouter.

Constructor Summary

Constructors

Constructor and Description
ParallelEdgeRouterData()

Method Summary

Modifier and Type	Method and Description
void	apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph) Applies this layout data to the specified layoutGraphAdapter.
AbortHandler	getAbortHandler() Gets the AbortHandler used during the layout.
ItemCollection<IEdge>	getAffectedEdges() Gets the collection of edges affected by this router.
ItemCollection<IEdge>	getLeadingEdges() Gets the collection of leading edges.
void	setAbortHandler(AbortHandler value) Sets the AbortHandler used during the layout.
void	setAffectedEdges(ItemCollection<IEdge> value) Sets the collection of edges affected by this router.
void	setLeadingEdges(ItemCollection<IEdge> value) Sets the collection of leading edges.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParallelEdgeRouterData

public ParallelEdgeRouterData()

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.

getAbortHandler

public final AbortHandler getAbortHandler()

Gets the AbortHandler used during the layout.

Returns:

The AbortHandler.

See Also:

AbortHandler.ABORT_HANDLER_DPKEY, setAbortHandler(AbortHandler)

getAffectedEdges

public final ItemCollection<IEdge> getAffectedEdges()

Gets the collection of edges affected by this router.

Returns:

The AffectedEdges.

See Also:

ParallelEdgeRouter.AFFECTED_EDGES_DPKEY, setAffectedEdges(ItemCollection)

getLeadingEdges

public final ItemCollection<IEdge> getLeadingEdges()

Gets the collection of leading edges.

A leading edge is the edge whose layout is used to obtain the layout of the corresponding parallel edges.

Returns:

The LeadingEdges.

See Also:

ParallelEdgeRouter.LEADING_EDGE_DPKEY, setLeadingEdges(ItemCollection)

setAbortHandler

public final void setAbortHandler(AbortHandler value)

Sets the AbortHandler used during the layout.

Parameters:

value - The AbortHandler to set.

See Also:

AbortHandler.ABORT_HANDLER_DPKEY, getAbortHandler()

setAffectedEdges

public final void setAffectedEdges(ItemCollection<IEdge> value)

Sets the collection of edges affected by this router.

Parameters:

value - The AffectedEdges to set.

See Also:

ParallelEdgeRouter.AFFECTED_EDGES_DPKEY, getAffectedEdges()

setLeadingEdges

public final void setLeadingEdges(ItemCollection<IEdge> value)

Sets the collection of leading edges.

A leading edge is the edge whose layout is used to obtain the layout of the corresponding parallel edges.

Parameters:

value - The LeadingEdges to set.

See Also:

ParallelEdgeRouter.LEADING_EDGE_DPKEY, getLeadingEdges()