org._3pq.jgrapht.event

Class GraphVertexChangeEvent


public class GraphVertexChangeEvent
extends GraphChangeEvent

An event which indicates that a graph vertex has changed, or is about to change. The event can be used either as an indication after the vertex has been added or removed, or before it is added. The type of the event can be tested using the GraphChangeEvent.getType() method.
Author:
Barak Naveh
Since:
Aug 10, 2003

Field Summary

static int
BEFORE_VERTEX_ADDED
Before vertex added event.
static int
BEFORE_VERTEX_REMOVED
Before vertex removed event.
static int
VERTEX_ADDED
Vertex added event.
static int
VERTEX_REMOVED
Vertex removed event.
protected Object
m_vertex
The vertex that this event is related to.

Fields inherited from class org._3pq.jgrapht.event.GraphChangeEvent

m_type

Constructor Summary

GraphVertexChangeEvent(Object eventSource, int type, Object vertex)
Creates a new GraphVertexChangeEvent object.

Method Summary

Object
getVertex()
Returns the vertex that this event is related to.

Methods inherited from class org._3pq.jgrapht.event.GraphChangeEvent

getType

Field Details

BEFORE_VERTEX_ADDED

public static final int BEFORE_VERTEX_ADDED
Before vertex added event. This event is fired before a vertex is added to a graph.
Field Value:
11

BEFORE_VERTEX_REMOVED

public static final int BEFORE_VERTEX_REMOVED
Before vertex removed event. This event is fired before a vertex is removed from a graph.
Field Value:
12

VERTEX_ADDED

public static final int VERTEX_ADDED
Vertex added event. This event is fired after a vertex is added to a graph.
Field Value:
13

VERTEX_REMOVED

public static final int VERTEX_REMOVED
Vertex removed event. This event is fired after a vertex is removed from a graph.
Field Value:
14

m_vertex

protected Object m_vertex
The vertex that this event is related to.

Constructor Details

GraphVertexChangeEvent

public GraphVertexChangeEvent(Object eventSource,
                              int type,
                              Object vertex)
Creates a new GraphVertexChangeEvent object.
Parameters:
eventSource - the source of the event.
type - the type of the event.
vertex - the vertex that the event is related to.

Method Details

getVertex

public Object getVertex()
Returns the vertex that this event is related to.
Returns:
the vertex that this event is related to.