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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EventOptions()
CreateEventOptions
used to configure the custom event published by an exported web component.EventOptions(boolean bubbles)
CreateEventOptions
used to configure the custom event published by an exported web component.EventOptions(boolean bubbles, boolean cancelable, boolean composed)
CreateEventOptions
used to configure the custom event published by an exported web component.
-
Method Summary
All Methods Instance Methods Concrete Methods 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.
-
-
-
Constructor Detail
-
EventOptions
public EventOptions()
CreateEventOptions
used to configure the custom event published by an exported web component.- See Also:
for all properties
,for exporting web components
-
EventOptions
public EventOptions(boolean bubbles)
CreateEventOptions
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:
for all properties
,for exporting web components
-
EventOptions
public EventOptions(boolean bubbles, boolean cancelable, boolean composed)
CreateEventOptions
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:
for exporting web components
-
-
Method Detail
-
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
-
-