Package com.vaadin.flow.component

Annotation Interface DomEvent

@Retention(RUNTIME)
@Target(TYPE)
@Documented
@Inherited
public @interface DomEvent

Maps a DOM event to a ComponentEvent.

Marking a ComponentEvent class with @DomEvent will cause the ComponentEvent to be fired whenever the DOM event occurs.

A ComponentEvent class mapped with @DomEvent must have a special constructor which is invoked by the framework when creating and firing a ComponentEvent based on a DOM event.

• The first parameter must be the event source, a Component.
• The second parameter must be a boolean, indicating whether the event originated from the client (always true when fired based on a DOM event)
• Any additional parameters must be annotated using @EventData, telling the framework which part of the DOM event data object to map to the parameter.

Since:

1.0

Author:

Vaadin Ltd

See Also:

• EventData
• Element.addEventListener(String, DomEventListener)

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	value	The name of the DOM event which should fire the annotated component event.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
DisabledUpdateMode	allowUpdates	Controls RPC for the listener when the element is disabled.
DebounceSettings	debounce	The debounce settings to use with this event.
String	filter	The filter expression to run in the browser to determine whether fired events should be passed to the server.
boolean	preventDefault	Controls if the browser is asked to prevent the default browser behavior.
boolean	stopPropagation	Controls if the event is let to propagate to parent elements.

Element Details

value

String value

The name of the DOM event which should fire the annotated component event.

Returns:

the name of the DOM event

allowUpdates

DisabledUpdateMode allowUpdates

Controls RPC for the listener when the element is disabled.

Returns:

the property update mode for disabled element

See Also:

• DomListenerRegistration.setDisabledUpdateMode(DisabledUpdateMode)

Default:

ONLY_WHEN_ENABLED

filter

String filter

The filter expression to run in the browser to determine whether fired events should be passed to the server.

Returns:

the filter expression to use, or empty string to not use any filtering

See Also:

• DomListenerRegistration.setFilter(String)

Default:

""

debounce

DebounceSettings debounce

The debounce settings to use with this event. By default, debounce is not used.

Returns:

the debounce settings

See Also:

• DomListenerRegistration.debounce(int, com.vaadin.flow.dom.DebouncePhase, com.vaadin.flow.dom.DebouncePhase...)

Default:

@com.vaadin.flow.component.DebounceSettings(timeout=0, phases={LEADING})

stopPropagation

boolean stopPropagation

Controls if the event is let to propagate to parent elements.

Returns:

true if the event is not let to propagate to parent elements

Default:

false

preventDefault

boolean preventDefault

Controls if the browser is asked to prevent the default browser behavior.

Returns:

true if default behavior is should be prevented

Default:

false