AbstractGridLayout (openjgraph-0.9.2 1.0.0 API)

java.lang.Object
- salvo.jesus.graph.visual.layout.AbstractGridLayout

All Implemented Interfaces:

Serializable, Runnable, GraphGridLayoutManager, GraphLayoutManager

Direct Known Subclasses:

LayeredTreeLayout, OrthogonalLineLayout
```
public abstract class AbstractGridLayout
extends Object
implements GraphGridLayoutManager, Runnable
```
An abstract implementation of the GraphLayoutManager interface. Neither layout() nor drawLayout() are implemented. However, this abstract implementation provides internal variables used by concrete implementations of the interface. This class has an internal instance of a VisualGraph to gain access to the graph itself and a Grid object used to place the vertices on a hypothetical grid. It also has general purpose methods for grid point assignments of vertices. These methods places the vertices in general position and median placement.

Author:

Jesus M. Salvo Jr.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AbstractGridLayout(VisualGraph vgraph)
Creates a GraphLayoutManager object, specifying vgraph as the VisualGraph object to be laid out.

Constructors
Constructor and Description
`AbstractGridLayout(VisualGraph vgraph)` Creates a GraphLayoutManager object, specifying vgraph as the VisualGraph object to be laid out.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`drawLayout()` This method is called to actually paint or draw the layout of the graph.
`VisualVertex`	`generalPosition(List connectedset, Grid grid)` Lays out the visual vertices of the specified connected set general position, meaning that only one visual vertex reside on each grid line.
`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.
`boolean`	`isInitialized()` Determines if the graph has been initially laid out.
`void`	`layout()` Partial implementation of the layout() method of GraphLayoutManager.
`void`	`medianPlacement()` Positions all vertices in median placement, starting with the first vertex in the graph.
`void`	`run()`
`void`	`setDrawGrid(boolean isdrawgrid)` This method sets or unsets the drawing of the grid
`void`	`setGraphLayoutListener(GraphLayoutListener listener)` Sets the listener object that receives notification whenever a vertex in the graph is laid out, either intermediately or for its final position, by the layout manager.
`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface salvo.jesus.graph.visual.layout.GraphLayoutManager
addEdge, addVertex, removeEdge, removeVertex, routeEdge

- Constructor Detail
  - AbstractGridLayout
```
public AbstractGridLayout(VisualGraph vgraph)
```
    Creates a GraphLayoutManager object, specifying vgraph as the VisualGraph object to be laid out. This will also initialize the internal Grid object based on the number of vertices that the graph has.
- Method Detail
  - setStartAt
```
public void setStartAt(Point startAt)
```
    This method sets the point at which the grid starts.
    
    Specified by:
    
    setStartAt in interface GraphGridLayoutManager
    
    Parameters:
    
    startAt - Point object indicating the upper left corner of the grid.
  - setXGridDistance
```
public void setXGridDistance(int xGridDistance)
```
    This method sets the distance between vertical grids
    
    Specified by:
    
    setXGridDistance in interface GraphGridLayoutManager
    
    Parameters:
    
    xGridDistance - Distance between vertical grids
  - setYGridDistance
```
public void setYGridDistance(int yGridDistance)
```
    This method sets the distance between horizontal grids
    
    Specified by:
    
    setYGridDistance in interface GraphGridLayoutManager
    
    Parameters:
    
    xGridDistance - Distance between horizontal grids
  - setDrawGrid
```
public void setDrawGrid(boolean isdrawgrid)
```
    This method sets or unsets the drawing of the grid
    
    Specified by:
    
    setDrawGrid in interface GraphGridLayoutManager
    
    Parameters:
    
    isdrawgrid - Boolean: If true, the grid will be drawn on the next paint operation. Otherwise, the grid will not be drawn.
  - getStartAt
```
public Point getStartAt()
```
    Returns the starting position where the grid will be drawn.
    
    Specified by:
    
    getStartAt in interface GraphGridLayoutManager
    
    Returns:
    
    Point object indicating the starting position where the grid will be drawn. By default, this is (0,0).
  - getXGridDistance
```
public int getXGridDistance()
```
    Returns the distance between horizontal grid lines.
    
    Specified by:
    
    getXGridDistance in interface GraphGridLayoutManager
    
    Returns:
    
    An int indicating the uniform distance between horizontal grid lines. By default, this is 100.
  - getYGridDistance
```
public int getYGridDistance()
```
    Returns the distance between vertical grid lines.
    
    Specified by:
    
    getYGridDistance in interface GraphGridLayoutManager
    
    Returns:
    
    An int indicating the uniform distance between vertical grid lines. By default, this is 100.
  - getDrawgrid
```
public boolean getDrawgrid()
```
    Determines if the grid is to be drawn.
    
    Specified by:
    
    getDrawgrid in interface GraphGridLayoutManager
    
    Returns:
    
    A boolean indicating if the grid will be drawn on the next paint operation of the containers of the visual graph.
  - getGrid
```
public Grid getGrid()
```
    Returns the grid object where the visual vertices are laid out.
    
    Specified by:
    
    getGrid in interface GraphGridLayoutManager
    
    Returns:
    
    A Grid object where the visual vertices are laid out.
  - setGraphLayoutListener
```
public void setGraphLayoutListener(GraphLayoutListener listener)
```
    Sets the listener object that receives notification whenever a vertex in the graph is laid out, either intermediately or for its final position, by the layout manager.
    
    Parameters:
    
    listener - The listener object that will received such notifications. Any previous listener will no longer receive notification.
  - layout
```
public void layout()
```
    Partial implementation of the layout() method of GraphLayoutManager. All this do is initialize the grid and does not really layout the vertices at all. Subclasses of this class must override this method and and call this method first before proceeding with any grid actvity.
    
    Specified by:
    
    layout in interface GraphLayoutManager
  - drawLayout
```
public void drawLayout()
```
    Description copied from interface: GraphLayoutManager
    
    This method is called to actually paint or draw the layout of the graph. This method should only be called after at least one call to layout().
    
    Specified by:
    
    drawLayout in interface GraphLayoutManager
  - isInitialized
```
public boolean isInitialized()
```
    Determines if the graph has been initially laid out. This method should be called prior to any painting to be done by the graph layout manager, as most internal variables are only initialized during layout.
    
    Specified by:
    
    isInitialized in interface GraphLayoutManager
    
    Returns:
    
    True if the graph has at least been laid out once.
  - generalPosition
```
public VisualVertex generalPosition(List connectedset,
                                    Grid grid)
```
    Lays out the visual vertices of the specified connected set general position, meaning that only one visual vertex reside on each grid line. The end result of this operation is that all visual vertices are in a straight diagonal line. The VisualVertex object with the highest degree is placed in the center, and those with lesser degrees are farther away from the center. To accomplish this, the grid matrix must be of size m x m, which is what is done.
    
    Parameters:
    
    connectedset - List of VisualVertex that are connected to each other
    
    grid - Grid object where the visual vertices in the connected set will be laid out for general position.
    
    Returns:
    
    Returns a VisualVertex object which is placed at the center. Put in another way, this is the VisualVertex object with the highest degree. If there are tweo or more vertices with the same highest degree, there is no guarantee as to which among them will be returned or placed in the center first.
  - medianPlacement
```
public void medianPlacement()
```
    Positions all vertices in median placement, starting with the first vertex in the graph.
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable

Class AbstractGridLayout

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGridLayout

Method Detail

setStartAt

setXGridDistance

setYGridDistance

setDrawGrid

getStartAt

getXGridDistance

getYGridDistance

getDrawgrid

getGrid

setGraphLayoutListener

layout

drawLayout

isInitialized

generalPosition

medianPlacement

run