salvo.jesus.graph.visual.layout

Class GraphLayoutEvent

java.lang.Object

java.util.EventObject

salvo.jesus.graph.visual.layout.GraphLayoutEvent

All Implemented Interfaces:

Serializable

public class GraphLayoutEvent
extends EventObject

This is a general purpose graph layout event that is used to notify interested parties that a vertex has just been laid out in the graph. This event is useful for drwaing intermediate layouts of the graph, allowing the user to see the graph from its original unordered layout all the way to its final ordered layout.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
GraphLayoutEvent(VisualGraph vgraph, VisualVertex vvertex) Creates a GraphLayoutEvent object indicating the VisualVertex object that has been laid out and the VisualGraph where the VisualVertex object belongs.

Method Summary

Modifier and Type	Method and Description
VisualGraph	getVisualGraph() Convenience method that is similar to getSource() but returns an explicit VisualGraph object.
VisualVertex	getVisualVertex() Returns the VisualVertex object that has been laid out.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphLayoutEvent

public GraphLayoutEvent(VisualGraph vgraph,
                        VisualVertex vvertex)

Creates a GraphLayoutEvent object indicating the VisualVertex object that has been laid out and the VisualGraph where the VisualVertex object belongs.

Parameters:

vgraph - The source of the event. The method getSource() will return an object of type VisualGraph. This also indicates the VisualGraph object where the VisualVertex that has been laid out belongs.

vvertex - The VisualVertex object that has been laid out.

Method Detail

getVisualGraph

public VisualGraph getVisualGraph()

Convenience method that is similar to getSource() but returns an explicit VisualGraph object.

Returns:

The VisualGraph object to which the VisualVertex that has been laid out belongs. This is also the object returned by the getSource() method.

getVisualVertex

public VisualVertex getVisualVertex()

Returns the VisualVertex object that has been laid out.

Returns:

The VisualVertex object that has been laid out.