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

public Class EventHandlerManager

extends BasicEventDispatcher
Class Inheritance
Imports
java.util.HashMap, .Map, javafx.event.Event, .EventHandler, .EventType

An EventDispatcher which allows user event handler / filter registration and when used in an event dispatch chain it forwards received events to the appropriate registered handlers / filters.

Field Summary

Modifier and TypeField and Description
private final Map<EventType<? extends Event>, CompositeEventHandler<? extends Event>>
private final Object

Constructor Summary

AccessConstructor and Description
public
EventHandlerManager(final Object eventSource)

Method Summary

Modifier and TypeMethod and Description
public final <
the specific event class of the filter
T extends Event
>
void
addEventFilter(final EventType<T>
the type of the events to receive by the filter
eventType
,
final EventHandler<? super T>
the filter to register
eventFilter
)

Registers an event filter in EventHandlerManager.

public final <
the specific event class of the handler
T extends Event
>
void
addEventHandler(final EventType<T>
the type of the events to receive by the handler
eventType
,
final EventHandler<? super T>
the handler to register
eventHandler
)

Registers an event handler in EventHandlerManager.

private <T extends Event> CompositeEventHandler<T>
public final Event
private Event
dispatchBubblingEvent(final EventType<? extends Event> handlerType, Event event)

public final Event
private Event
dispatchCapturingEvent(final EventType<? extends Event> handlerType, Event event)

private static Event
fixEventSource(final Event event, final Object eventSource)

public final <T extends Event> EventHandler<? super T>
getEventHandler(final EventType<T> eventType)

protected Object
public final <
the specific event class of the filter
T extends Event
>
void
removeEventFilter(final EventType<T>
the event type from which to unregister
eventType
,
final EventHandler<? super T>
the filter to unregister
eventFilter
)

Unregisters a previously registered event filter.

public final <
the specific event class of the handler
T extends Event
>
void
removeEventHandler(final EventType<T>
the event type from which to unregister
eventType
,
final EventHandler<? super T>
the handler to unregister
eventHandler
)

Unregisters a previously registered event handler.

public final <
the specific event class of the handler
T extends Event
>
void
setEventHandler(final EventType<T>
the event type to associate with the given eventHandler
eventType
,
final EventHandler<? super T>
the handler to register, or null to unregister
eventHandler
)

Sets the specified singleton handler.

private static void
validateEventFilter(final EventHandler<?> eventFilter)

private static void
validateEventHandler(final EventHandler<?> eventHandler)

private static void
validateEventType(final EventType<?> eventType)

Inherited from com.sun.javafx.event.BasicEventDispatcher:
dispatchEventgetNextDispatchergetPreviousDispatcherinsertNextDispatcher

Field Detail

eventHandlerMapback to summary
private final Map<EventType<? extends Event>, CompositeEventHandler<? extends Event>> eventHandlerMap
eventSourceback to summary
private final Object eventSource

Constructor Detail

EventHandlerManagerback to summary
public EventHandlerManager(final Object eventSource)

Method Detail

addEventFilterback to summary
public final <T extends Event> void addEventFilter(final EventType<T> eventType, final EventHandler<? super T> eventFilter)

Registers an event filter in EventHandlerManager.

Parameters
<T>
the specific event class of the filter
eventType:EventType<T>

the type of the events to receive by the filter

eventFilter:EventHandler<? super T>

the filter to register

Exceptions
NullPointerException:
if the event type or filter is null
addEventHandlerback to summary
public final <T extends Event> void addEventHandler(final EventType<T> eventType, final EventHandler<? super T> eventHandler)

Registers an event handler in EventHandlerManager.

Parameters
<T>
the specific event class of the handler
eventType:EventType<T>

the type of the events to receive by the handler

eventHandler:EventHandler<? super T>

the handler to register

Exceptions
NullPointerException:
if the event type or handler is null
createGetCompositeEventHandlerback to summary
private <T extends Event> CompositeEventHandler<T> createGetCompositeEventHandler(final EventType<T> eventType)
dispatchBubblingEventback to summary
public final Event dispatchBubblingEvent(Event event)

Overrides com.sun.javafx.event.BasicEventDispatcher.dispatchBubblingEvent.

Annotations
@Override
dispatchBubblingEventback to summary
private Event dispatchBubblingEvent(final EventType<? extends Event> handlerType, Event event)
dispatchCapturingEventback to summary
public final Event dispatchCapturingEvent(Event event)

Overrides com.sun.javafx.event.BasicEventDispatcher.dispatchCapturingEvent.

Annotations
@Override
dispatchCapturingEventback to summary
private Event dispatchCapturingEvent(final EventType<? extends Event> handlerType, Event event)
fixEventSourceback to summary
private static Event fixEventSource(final Event event, final Object eventSource)
getEventHandlerback to summary
public final <T extends Event> EventHandler<? super T> getEventHandler(final EventType<T> eventType)
getEventSourceback to summary
protected Object getEventSource()
removeEventFilterback to summary
public final <T extends Event> void removeEventFilter(final EventType<T> eventType, final EventHandler<? super T> eventFilter)

Unregisters a previously registered event filter.

Parameters
<T>
the specific event class of the filter
eventType:EventType<T>

the event type from which to unregister

eventFilter:EventHandler<? super T>

the filter to unregister

Exceptions
NullPointerException:
if the event type or filter is null
removeEventHandlerback to summary
public final <T extends Event> void removeEventHandler(final EventType<T> eventType, final EventHandler<? super T> eventHandler)

Unregisters a previously registered event handler.

Parameters
<T>
the specific event class of the handler
eventType:EventType<T>

the event type from which to unregister

eventHandler:EventHandler<? super T>

the handler to unregister

Exceptions
NullPointerException:
if the event type or handler is null
setEventHandlerback to summary
public final <T extends Event> void setEventHandler(final EventType<T> eventType, final EventHandler<? super T> eventHandler)

Sets the specified singleton handler. There can only be one such handler specified at a time.

Parameters
<T>
the specific event class of the handler
eventType:EventType<T>

the event type to associate with the given eventHandler

eventHandler:EventHandler<? super T>

the handler to register, or null to unregister

Exceptions
NullPointerException:
if the event type is null
validateEventFilterback to summary
private static void validateEventFilter(final EventHandler<?> eventFilter)
validateEventHandlerback to summary
private static void validateEventHandler(final EventHandler<?> eventHandler)
validateEventTypeback to summary
private static void validateEventType(final EventType<?> eventType)