salvo.jesus.graph.visual.layout

Interface GraphGridLayoutManager

All Superinterfaces:

GraphLayoutManager, Serializable

All Known Implementing Classes:

AbstractGridLayout, LayeredTreeLayout, OrthogonalLineLayout, StraightLineLayout

public interface GraphGridLayoutManager
extends GraphLayoutManager

An extension of the GraphLayoutManager interface specifically for placing vertices in grids.

Author:

Jesus M. Salvo Jr.

Method Summary

Modifier and Type	Method and Description
boolean	getDrawgrid() Determines if the grid is to be drawn.
Grid	getGrid() Returns the grid object where the visual vertices are laid out.
Point	getStartAt() Returns the starting position where the grid will be drawn.
int	getXGridDistance() Returns the distance between horizontal grid lines.
int	getYGridDistance() Returns the distance between vertical grid lines.
void	setDrawGrid(boolean isdrawgrid) This method sets or unsets the drawing of the grid
void	setStartAt(Point startat) This method sets the point at which the grid starts.
void	setXGridDistance(int xgriddistance) This method sets the distance between vertical grids
void	setYGridDistance(int ygriddistance) This method sets the distance between horizontal grids

Methods inherited from interface salvo.jesus.graph.visual.layout.GraphLayoutManager

addEdge, addVertex, drawLayout, isInitialized, layout, removeEdge, removeVertex, routeEdge

Method Detail

setStartAt

void setStartAt(Point startat)

This method sets the point at which the grid starts.

Parameters:

startat - Point object indicating the upper left corner of the grid.

setXGridDistance

void setXGridDistance(int xgriddistance)

This method sets the distance between vertical grids

Parameters:

xgriddistance - Distance between vertical grids

setYGridDistance

void setYGridDistance(int ygriddistance)

This method sets the distance between horizontal grids

Parameters:

xgriddistance - Distance between horizontal grids

setDrawGrid

void setDrawGrid(boolean isdrawgrid)

This method sets or unsets the drawing of the grid

Parameters:

isdrawgrid - Boolean: If true, the grid will be drawn on the next paint operation. Otherwise, the grid will not be drawn.

getGrid

Grid getGrid()

Returns the grid object where the visual vertices are laid out.

Returns:

A Grid object where the visual vertices are laid out.

getStartAt

Point getStartAt()

Returns the starting position where the grid will be drawn.

Returns:

Point object indicating the starting position where the grid will be drawn. By default, this is (0,0).

getXGridDistance

int getXGridDistance()

Returns the distance between horizontal grid lines.

Returns:

An int indicating the uniform distance between horizontal grid lines. By default, this is 100.

getYGridDistance

int getYGridDistance()

Returns the distance between vertical grid lines.

Returns:

An int indicating the uniform distance between vertical grid lines. By default, this is 100.

getDrawgrid

boolean getDrawgrid()

Determines if the grid is to be drawn.

Returns:

A boolean indicating if the grid will be drawn on the next paint operation of the containers of the visual graph.