javafx.concurrent

Class EventHelper

java.lang.Object

javafx.concurrent.EventHelper

class EventHelper
extends java.lang.Object

This utility class is used both to bucketize the event handler related methods and state in Service and Task, but also (and more importantly) to consolidate the implementation into one place.

Property Summary

Type	Property and Description
(package private) <any>	onCancelled
(package private) <any>	onFailed
(package private) <any>	onReady
(package private) <any>	onRunning
(package private) <any>	onScheduled
(package private) <any>	onSucceeded

Field Summary

Fields

Modifier and Type	Field and Description
private EventHandlerManager	internalEventDispatcher
private <any>	onCancelled
private <any>	onFailed
private <any>	onReady
private <any>	onRunning
private <any>	onScheduled
private <any>	onSucceeded
private EventTarget	target

Constructor Summary

Constructors

Constructor and Description
EventHelper(EventTarget bean)

Method Summary

Modifier and Type	Method and Description
(package private) <T extends Event> void	addEventFilter(<any> eventType, <any> eventFilter) Registers an event filter to this task.
(package private) <T extends Event> void	addEventHandler(<any> eventType, <any> eventHandler) Registers an event handler to this task.
(package private) EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail)
(package private) void	fireEvent(Event event) Fires the specified event.
private EventHandlerManager	getInternalEventDispatcher()
(package private) <any>	getOnCancelled()
(package private) <any>	getOnFailed()
(package private) <any>	getOnReady()
(package private) <any>	getOnRunning()
(package private) <any>	getOnScheduled()
(package private) <any>	getOnSucceeded()
(package private) <any>	onCancelledProperty()
(package private) <any>	onFailedProperty()
(package private) <any>	onReadyProperty()
(package private) <any>	onRunningProperty()
(package private) <any>	onScheduledProperty()
(package private) <any>	onSucceededProperty()
(package private) <T extends Event> void	removeEventFilter(<any> eventType, <any> eventFilter) Unregisters a previously registered event filter from this task.
(package private) <T extends Event> void	removeEventHandler(<any> eventType, <any> eventHandler) Unregisters a previously registered event handler from this task.
(package private) <T extends Event> void	setEventHandler(<any> eventType, <any> eventHandler) Sets the handler to use for this event type.
(package private) void	setOnCancelled(<any> value)
(package private) void	setOnFailed(<any> value)
(package private) void	setOnReady(<any> value)
(package private) void	setOnRunning(<any> value)
(package private) void	setOnScheduled(<any> value)
(package private) void	setOnSucceeded(<any> value)

Methods inherited from class java.lang.Object

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

Property Detail

onReady

final <any> onReadyProperty

onScheduled

final <any> onScheduledProperty

onRunning

final <any> onRunningProperty

onSucceeded

final <any> onSucceededProperty

onCancelled

final <any> onCancelledProperty

onFailed

final <any> onFailedProperty

Field Detail

target

private final EventTarget target

onReady

private final <any> onReady

onScheduled

private final <any> onScheduled

onRunning

private final <any> onRunning

onSucceeded

private final <any> onSucceeded

onCancelled

private final <any> onCancelled

onFailed

private final <any> onFailed

internalEventDispatcher

private EventHandlerManager internalEventDispatcher

Constructor Detail

EventHelper

EventHelper(EventTarget bean)

Method Detail

onReadyProperty

final <any> onReadyProperty()

getOnReady

final <any> getOnReady()

setOnReady

final void setOnReady(<any> value)

onScheduledProperty

final <any> onScheduledProperty()

getOnScheduled

final <any> getOnScheduled()

setOnScheduled

final void setOnScheduled(<any> value)

onRunningProperty

final <any> onRunningProperty()

getOnRunning

final <any> getOnRunning()

setOnRunning

final void setOnRunning(<any> value)

onSucceededProperty

final <any> onSucceededProperty()

getOnSucceeded

final <any> getOnSucceeded()

setOnSucceeded

final void setOnSucceeded(<any> value)

onCancelledProperty

final <any> onCancelledProperty()

getOnCancelled

final <any> getOnCancelled()

setOnCancelled

final void setOnCancelled(<any> value)

onFailedProperty

final <any> onFailedProperty()

getOnFailed

final <any> getOnFailed()

setOnFailed

final void setOnFailed(<any> value)

addEventHandler

final <T extends Event> void addEventHandler(<any> eventType,
                                             <any> eventHandler)

Registers an event handler to this task. Any event filters are first processed, then the specified onFoo event handlers, and finally any event handlers registered by this method. As with other events in the scene graph, if an event is consumed, it will not continue dispatching.

Type Parameters:

T - the specific event class of the handler

Parameters:

eventType - the type of the events to receive by the handler

eventHandler - the handler to register

removeEventHandler

final <T extends Event> void removeEventHandler(<any> eventType,
                                                <any> eventHandler)

Unregisters a previously registered event handler from this task. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.

Type Parameters:

T - the specific event class of the handler

Parameters:

eventType - the event type from which to unregister

eventHandler - the handler to unregister

addEventFilter

final <T extends Event> void addEventFilter(<any> eventType,
                                            <any> eventFilter)

Registers an event filter to this task. Registered event filters get an event before any associated event handlers.

Type Parameters:

T - the specific event class of the filter

Parameters:

eventType - the type of the events to receive by the filter

eventFilter - the filter to register

removeEventFilter

final <T extends Event> void removeEventFilter(<any> eventType,
                                               <any> eventFilter)

Unregisters a previously registered event filter from this task. One filter might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the filter.

Type Parameters:

T - the specific event class of the filter

Parameters:

eventType - the event type from which to unregister

eventFilter - the filter to unregister

setEventHandler

final <T extends Event> void setEventHandler(<any> eventType,
                                             <any> eventHandler)

Sets the handler to use for this event type. There can only be one such handler specified at a time. This handler is guaranteed to be called first. This is used for registering the user-defined onFoo event handlers.

Type Parameters:

T - the specific event class of the handler

Parameters:

eventType - the event type to associate with the given eventHandler

eventHandler - the handler to register, or null to unregister

getInternalEventDispatcher

private EventHandlerManager getInternalEventDispatcher()

fireEvent

final void fireEvent(Event event)

Fires the specified event. Any event filter encountered will be notified and can consume the event. If not consumed by the filters, the event handlers on this task are notified. If these don't consume the event either, then all event handlers are called and can consume the event.

This method must be called on the FX user thread.

Parameters:

event - the event to fire

buildEventDispatchChain

EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)