com.yworks.yfiles.layout.radial

Class RadialLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.radial.RadialLayoutData

public class RadialLayoutData
extends LayoutData

Specifies custom data for the RadialLayout.

Constructor Summary

Constructors

Constructor and Description
RadialLayoutData()

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.
DpKeyItemCollection<INode>	getCenterNodes() Gets the collection of nodes that shall be placed in the center with center node policy set to CenterNodesPolicy.CUSTOM .
ItemMapping<IEdge,EdgeBundleDescriptor>	getEdgeBundleDescriptors() Gets the mapping of edges to their EdgeBundleDescriptor.
ItemMapping<INode,NodeHalo>	getNodeHalos() Gets the mapping from nodes to their NodeHalo.
IMapper<INode,RadialLayout.NodeInfo>	getNodeInfos() Gets the mapping from nodes to a RadialLayout.NodeInfo describing on which circle and in which sector the node is placed.
ItemMapping<IEdge,Object>	getSourceGroups() Gets a mapping from edges to an object representing their source edge group.
ItemMapping<IEdge,Object>	getTargetGroups() 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	setCenterNodes(DpKeyItemCollection<INode> value) Sets the collection of nodes that shall be placed in the center with center node policy set to CenterNodesPolicy.CUSTOM .
void	setEdgeBundleDescriptors(ItemMapping<IEdge,EdgeBundleDescriptor> value) Sets the mapping of edges to their EdgeBundleDescriptor.
void	setNodeHalos(ItemMapping<INode,NodeHalo> value) Sets the mapping from nodes to their NodeHalo.
void	setNodeInfos(IMapper<INode,RadialLayout.NodeInfo> value) Sets the mapping from nodes to a RadialLayout.NodeInfo describing on which circle and in which sector the node is placed.
void	setSourceGroups(ItemMapping<IEdge,Object> value) Sets a mapping from edges to an object representing their source edge group.
void	setTargetGroups(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

RadialLayoutData

public RadialLayoutData()

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)

getCenterNodes

public final DpKeyItemCollection<INode> getCenterNodes()

Gets the collection of nodes that shall be placed in the center with center node policy set to CenterNodesPolicy.CUSTOM .

Returns:

The CenterNodes.

See Also:

RadialLayout.getCenterNodesDpKey(), setCenterNodes(DpKeyItemCollection)

getEdgeBundleDescriptors

public final ItemMapping<IEdge,EdgeBundleDescriptor> getEdgeBundleDescriptors()

Gets the mapping of edges to their EdgeBundleDescriptor.

Bundling together multiple edges means that their common parts are to some degree merged into a bundled part. At the source and target point, the edges are again clearly split.

If an edge is mapped to null, the default descriptor is used.

Returns:

The EdgeBundleDescriptors.

See Also:

EdgeBundleDescriptor, RadialLayout.getEdgeBundling(), setEdgeBundleDescriptors(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)

getNodeInfos

public final IMapper<INode,RadialLayout.NodeInfo> getNodeInfos()

Gets the mapping from nodes to a RadialLayout.NodeInfo describing on which circle and in which sector the node is placed.

If the mapper contains a RadialLayout.NodeInfo for a node, the layout will update its property during the layout.

Returns:

The NodeInfos.

See Also:

RadialLayout.NODE_INFO_DPKEY, setNodeInfos(IMapper)

getSourceGroups

public final ItemMapping<IEdge,Object> getSourceGroups()

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

Returns:

The SourceGroups.

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, setSourceGroups(ItemMapping)

getTargetGroups

public final ItemMapping<IEdge,Object> getTargetGroups()

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

Returns:

The TargetGroups.

See Also:

PortConstraintKeys.TARGET_GROUP_ID_DPKEY, setTargetGroups(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()

setCenterNodes

public final void setCenterNodes(DpKeyItemCollection<INode> value)

Sets the collection of nodes that shall be placed in the center with center node policy set to CenterNodesPolicy.CUSTOM .

Parameters:

value - The CenterNodes to set.

See Also:

RadialLayout.getCenterNodesDpKey(), getCenterNodes()

setEdgeBundleDescriptors

public final void setEdgeBundleDescriptors(ItemMapping<IEdge,EdgeBundleDescriptor> value)

Sets the mapping of edges to their EdgeBundleDescriptor.

Bundling together multiple edges means that their common parts are to some degree merged into a bundled part. At the source and target point, the edges are again clearly split.

If an edge is mapped to null, the default descriptor is used.

Parameters:

value - The EdgeBundleDescriptors to set.

See Also:

EdgeBundleDescriptor, RadialLayout.getEdgeBundling(), getEdgeBundleDescriptors()

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

setNodeInfos

public final void setNodeInfos(IMapper<INode,RadialLayout.NodeInfo> value)

Sets the mapping from nodes to a RadialLayout.NodeInfo describing on which circle and in which sector the node is placed.

If the mapper contains a RadialLayout.NodeInfo for a node, the layout will update its property during the layout.

Parameters:

value - The NodeInfos to set.

See Also:

RadialLayout.NODE_INFO_DPKEY, getNodeInfos()

setSourceGroups

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

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

Parameters:

value - The SourceGroups to set.

See Also:

PortConstraintKeys.SOURCE_GROUP_ID_DPKEY, getSourceGroups()

setTargetGroups

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

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

Parameters:

value - The TargetGroups to set.

See Also:

PortConstraintKeys.TARGET_GROUP_ID_DPKEY, getTargetGroups()