com.yworks.yfiles.layout.seriesparallel

Class SeriesParallelLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.seriesparallel.SeriesParallelLayoutData

public class SeriesParallelLayoutData
extends LayoutData

Specifies custom data for the SeriesParallelLayout.

Constructor Summary

Constructors

Constructor and Description
SeriesParallelLayoutData()

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.
ItemMapping<IEdge,EdgeLayoutDescriptor>	getEdgeLayoutDescriptors() Gets the mapping from edges to their EdgeLayoutDescriptor.
ItemMapping<INode,Comparator<IEdge>>	getOutEdgeComparators() Gets the mapping from nodes to comparison functions used to sort the nodes' outgoing edges.
ItemMapping<INode,IPortAssignment>	getPortAssignments() Gets the mapping from nodes to their IPortAssignment.
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	setEdgeLayoutDescriptors(ItemMapping<IEdge,EdgeLayoutDescriptor> value) Sets the mapping from edges to their EdgeLayoutDescriptor.
void	setOutEdgeComparators(ItemMapping<INode,Comparator<IEdge>> value) Sets the mapping from nodes to comparison functions used to sort the nodes' outgoing edges.
void	setPortAssignments(ItemMapping<INode,IPortAssignment> value) Sets the mapping from nodes to their IPortAssignment.
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

SeriesParallelLayoutData

public SeriesParallelLayoutData()

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)

getEdgeLayoutDescriptors

public final ItemMapping<IEdge,EdgeLayoutDescriptor> getEdgeLayoutDescriptors()

Gets the mapping from edges to their EdgeLayoutDescriptor.

Returns:

The EdgeLayoutDescriptors.

See Also:

EdgeLayoutDescriptor, SeriesParallelLayout.EDGE_LAYOUT_DESCRIPTOR_DPKEY, setEdgeLayoutDescriptors(ItemMapping)

getOutEdgeComparators

public final ItemMapping<INode,Comparator<IEdge>> getOutEdgeComparators()

Gets the mapping from nodes to comparison functions used to sort the nodes' outgoing edges.

Returns:

The OutEdgeComparators.

See Also:

SeriesParallelLayout.OUT_EDGE_COMPARATOR_DPKEY, setOutEdgeComparators(ItemMapping)

getPortAssignments

public final ItemMapping<INode,IPortAssignment> getPortAssignments()

Gets the mapping from nodes to their IPortAssignment.

Returns:

The PortAssignments.

See Also:

SeriesParallelLayout.PORT_ASSIGNMENT_DPKEY, setPortAssignments(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()

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, SeriesParallelLayout.EDGE_LAYOUT_DESCRIPTOR_DPKEY, getEdgeLayoutDescriptors()

setOutEdgeComparators

public final void setOutEdgeComparators(ItemMapping<INode,Comparator<IEdge>> value)

Sets the mapping from nodes to comparison functions used to sort the nodes' outgoing edges.

Parameters:

value - The OutEdgeComparators to set.

See Also:

SeriesParallelLayout.OUT_EDGE_COMPARATOR_DPKEY, getOutEdgeComparators()

setPortAssignments

public final void setPortAssignments(ItemMapping<INode,IPortAssignment> value)

Sets the mapping from nodes to their IPortAssignment.

Parameters:

value - The PortAssignments to set.

See Also:

SeriesParallelLayout.PORT_ASSIGNMENT_DPKEY, getPortAssignments()

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