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 WebComponentWrapper
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.webcomponent.WebComponentWrapper
-
All Implemented Interfaces:
public class WebComponentWrapper extends ComponentWrapper component for a web component that exposes
ClientCallablemethods that the client-side components expect to be available.Since:
2.0
Author:
Vaadin Ltd.
See Also:
-
-
Constructor Summary
Constructors Modifier Constructor and Description WebComponentWrapper(Element rootElement, WebComponentBinding<?> binding)Wrapper class for the server side WebComponent.
protectedWebComponentWrapper(Element rootElement, WebComponentBinding<?> binding, List<Element> bootstrapElements)Wrapper class for the server side WebComponent.
-
Method Summary
All Methods Modifier and Type Method and Description voiddisconnected()A WebComponent disconnected from the dom will be scheduled for cleaning if it doesn't get reconnected before times up.
voidreconnect()Cancel cleanup for a disconnected component.
voidsync(String property, elemental.json.JsonValue newValue)Synchronize method for client side to send property value updates to the server.
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
-
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
-
-
-
-
Constructor Detail
-
WebComponentWrapper
public WebComponentWrapper(Element rootElement, WebComponentBinding<?> binding)Wrapper class for the server side WebComponent.
Parameters:
rootElement-Elementto which theWebComponentWrapperis bound to.binding- binding that offers methods for delivering property updates to thecomponentbeing wrapped byWebComponentWrapper
-
WebComponentWrapper
protected WebComponentWrapper(Element rootElement, WebComponentBinding<?> binding, List<Element> bootstrapElements)Wrapper class for the server side WebComponent.
Parameters:
rootElement-Elementto which theWebComponentWrapperis bound to.binding- binding that offers methods for delivering property updates to thecomponentbeing wrapped byWebComponentWrapperbootstrapElements- elements that should be added to the shadow dom of therootElement. These are copies of the original elements and the copies are created byWebComponentConfigurationRegistry
-
-
Method Detail
-
sync
@ClientCallable public void sync(String property, elemental.json.JsonValue newValue)Synchronize method for client side to send property value updates to the server.
Parameters:
property- property name to updatenewValue- the new value to set
-
reconnect
@ClientCallable public void reconnect()Cancel cleanup for a disconnected component.
-
disconnected
@ClientCallable public void disconnected()A WebComponent disconnected from the dom will be scheduled for cleaning if it doesn't get reconnected before times up.
-
-