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:
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    The name of the DOM event which should fire the annotated component event.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Controls RPC for the listener when the element is disabled.
    The debounce settings to use with this event.
    The filter expression to run in the browser to determine whether fired events should be passed to the server.