prajna.viz.arrange

Class OrthoTreeArrangement<N>

java.lang.Object

prajna.viz.arrange.AbstractArrangement<N>

prajna.viz.arrange.OrthoTreeArrangement<N>

Type Parameters:

N - The node data type for the tree

All Implemented Interfaces:

Arrangement<N>, TreeArrangement<N>

public class OrthoTreeArrangement<N>
extends AbstractArrangement<N>
implements TreeArrangement<N>

Arrangement class which will arrange the nodes in a hierarchical layout. The nodes are arranged with the root on the top (lowest Y value). If the nodes are TreeNodes, the hierarchy is used. Otherwise, the Arrangement will attempt to make the best decision about how to arrange the nodes. If there is no obvious root, an ArrangementException is thrown.

The nodes are arranged by alternating the arrangement direction between horizontal and vertical arrangements. The children nodes are arranged as regularly as possible, and tries to fill the arrangement space. For strict hierarchies, it attempts to group the nodes below their parents. For other graphs, the levels will be arranged in such a way that the nodes at each layer are spaced evenly.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
OrthoTreeArrangement()

Method Summary

Methods

Modifier and Type	Method and Description
void	arrange(Tree<N> root) Arranges the graph starting at the specified node.
boolean	isHorizontal() Returns whether the arrangement is oriented horizontally or vertically
void	setHorizontal(boolean horizontalFlag) Sets the initial direction for arrangement.
void	setMaxSiblings(int max) sets the maximum siblings arranged in a row or column for a particular set of siblings.

Methods inherited from class prajna.viz.arrange.AbstractArrangement

getMargin, getNodeLocation, getSize, invalidate, setMargin, setNodeLocation, setSize, setSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface prajna.viz.arrange.Arrangement

getNodeLocation, getSize, setMargin, setSize, setSize

Constructor Detail

OrthoTreeArrangement

public OrthoTreeArrangement()

Method Detail

arrange

public void arrange(Tree<N> root)
             throws ArrangementException

Arranges the graph starting at the specified node. All other connected nodes are arranged. In this case, the Arrangement attempts to arrange the tree using the specified node as the root node. If the node is not a tree node, the arrangement will attempt to arrange in levels based upon distance from the specified node.

Specified by:

arrange in interface TreeArrangement<N>

Parameters:

root - the node to start from in the arrangement

Throws:

ArrangementException - if the node is not within a tree structure

isHorizontal

public boolean isHorizontal()

Returns whether the arrangement is oriented horizontally or vertically

Returns:

true if the arrangement is oriented horizontally, false if it is oriented vertically

setHorizontal

public void setHorizontal(boolean horizontalFlag)

Sets the initial direction for arrangement. This determines which direction the arrangement uses for its first tier. If the flag is set to true, the first tier is arranged horizontally. If it is false, the first tier is vertically arranged.

Parameters:

horizontalFlag - whether to arrange horizontally or vertically.

setMaxSiblings

public void setMaxSiblings(int max)

sets the maximum siblings arranged in a row or column for a particular set of siblings. Thus if the maximum is 5 nodes, and a particular node has 8 children, the children will be arranged in two rows.

Parameters:

max - the maxim number of child nodes arranged on the same layer. Must be at least 2.