com.yworks.yfiles.layout.organic

Class RecursiveShuffleLayout

java.lang.Object

com.yworks.yfiles.layout.AbstractLayoutStage

com.yworks.yfiles.layout.organic.RecursiveShuffleLayout

All Implemented Interfaces:

ILayoutAlgorithm, ILayoutStage

public class RecursiveShuffleLayout
extends AbstractLayoutStage

This algorithm recursively removes node overlaps from a graph with a hierarchic group structure.

Basically, this algorithm combines a RecursiveGroupLayout with a specific customizable shuffle algorithm as its core layout algorithm. The shuffle algorithm will be recursively applied to all groups of the input graph to remove node overlaps.

Input graph (left) and result (right) after executing this algorithm with default settings

Since this algorithm is a ILayoutStage, a core layout algorithm can be specified. In consequence, this algorithm will perform its work after the core algorithm was executed.

See Also:

ShuffleLayout, RecursiveGroupLayout

Constructor Summary

Constructors

Constructor and Description
RecursiveShuffleLayout() Creates a new RecursiveShuffleLayout instance with an optional core layout algorithm.
RecursiveShuffleLayout(ILayoutAlgorithm core) Creates a new RecursiveShuffleLayout instance with an optional core layout algorithm.

Method Summary

Modifier and Type	Method and Description
void	applyLayout(LayoutGraph graph) Removes all node overlaps in the given graph, after executing the specified core layout algorithm.
IGroupBoundsCalculator	getGroupBoundsCalculator() Gets the IGroupBoundsCalculator instance that computes the sizes of all group nodes.
ILayoutAlgorithm	getShuffleLayout() Gets the ILayoutAlgorithm instance that is used for removing node overlaps.
void	setGroupBoundsCalculator(IGroupBoundsCalculator value) Sets the IGroupBoundsCalculator instance that computes the sizes of all group nodes.
void	setShuffleLayout(ILayoutAlgorithm value) Sets the ILayoutAlgorithm instance that is used for removing node overlaps.

Methods inherited from class com.yworks.yfiles.layout.AbstractLayoutStage

applyLayoutCore, getCoreLayout, setCoreLayout

Methods inherited from class java.lang.Object

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

Constructor Detail

RecursiveShuffleLayout

public RecursiveShuffleLayout()

Creates a new RecursiveShuffleLayout instance with an optional core layout algorithm.

RecursiveShuffleLayout

public RecursiveShuffleLayout(ILayoutAlgorithm core)

Creates a new RecursiveShuffleLayout instance with an optional core layout algorithm.

Parameters:

core - The core layout algorithm.

Method Detail

applyLayout

public void applyLayout(LayoutGraph graph)

Removes all node overlaps in the given graph, after executing the specified core layout algorithm.

Specified by:

applyLayout in interface ILayoutAlgorithm

Specified by:

applyLayout in class AbstractLayoutStage

Parameters:

graph - the input graph

getGroupBoundsCalculator

public IGroupBoundsCalculator getGroupBoundsCalculator()

Gets the IGroupBoundsCalculator instance that computes the sizes of all group nodes.

Default Value:

The default value is MinimumSizeGroupBoundsCalculator

Returns:

the current IGroupBoundsCalculator instance

See Also:

setGroupBoundsCalculator(IGroupBoundsCalculator)

getShuffleLayout

public ILayoutAlgorithm getShuffleLayout()

Gets the ILayoutAlgorithm instance that is used for removing node overlaps.

This instance will be applied recursively to all group nodes of the graph.

Default Value:

The default value is ShuffleLayout

Returns:

the ILayoutAlgorithm instance for removing node overlaps

See Also:

setShuffleLayout(ILayoutAlgorithm)

setGroupBoundsCalculator

public void setGroupBoundsCalculator(IGroupBoundsCalculator value)

Sets the IGroupBoundsCalculator instance that computes the sizes of all group nodes.

Default Value:

The default value is MinimumSizeGroupBoundsCalculator

Parameters:

value - the current IGroupBoundsCalculator instance

See Also:

getGroupBoundsCalculator()

setShuffleLayout

public void setShuffleLayout(ILayoutAlgorithm value)

Sets the ILayoutAlgorithm instance that is used for removing node overlaps.

This instance will be applied recursively to all group nodes of the graph.

Default Value:

The default value is ShuffleLayout

Parameters:

value - the ILayoutAlgorithm instance for removing node overlaps

See Also:

getShuffleLayout()