com.vaadin.flow.component.polymertemplate

Class PolymerTemplate<M extends TemplateModel>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.polymertemplate.AbstractTemplate<M>

com.vaadin.flow.component.polymertemplate.PolymerTemplate<M>

Type Parameters:

M - a model class that will be used for template data propagation

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, Serializable

public abstract class PolymerTemplate<M extends TemplateModel>
extends AbstractTemplate<M>

Component for an HTML element declared as a polymer component. The HTML markup should be loaded using the @HtmlImport annotation and the components should be associated with the web component element using the @Tag annotation.

You may use Id annotation inside your template class for a field to reference an element inside your template via id attribute value. Note that the injected element will have functional limitations on the server side.

Since:

1.0

Author:

Vaadin Ltd

See Also:

HtmlImport, Tag, Id, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	PolymerTemplate() Creates the component that is responsible for Polymer template functionality.
	PolymerTemplate(TemplateParser parser) Creates the component that is responsible for Polymer template functionality using the provided parser.
protected	PolymerTemplate(TemplateParser parser, VaadinService service) Creates the component that is responsible for Polymer template functionality using the provided parser.

Method Summary

Modifier and Type	Method and Description
Stream<Component>	getChildren() Gets the child components of this component.
protected M	getModel() Returns the model of this template.
ModelType	getModelType(Type type) Get the ModelType for given class.
boolean	isSupportedClass(Class<?> type) Check if the given Class type is found in the Model.

Methods inherited from class com.vaadin.flow.component.polymertemplate.AbstractTemplate

getModelType, getStateNode

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, 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

PolymerTemplate

public PolymerTemplate(TemplateParser parser)

Creates the component that is responsible for Polymer template functionality using the provided parser.

Parameters:

parser - a template parser

PolymerTemplate

protected PolymerTemplate(TemplateParser parser,
                          VaadinService service)

Creates the component that is responsible for Polymer template functionality using the provided parser.

Parameters:

parser - a template parser

service - the related service instance

PolymerTemplate

public PolymerTemplate()

Creates the component that is responsible for Polymer template functionality.

Method Detail

isSupportedClass

public boolean isSupportedClass(Class<?> type)

Check if the given Class type is found in the Model.

Parameters:

type - Class to check support for

Returns:

True if supported by this PolymerTemplate

getModelType

public ModelType getModelType(Type type)

Get the ModelType for given class.

Parameters:

type - Type to get the ModelType for

Returns:

ModelType for given Type

getModel

protected M getModel()

Description copied from class: AbstractTemplate

Returns the model of this template.

The type of the model will be the type that this method returns in the instance it is invoked on - meaning that you should override this method and return your own model type.

Specified by:

getModel in class AbstractTemplate<M extends TemplateModel>

Returns:

the model of this template

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 since they are attached inside the Shadow DOM. 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