com.vaadin.flow.component.
Annotation Type DomEvent
-
@Retention(value=RUNTIME) @Target(value=TYPE) @Documented @Inherited public @interface DomEvent
Maps a DOM event to a
ComponentEvent
.Marking a
ComponentEvent
class with @DomEvent
will cause theComponentEvent
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 aComponentEvent
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, com.vaadin.flow.dom.DomEventListener, String...)
- The first parameter must be the event source, a
-
-
Required Element Summary
Required Elements Modifier and Type Required Element and 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 and 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.
-
-
-
Element Detail
-
value
public abstract String value
The name of the DOM event which should fire the annotated component event.
Returns:
the name of the DOM event
-
-
-
allowUpdates
public abstract 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:
com.vaadin.flow.dom.DisabledUpdateMode.ONLY_WHEN_ENABLED
-
-
-
filter
public abstract 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:
Default:
""
-
-
-
debounce
public abstract DebounceSettings debounce
The debounce settings to use with this event. By default, debounce is not used.
Returns:
the debounce settings
See Also:
Default:
@com.vaadin.flow.component.DebounceSettings(timeout=0, phases=com.vaadin.flow.dom.DebouncePhase.LEADING)
-
-