salvo.jesus.graph.visual.layout

Class Grid

java.lang.Object

salvo.jesus.graph.visual.layout.Grid

All Implemented Interfaces:

Serializable

public class Grid
extends Object
implements Serializable

The Grid class represents a matrix of hypothetical vertical and horizontal grid lines, where each intersection of the grid lines is a grid point.

This matrix is used to layout the vertices of a graph, where each VisualVertex is assigned to a grid point and one grid point can have only one VisualVertex.

In reality, the matrix will probably non-proportional. That is, certain columns will have different height than the other columns. This usually happens when appending Grids.

Author:

Jesus M. Salvo Jr.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Grid(List visualVertices) Creates a Grid object to be used by the vertices.
Grid(List visualVertices, int width, int height)

Method Summary

Modifier and Type	Method and Description
void	appendToBottom(Grid gridtoappend) Appends the specified grid to this grid.
void	appendToRight(Grid gridtoappend) Appends the specified grid to this grid.
Point	findVisualVertex(VisualVertex v) Returns the grid point assignment of a VisualVertex.
VisualVertex	getGridPoint(int x, int y) Returns the VisualVertex object assigned to the specified grid point.
int	getGridSize() Return the size of the internal grid
int	getHeight() Returns the number of y grid lines.
int	getStartingXGridPoint()
int	getStartingYGridPoint()
int	getWidth() Returns the number of x grid lines.
protected void	initGrid() Initializes the grid to be of size m x m, where m is the number of vertices in the graph.
protected void	initGrid(int width, int height)
void	insertEmptyGrid(int insertBeforeIndex) Inserts an empty grid before the specified index
void	setGridPoint(int x, int y, VisualVertex vvertex) Assigns a VisualVertex object of the graph to the specified position in the grid.
String	toString() Returns a String representation of the Grid object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Grid

public Grid(List visualVertices)

Creates a Grid object to be used by the vertices. This will also initialize the grid to be of size m x m, where m is the number of vertices specified in the argument.

Parameters:

visualvertices - List of VisualVertexs that will be laid out on the grid.

Grid

public Grid(List visualVertices,
            int width,
            int height)

Method Detail

initGrid

protected void initGrid(int width,
                        int height)

initGrid

protected void initGrid()

Initializes the grid to be of size m x m, where m is the number of vertices in the graph. This effectively creates List of List of null VisualVertex objects for the internal grid variable. This also initializes the gridpointassignment List of null Points.

getGridSize

public int getGridSize()

Return the size of the internal grid

getStartingXGridPoint

public int getStartingXGridPoint()

getStartingYGridPoint

public int getStartingYGridPoint()

getWidth

public int getWidth()

Returns the number of x grid lines.

Returns:

An int specifying the number of x (vertical) grid lines.

getHeight

public int getHeight()

Returns the number of y grid lines.

Returns:

An int specifying the number of y (horizontal) grid lines. If width is zero, this also returns zero. Otherwise, it checks the column with the highest height and returns that height.

setGridPoint

public void setGridPoint(int x,
                         int y,
                         VisualVertex vvertex)

Assigns a VisualVertex object of the graph to the specified position in the grid. If the VisualVertex has an existing grid point assignment, it is first cleared to guarantee that a vertex has only one grid point assignment.

Parameters:

x - The vertical grid line, starting at 0, of the grid point.

y - The horizontal grid line, starting at 0, of the grid point.

vvertex - The VisualVertex object to be assigned to the specified grid point.

getGridPoint

public VisualVertex getGridPoint(int x,
                                 int y)

Returns the VisualVertex object assigned to the specified grid point.

Parameters:

x - The vertical grid line, starting at 0, of the grid point.

y - The horizontal grid line, starting at 0, of the grid point.

Returns:

The VisualVertex object assigned to the specified grid point. If nothing is currently assigned to the grid point, null is returned.

findVisualVertex

public Point findVisualVertex(VisualVertex v)

Returns the grid point assignment of a VisualVertex.

Parameters:

vvertex - The VisualVertex object of which we want to find the grid point assignment.

Returns:

Point object indicating the grid point assignment of the specified VisualVertex object.

appendToRight

public void appendToRight(Grid gridtoappend)

Appends the specified grid to this grid. The grid to append will be appended to the right of the grid.

Parameters:

gridtoappend - Grid object that is to be appended to this Grid object.

appendToBottom

public void appendToBottom(Grid gridtoappend)

Appends the specified grid to this grid. The grid to append will be appended to the bottom of the grid.

Parameters:

gridtoappend - Grid object that is to be appended to this Grid object.

insertEmptyGrid

public void insertEmptyGrid(int insertBeforeIndex)

Inserts an empty grid before the specified index

toString

public String toString()

Returns a String representation of the Grid object.

Overrides:

toString in class Object

Returns:

The String representation of the Grid object.