VisualGraph (openjgraph-0.9.2 1.0.0 API)

java.lang.Object
- salvo.jesus.graph.listener.NullGraphListener
- - salvo.jesus.graph.visual.VisualGraph

All Implemented Interfaces:

Serializable, EventListener, GraphListener
```
public class VisualGraph
extends NullGraphListener
implements Serializable
```
The VisualGraph encapsulates a Graph object with the necessary attributes and methods for drawing the entire graph on one or more containers.

Author:

Jesus M. Salvo Jr.

See Also:

Graph, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VisualGraph()
Creates a new, empty VisualGraph object.

VisualGraph(Graph g)

Constructors
Constructor and Description
`VisualGraph()` Creates a new, empty VisualGraph object.
`VisualGraph(Graph g)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Vertex vertex)` Adds a Vertex object to the Graph object encapsulated by the VisualGraph object.
`void`	`add(Vertex vertex, Font f)` Adds a Vertex object to the Graph object encapsulated by the VisualGraph object then set the Font used by corresponding VisualVertex object.
`void`	`addContainer(Container c)` Registers a Container for drawing the VisualGraph.
`void`	`addEdge(VisualVertex from, VisualVertex to)` Adds an edge to the Graph object encapsulated by the VisualGraph object.
`void`	`afterEdgeAdded(GraphAddEdgeEvent e)` This method is automatically called whenever an Edge is added to the Graph object encapsulated by the VisualGraph object.
`void`	`afterEdgeRemoved(GraphRemoveEdgeEvent e)` This method is automatically called whenever an Edge is removed from the Graph object encapsulated by the VisualGraph object.
`void`	`afterVertexAdded(GraphAddVertexEvent e)` This method is automatically called whenever a Vertex is added to the Graph object encapsulated by the VisualGraph object.
`void`	`afterVertexRemoved(GraphRemoveVertexEvent e)` This method is automatically called whenever a Vertex is about to be removed from the Graph object encapsulated by the VisualGraph object.
`void`	`emphasizeSubGraph(Graph subGraph, VisualVertexPainter vPainter, VisualEdgePainter ePainter)` Emphasizes a subgraph by changing the painters for the `VisualGraphComponent`s of the subgraph.
`void`	`emphasizeSubGraph(Graph subGraph, VisualVertexPainter mainGraphVPainter, VisualEdgePainter mainGraphEPainter, VisualVertexPainter subGraphVPainter, VisualEdgePainter subGraphEPainter)` Emphasizes a subgraph by changing the both the painters for the `VisualGraphComponent`s of the subgraph and the painters for the main graph.
`List`	`getContainers()` Returns the Containers that are registered with the VisualGraph object where VisualGraph will be drawn.
`Graph`	`getGraph()` Returns the Graph object that the VisualGraph object encapsulates.
`GraphLayoutManager`	`getGraphLayoutManager()` Returns the layout manager used to layout the vertices of the graph.
`Dimension`	`getMaxSize()` Determines the dimension that contains all the VisualGraph's VisualVertex.
`VisualVertex`	`getNode(int x, int y)` Returns the VisualVertex object that has the given x and y coordinate inside its shape.
`Point`	`getStartDrawPoint()` Determines the starting point where a VisualVertex is drawn.
`VisualEdge`	`getVisualEdge(Edge edge)`
`VisualEdge`	`getVisualEdge(int x, int y)` Returns a `VisualEdge` whose line is nearest the specified point.
`VisualEdgePainterFactory`	`getVisualEdgePainterFactory()` Returns an instance of the factory used to create painters for VisualEdges.
`List`	`getVisualEdges()` Returns the List of VisualEdges contained within this VisualGraph
`VisualGraphComponentEditorFactory`	`getVisualGraphComponentEditorFactory()` Returns an instance of the factory used to create custom editors for VisualVertex and VisualEdge.
`VisualVertex`	`getVisualVertex(Vertex vertex)` Returns the VisualVertex object for the corresponding Vertex object in the Graph object encapsulated by VisualGraph.
`VisualVertexPainterFactory`	`getVisualVertexPainterFactory()` Returns an instance of the factory used to create painters for VisualVertices.
`List`	`getVisualVertices()` Returns the List of VisualVertices contained within this VisualGraph
`void`	`layout()` Ask the layout manager to layout the vertices of the graph according to the rules of the layout manager.
`void`	`paint(Graphics2D g2d)` Draws the elements of VisualGraph (all of its VisualVertex and VisualEdges) using the given Graphics2D graphics context object.
`void`	`paint(Graphics2D g2d, Line2D probableedgeline)` Draws the elements of VisualGraph (all of its VisualVertex and VisualEdges) using the given Graphics2D graphics context object.
`void`	`paint(Graphics2D g2d, VisualVertex onfront)` Draws the elements of VisualGraph (all of its VisualVertex and VisualEdges) using the given Graphics2D graphics context object.
`void`	`remove(Vertex vertex)` Removes a Vertex object from the Graph object encapsulated by the VisualGraph object.
`void`	`remove(VisualVertex vvertex)` Removes a Vertex object from the Graph object encapsulated by the VisualGraph object.
`void`	`removeContainer(Container c)` Removes a Container from drawing of the VisualGraph object.
`void`	`removeEdge(Edge edge)` Removes an Edge object from the Graph object encapsulated by the VisualGraph object.
`void`	`removeEdge(VisualEdge vedge)` Removes an Edge object from the Graph object encapsulated by the VisualGraph object.
`void`	`repaint()` Repaints the VisualGraph in all the registered Containers.
`void`	`setGraph(Graph graph)` Sets the Graph object that the VisualGraph object encapsulates.
`void`	`setGraphLayoutManager(GraphLayoutManager layoutmanager)` Sets the layout manager to use to layout the vertices of the graph.
`void`	`setOrthogonalLine()`
`void`	`setStraightLine()`
`void`	`setVisualEdge(Edge edge, VisualEdge newVisualEdge)`
`void`	`setVisualEdgePainterFactory(VisualEdgePainterFactory newFactory)` Sets the factory for creating painters for VisualEdges.
`void`	`setVisualGraphComponentEditorFactory(VisualGraphComponentEditorFactory editorFactory)` Sets the factory for creating custom editors for VisualVertex and VisualEdges.
`void`	`setVisualVertex(Vertex vertex, VisualVertex newVisualVertex)`
`void`	`setVisualVertexPainterFactory(VisualVertexPainterFactory newFactory)` Sets the factory for creating painters for VisualVertices
`List`	`translateToVertices(Collection visualvertices)` Translates each Visual Vertex object in the specified collection to their Vertex counterpart.
`List`	`translateToVisualEdges(List edges)` Translates each of the Edge object in the specified collection to their Edge counterpart.
`List`	`translateToVisualVertices(Collection vertices)` Translates the vertices in the specified collection to their VisualVertex counterpart.

Methods inherited from class salvo.jesus.graph.listener.NullGraphListener
beforeEdgeAdded, beforeEdgeRemoved, beforeVertexAdded, beforeVertexRemoved

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VisualGraph
```
public VisualGraph()
```
    Creates a new, empty VisualGraph object. You need to later on call setGraph() to set the Graph that the VisualGraph object will encapsulate.
  - VisualGraph
```
public VisualGraph(Graph g)
```
- Method Detail
  - getContainers
```
public List getContainers()
```
    Returns the Containers that are registered with the VisualGraph object where VisualGraph will be drawn.
    
    Returns:
    
    List of Containers where VisualGraph will be drawn.
    
    See Also:
    
    addContainer( Container ), removeContainer( Container )
  - addContainer
```
public void addContainer(Container c)
```
    Registers a Container for drawing the VisualGraph. The next repaint() on the VisualGraph object will draw the VisualGraph on the added container. For the moment, limit the types to be added to be instances of GraphScrollPane.
    
    Parameters:
    
    c - Additional Container where VisualGraph will be drawn
    
    See Also:
    
    removeContainer( Container )
  - removeContainer
```
public void removeContainer(Container c)
```
    Removes a Container from drawing of the VisualGraph object. this will not necessarily clear or remove the existing paint on the Container. You have to clear the Container yourself.
    
    Parameters:
    
    c - Container where VisualGraph will no longer be drawn
    
    See Also:
    
    addContainer( Container )
  - getMaxSize
```
public Dimension getMaxSize()
```
    Determines the dimension that contains all the VisualGraph's VisualVertex.
    
    Returns:
    
    Dimension object that represents the dimension that covers all the VisualVertex in the VisualGraph.
  - getStartDrawPoint
```
public Point getStartDrawPoint()
```
    Determines the starting point where a VisualVertex is drawn.
    
    Returns:
    
    Point object of the VisualVertex which has the minimum x and y coordinate.
  - repaint
```
public void repaint()
```
    Repaints the VisualGraph in all the registered Containers.
  - getGraph
```
public Graph getGraph()
```
    Returns the Graph object that the VisualGraph object encapsulates.
    
    Returns:
    
    Graph object encapsulated by the VisualGraph object
  - setGraph
```
public void setGraph(Graph graph)
```
    Sets the Graph object that the VisualGraph object encapsulates. If an existing Graph object is already encapsulated, the existing Graph object is replaced by the new Graph object. This will not however trigger methods in the registered listener objects.
    
    Parameters:
    
    graph - The new Graph object that will be encapsulated by the VisualGraph object
  - getGraphLayoutManager
```
public GraphLayoutManager getGraphLayoutManager()
```
    Returns the layout manager used to layout the vertices of the graph.
  - setGraphLayoutManager
```
public void setGraphLayoutManager(GraphLayoutManager layoutmanager)
```
    Sets the layout manager to use to layout the vertices of the graph.
    
    Parameters:
    
    layoutmanager - An object implementing the GraphLayoutManager interface.
  - getVisualVertexPainterFactory
```
public VisualVertexPainterFactory getVisualVertexPainterFactory()
```
    Returns an instance of the factory used to create painters for VisualVertices. Unless setVisualVertexPainterFactory() was called, the factory used by default is VisualVertexPainterFactoryImpl.
  - setVisualVertexPainterFactory
```
public void setVisualVertexPainterFactory(VisualVertexPainterFactory newFactory)
```
    Sets the factory for creating painters for VisualVertices
  - getVisualEdgePainterFactory
```
public VisualEdgePainterFactory getVisualEdgePainterFactory()
```
    Returns an instance of the factory used to create painters for VisualEdges. Unless setVisualEdgePainterFactory() was called, the factory used by default is VisualEdgePainterFactoryImpl.
  - setVisualEdgePainterFactory
```
public void setVisualEdgePainterFactory(VisualEdgePainterFactory newFactory)
```
    Sets the factory for creating painters for VisualEdges.
  - getVisualGraphComponentEditorFactory
```
public VisualGraphComponentEditorFactory getVisualGraphComponentEditorFactory()
```
    Returns an instance of the factory used to create custom editors for VisualVertex and VisualEdge.
  - setVisualGraphComponentEditorFactory
```
public void setVisualGraphComponentEditorFactory(VisualGraphComponentEditorFactory editorFactory)
```
    Sets the factory for creating custom editors for VisualVertex and VisualEdges.
  - getVisualVertices
```
public List getVisualVertices()
```
    Returns the List of VisualVertices contained within this VisualGraph
  - getVisualEdges
```
public List getVisualEdges()
```
    Returns the List of VisualEdges contained within this VisualGraph
  - setOrthogonalLine
```
public void setOrthogonalLine()
```
  - setStraightLine
```
public void setStraightLine()
```
  - layout
```
public void layout()
```
    Ask the layout manager to layout the vertices of the graph according to the rules of the layout manager.
  - getVisualEdge
```
public VisualEdge getVisualEdge(Edge edge)
```
  - setVisualEdge
```
public void setVisualEdge(Edge edge,
                          VisualEdge newVisualEdge)
```
  - getVisualVertex
```
public VisualVertex getVisualVertex(Vertex vertex)
```
    Returns the VisualVertex object for the corresponding Vertex object in the Graph object encapsulated by VisualGraph.
    
    Parameters:
    
    vertex - The Vertex object whose corresponding VisualVertex object we want
    
    Returns:
    
    The corresponding VisualVertx object of the vertex. Returns null if vertex in not a Vertex in the Graph encapsulated by the VisualGraph object.
  - setVisualVertex
```
public void setVisualVertex(Vertex vertex,
                            VisualVertex newVisualVertex)
```
  - getVisualEdge
```
public VisualEdge getVisualEdge(int x,
                                int y)
```
    Returns a VisualEdge whose line is nearest the specified point. Only VisualEdges that have at least a distance of 5 are considered, from which the VisualEdge that has the least distance among them are returned.
    
    Parameters:
    
    x - x-coordinate
    
    y - y-coordinate
    
    Returns:
    
    A VisualEdge object that is nearest the specified point
  - add
```
public void add(Vertex vertex)
         throws Exception
```
    Adds a Vertex object to the Graph object encapsulated by the VisualGraph object. This is simply a wrapper around graph.add( Vertex ).
    
    Parameters:
    
    vertex - The Vertex object to be added to the graph
    
    Throws:
    
    Exception
    
    See Also:
    
    add( Vertex, Font )
  - add
```
public void add(Vertex vertex,
                Font f)
         throws Exception
```
    Adds a Vertex object to the Graph object encapsulated by the VisualGraph object then set the Font used by corresponding VisualVertex object.
    
    Parameters:
    
    vertex - The Vertex object to be added to the graph
    
    f - Font object to be used for drawing the String inside the shape of VisualVertex.
    
    Throws:
    
    Exception
  - addEdge
```
public void addEdge(VisualVertex from,
                    VisualVertex to)
             throws Exception
```
    Adds an edge to the Graph object encapsulated by the VisualGraph object. This is simply a wrapper around graph.addEdge( Vertex, Vertex ).
    
    Parameters:
    
    from - The source Vertex object of the edge
    
    to - The destination Vertex object of the edge
    
    Throws:
    
    Exception
  - remove
```
public void remove(Vertex vertex)
            throws Exception
```
    Removes a Vertex object from the Graph object encapsulated by the VisualGraph object. This is simply a wrapper around graph.remove( Vertex ). This will also eventually remove the corresponding VisualVertex object from the VisualGraph object.
    
    Parameters:
    
    vertex - The Vertex object to be removed
    
    Throws:
    
    Exception
    
    See Also:
    
    remove( VisualVertex )
  - remove
```
public void remove(VisualVertex vvertex)
            throws Exception
```
    Removes a Vertex object from the Graph object encapsulated by the VisualGraph object. This is simply a wrapper around graph.remove( Vertex ), as this method actually calls graph.remove( VisualVertex.getVertex()) so that the graph removes the corresponding Vertex object first before the VisualVertex object is removed from the VisualGraph object.
    
    Parameters:
    
    vertex - The VisualVertex object to be removed
    
    Throws:
    
    Exception
    
    See Also:
    
    remove( Vertex )
  - removeEdge
```
public void removeEdge(Edge edge)
                throws Exception
```
    Removes an Edge object from the Graph object encapsulated by the VisualGraph object. This is simply a wrapper around graph.removeEdge( Edge ). This will also eventually remove the corresponding VisualEdge object from the VisualGraph object.
    
    Parameters:
    
    edge - The Edge object to be removed
    
    Throws:
    
    Exception
    
    See Also:
    
    removeEdge( VisualEdge )
  - removeEdge
```
public void removeEdge(VisualEdge vedge)
                throws Exception
```
    Removes an Edge object from the Graph object encapsulated by the VisualGraph object. This is simply a wrapper around graph.removeEdge( Edge ), as this method actually calls graph.removeEdge( VisualEdge.getEdge()) so that the graph removes the corresponding Edge object first before the VisualEdge object is removed from the VisualGraph object.
    
    Parameters:
    
    vedge - The VisualEdge object to be removed
    
    Throws:
    
    Exception
    
    See Also:
    
    removeEdge( Edge )
  - getNode
```
public VisualVertex getNode(int x,
                            int y)
```
    Returns the VisualVertex object that has the given x and y coordinate inside its shape. If there are more than one VisualVertex which contains the specified coordinate, the first VisualVertex object in the List visualvertices will be returned.
    
    Parameters:
    
    x - x-coordinate
    
    y - y-coordinate
    
    Returns:
    
    A VisualVertex object that contains the given coordinate
  - translateToVisualVertices
```
public List translateToVisualVertices(Collection vertices)
```
    Translates the vertices in the specified collection to their VisualVertex counterpart. In reality, this method creates a new Collection object to hold the visual vertices, thereby leaving the collection specified in the argument untouched.
    
    Parameters:
    
    vertices - Collection of vertices to be translated to their corresponding Visual Vertex. If the vertex does not have a corresponding Visual Vertex or the vertex is not in the graph, then null will be the translation.
    
    Returns:
    
    A List object that holds the corresponding Visual Vertex of each vertex in the vertices collection.
  - translateToVertices
```
public List translateToVertices(Collection visualvertices)
```
    Translates each Visual Vertex object in the specified collection to their Vertex counterpart. In reality, this method creates a new Collection object to hold the vertices, thereby leaving the collection specified in the argument untouched.
    
    Parameters:
    
    vertices - Collection of visual vertices to be translated to their corresponding Vertex. If the vertex does not have a corresponding Vertex or the visual vertex is not in the graph, then null will be the translation.
    
    Returns:
    
    A List object that holds the corresponding Vertex of each Visual Vertex in the collection.
  - translateToVisualEdges
```
public List translateToVisualEdges(List edges)
```
    Translates each of the Edge object in the specified collection to their Edge counterpart. In reality, this method creates a new Collection object to hold the visual edges, thereby leaving the collection specified in the argument untouched.
    
    Parameters:
    
    vertices - Collection of edges to be translated to their corresponding Visual Edge. If the edge does not have a corresponding Visual Edge or the edge is not in the graph, then null will be the translation.
    
    Returns:
    
    A Collection object that holds the corresponding Visual Edge of each edge in the vertices collection.
  - paint
```
public void paint(Graphics2D g2d,
                  VisualVertex onfront)
```
    Draws the elements of VisualGraph (all of its VisualVertex and VisualEdges) using the given Graphics2D graphics context object. This method is used when dragging a VisualVertex so that the VisualVertex being dragged is always on front of ther vertices and edges.
    
    Parameters:
    
    g2d - Graphics2D graphics context object to be used for painting the elements of VisualGraph.
    
    onfront - If not null, the given VisualVertex will be redrawn at the last stage so that it will always be on front of all other vertices and edges.
  - paint
```
public void paint(Graphics2D g2d)
```
    Draws the elements of VisualGraph (all of its VisualVertex and VisualEdges) using the given Graphics2D graphics context object.
    
    Parameters:
    
    g2d - Graphics2D graphics context object to be used for painting the elements of VisualGraph.
  - paint
```
public void paint(Graphics2D g2d,
                  Line2D probableedgeline)
```
    Draws the elements of VisualGraph (all of its VisualVertex and VisualEdges) using the given Graphics2D graphics context object. This method is used when creating an edge by clicking on a given VisualVertex and dragging the mouse so that a dashed line is drawn from the VisualVertex that was clicked to the current coordinates of the mouse position.
    
    Parameters:
    
    g2d - Graphics2D graphics context object to be used for painting the elements of VisualGraph.
    
    probableedgeline - If not null, a dashed line is drawn.
  - afterVertexAdded
```
public void afterVertexAdded(GraphAddVertexEvent e)
```
    This method is automatically called whenever a Vertex is added to the Graph object encapsulated by the VisualGraph object.
    
    Specified by:
    
    afterVertexAdded in interface GraphListener
    
    Overrides:
    
    afterVertexAdded in class NullGraphListener
    
    Parameters:
    
    e - GraphAddVertexEvent object that also specifies the Vertex that was added to the graph
  - afterEdgeAdded
```
public void afterEdgeAdded(GraphAddEdgeEvent e)
```
    This method is automatically called whenever an Edge is added to the Graph object encapsulated by the VisualGraph object.
    
    Specified by:
    
    afterEdgeAdded in interface GraphListener
    
    Overrides:
    
    afterEdgeAdded in class NullGraphListener
    
    Parameters:
    
    e - GraphAddEdgeEvent object that also specifies the Edge that was added to the graph
  - afterVertexRemoved
```
public void afterVertexRemoved(GraphRemoveVertexEvent e)
```
    This method is automatically called whenever a Vertex is about to be removed from the Graph object encapsulated by the VisualGraph object.
    
    Specified by:
    
    afterVertexRemoved in interface GraphListener
    
    Overrides:
    
    afterVertexRemoved in class NullGraphListener
    
    Parameters:
    
    e - GraphRemoveVertexEvent object that also specifies the Vertex that is about to be removed from the graph
  - afterEdgeRemoved
```
public void afterEdgeRemoved(GraphRemoveEdgeEvent e)
```
    This method is automatically called whenever an Edge is removed from the Graph object encapsulated by the VisualGraph object.
    
    Specified by:
    
    afterEdgeRemoved in interface GraphListener
    
    Overrides:
    
    afterEdgeRemoved in class NullGraphListener
    
    Parameters:
    
    e - GraphRemoveEdgeEvent object that also specifies the Edge that is about to be removed from the graph
  - emphasizeSubGraph
```
public void emphasizeSubGraph(Graph subGraph,
                              VisualVertexPainter vPainter,
                              VisualEdgePainter ePainter)
```
    Emphasizes a subgraph by changing the painters for the VisualGraphComponents of the subgraph.
  - emphasizeSubGraph
```
public void emphasizeSubGraph(Graph subGraph,
                              VisualVertexPainter mainGraphVPainter,
                              VisualEdgePainter mainGraphEPainter,
                              VisualVertexPainter subGraphVPainter,
                              VisualEdgePainter subGraphEPainter)
```
    Emphasizes a subgraph by changing the both the painters for the VisualGraphComponents of the subgraph and the painters for the main graph.

Class VisualGraph

Constructor Summary

Method Summary

Methods inherited from class salvo.jesus.graph.listener.NullGraphListener

Methods inherited from class java.lang.Object

Constructor Detail

VisualGraph

VisualGraph

Method Detail

getContainers

addContainer

removeContainer

getMaxSize

getStartDrawPoint

repaint

getGraph

setGraph

getGraphLayoutManager

setGraphLayoutManager

getVisualVertexPainterFactory

setVisualVertexPainterFactory

getVisualEdgePainterFactory

setVisualEdgePainterFactory

getVisualGraphComponentEditorFactory

setVisualGraphComponentEditorFactory

getVisualVertices

getVisualEdges

setOrthogonalLine

setStraightLine

layout

getVisualEdge

setVisualEdge

getVisualVertex

setVisualVertex

getVisualEdge

add

add

addEdge

remove

remove

removeEdge

removeEdge

getNode

translateToVisualVertices

translateToVertices

translateToVisualEdges

paint

paint

paint

afterVertexAdded

afterEdgeAdded

afterVertexRemoved

afterEdgeRemoved

emphasizeSubGraph

emphasizeSubGraph