org.uberfire.ext.wires.core.trees.client.layout.treelayout

Class TreeLayout<TreeNode>

java.lang.Object

org.uberfire.ext.wires.core.trees.client.layout.treelayout.TreeLayout<TreeNode>

Type Parameters:

TreeNode -

Adapted from https://code.google.com/p/treelayout/ to be available to GWT clients

public class TreeLayout<TreeNode>
extends Object

Implements the actual tree layout algorithm.

The nodes with their final layout can be retrieved through getNodeBounds().

Constructor Summary

Constructors

Constructor and Description
TreeLayout(TreeForTreeLayout<TreeNode> tree, NodeExtentProvider<TreeNode> nodeExtentProvider, Configuration<TreeNode> configuration)
TreeLayout(TreeForTreeLayout<TreeNode> tree, NodeExtentProvider<TreeNode> nodeExtentProvider, Configuration<TreeNode> configuration, boolean useIdentity) Creates a TreeLayout for a given tree.

Method Summary

Modifier and Type	Method and Description
void	checkTree() Check if the tree is a "valid" tree.
Rectangle2D	getBounds() Returns the bounds of the tree layout.
Configuration<TreeNode>	getConfiguration() Returns the Configuration used by this TreeLayout.
int	getLevelCount() Returns the number of levels of the tree.
Map<TreeNode,Rectangle2D>	getNodeBounds() Returns the layout of the tree nodes by mapping each node of the tree to its bounds (position and size).
NodeExtentProvider<TreeNode>	getNodeExtentProvider() Returns the NodeExtentProvider used by this TreeLayout.
double	getSizeOfLevel(int level) Returns the size of a level.
TreeForTreeLayout<TreeNode>	getTree() Returns the Tree the layout is created for.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeLayout

public TreeLayout(TreeForTreeLayout<TreeNode> tree,
                  NodeExtentProvider<TreeNode> nodeExtentProvider,
                  Configuration<TreeNode> configuration,
                  boolean useIdentity)

Creates a TreeLayout for a given tree.

In addition to the tree the NodeExtentProvider and the Configuration must be given.

Parameters:

useIdentity - [default: false] when true, identity ("==") is used instead of equality ("equals(...)") when checking nodes. Within a tree each node must only be once (using this check).

TreeLayout

public TreeLayout(TreeForTreeLayout<TreeNode> tree,
                  NodeExtentProvider<TreeNode> nodeExtentProvider,
                  Configuration<TreeNode> configuration)

Method Detail

getTree

public TreeForTreeLayout<TreeNode> getTree()

Returns the Tree the layout is created for.

getNodeExtentProvider

public NodeExtentProvider<TreeNode> getNodeExtentProvider()

Returns the NodeExtentProvider used by this TreeLayout.

getConfiguration

public Configuration<TreeNode> getConfiguration()

Returns the Configuration used by this TreeLayout.

getBounds

public Rectangle2D getBounds()

Returns the bounds of the tree layout.

The bounds of a TreeLayout is the smallest rectangle containing the bounds of all nodes in the layout. It always starts at (0,0).

Returns:

the bounds of the tree layout

getLevelCount

public int getLevelCount()

Returns the number of levels of the tree.

Returns:

[level > 0]

getSizeOfLevel

public double getSizeOfLevel(int level)

Returns the size of a level.

When the root is located at the top or bottom the size of a level is the maximal height of the nodes of that level. When the root is located at the left or right the size of a level is the maximal width of the nodes of that level.

Parameters:

level -

Returns:

the size of the level [level >= 0 && level < levelCount]

getNodeBounds

public Map<TreeNode,Rectangle2D> getNodeBounds()

Returns the layout of the tree nodes by mapping each node of the tree to its bounds (position and size).

For each rectangle x and y will be >= 0. At least one rectangle will have an x == 0 and at least one rectangle will have an y == 0.

Returns:

maps each node of the tree to its bounds (position and size).

checkTree

public void checkTree()

Check if the tree is a "valid" tree.

Typically you will use this method during development when you get an unexpected layout from your trees.

The following checks are performed:

• Each node must only occur once in the tree.