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	Represents a functional interface that provides methods for creating components and SVG elements based on unique identifiers or tags.
static interface	HtmlTemplate.StreamSupplier	Callback for creating an input stream on demand.
static interface	HtmlTemplate.StyleSupplier	Represents a supplier functional interface for providing style information.

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()	Build the template.
static void	clearCache()	Clears the cache used by the HTML template parser.
protected com.vaadin.flow.component.Component	createComponentForId(String id)	Creates a Component for the given identifier.
protected com.vaadin.flow.component.Component	createComponentForId(String id, String tag)	Creates a Component for the given identifier and tag.
protected com.vaadin.flow.component.Svg	createSvgForId(String id)	Creates an SVG element for the given identifier.
boolean	isCreated()	Checks whether the HTML template has been successfully created.
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	setComponentCreator(HtmlTemplate.ComponentCreator componentCreator)	Sets the ComponentCreator that will be used to create components for specific IDs within the HTML template.
void	setView(Object view)	Sets the view object for the current template.

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()

Build the template. This method is called automatically when the template is attached to the UI.

isCreated

public boolean isCreated()

Checks whether the HTML template has been successfully created.

Returns:

true if the template has been created, false otherwise

setView

public void setView(Object view)

Sets the view object for the current template.

Parameters:

view - the view object to be associated with this template

setComponentCreator

public void setComponentCreator(HtmlTemplate.ComponentCreator componentCreator)

Sets the ComponentCreator that will be used to create components for specific IDs within the HTML template.

Parameters:

componentCreator - the ComponentCreator instance responsible for creating components for specified IDs

createComponentForId

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

Creates a Component for the given identifier. If a ComponentCreator is set, the creation is delegated to it. Otherwise, a default ISpan instance is created with the ID embedded in its text.

Parameters:

id - The identifier for which the Component is to be created.

Returns:

The created Component, either provided by the ComponentCreator or an instance of ISpan with the given ID.

createSvgForId

protected com.vaadin.flow.component.Svg createSvgForId(String id)

Creates an SVG element for the given identifier. If a ComponentCreator is set, the creation is delegated to it. Otherwise, null is returned.

Parameters:

id - The identifier for which to create the Svg element.

Returns:

The created Svg element if a ComponentCreator is present, or null if no ComponentCreator is set or unable to handle the request.

createComponentForId

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

Creates a Component for the given identifier and tag. If a ComponentCreator is available, it delegates the creation process. If no component is created by the ComponentCreator or if the result is null or an ISpan, additional logic is applied to create an appropriate component.

Parameters:

id - The identifier for which the Component is to be created.

tag - The HTML tag used to infer the type of Component to create.

Returns:

The created Component. If no specific component can be created, an Html object based on the given tag and identifier is returned.

clearCache

public static void clearCache()

Clears the cache used by the HTML template parser. This method removes all cached entries within the `parserCache`, ensuring that subsequent parsing operations start with an empty cache. It is typically invoked to force the system to reparse and refresh template data without relying on previously cached results.