com.yworks.yfiles.layout

Class RecursiveGroupLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.RecursiveGroupLayoutData

public class RecursiveGroupLayoutData
extends LayoutData

Specifies custom data for the RecursiveGroupLayout.

Constructor Summary

Constructors

Constructor and Description
RecursiveGroupLayoutData()

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<INode,ILayoutAlgorithm>	getGroupNodeLayouts() Gets the mapping from group nodes to the ILayoutAlgorithm used for their child nodes.
ItemMapping<INode,NodeHalo>	getNodeHalos() Gets the mapping from nodes to their NodeHalo.
ItemMapping<INode,PortCandidateSet>	getNodePortCandidateSets() Gets a mapping from nodes to their PortCandidateSet.
ItemMapping<IEdge,Collection<PortCandidate>>	getSourcePortCandidates() Gets a mapping from edges to a collection of their source port candidates.
ItemMapping<IEdge,PortConstraint>	getSourcePortConstraints() Gets a mapping from edges to their source PortConstraint.
ItemMapping<IEdge,Object>	getSourceSplitIds() Gets a mapping from edges connecting to group nodes to source split ids.
ItemMapping<IEdge,Collection<PortCandidate>>	getTargetPortCandidates() Gets a mapping from edges to a collection of their target port candidates.
ItemMapping<IEdge,PortConstraint>	getTargetPortConstraints() Gets a mapping from edges to their target PortConstraint.
ItemMapping<IEdge,Object>	getTargetSplitIds() Gets a mapping from edges connecting to group nodes to target split ids.
void	setAbortHandler(AbortHandler value) Sets the AbortHandler used during the layout.
void	setGroupNodeLayouts(ItemMapping<INode,ILayoutAlgorithm> value) Sets the mapping from group nodes to the ILayoutAlgorithm used for their child nodes.
void	setNodeHalos(ItemMapping<INode,NodeHalo> value) Sets the mapping from nodes to their NodeHalo.
void	setNodePortCandidateSets(ItemMapping<INode,PortCandidateSet> value) Sets a mapping from nodes to their PortCandidateSet.
void	setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their source port candidates.
void	setSourcePortConstraints(ItemMapping<IEdge,PortConstraint> value) Sets a mapping from edges to their source PortConstraint.
void	setSourceSplitIds(ItemMapping<IEdge,Object> value) Sets a mapping from edges connecting to group nodes to source split ids.
void	setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value) Sets a mapping from edges to a collection of their target port candidates.
void	setTargetPortConstraints(ItemMapping<IEdge,PortConstraint> value) Sets a mapping from edges to their target PortConstraint.
void	setTargetSplitIds(ItemMapping<IEdge,Object> value) Sets a mapping from edges connecting to group nodes to target split ids.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecursiveGroupLayoutData

public RecursiveGroupLayoutData()

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)

getGroupNodeLayouts

public final ItemMapping<INode,ILayoutAlgorithm> getGroupNodeLayouts()

Gets the mapping from group nodes to the ILayoutAlgorithm used for their child nodes.

Returns:

The GroupNodeLayouts.

See Also:

RecursiveGroupLayout.GROUP_NODE_LAYOUT_DPKEY, setGroupNodeLayouts(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)

getNodePortCandidateSets

public final ItemMapping<INode,PortCandidateSet> getNodePortCandidateSets()

Gets a mapping from nodes to their PortCandidateSet.

Returns:

The NodePortCandidateSets.

See Also:

PortCandidateSet.NODE_PORT_CANDIDATE_SET_DPKEY, setNodePortCandidateSets(ItemMapping)

getSourcePortCandidates

public final ItemMapping<IEdge,Collection<PortCandidate>> getSourcePortCandidates()

Gets a mapping from edges to a collection of their source port candidates.

Returns:

The SourcePortCandidates.

See Also:

PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY, setSourcePortCandidates(ItemMapping)

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)

getSourceSplitIds

public final ItemMapping<IEdge,Object> getSourceSplitIds()

Gets a mapping from edges connecting to group nodes to source split ids.

Edges will be aligned with edges that connect to the same group node and have the same split id at their source (preferably) or target.

Returns:

The SourceSplitIds.

See Also:

RecursiveGroupLayout.SOURCE_SPLIT_ID_DPKEY, setSourceSplitIds(ItemMapping)

getTargetPortCandidates

public final ItemMapping<IEdge,Collection<PortCandidate>> getTargetPortCandidates()

Gets a mapping from edges to a collection of their target port candidates.

Returns:

The TargetPortCandidates.

See Also:

PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY, setTargetPortCandidates(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)

getTargetSplitIds

public final ItemMapping<IEdge,Object> getTargetSplitIds()

Gets a mapping from edges connecting to group nodes to target split ids.

Edges will be aligned with edges that connect to the same group node and have the same split id at their source or target (preferably).

Returns:

The TargetSplitIds.

See Also:

RecursiveGroupLayout.TARGET_SPLIT_ID_DPKEY, setTargetSplitIds(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()

setGroupNodeLayouts

public final void setGroupNodeLayouts(ItemMapping<INode,ILayoutAlgorithm> value)

Sets the mapping from group nodes to the ILayoutAlgorithm used for their child nodes.

Parameters:

value - The GroupNodeLayouts to set.

See Also:

RecursiveGroupLayout.GROUP_NODE_LAYOUT_DPKEY, getGroupNodeLayouts()

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

setNodePortCandidateSets

public final void setNodePortCandidateSets(ItemMapping<INode,PortCandidateSet> value)

Sets a mapping from nodes to their PortCandidateSet.

Parameters:

value - The NodePortCandidateSets to set.

See Also:

PortCandidateSet.NODE_PORT_CANDIDATE_SET_DPKEY, getNodePortCandidateSets()

setSourcePortCandidates

public final void setSourcePortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)

Sets a mapping from edges to a collection of their source port candidates.

Parameters:

value - The SourcePortCandidates to set.

See Also:

PortCandidate.SOURCE_PORT_CANDIDATE_COLLECTION_DPKEY, getSourcePortCandidates()

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

setSourceSplitIds

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

Sets a mapping from edges connecting to group nodes to source split ids.

Edges will be aligned with edges that connect to the same group node and have the same split id at their source (preferably) or target.

Parameters:

value - The SourceSplitIds to set.

See Also:

RecursiveGroupLayout.SOURCE_SPLIT_ID_DPKEY, getSourceSplitIds()

setTargetPortCandidates

public final void setTargetPortCandidates(ItemMapping<IEdge,Collection<PortCandidate>> value)

Sets a mapping from edges to a collection of their target port candidates.

Parameters:

value - The TargetPortCandidates to set.

See Also:

PortCandidate.TARGET_PORT_CANDIDATE_COLLECTION_DPKEY, getTargetPortCandidates()

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

setTargetSplitIds

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

Sets a mapping from edges connecting to group nodes to target split ids.

Edges will be aligned with edges that connect to the same group node and have the same split id at their source or target (preferably).

Parameters:

value - The TargetSplitIds to set.

See Also:

RecursiveGroupLayout.TARGET_SPLIT_ID_DPKEY, getTargetSplitIds()