com.tensegrity.graph.event
Interface VetoableVisualGraphListener

All Superinterfaces:

EventListenerTag

All Known Subinterfaces:

VetoableVisualGraphEventMediatorListener

All Known Implementing Classes:

GraphEventMultiplexer, VetoableVisualGraphEventMediator

public interface VetoableVisualGraphListener

extends EventListenerTag

The VetoableVisualGraphListener interface defines an object that is able to receive events that are related to a VisualGraph instance and is able to veto the received events.

To veto an event means that the processing of the event is completely stopped.
To veto an event the listener has to throw a VisualGraphEventVetoException.

VetoableVisualGraphListeners should not process an event like a normal VisualGraphListener may does. Their sole task is to veto an event if necessary.

Version:

$Id: VetoableVisualGraphListener.java,v 1.2 2005/04/04 07:16:54 MichaelKegel Exp $

Author:

MichaelKegel

Method Summary

void	vetoableIsolatedVisualEdgePreAdd(VisualGraphEvent visualgraphevent) This mehtod is called when an isolated VisualEdge is about to be added to a VisualGraph.
void	vetoableIsolatedVisualEdgePreRemove(VisualGraphEvent visualgraphevent) This method is called when an isolated VisualEdge is about to be removed from a VisualGraph.
void	vetoableVisualEdgePreAdd(VisualGraphEvent visualgraphevent) This mehtod is called when an VisualEdge is about to be added to a VisualGraph.
void	vetoableVisualEdgePreRemove(VisualGraphEvent visualgraphevent) This method is called when an VisualEdge is about to be removed from a VisualGraph.
void	vetoableVisualNodePreAdd(VisualGraphEvent visualgraphevent) This method is called when a VisualNode is about to be added to a VisualGraph.
void	vetoableVisualNodePreRemove(VisualGraphEvent visualgraphevent) This method is called when a VisualNode is about to be removed from a VisualGraph.

Method Detail

vetoableVisualNodePreAdd

public void vetoableVisualNodePreAdd(VisualGraphEvent visualgraphevent)
                              throws VisualGraphEventVetoException

This method is called when a VisualNode is about to be added to a VisualGraph.
If the implementor throws a VisualGraphEventVetoException the event will be veto'd and the corresponding action will not be completed.

Parameters:

visualgraphevent - the VisualGraphEvent structure carrying event information.

Throws:

VisualGraphEventVetoException - that indicates the VisualGraphEvent is not desired.

vetoableVisualNodePreRemove

public void vetoableVisualNodePreRemove(VisualGraphEvent visualgraphevent)
                                 throws VisualGraphEventVetoException

This method is called when a VisualNode is about to be removed from a VisualGraph.
If the implementor throws a VisualGraphEventVetoException the event will be veto'd and the corresponding action will not be completed.

Parameters:

visualgraphevent - the VisualGraphEvent structure carrying event information.

Throws:

VisualGraphEventVetoException - that indicates the VisualGraphEvent is not desired.

vetoableVisualEdgePreAdd

public void vetoableVisualEdgePreAdd(VisualGraphEvent visualgraphevent)
                              throws VisualGraphEventVetoException

This mehtod is called when an VisualEdge is about to be added to a VisualGraph.
If the implementor throws a VisualGraphEventVetoException the event will be veto'd and the corresponding action will not be completed.

Parameters:

visualgraphevent - the VisualGraphEvent structure carrying event information.

Throws:

VisualGraphEventVetoException - that indicates the VisualGraphEvent is not desired.

vetoableVisualEdgePreRemove

public void vetoableVisualEdgePreRemove(VisualGraphEvent visualgraphevent)
                                 throws VisualGraphEventVetoException

This method is called when an VisualEdge is about to be removed from a VisualGraph.
If the implementor throws a VisualGraphEventVetoException the event will be veto'd and the corresponding action will not be completed.

Parameters:

visualgraphevent - the VisualGraphEvent structure carrying event information.

Throws:

VisualGraphEventVetoException - that indicates the VisualGraphEvent is not desired.

vetoableIsolatedVisualEdgePreAdd

public void vetoableIsolatedVisualEdgePreAdd(VisualGraphEvent visualgraphevent)
                                      throws VisualGraphEventVetoException

This mehtod is called when an isolated VisualEdge is about to be added to a VisualGraph.
If the implementor throws a VisualGraphEventVetoException the event will be veto'd and the corresponding action will not be completed.

Parameters:

visualgraphevent - the VisualGraphEvent structure carrying event information.

Throws:

VisualGraphEventVetoException - that indicates the VisualGraphEvent is not desired.

vetoableIsolatedVisualEdgePreRemove

public void vetoableIsolatedVisualEdgePreRemove(VisualGraphEvent visualgraphevent)
                                         throws VisualGraphEventVetoException

This method is called when an isolated VisualEdge is about to be removed from a VisualGraph.
If the implementor throws a VisualGraphEventVetoException the event will be veto'd and the corresponding action will not be completed.

Parameters:

visualgraphevent - the VisualGraphEvent structure carrying event information.

Throws:

VisualGraphEventVetoException - that indicates the VisualGraphEvent is not desired.