Module VirtualizedFX

Package io.github.palexdev.virtualizedfx.controls.behavior.actions

Class EventAction<E extends Event>

java.lang.Object

io.github.palexdev.virtualizedfx.controls.behavior.actions.EventAction<E>

All Implemented Interfaces:

DisposableAction

public class EventAction<E extends Event>
extends Object
implements DisposableAction

An EventAction is a convenience bean which implements DisposableAction used by BehaviorBase to register an EventHandler on a certain Node for a certain EventType, and dispose it once it's not needed anymore.

This bean also has a boolean flag to indicate whether this should be registered as a handler or a filter.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isFilter

Constructor Summary

Constructors

Constructor	Description
EventAction(Node node, EventType<E> eventType, EventHandler<E> handler)
EventAction(Node node, EventType<E> eventType, EventHandler<E> handler, boolean isFilter)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Disposes this action.
static <E extends Event> EventAction<E>	filter(Node node, EventType<E> et, EventHandler<E> handler)	Equivalent to EventAction(Node, EventType, EventHandler, boolean) but this also registers the action on the node already.
EventType<E>	getEventType()
EventHandler<E>	getHandler()
Node	getNode()
static <E extends Event> EventAction<E>	handler(Node node, EventType<E> et, EventHandler<E> handler)	Equivalent to EventAction(Node, EventType, EventHandler) but this also registers the action on the node already.
boolean	isFilter()

Methods inherited from class java.lang.Object

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

Field Details

isFilter

protected boolean isFilter

Constructor Details

EventAction

public EventAction(Node node,
 EventType<E> eventType,
 EventHandler<E> handler)

EventAction

public EventAction(Node node,
 EventType<E> eventType,
 EventHandler<E> handler,
 boolean isFilter)

Method Details

handler

public static <E extends Event> EventAction<E> handler(Node node,
 EventType<E> et,
 EventHandler<E> handler)

Equivalent to EventAction(Node, EventType, EventHandler) but this also registers the action on the node already.

filter

public static <E extends Event> EventAction<E> filter(Node node,
 EventType<E> et,
 EventHandler<E> handler)

Equivalent to EventAction(Node, EventType, EventHandler, boolean) but this also registers the action on the node already.

dispose

public void dispose()

Disposes this action.

Removes the handler from the node, then sets all the fields to null.

Specified by:

dispose in interface DisposableAction

getNode

public Node getNode()

getEventType

public EventType<E> getEventType()

getHandler

public EventHandler<E> getHandler()

isFilter

public boolean isFilter()