Package com.storedobject.ui

Class ObjectTemplate<T>

java.lang.Object

com.vaadin.flow.component.Component

com.storedobject.ui.util.HtmlTemplate

com.storedobject.ui.TemplateLayout

com.storedobject.ui.TemplateComponent

com.storedobject.ui.ObjectTemplate<T>

Type Parameters:

T - The type of data this template can manage.

All Implemented Interfaces:

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

Direct Known Subclasses:

Dashboard, ObjectCardTemplate

public class ObjectTemplate<T>
extends TemplateComponent

A template-based component for displaying and managing an object and its associated objects in a UI.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.ui.util.HtmlTemplate

HtmlTemplate.ComponentCreator, HtmlTemplate.StreamSupplier, HtmlTemplate.StyleSupplier

Field Summary

Fields

Modifier and Type	Field	Description
protected T	object	Current value of the object.
protected final Class<T>	objectClass	The type of data this template is managing.

Constructor Summary

Constructors

Constructor	Description
ObjectTemplate(Class<T> objectClass, String templateCode)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected com.vaadin.flow.component.Component	createComponentForId(String id, String tag)	Creates a Component for the given identifier and tag.
final T	getObject()	Retrieves the stored object of type T.
final Class<T>	getObjectClass()	Retrieves the class type of the object managed by this template.
void	paint(T object)	This method is called whenever the object is set.
final void	setObject(T object)	Sets the object and paint the component according to the object's attributes.

Methods inherited from class com.storedobject.ui.TemplateLayout

center

Methods inherited from class com.storedobject.ui.util.HtmlTemplate

build, clearCache, createComponentForId, createSvgForId, isCreated, onAttach, setComponentCreator, setView

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.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

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

Field Details

objectClass

protected final Class<T> objectClass

The type of data this template is managing.

object

protected T object

Current value of the object.

Constructor Details

ObjectTemplate

public ObjectTemplate(Class<T> objectClass,
 String templateCode)

Constructor.

Parameters:

templateCode - Template containing HTML and CSS (within style tag).

Method Details

setObject

public final void setObject(T object)

Sets the object and paint the component according to the object's attributes.

Parameters:

object - the object to be stored may be null.

paint

public void paint(T object)

This method is called whenever the object is set. Typically, this method is overridden by subclasses to provide custom painting logic.

Parameters:

object - Object to be painted.

getObject

public final T getObject()

Retrieves the stored object of type T.

Returns:

the object of type T contained in this instance, or null if no object is set.

getObjectClass

public final Class<T> getObjectClass()

Retrieves the class type of the object managed by this template.

Returns:

the Class instance representing the type parameter T.

createComponentForId

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

Description copied from class: HtmlTemplate

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.

Overrides:

createComponentForId in class HtmlTemplate

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.