com.sun.javafx.event

Class EventDispatchChainImpl

java.lang.Object

com.sun.javafx.event.EventDispatchChainImpl

All Implemented Interfaces:

EventDispatchChain

public class EventDispatchChainImpl
extends Object
implements EventDispatchChain

Constructor Summary

Constructors

Constructor and Description
EventDispatchChainImpl()

Method Summary

Modifier and Type	Method and Description
EventDispatchChain	append(EventDispatcher eventDispatcher) Appends the specified EventDispatcher to this chain.
Event	dispatchEvent(Event event) Dispatches the specified event through this EventDispatchChain.
EventDispatchChain	prepend(EventDispatcher eventDispatcher) Prepends the specified EventDispatcher to this chain.
void	reset()

Methods inherited from class java.lang.Object

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

Constructor Detail

EventDispatchChainImpl

public EventDispatchChainImpl()

Method Detail

reset

public void reset()

append

public EventDispatchChain append(EventDispatcher eventDispatcher)

Description copied from interface: EventDispatchChain

Appends the specified EventDispatcher to this chain. Returns a reference to the chain with the appended element.

The caller shouldn't assume that this EventDispatchChain remains unchanged nor that the returned value will reference a different chain after the call. All this depends on the EventDispatchChain implementation.

So the call should be always done in the following form: chain = chain.append(eventDispatcher);

Specified by:

append in interface EventDispatchChain

Parameters:

eventDispatcher - the EventDispatcher to append to the chain

Returns:

the chain with the appended event dispatcher

prepend

public EventDispatchChain prepend(EventDispatcher eventDispatcher)

Description copied from interface: EventDispatchChain

Prepends the specified EventDispatcher to this chain. Returns a reference to the chain with the prepended element.

The caller shouldn't assume that this EventDispatchChain remains unchanged nor that the returned value will reference a different chain after the call. All this depends on the EventDispatchChain implementation.

So the call should be always done in the following form: chain = chain.prepend(eventDispatcher);

Specified by:

prepend in interface EventDispatchChain

Parameters:

eventDispatcher - the EventDispatcher to prepend to the chain

Returns:

the chain with the prepended event dispatcher

dispatchEvent

public Event dispatchEvent(Event event)

Description copied from interface: EventDispatchChain

Dispatches the specified event through this EventDispatchChain. The return value represents the event after processing done by the chain. If further processing is to be done after the call the event referenced by the return value should be used instead of the original event. In the case the event is fully handled / consumed in the chain the returned value is null and no further processing should be done with that event.

Specified by:

dispatchEvent in interface EventDispatchChain

Parameters:

event - the event to dispatch

Returns:

the processed event or null if the event had been fully handled / consumed