ds.funnel.node.event

Interface EventDispatcher

All Superinterfaces:

EventDispatchHandler<Event>, EventHandler<Event>

All Known Implementing Classes:

EventDispatcherImpl

public interface EventDispatcher
extends EventDispatchHandler<Event>

Method Summary

Modifier and Type	Method and Description
<E extends Event> void	dispatch(E event) Dispatch an event, passing the event to matching registered handlers.
boolean	register(java.lang.Object handlerObj) Register a new event handler.
EventDispatchHandler<Event>	setParent(EventDispatchHandler<Event> inParent) Sets the parent event dispatcher.
void	unregister(java.lang.Object handlerObj) Unregister an event handler.
void	unregisterAll() Remove all event handlers.

Methods inherited from interface ds.funnel.node.event.EventDispatchHandler

handle, handleOrder, handleType, onCancelHandler

Method Detail

register

boolean register(java.lang.Object handlerObj)
          throws RegistrationException

Register a new event handler. The handler is called when a matching event is dispatched.

Parameters:

handlerObj - - The event handler to register with this dispatcher.

Returns:

True on success, false otherwise.

Throws:

RegistrationException

unregister

void unregister(java.lang.Object handlerObj)

Unregister an event handler. The handler will no longer be called.

Parameters:

handlerObj - - The event handler to register with this dispatcher.

unregisterAll

void unregisterAll()

Remove all event handlers.

dispatch

<E extends Event> void dispatch(E event)

Dispatch an event, passing the event to matching registered handlers.

Parameters:

event - - The event to dispatch.

setParent

EventDispatchHandler<Event> setParent(EventDispatchHandler<Event> inParent)

Sets the parent event dispatcher. Events will be also be dispatched by the parent.

Parameters:

inParent -