com.vaadin.flow.dom

Class DomEvent

java.lang.Object

java.util.EventObject

com.vaadin.flow.dom.DomEvent

All Implemented Interfaces:

Serializable

public class DomEvent
extends EventObject

Server-side representation of a DOM event fired in the browser.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
DomEvent(Element source, String eventType, elemental.json.JsonObject eventData) Creates a new DOM event.

Method Summary

Modifier and Type	Method and Description
elemental.json.JsonObject	getEventData() Gets additional data related to the event.
DebouncePhase	getPhase() Gets the debounce phase for which this event is fired.
Element	getSource()
String	getType() Gets the type of the event.

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DomEvent

public DomEvent(Element source,
                String eventType,
                elemental.json.JsonObject eventData)

Creates a new DOM event.

Parameters:

source - the element for which the event is fired, not null

eventType - the type of the event, not null

eventData - additional data related to the event, not null

Method Detail

getSource

public Element getSource()

Overrides:

getSource in class EventObject

getType

public String getType()

Gets the type of the event.

Returns:

the type of the event

getEventData

public elemental.json.JsonObject getEventData()

Gets additional data related to the event. An empty JSON object is returned if no event data is available.

Returns:

a JSON object containing event data, never null

See Also:

DomListenerRegistration.addEventData(String)

getPhase

public DebouncePhase getPhase()

Gets the debounce phase for which this event is fired. This is used internally to only deliver the event to the appropriate listener in cases where there are multiple listeners for the same event with different debounce settings.

Returns:

the debounce phase