com.tensegrity.graph.event
Class VisualEdgeEvent

java.lang.Object
  com.tensegrity.graph.event.AbstractVisualGraphEvent
      com.tensegrity.graph.event.VisualEdgeEvent

All Implemented Interfaces:

VisualGraphRootEvent

public class VisualEdgeEvent

extends com.tensegrity.graph.event.AbstractVisualGraphEvent

This event handles events that occur on a per-VisualEdge basis.

Version:

$Id: VisualEdgeEvent.java,v 1.6 2003/05/13 15:58:56 sr Exp $

Author:

Stepan Rutz

See Also:

VisualEdge

Field Summary

static int	ISOLATEDVISUALEDGE_ADDED Constants that define the type of the event.
static int	ISOLATEDVISUALEDGE_REMOVED Constants that define the type of the event.
static int	VISUALEDGE_ADDED Constants that define the type of the event.
static int	VISUALEDGE_REMOVED Constants that define the type of the event.

Constructor Summary

VisualEdgeEvent(int id, VisualGraph visualgraph, VisualEdge visualedge)
Constructs a new VisualEdgeEvent instance.

VisualEdgeEvent(int id, VisualSubgraph visualsubgraph, VisualEdge visualedge)
Constructs a new VisualEdgeEvent instance.

Method Summary

java.lang.String	getDescription() Returns a textual description for the event.
int	getID() Returns the event id of this event.
VisualEdge	getVisualEdge() Returns the VisualEdge that is associated with the event.
VisualGraph	getVisualGraph() Returns the VisualGraph that caused the event.
VisualSubgraph	getVisualSubgraph() Returns the VisualSubgraph that caused the event.

Methods inherited from class java.lang.Object

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

Field Detail

VISUALEDGE_ADDED

public static final int VISUALEDGE_ADDED

Constants that define the type of the event.

See Also:

Constant Field Values

VISUALEDGE_REMOVED

public static final int VISUALEDGE_REMOVED

Constants that define the type of the event.

See Also:

Constant Field Values

ISOLATEDVISUALEDGE_ADDED

public static final int ISOLATEDVISUALEDGE_ADDED

Constants that define the type of the event.

See Also:

Constant Field Values

ISOLATEDVISUALEDGE_REMOVED

public static final int ISOLATEDVISUALEDGE_REMOVED

Constants that define the type of the event.

See Also:

Constant Field Values

Constructor Detail

VisualEdgeEvent

public VisualEdgeEvent(int id,
                       VisualGraph visualgraph,
                       VisualEdge visualedge)

Constructs a new VisualEdgeEvent instance.

Parameters:

id - the id of this event.

visualgraph - the associated VisualGraph of the event.

visualedge - the associated of the event. This may be null if the event did not occur in a subgraph. VisualEdge of the event.

VisualEdgeEvent

public VisualEdgeEvent(int id,
                       VisualSubgraph visualsubgraph,
                       VisualEdge visualedge)

Constructs a new VisualEdgeEvent instance.

Parameters:

id - the id of this event.

visualsubgraph - the associated VisualSubgraph

visualedge - the associated of the event. This may be null if the event did not occur in a subgraph. VisualEdge of the event.

Method Detail

getID

public int getID()

Returns the event id of this event.

Returns:

the event id of this event.

getVisualEdge

public VisualEdge getVisualEdge()

Returns the VisualEdge that is associated with the event.

Returns:

the VisualEdge that is associated with the event.

getVisualGraph

public VisualGraph getVisualGraph()

Returns the VisualGraph that caused the event.

If the event source was not of the type VisualGraph then this method returns null.

Specified by:

getVisualGraph in interface VisualGraphRootEvent

Returns:

the VisualGraph that caused the event.

getVisualSubgraph

public VisualSubgraph getVisualSubgraph()

Returns the VisualSubgraph that caused the event.

If the event source was not of the type VisualSubgraph then this method returns null.

Returns:

the VisualSubgraph that caused the event.

getDescription

public java.lang.String getDescription()

Returns a textual description for the event.

Specified by:

getDescription in interface VisualGraphRootEvent

Returns:

a textual description for the event.