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.littemplate.
Class LitTemplate
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.littemplate.LitTemplate
-
All Implemented Interfaces:
AttachNotifier,DetachNotifier,HasElement,HasStyle,Template,Serializablepublic abstract class LitTemplate extends Component implements HasStyle, TemplateComponent which renders a LitElement template.
A LitElement template is defined in a JavaScript module which should be placed inside the frontend folder and loaded using
@JsModule. The tag name defined for the Lit template must be defined using@Tagon this class.By annotating a field using
@Idyou can map a@Componentinstance to an element in the template, marked with anidattribute which matches the field name or the optionally given value to the annotation.Note that injected components will have the same limitations as with
PolymerTemplate.For more information about the LitElement project, see https://lit-element.polymer-project.org/
Since:
Author:
Vaadin Ltd
See Also:
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedLitTemplate()Creates the component mapped to a LitElement.
protectedLitTemplate(LitTemplateParser parser, VaadinService service)Creates the component component mapped to a LitElement using the provided
parserandservice.
-
Method Summary
All Methods Modifier and Type Method Description Stream<Component>getChildren()Gets the child components of this component.
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, scrollIntoView, 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
-
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
-
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
-
-
-
-
Constructor Detail
-
LitTemplate
protected LitTemplate()Creates the component mapped to a LitElement.
The call is delegated to
LitTemplate(LitTemplateParser, VaadinService)viaVaadinService.getCurrent()as a service and parser created viaLitTemplateParser.LitTemplateParserFactoryretrieved fromInstantiator.
-
LitTemplate
protected LitTemplate(LitTemplateParser parser, VaadinService service)Creates the component component mapped to a LitElement using the provided
parserandservice.Parameters:
parser- a template parserservice- the related service instance
-
-
Method Detail
-
getChildren
public Stream<Component> getChildren()Gets the child components of this component.
The default implementation finds child components by traversing each child
Elementtree.If the component is injected to a PolymerTemplate using the
@Idannotation the getChildren method will only return children added from the server side and will not return any children declared in the template file.Please note that components defined using
@Idare not child components. Only components explicitly added through methods such asHasComponents.add(com.vaadin.flow.component.Component...)orNode.appendChild(Element...)are returned by this method.Overrides:
getChildrenin classComponentReturns:
the child components of this component
See Also:
-
-