com.yworks.yfiles.layout.tree

Class TreeComponentLayout

java.lang.Object

com.yworks.yfiles.layout.tree.TreeComponentLayout

All Implemented Interfaces:

ILayoutAlgorithm, ILayoutStage

public class TreeComponentLayout
extends Object
implements ILayoutStage

The TreeComponentLayout arranges tree-like subgraph structures in a mixed layout style.

The tree components are marked

Field Summary

Fields

Modifier and Type	Field and Description
static NodeDpKey<Boolean>	DUMMY_NODE_DPKEY A DataProvider key for identifying dummy nodes during the layout calculation This IDataProvider is registered and also removed in applyLayoutUsingDummies(LayoutGraph, IDataProvider).

Constructor Summary

Constructors

Constructor and Description
TreeComponentLayout(ILayoutAlgorithm treeCoreLayouter) Creates a new TreeComponentLayout instance using the specified layouter for arranging the subtrees.

Method Summary

Modifier and Type	Method and Description
void	applyLayout(LayoutGraph graph) Finds the tree components inside the given graph and applies a tree layout to them.
protected void	applyLayoutUsingDummies(LayoutGraph graph, IDataProvider dummyDp) Delegates the layout calculation to the core layout algorithm and handles the dummy nodes.
ILayoutAlgorithm	getCoreLayout() Gets the core layout algorithm.
ILayoutAlgorithm	getTreeComponentCoreLayout() Gets the layout algorithm that is applied to tree components.
boolean	isOrientationOptimizationEnabled() Gets whether or not tree component arrangement is improved by changing the orientation of components.
void	setCoreLayout(ILayoutAlgorithm value) Sets the core layout algorithm.
void	setOrientationOptimizationEnabled(boolean value) Sets whether or not tree component arrangement is improved by changing the orientation of components.
void	setTreeComponentCoreLayout(ILayoutAlgorithm value) Sets the layout algorithm that is applied to tree components.

Methods inherited from class java.lang.Object

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

Field Detail

DUMMY_NODE_DPKEY

public static final NodeDpKey<Boolean> DUMMY_NODE_DPKEY

A DataProvider key for identifying dummy nodes during the layout calculation

This IDataProvider is registered and also removed in applyLayoutUsingDummies(LayoutGraph, IDataProvider).

See Also:

applyLayoutUsingDummies(LayoutGraph, IDataProvider)

Constructor Detail

TreeComponentLayout

public TreeComponentLayout(ILayoutAlgorithm treeCoreLayouter)

Creates a new TreeComponentLayout instance using the specified layouter for arranging the subtrees.

Throws:

IllegalArgumentException - if the specified layout algorithm is null

Parameters:

treeCoreLayouter - the layout algorithm used for arranging the tree components

Method Detail

applyLayout

public void applyLayout(LayoutGraph graph)

Finds the tree components inside the given graph and applies a tree layout to them.

Specified by:

applyLayout in interface ILayoutAlgorithm

Parameters:

graph - the input graph

applyLayoutUsingDummies

protected void applyLayoutUsingDummies(LayoutGraph graph,
                                       IDataProvider dummyDp)

Delegates the layout calculation to the core layout algorithm and handles the dummy nodes.

The dummy nodes are marked using the given IDataProvider.

This implementation just registers the dummy node IDataProvider with the graph with key DUMMY_NODE_DPKEY, executes the core layout algorithm and finally removes the data provider again.

This method is called by applyLayout(LayoutGraph) to invoke the core layout algorithm. It may be overridden to customize the handling of the dummy nodes.

Parameters:

graph - the input graph

dummyDp - the IDataProvider which marks the dummy nodes

getCoreLayout

public ILayoutAlgorithm getCoreLayout()

Description copied from interface: ILayoutStage

Gets the core layout algorithm.

This algorithm is wrapped by this stage. It is invoked in ILayoutAlgorithm.applyLayout(com.yworks.yfiles.layout.LayoutGraph). The ILayoutStage may add pre- and post-processing steps before and after calling the core layout algorithm.

Specified by:

getCoreLayout in interface ILayoutStage

Returns:

the core layout algorithm

See Also:

ILayoutStage.setCoreLayout(ILayoutAlgorithm)

getTreeComponentCoreLayout

public ILayoutAlgorithm getTreeComponentCoreLayout()

Gets the layout algorithm that is applied to tree components.

Returns:

the layout algorithm for tree components

See Also:

setTreeComponentCoreLayout(ILayoutAlgorithm)

isOrientationOptimizationEnabled

public boolean isOrientationOptimizationEnabled()

Gets whether or not tree component arrangement is improved by changing the orientation of components.

Default Value:

The default value is false. Components keep their orientation.

Returns:

true if the component arrangement is optimized, false otherwise

See Also:

setOrientationOptimizationEnabled(boolean)

setCoreLayout

public void setCoreLayout(ILayoutAlgorithm value)

Description copied from interface: ILayoutStage

Sets the core layout algorithm.

This algorithm is wrapped by this stage. It is invoked in ILayoutAlgorithm.applyLayout(com.yworks.yfiles.layout.LayoutGraph). The ILayoutStage may add pre- and post-processing steps before and after calling the core layout algorithm.

Specified by:

setCoreLayout in interface ILayoutStage

Parameters:

value - the core layout algorithm

See Also:

ILayoutStage.getCoreLayout()

setOrientationOptimizationEnabled

public void setOrientationOptimizationEnabled(boolean value)

Sets whether or not tree component arrangement is improved by changing the orientation of components.

Default Value:

The default value is false. Components keep their orientation.

Parameters:

value - true if the component arrangement is optimized, false otherwise

See Also:

isOrientationOptimizationEnabled()

setTreeComponentCoreLayout

public void setTreeComponentCoreLayout(ILayoutAlgorithm value)

Sets the layout algorithm that is applied to tree components.

Parameters:

value - the layout algorithm for tree components

See Also:

getTreeComponentCoreLayout()