Contact us
Create app
com.vaadin.flow.component.webcomponent.
Package com.vaadin.flow.component.webcomponent

Class EventOptions

java.lang.Object
com.vaadin.flow.component.webcomponent.EventOptions

All Implemented Interfaces:

Serializable

public class EventOptions extends Object implements Serializable

EventOptions is used to configure the custom event published by an exported web component.

Since:

2.0

Author:

Vaadin Ltd.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    EventOptions()

    Create EventOptions used to configure the custom event published by an exported web component.

    EventOptions(boolean bubbles)

    Create EventOptions used to configure the custom event published by an exported web component.

    EventOptions(boolean bubbles, boolean cancelable, boolean composed)

    Create EventOptions used to configure the custom event published by an exported web component.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isBubbles()

    Can the event bubbles up through the DOM or not.

    boolean
    isCancelable()

    Is the event is cancelable.

    boolean
    isComposed()

    Can the event bubble across the boundary between the shadow DOM and the regular DOM.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • EventOptions

      public EventOptions()

      Create EventOptions used to configure the custom event published by an exported web component.

      See Also:

    • EventOptions

      public EventOptions(boolean bubbles)

      Create EventOptions used to configure the custom event published by an exported web component.

      Parameters:

      bubbles - A Boolean indicating whether the event bubbles up through the DOM or not.

      See Also:

    • EventOptions

      public EventOptions(boolean bubbles, boolean cancelable, boolean composed)

      Create EventOptions used to configure the custom event published by an exported web component.

      Parameters:

      bubbles - indicates whether the event bubbles up through the DOM or not.

      cancelable - indicates whether the event is cancelable.

      composed - indicates whether or not the event can bubble across the boundary between the shadow DOM and the regular DOM.

      See Also:

  • Method Details

    • isBubbles

      public boolean isBubbles()

      Can the event bubbles up through the DOM or not.

      Returns:

      bubbles

    • isCancelable

      public boolean isCancelable()

      Is the event is cancelable.

      Returns:

      cancellable

    • isComposed

      public boolean isComposed()

      Can the event bubble across the boundary between the shadow DOM and the regular DOM.

      Returns:

      composed

Copyright © 2025. All rights reserved.