salvo.jesus.graph.visual.layout

Interface GraphLayoutManager

All Superinterfaces:

Serializable

All Known Subinterfaces:

GraphGridLayoutManager

All Known Implementing Classes:

AbstractGridLayout, ForceDirectedLayout, LayeredTreeLayout, OrthogonalLineLayout, RadialTreeLayout, StraightLineLayout

public interface GraphLayoutManager
extends Serializable

The layout manager interface responsible for visually laying out the vertices in a graph. Implementations of this interface should be registered with an instance of VisualGraph, via the setGraphLayoutManager() method.

Author:

Jesus M. Salvo Jr.

Method Summary

Modifier and Type	Method and Description
void	addEdge(VisualEdge vedge) Automatically called when a VisualEdge object has been added to the VisualGraph object being laid out.
void	addVertex(VisualVertex vvertex) Automatically called when a VisualVertex object has been added to the VisualGraph object being laid out.
void	drawLayout() This method is called to actually paint or draw the layout of the graph.
boolean	isInitialized() Determines if the graph has been initially laid out.
void	layout() This method is called to layout the vertices in the graph, without actually drawing the finished or intermediate layout.
void	removeEdge(VisualEdge vedge) Automatically called when a VisualEdge object is about to be removed from the VisualGraph object being laid out.
void	removeVertex(VisualVertex vvertex) Automatically called when a VisualVertex object is about to be removed from the VisualGraph object being laid out.
void	routeEdge(Graphics2D g2d, VisualEdge vEdge) Automatically called when a VisualEdge object needs to be drawn.

Method Detail

isInitialized

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.

Returns:

True if the graph has at least been laid out once.

layout

void layout()

This method is called to layout the vertices in the graph, without actually drawing the finished or intermediate layout.

addVertex

void addVertex(VisualVertex vvertex)

Automatically called when a VisualVertex object has been added to the VisualGraph object being laid out.

Parameters:

vvertex - The newly added VisualVertex object.

removeVertex

void removeVertex(VisualVertex vvertex)

Automatically called when a VisualVertex object is about to be removed from the VisualGraph object being laid out.

Parameters:

vvertex - The VisualVertex object to be removed.

addEdge

void addEdge(VisualEdge vedge)

Automatically called when a VisualEdge object has been added to the VisualGraph object being laid out.

Parameters:

vedge - The newly added VisualEdge object.

removeEdge

void removeEdge(VisualEdge vedge)

Automatically called when a VisualEdge object is about to be removed from the VisualGraph object being laid out.

Parameters:

vedge - The VisualEdge object to be removed

routeEdge

void routeEdge(Graphics2D g2d,
               VisualEdge vEdge)

Automatically called when a VisualEdge object needs to be drawn. This method is typically called from VisualEdgePainterImpl when the VisualGraph encapsulating the VisualEdge has a GraphLayoutManager set. Prior to calling this method, the GeneralPath of the VisualEdge is reset.

Implementations of this method should set the segments of the VisualEdge's GeneralPath by calling the methods moveTo(), lineTo(), curveTo(), and quadTo().

Parameters:

g2d - The Graphics2D object used for painting

vedge - The VisualEdge object to be drawn

drawLayout

void drawLayout()

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().