Top Description Fields Constructors Methods
com.sun.javafx.event

public abstract Class BasicEventDispatcher

extends Object
implements EventDispatcher
Class Inheritance
All Implemented Interfaces
javafx.event.EventDispatcher
Known Direct Subclasses
com.sun.javafx.event.CompositeEventDispatcher, com.sun.javafx.event.EventHandlerManager, com.sun.javafx.event.EventRedirector
Imports
javafx.event.Event, .EventDispatchChain, .EventDispatcher
Event dispatcher which introduces event dispatch phase specific methods - dispatchCapturingEvent and dispatchBubblingEvent. These are used in the BasicEventDispatcher.dispatchEvent implementation, but because they are public they can be called directly as well. Their default implementation does nothing and is expected to be overridden in subclasses. The BasicEventDispatcher also adds possibility to chain event dispatchers. This is used together with the direct access to the phase specific dispatch methods to implement CompositeEventDispatcher.

An event dispatcher derived from BasicEventDispatcher can act as a standalone event dispatcher or can be used to form a dispatch chain in CompositeEventDispatcher.

Field Summary

Modifier and TypeField and Description
private BasicEventDispatcher
nextDispatcher

private BasicEventDispatcher
previousDispatcher

Constructor Summary

AccessConstructor and Description
public
BasicEventDispatcher()

Method Summary

Modifier and TypeMethod and Description
public Event
dispatchBubblingEvent(Event event)

public Event
dispatchCapturingEvent(Event event)

public Event
dispatchEvent(Event
the event do dispatch
event, final EventDispatchChain
the rest of the chain to dispatch event to
tail)

Implements javafx.event.EventDispatcher.dispatchEvent.

Dispatches the specified event by this EventDispatcher.

public final BasicEventDispatcher
getNextDispatcher()

public final BasicEventDispatcher
getPreviousDispatcher()

public final void
insertNextDispatcher(final BasicEventDispatcher newDispatcher)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

nextDispatcherback to summary
private BasicEventDispatcher nextDispatcher
previousDispatcherback to summary
private BasicEventDispatcher previousDispatcher

Constructor Detail

BasicEventDispatcherback to summary
public BasicEventDispatcher()

Method Detail

dispatchBubblingEventback to summary
public Event dispatchBubblingEvent(Event event)
dispatchCapturingEventback to summary
public Event dispatchCapturingEvent(Event event)
dispatchEventback to summary
public Event dispatchEvent(Event event, final EventDispatchChain tail)

Implements javafx.event.EventDispatcher.dispatchEvent.

Doc from javafx.event.EventDispatcher.dispatchEvent.

Dispatches the specified event by this EventDispatcher. Does any required event processing. Both the event and its further path can be modified in this method. If the event is not handled / consumed during the capturing phase, it should be dispatched to the rest of the chain (event = tail.dispatch(event);).

Parameters
event:Event

the event do dispatch

tail:EventDispatchChain

the rest of the chain to dispatch event to

Returns:Event

the return event or null if the event has been handled / consumed

Annotations
@Override
getNextDispatcherback to summary
public final BasicEventDispatcher getNextDispatcher()
getPreviousDispatcherback to summary
public final BasicEventDispatcher getPreviousDispatcher()
insertNextDispatcherback to summary
public final void insertNextDispatcher(final BasicEventDispatcher newDispatcher)