Package 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, Serializable

public abstract class LitTemplate
extends Component
implements HasStyle, Template

Component 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 @Tag on this class.

By annotating a field using @Id you can map a @Component instance to an element in the template, marked with an id attribute 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:

• JsModule
• Tag
• Id
• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LitTemplate()	Creates the component mapped to a LitElement.
protected	LitTemplate(LitTemplateParser parser, VaadinService service)	Creates the component component mapped to a LitElement using the provided parser and service.

Method Summary

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, findAncestor, fireEvent, from, get, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, 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 Details

LitTemplate

protected LitTemplate()

Creates the component mapped to a LitElement.

The call is delegated to LitTemplate(LitTemplateParser, VaadinService) via VaadinService.getCurrent() as a service and parser created via LitTemplateParser.LitTemplateParserFactory retrieved from Instantiator.

See Also:

• LitTemplate(LitTemplateParser, VaadinService)
• VaadinService
• LitTemplateParser.LitTemplateParserFactory
• Instantiator
• Instantiator.getOrCreate(Class)

LitTemplate

protected LitTemplate(LitTemplateParser parser,
 VaadinService service)

Creates the component component mapped to a LitElement using the provided parser and service.

Parameters:

parser - a template parser

service - the related service instance

Method Details

getChildren

public Stream<Component> getChildren()

Gets the child components of this component.

The default implementation finds child components by traversing each child Element tree.

If the component is injected to a PolymerTemplate using the @Id annotation 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 @Id are not child components. Only components explicitly added through methods such as HasComponents.add(com.vaadin.flow.component.Component...) or Node.appendChild(Element...) are returned by this method.

Overrides:

getChildren in class Component

Returns:

the child components of this component

See Also:

• Id