com.tensegrity.composite.event
Interface VetoableCompositeLineListener

All Superinterfaces:

EventListenerTag, VetoableBaseCompositeListener

All Known Subinterfaces:

VetoableEventMediator, VetoableEventMediatorListener

All Known Implementing Classes:

CompositeEventMultiplexer, VetoableCompositeLineAdapter, VetoableEventMediatorAdapter

public interface VetoableCompositeLineListener

extends VetoableBaseCompositeListener

The VetoableCompositeLineListener interface defines an object that can be notified about vetoable events that are generated by a CompositeLine.

An event is vetoed by throwing a CompositeLineEventVetoException.

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

Version:

$Id: VetoableCompositeLineListener.java,v 1.2 2004/04/16 08:01:25 MichaelKegel Exp $

Author:

MichaelKegel

Method Summary

void	vetoableCompositeManipulating(LineManipulationEvent event) This method is called while a CompositeLine is being manipulated.
void	vetoableCompositeMoving(LineMoveEvent event) This method is called while a CompositeLine is being moved around.
void	vetoableCompositePreManipulating(LineManipulationEvent event) This method is called before the manipulation of a CompositeLine starts.
void	vetoableCompositePreMoving(LineMoveEvent event) This method is called before a CompositeLine is being moved around.

Methods inherited from interface com.tensegrity.composite.event.VetoableBaseCompositeListener

vetoablePreSelect

Method Detail

vetoableCompositePreManipulating

public void vetoableCompositePreManipulating(LineManipulationEvent event)
                                      throws CompositeLineEventVetoException

This method is called before the manipulation of a CompositeLine starts.

Throwing a CompositeLineEventVetoException prevents the CompositeLine against manipulation completely.

Parameters:

event - the LineManipulationEvent event instance

Throws:

CompositeLineEventVetoException - is thrown to completely prevent the CompositeLine against manipulation.

See Also:

LineManipulationEvent

vetoableCompositeManipulating

public void vetoableCompositeManipulating(LineManipulationEvent event)
                                   throws CompositeLineEventVetoException

This method is called while a CompositeLine is being manipulated.

Throwing a CompositeLineEventVetoException prevents the CompositeLine against manipulation. For instance this can be used to avoid that a single point of the CompositeLine is being moved to a location that is not acceptable.

Notice that this method is only called while interaction with the CompositeLine is taking place and not when manipulate it by the interface methods.

Parameters:

event - the LineManipulationEvent event instance

Throws:

CompositeLineEventVetoException

See Also:

LineManipulationEvent

vetoableCompositePreMoving

public void vetoableCompositePreMoving(LineMoveEvent event)
                                throws CompositeLineEventVetoException

This method is called before a CompositeLine is being moved around. Throwing a CompositeLineEventVetoException prevents movement of the CompositeLine completely.

Parameters:

event - the LineMoveEvent

Throws:

CompositeLineEventVetoException - is thrown to completely prevent the CompositeLine of movement.

See Also:

LineMoveEvent

vetoableCompositeMoving

public void vetoableCompositeMoving(LineMoveEvent event)
                             throws CompositeLineEventVetoException

This method is called while a CompositeLine is being moved around. Throwing a CompositeLineEventVetoException prevents movement of the CompositeLine to the actual position. For instance this can be used to avoid that the CompositeLine is being moved to a location that is not acceptable.

Notice that this method is only called while interaction with the CompositeLine is taking place and not when moving it by the interface methods.

Parameters:

event - the LineMoveEvent

Throws:

CompositeLineEventVetoException - is thrown to prevent the CompositeLine of movement to the current location

See Also:

LineMoveEvent