com.yworks.yfiles.layout.circular

Class CircularLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.circular.CircularLayoutData

public class CircularLayoutData
extends LayoutData

Specifies custom data for the CircularLayout.

Constructor Summary

Constructors

Constructor and Description
CircularLayoutData()

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.
IMapper<INode,Integer>	getCircleIds() Gets the mapper from nodes to their circle id.
ItemMapping<INode,Object>	getCustomGroups() Gets the mapping from nodes to their custom group object.
ItemMapping<IEdge,EdgeBundleDescriptor>	getEdgeBundleDescriptors() Gets the mapping of edges to their EdgeBundleDescriptor.
ItemMapping<INode,NodeHalo>	getNodeHalos() Gets the mapping from nodes to their NodeHalo.
void	setAbortHandler(AbortHandler value) Sets the AbortHandler used during the layout.
void	setCircleIds(IMapper<INode,Integer> value) Sets the mapper from nodes to their circle id.
void	setCustomGroups(ItemMapping<INode,Object> value) Sets the mapping from nodes to their custom group object.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CircularLayoutData

public CircularLayoutData()

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)

getCircleIds

public final IMapper<INode,Integer> getCircleIds()

Gets the mapper from nodes to their circle id.

If this property is set, the mapper is filled by the layout with the circle information.

Returns:

The CircleIds.

See Also:

CircularLayout.CIRCLE_ID_DPKEY, setCircleIds(IMapper)

getCustomGroups

public final ItemMapping<INode,Object> getCustomGroups()

Gets the mapping from nodes to their custom group object.

The custom groups are only considered if LayoutStyle is set to LayoutStyle.CUSTOM_GROUPS

Returns:

The CustomGroups.

See Also:

CircularLayout.CUSTOM_GROUPS_DPKEY, setCustomGroups(ItemMapping)

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, CircularLayout.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)

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

setCircleIds

public final void setCircleIds(IMapper<INode,Integer> value)

Sets the mapper from nodes to their circle id.

If this property is set, the mapper is filled by the layout with the circle information.

Parameters:

value - The CircleIds to set.

See Also:

CircularLayout.CIRCLE_ID_DPKEY, getCircleIds()

setCustomGroups

public final void setCustomGroups(ItemMapping<INode,Object> value)

Sets the mapping from nodes to their custom group object.

The custom groups are only considered if LayoutStyle is set to LayoutStyle.CUSTOM_GROUPS

Parameters:

value - The CustomGroups to set.

See Also:

CircularLayout.CUSTOM_GROUPS_DPKEY, getCustomGroups()

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, CircularLayout.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()