We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.webcomponent.
Class WebComponentUI.WebComponentConnectEvent
java.lang.Object
java.util.EventObject
com.vaadin.flow.component.ComponentEvent<UI>
com.vaadin.flow.component.webcomponent.WebComponentUI.WebComponentConnectEvent
All Implemented Interfaces:
Enclosing class:
@DomEvent("connect-web-component")
public static class WebComponentUI.WebComponentConnectEvent
extends ComponentEvent<UI>
Event used for sending the activation event for an exported web component from the client to the server.
See Also:
-
Field Summary
Fields inherited from class java.util.EventObject
source -
Constructor Summary
ConstructorsConstructorDescriptionWebComponentConnectEvent(UI source, boolean fromClient, String tag, String webComponentElementId, String userAssignedId, elemental.json.JsonObject attributeValues) Creates a new web component connection event.
-
Method Summary
Modifier and TypeMethodDescriptionelemental.json.JsonObjectGets the initial attribute values.
getTag()Gets the tag of the element to connect.
Gets the id of the web component.
Gets the user-assigned id of the web component.
Methods inherited from class com.vaadin.flow.component.ComponentEvent
getSource, isFromClient, unregisterListenerMethods inherited from class java.util.EventObject
toString
-
Constructor Details
-
WebComponentConnectEvent
public WebComponentConnectEvent(UI source, boolean fromClient, @EventData("tag") String tag, @EventData("id") String webComponentElementId, @EventData("userAssignedId") String userAssignedId, @EventData("attributeValues") elemental.json.JsonObject attributeValues) Creates a new web component connection event.
Parameters:
source- the component that was attachedfromClient-trueif the event was originally fired on the client,falseif the event originates from server-side logictag- the tag of the element to connectwebComponentElementId- the id of the embedded web componentuserAssignedId- the id user might have set on the embedding web component elementattributeValues- initial attribute values as a JsonObject. If present, these will override the default value designated by theWebComponentExporterbut only for this instance.
-
-
Method Details
-
getTag
Gets the tag of the element to connect.
Returns:
the tag of the element
-
getWebComponentElementId
Gets the id of the web component.
Returns:
the id of the web component
-
getWebComponentUserAssignedId
Gets the user-assigned id of the web component.
Returns:
user-assigned id
-
getAttributeJson
public elemental.json.JsonObject getAttributeJson()Gets the initial attribute values.
Returns:
the initial attribute values
-