prajna.viz.arrange

Class AbstractArrangement<N>

java.lang.Object

prajna.viz.arrange.AbstractArrangement<N>

Type Parameters:

N - The node class to arrange

All Implemented Interfaces:

Arrangement<N>

Direct Known Subclasses:

CircleArrangement, ClusterArrangement, DiagonalArrangement, DirectedArrangement, FocusArrangement, OrthoTreeArrangement, ProjectionArrangement, RandomArrangement, RectangularArrangement

public abstract class AbstractArrangement<N>
extends java.lang.Object
implements Arrangement<N>

Abstract class for arrangements of nodes. This class provides support for margins, storing locations for later access, and the current arrangement size.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
AbstractArrangement()

Method Summary

Methods

Modifier and Type	Method and Description
int	getMargin() Gets the margin around arrangement
java.awt.Point	getNodeLocation(N node) Get the location of the node, or null if the node has no location
java.awt.Dimension	getSize() Returns the size of the arranger's working area in the form of a Dimension object.
protected void	invalidate() Invalidate this arrangement.
void	setMargin(int newMargin) sets a uniform margin around arrangement
protected void	setNodeLocation(N node, java.awt.Point loc) Set the location for the node in this arrangement.
void	setSize(java.awt.Dimension dim) sets size of working area
void	setSize(int wide, int high) sets size of working area

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractArrangement

public AbstractArrangement()

Method Detail

getMargin

public int getMargin()

Gets the margin around arrangement

Returns:

the margin around the arrangement

getNodeLocation

public java.awt.Point getNodeLocation(N node)

Get the location of the node, or null if the node has no location

Specified by:

getNodeLocation in interface Arrangement<N>

Parameters:

node - the node

Returns:

The location within the arrangement of the node

getSize

public java.awt.Dimension getSize()

Returns the size of the arranger's working area in the form of a Dimension object. The height field of the Dimension object contains the arranger's work area height, and the width field of the Dimension object contains the work area width.

Specified by:

getSize in interface Arrangement<N>

Returns:

a Dimension object that indicates the size of this component

invalidate

protected void invalidate()

Invalidate this arrangement. All node locations are set to null, requiring a call to arrange() to reset the node locations

setMargin

public void setMargin(int newMargin)

sets a uniform margin around arrangement

Specified by:

setMargin in interface Arrangement<N>

Parameters:

newMargin - the margin around the arrangement

setNodeLocation

protected void setNodeLocation(N node,
                   java.awt.Point loc)

Set the location for the node in this arrangement.

Parameters:

node - the node

loc - the location for the node within this arrangement.

setSize

public void setSize(java.awt.Dimension dim)

sets size of working area

Specified by:

setSize in interface Arrangement<N>

Parameters:

dim - the size of the working area

setSize

public void setSize(int wide,
           int high)

sets size of working area

Specified by:

setSize in interface Arrangement<N>

Parameters:

wide - the width of the working area

high - the height of the working area