com.tensegrity.composite.event
Interface VetoableCompositeListener

All Superinterfaces:

EventListenerTag, VetoableBaseCompositeListener

All Known Subinterfaces:

VetoableEventMediator, VetoableEventMediatorListener

All Known Implementing Classes:

CompositeEventMultiplexer, VetoableCompositeAdapter, VetoableEventMediatorAdapter

public interface VetoableCompositeListener

extends VetoableBaseCompositeListener

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

An event is vetoed by throwing a CompositeEventVetoException.

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

Version:

$Id: VetoableCompositeListener.java,v 1.1 2003/05/16 14:46:28 MichaelKegel Exp $

Author:

MichaelKegel

See Also:

EventListenerTag, Composite

Method Summary

void	vetoableCompositeMoving(MoveEvent event) This method is called while a Composite is being moved around.
void	vetoableCompositePreMoving(MoveEvent event) This method is called before a Composite is being moved around.
void	vetoableCompositePreResizing(ResizeEvent event) This method is called before a Composite is about to be resized.
void	vetoableCompositeResizing(ResizeEvent event) This method is called while a Composite is being resized.

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

vetoablePreSelect

Method Detail

vetoableCompositePreMoving

public void vetoableCompositePreMoving(MoveEvent event)
                                throws CompositeEventVetoException

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

Parameters:

event - the MoveEvent

Throws:

CompositeEventVetoException - is thrown to completely prevent the Composite of movement.

See Also:

MoveEvent

vetoableCompositeMoving

public void vetoableCompositeMoving(MoveEvent event)
                             throws CompositeEventVetoException

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

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

Parameters:

event - the MoveEvent

Throws:

CompositeEventVetoException - is thrown to prevent the Composite of movement to the current location

See Also:

MoveEvent

vetoableCompositePreResizing

public void vetoableCompositePreResizing(ResizeEvent event)
                                  throws CompositeEventVetoException

This method is called before a Composite is about to be resized. Throwing a CompositeEventVetoException prevents the Composite against resizement completely.

Parameters:

event - the ResizeEvent

Throws:

CompositeEventVetoException - is thrown to completely prevent the Composite of resizement.

See Also:

ResizeEvent

vetoableCompositeResizing

public void vetoableCompositeResizing(ResizeEvent event)
                               throws CompositeEventVetoException

This method is called while a Composite is being resized. Throwing a CompositeEventVetoException prevents the Composite against resizement to the actual size. For instance this can be used to avoid that the Composite is being resized to a size that is not acceptable.

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

Parameters:

event - the ResizeEvent

Throws:

CompositeEventVetoException - is thrown to prevent the Composite of resize to the current size

See Also:

ResizeEvent