java.lang.Object
java.util.EventObject
javafx.event.Event
- All Implemented Interfaces:
Serializable
,Cloneable
- Direct Known Subclasses:
ActionEvent
,CheckBoxTreeItem.TreeModificationEvent
,DialogEvent
,InputEvent
,ListView.EditEvent
,MediaErrorEvent
,ScrollToEvent
,SortEvent
,TableColumn.CellEditEvent
,TransformChangedEvent
,TreeItem.TreeModificationEvent
,TreeTableColumn.CellEditEvent
,TreeTableView.EditEvent
,TreeView.EditEvent
,WebErrorEvent
,WebEvent
,WindowEvent
,WorkerStateEvent
public class Event extends EventObject implements Cloneable
Base class for FX events. Each FX event has associated an event source,
event target and an event type. The event source specifies for an event
handler the object on which that handler has been registered and which sent
the event to it. The event target defines the path through which the event
will travel when posted. The event type provides additional classification
to events of the same
Event
class.- Since:
- JavaFX 2.0
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description static EventType<Event>
ANY
Common supertype for all event types.protected boolean
consumed
Whether this event has been consumed by any filter or handler.protected EventType<? extends Event>
eventType
Type of the event.static EventTarget
NULL_SOURCE_TARGET
The constant which represents an unknown event source / target.protected EventTarget
target
Event target that defines the path through which the event will travel when posted.Fields inherited from class java.util.EventObject
source
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description Object
clone()
Creates and returns a copy of thisEvent
.void
consume()
Marks thisEvent
as consumed.Event
copyFor(Object newSource, EventTarget newTarget)
Creates and returns a copy of this event with the specified event source and target.static void
fireEvent(EventTarget eventTarget, Event event)
Fires the specified event.EventType<? extends Event>
getEventType()
Gets the event type of this event.EventTarget
getTarget()
Returns the event target of this event.boolean
isConsumed()
Indicates whether thisEvent
has been consumed by any filter or handler.Methods inherited from class java.util.EventObject
getSource, toString
-
Field Details
-
NULL_SOURCE_TARGET
The constant which represents an unknown event source / target. -
ANY
Common supertype for all event types. -
eventType
Type of the event. -
target
Event target that defines the path through which the event will travel when posted. -
consumed
protected boolean consumedWhether this event has been consumed by any filter or handler.
-
-
Constructor Details
-
Event
Construct a newEvent
with the specified event type. The source and target of the event is set toNULL_SOURCE_TARGET
.- Parameters:
eventType
- the event type
-
Event
Construct a newEvent
with the specified event source, target and type. If the source or target is set tonull
, it is replaced by theNULL_SOURCE_TARGET
value.- Parameters:
source
- the event source which sent the eventtarget
- the event target to associate with the eventeventType
- the event type
-
-
Method Details
-
getTarget
Returns the event target of this event. The event target specifies the path through which the event will travel when posted.- Returns:
- the event target
-
getEventType
Gets the event type of this event. Objects of the sameEvent
class can have different event types. These event types further specify what kind of event occurred.- Returns:
- the event type
-
copyFor
Creates and returns a copy of this event with the specified event source and target. If the source or target is set tonull
, it is replaced by theNULL_SOURCE_TARGET
value.- Parameters:
newSource
- the new source of the copied eventnewTarget
- the new target of the copied event- Returns:
- the event copy with the new source and target
-
isConsumed
public boolean isConsumed()Indicates whether thisEvent
has been consumed by any filter or handler.- Returns:
true
if thisEvent
has been consumed,false
otherwise
-
consume
public void consume()Marks thisEvent
as consumed. This stops its further propagation. -
clone
Creates and returns a copy of thisEvent
. -
fireEvent
Fires the specified event. The given event target specifies the path through which the event will travel.- Parameters:
eventTarget
- the target for the eventevent
- the event to fire- Throws:
NullPointerException
- if eventTarget or event is null
-