Package com.storedobject.ui.util

Class HtmlTemplate

java.lang.Object

com.vaadin.flow.component.Component

com.storedobject.ui.util.HtmlTemplate

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, Serializable

Direct Known Subclasses:

TemplateLayout

@Tag("div")
public abstract class HtmlTemplate
extends com.vaadin.flow.component.Component

Abstract base class for a component that is initialized based on the contents of an HTML template. The HTML content is read to create a server-side Element tree. For instance fields marked with @Id, an element with the corresponding id attribute value is identified, upgraded to a component of the type defined by the field and the component instance is set as the field value. However, it is possible to custom-create the component instance by overriding the createComponentForId(String) or createComponentForId(String, String) method.

Author:

Leif Åstrand (Vaadin Ltd.). Enhanced by Syam.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HtmlTemplate.ComponentCreator
static interface	HtmlTemplate.StreamSupplier	Callback for creating an input stream on demand.
static interface	HtmlTemplate.StyleSupplier

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HtmlTemplate()	Creates a new HTML template based on the content of the TextContent that has the same name of this class.
protected	HtmlTemplate(TextContent tc)	Creates a new HTML template based on the content of the TextContent provided.
protected	HtmlTemplate(String textContentName)	Creates a new HTML template based on the content of the TextContent provided.
protected	HtmlTemplate(String cacheKey, HtmlTemplate.StreamSupplier streamSupplier)	Creates a new HTML template based on HTML read from an input stream.
protected	HtmlTemplate(String cacheKey, HtmlTemplate.StreamSupplier streamSupplier, HtmlTemplate.StyleSupplier styleSupplier)	Creates a new HTML template based on HTML read from an input stream.
protected	HtmlTemplate(Supplier<String> contentSupplier)	Creates a new HTML template based on the content provided by a supplier.

Method Summary

Modifier and Type	Method	Description
void	build()
static void	clearCache()
protected com.vaadin.flow.component.Component	createComponentForId(String id)
protected com.vaadin.flow.component.Component	createComponentForId(String id, String tag)
boolean	isCreated()
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	setComponentCreator(HtmlTemplate.ComponentCreator componentCreator)
void	setView(Object view)

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

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, 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.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Details

HtmlTemplate

protected HtmlTemplate()

Creates a new HTML template based on the content of the TextContent that has the same name of this class.

HtmlTemplate

protected HtmlTemplate(TextContent tc)

Creates a new HTML template based on the content of the TextContent provided.

Parameters:

tc - Text content.

HtmlTemplate

protected HtmlTemplate(String textContentName)

Creates a new HTML template based on the content of the TextContent provided.

Parameters:

textContentName - Text content name.

HtmlTemplate

protected HtmlTemplate(Supplier<String> contentSupplier)

Creates a new HTML template based on the content provided by a supplier.

Parameters:

contentSupplier - Content supplier.

HtmlTemplate

protected HtmlTemplate(String cacheKey,
 HtmlTemplate.StreamSupplier streamSupplier)

Creates a new HTML template based on HTML read from an input stream.

Parameters:

cacheKey - the key to use for potentially caching the result of reading and parsing the template, or null never cache the result

streamSupplier - an input stream supplier that will be used if caching isn't used or if there is a cache miss, not null

HtmlTemplate

protected HtmlTemplate(String cacheKey,
 HtmlTemplate.StreamSupplier streamSupplier,
 HtmlTemplate.StyleSupplier styleSupplier)

Creates a new HTML template based on HTML read from an input stream.

Parameters:

cacheKey - the key to use for potentially caching the result of reading and parsing the template, or null never cache the result

streamSupplier - an input stream supplier that will be used if caching isn't used or if there is a cache miss, not null

Method Details

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

build

public void build()

isCreated

public boolean isCreated()

setView

public void setView(Object view)

setComponentCreator

public void setComponentCreator(HtmlTemplate.ComponentCreator componentCreator)

createComponentForId

protected com.vaadin.flow.component.Component createComponentForId(String id)

createComponentForId

protected com.vaadin.flow.component.Component createComponentForId(String id,
 String tag)

clearCache

public static void clearCache()