prajna.viz.arrange

Class DirectedArrangement<N,E>

java.lang.Object

prajna.viz.arrange.AbstractArrangement<N>

prajna.viz.arrange.DirectedArrangement<N,E>

Type Parameters:

N - The node type for the graph

E - The edge type for the graph

All Implemented Interfaces:

Arrangement<N>, GraphArrangement<N,E>

public class DirectedArrangement<N,E>
extends AbstractArrangement<N>
implements GraphArrangement<N,E>

Arrangement class which will arrange all nodes in a directed fashion, similar to a tree, but with multiple possible roots. This arrangement is designed for work-flow or process diagrams. It relies upon having directed edges within the arrangement.

The arrangement can be set to either arrange left-to-right (the default) or top-to-bottom. Any nodes which have no directed edges are placed at the same level as the lowest level edge they connect to; if none of their neighbors are in the directed portion of the graph, they are set to level zero (the top/left side).

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
DirectedArrangement()

Method Summary

Methods

Modifier and Type	Method and Description
void	arrange(Graph<N,E> graph) Arranges the specified Graph
boolean	getShortFlag() Returns the value of the shortFlag, which is used to determine how compact to make the arrangement
boolean	isHorizontal() Returns whether the arrangement is oriented horizontally or vertically
void	setHorizontal(boolean horizontalFlag) Sets the direction for the arrangement.
void	setShortFlag(boolean shortFlag) Sets the ShortFlag.

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

DirectedArrangement

public DirectedArrangement()

Method Detail

arrange

public void arrange(Graph<N,E> graph)
             throws ArrangementException

Arranges the specified Graph

Specified by:

arrange in interface GraphArrangement<N,E>

Parameters:

graph - the graph to be arranged

Throws:

ArrangementException - Exception thrown if the graph cannot be arranged

getShortFlag

public boolean getShortFlag()

Returns the value of the shortFlag, which is used to determine how compact to make the arrangement

Returns:

whether the arrangement uses a shortened arrangement.

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 direction for the arrangement. If horizontal is true, the nodes are arranged left to right. If false, the nodes are arranged top to bottom.

Parameters:

horizontalFlag - whether to arrange horizontally or vertically.

setShortFlag

public void setShortFlag(boolean shortFlag)

Sets the ShortFlag. The ShortFlag determines whether to use the shortest possible path to determine the layer of a particular node, or the longest. if shortFlag is true, the arrangement will be more compact; if false, the arrangement will be more stretched out. The default value is true.

Parameters:

shortFlag - whether to use a shortened arrangement