JavaFX 25 · javafx.concurrent.EventHelper · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private EventHandlerManager	internalEventDispatcher
private final ObjectProperty<EventHandler<WorkerStateEvent>>	onCancelled
private final ObjectProperty<EventHandler<WorkerStateEvent>>	onFailed
private final ObjectProperty<EventHandler<WorkerStateEvent>>	onReady
private final ObjectProperty<EventHandler<WorkerStateEvent>>	onRunning
private final ObjectProperty<EventHandler<WorkerStateEvent>>	onScheduled
private final ObjectProperty<EventHandler<WorkerStateEvent>>	onSucceeded
private final EventTarget	target

Access	Constructor and Description
pack-priv	EventHelper(EventTarget bean)

Method Summary

Modifier and Type	Method and Description
pack-priv 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 to this task.
pack-priv 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 to this task.
pack-priv EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail)
pack-priv final void	fireEvent(Event the event to fire event) Fires the specified event.
private EventHandlerManager	getInternalEventDispatcher()
pack-priv final EventHandler<WorkerStateEvent>	getOnCancelled()
pack-priv final EventHandler<WorkerStateEvent>	getOnFailed()
pack-priv final EventHandler<WorkerStateEvent>	getOnReady()
pack-priv final EventHandler<WorkerStateEvent>	getOnRunning()
pack-priv final EventHandler<WorkerStateEvent>	getOnScheduled()
pack-priv final EventHandler<WorkerStateEvent>	getOnSucceeded()
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>>	onCancelledProperty()
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>>	onFailedProperty()
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>>	onReadyProperty()
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>>	onRunningProperty()
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>>	onScheduledProperty()
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>>	onSucceededProperty()
pack-priv 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 from this task.
pack-priv 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 from this task.
pack-priv 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 handler to use for this event type.
pack-priv final void	setOnCancelled(EventHandler<WorkerStateEvent> value)
pack-priv final void	setOnFailed(EventHandler<WorkerStateEvent> value)
pack-priv final void	setOnReady(EventHandler<WorkerStateEvent> value)
pack-priv final void	setOnRunning(EventHandler<WorkerStateEvent> value)
pack-priv final void	setOnScheduled(EventHandler<WorkerStateEvent> value)
pack-priv final void	setOnSucceeded(EventHandler<WorkerStateEvent> value)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

internalEventDispatcher	back to summary
private EventHandlerManager internalEventDispatcher

onCancelled	back to summary
private final ObjectProperty<EventHandler<WorkerStateEvent>> onCancelled

onFailed	back to summary
private final ObjectProperty<EventHandler<WorkerStateEvent>> onFailed

onReady	back to summary
private final ObjectProperty<EventHandler<WorkerStateEvent>> onReady

onRunning	back to summary
private final ObjectProperty<EventHandler<WorkerStateEvent>> onRunning

onScheduled	back to summary
private final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduled

onSucceeded	back to summary
private final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceeded

target	back to summary
private final EventTarget target

EventHelper	back to summary
pack-priv EventHelper(EventTarget bean)

Method Detail

addEventFilter	back to summary
pack-priv final <T extends Event> void addEventFilter(final EventType<T> eventType, final EventHandler<? super T> eventFilter) Registers an event filter to this task. Registered event filters get an event before any associated event handlers. 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

addEventFilter

back to summary

pack-priv final <T extends Event> void addEventFilter(final EventType<T> eventType, final EventHandler<? super T> eventFilter)

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

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

addEventHandler	back to summary
pack-priv final <T extends Event> void addEventHandler(final EventType<T> eventType, final EventHandler<? super T> 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. 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

addEventHandler

back to summary

pack-priv final <T extends Event> void addEventHandler(final EventType<T> eventType, final EventHandler<? super T> 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.

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

buildEventDispatchChain	back to summary
pack-priv EventDispatchChain buildEventDispatchChain(EventDispatchChain tail)

fireEvent	back to summary
pack-priv 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:Event the event to fire

fireEvent

back to summary

pack-priv 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:Event: the event to fire

getInternalEventDispatcher	back to summary
private EventHandlerManager getInternalEventDispatcher()

getOnCancelled	back to summary
pack-priv final EventHandler<WorkerStateEvent> getOnCancelled()

getOnFailed	back to summary
pack-priv final EventHandler<WorkerStateEvent> getOnFailed()

getOnReady	back to summary
pack-priv final EventHandler<WorkerStateEvent> getOnReady()

getOnRunning	back to summary
pack-priv final EventHandler<WorkerStateEvent> getOnRunning()

getOnScheduled	back to summary
pack-priv final EventHandler<WorkerStateEvent> getOnScheduled()

getOnSucceeded	back to summary
pack-priv final EventHandler<WorkerStateEvent> getOnSucceeded()

onCancelledProperty	back to summary
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>> onCancelledProperty()

onFailedProperty	back to summary
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>> onFailedProperty()

onReadyProperty	back to summary
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>> onReadyProperty()

onRunningProperty	back to summary
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>> onRunningProperty()

onScheduledProperty	back to summary
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>> onScheduledProperty()

onSucceededProperty	back to summary
pack-priv final ObjectProperty<EventHandler<WorkerStateEvent>> onSucceededProperty()

removeEventFilter	back to summary
pack-priv final <T extends Event> void removeEventFilter(final EventType<T> eventType, final EventHandler<? super T> 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. 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

removeEventFilter

back to summary

pack-priv final <T extends Event> void removeEventFilter(final EventType<T> eventType, final EventHandler<? super T> 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.

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

removeEventHandler	back to summary
pack-priv final <T extends Event> void removeEventHandler(final EventType<T> eventType, final EventHandler<? super T> 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. 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

removeEventHandler

back to summary

pack-priv final <T extends Event> void removeEventHandler(final EventType<T> eventType, final EventHandler<? super T> 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.

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

setEventHandler	back to summary
pack-priv final <T extends Event> void setEventHandler(final EventType<T> eventType, final EventHandler<? super T> 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. 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

setEventHandler

back to summary

pack-priv final <T extends Event> void setEventHandler(final EventType<T> eventType, final EventHandler<? super T> 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.

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

setOnCancelled	back to summary
pack-priv final void setOnCancelled(EventHandler<WorkerStateEvent> value)

setOnFailed	back to summary
pack-priv final void setOnFailed(EventHandler<WorkerStateEvent> value)

setOnReady	back to summary
pack-priv final void setOnReady(EventHandler<WorkerStateEvent> value)

setOnRunning	back to summary
pack-priv final void setOnRunning(EventHandler<WorkerStateEvent> value)

setOnScheduled	back to summary
pack-priv final void setOnScheduled(EventHandler<WorkerStateEvent> value)

setOnSucceeded	back to summary
pack-priv final void setOnSucceeded(EventHandler<WorkerStateEvent> value)

pack-priv Class EventHelper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail