com.yworks.yfiles.layout.orthogonal

Class OrthogonalLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.orthogonal.OrthogonalLayoutData

public class OrthogonalLayoutData
extends LayoutData

Specifies custom data for the OrthogonalLayout.

Constructor Summary

Constructors

Constructor and Description
OrthogonalLayoutData()

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>	getDirectedEdges() Gets the collection of edges that should be routed in a way that point in the main layout direction.
ItemMapping<IEdge,EdgeLayoutDescriptor>	getEdgeLayoutDescriptors() Gets the mapping from edges to their EdgeLayoutDescriptor.
ItemMapping<INode,NodeHalo>	getNodeHalos() Gets the mapping from nodes to their NodeHalo.
ItemMapping<IEdge,Object>	getSourceGroupIds() Gets a mapping from edges to an object representing their source edge group.
ItemMapping<IEdge,Object>	getTargetGroupIds() Gets a mapping from edges to an object representing their target edge group.
void	setAbortHandler(AbortHandler value) Sets the AbortHandler used during the layout.
void	setDirectedEdges(ItemCollection<IEdge> value) Sets the collection of edges that should be routed in a way that point in the main layout direction.
void	setEdgeLayoutDescriptors(ItemMapping<IEdge,EdgeLayoutDescriptor> value) Sets the mapping from edges to their EdgeLayoutDescriptor.
void	setNodeHalos(ItemMapping<INode,NodeHalo> value) Sets the mapping from nodes to their NodeHalo.
void	setSourceGroupIds(ItemMapping<IEdge,Object> value) Sets a mapping from edges to an object representing their source edge group.
void	setTargetGroupIds(ItemMapping<IEdge,Object> value) Sets a mapping from edges to an object representing their target edge group.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrthogonalLayoutData

public OrthogonalLayoutData()

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)

getDirectedEdges

public final ItemCollection<IEdge> getDirectedEdges()

Gets the collection of edges that should be routed in a way that point in the main layout direction.

Returns:

The DirectedEdges.

See Also:

OrthogonalLayout.DIRECTED_EDGE_DPKEY, setDirectedEdges(ItemCollection)

getEdgeLayoutDescriptors

public final ItemMapping<IEdge,EdgeLayoutDescriptor> getEdgeLayoutDescriptors()

Gets the mapping from edges to their EdgeLayoutDescriptor.

Returns:

The EdgeLayoutDescriptors.

See Also:

EdgeLayoutDescriptor, OrthogonalLayout.EDGE_LAYOUT_DESCRIPTOR_DPKEY, setEdgeLayoutDescriptors(ItemMapping)

getNodeHalos

public final ItemMapping<INode,NodeHalo> getNodeHalos()

Gets the mapping from nodes to their NodeHalo.

Returns:

The NodeHalos.

See Also:

NodeHalo.NODE_HALO_DPKEY, setNodeHalos(ItemMapping)

getSourceGroupIds

public final ItemMapping<IEdge,Object> getSourceGroupIds()

Gets a mapping from edges to an object representing their source edge group.

Returns:

The SourceGroupIds.

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, setSourceGroupIds(ItemMapping)

getTargetGroupIds

public final ItemMapping<IEdge,Object> getTargetGroupIds()

Gets a mapping from edges to an object representing their target edge group.

Returns:

The TargetGroupIds.

See Also:

PortConstraintKeys.TARGET_GROUP_ID_DPKEY, setTargetGroupIds(ItemMapping)

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()

setDirectedEdges

public final void setDirectedEdges(ItemCollection<IEdge> value)

Sets the collection of edges that should be routed in a way that point in the main layout direction.

Parameters:

value - The DirectedEdges to set.

See Also:

OrthogonalLayout.DIRECTED_EDGE_DPKEY, getDirectedEdges()

setEdgeLayoutDescriptors

public final void setEdgeLayoutDescriptors(ItemMapping<IEdge,EdgeLayoutDescriptor> value)

Sets the mapping from edges to their EdgeLayoutDescriptor.

Parameters:

value - The EdgeLayoutDescriptors to set.

See Also:

EdgeLayoutDescriptor, OrthogonalLayout.EDGE_LAYOUT_DESCRIPTOR_DPKEY, getEdgeLayoutDescriptors()

setNodeHalos

public final void setNodeHalos(ItemMapping<INode,NodeHalo> value)

Sets the mapping from nodes to their NodeHalo.

Parameters:

value - The NodeHalos to set.

See Also:

NodeHalo.NODE_HALO_DPKEY, getNodeHalos()

setSourceGroupIds

public final void setSourceGroupIds(ItemMapping<IEdge,Object> value)

Sets a mapping from edges to an object representing their source edge group.

Parameters:

value - The SourceGroupIds to set.

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, getSourceGroupIds()

setTargetGroupIds

public final void setTargetGroupIds(ItemMapping<IEdge,Object> value)

Sets a mapping from edges to an object representing their target edge group.

Parameters:

value - The TargetGroupIds to set.

See Also:

PortConstraintKeys.TARGET_GROUP_ID_DPKEY, getTargetGroupIds()