net.sf.cuf.appevent

Class AppEvent

java.lang.Object

java.util.EventObject

net.sf.cuf.appevent.AppEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BindEvent, BlockEvent, CloseDialogEvent, MenuToolBarEvent, OpenDialogEvent, ShowStatusEvent, UnbindEvent

public class AppEvent
extends EventObject

AppEvent is the base class of all events that use the AppEvent mechanism. AppEvents decouple a event sender and a event receiver, see AppEventSupport, AppEventManager and BindEvent for more details on the dispatch possibilities.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AppEvent(Object pSource) Create a non-consumed event.

Method Summary

Methods

Modifier and Type	Method and Description
void	consume() Consume the event.
void	forward() The method is called once at each step during processing.
boolean	isConsumed() Returns of this event was consumed, may be used e.g. to stop propagation of the event.
String	toString() Returns a String representation of this EventObject.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

AppEvent

public AppEvent(Object pSource)

Create a non-consumed event.

Parameters:

pSource - null or event source

Method Detail

isConsumed

public boolean isConsumed()

Returns of this event was consumed, may be used e.g. to stop propagation of the event.

Returns:

true if the event got consumed, false otherwise

consume

public void consume()

Consume the event.

forward

public void forward()

The method is called once at each step during processing. This can be used in a sub-class that the event consumes itself to stop propagating.

toString

public String toString()

Returns a String representation of this EventObject.

Overrides:

toString in class EventObject

Returns:

A a String representation of this EventObject.