Package com.storedobject.ui

Class ObjectCardDashboard<T extends StoredObject>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.HtmlComponent

com.vaadin.flow.component.HtmlContainer

com.vaadin.flow.component.html.Div

com.storedobject.ui.ScrollingContent

com.storedobject.ui.CardDashboard

com.storedobject.ui.ObjectCardDashboard<T>

Type Parameters:

T - The type of objects managed by this dashboard. It must extend StoredObject.

All Implemented Interfaces:

FilterMethods<T>, ObjectLoader<T>, ObjectLoader<T>, ClickHandler, CloseableView, ExecutableView, ValueChangeHandler, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.html.Div>, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<? extends com.vaadin.flow.component.Component>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, com.vaadin.flow.component.HasValue.ValueChangeListener, Serializable, Runnable, EventListener

public class ObjectCardDashboard<T extends StoredObject>
extends CardDashboard
implements ObjectLoader<T>

A specialized dashboard for managing and displaying cards representing objects of a specific type. This class extends the functionality of CardDashboard and integrates with an ObjectLoader for loading and managing lists of objects of type T.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.storedobject.vaadin.ClickHandler

ClickHandler.ModifiedClickEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

com.vaadin.flow.component.HasText.WhiteSpace

Constructor Summary

Constructors

Constructor	Description
ObjectCardDashboard(Class<T> objectClass)	Constructs an ObjectCardDashboard instance to manage and display object cards.
ObjectCardDashboard(Class<T> objectClass, boolean allowAny)	Constructs a new ObjectCardDashboard instance for managing object-specific cards within the dashboard.
ObjectCardDashboard(String className)	Constructs an instance of ObjectCardDashboard using the class name provided.

Method Summary

Modifier and Type	Method	Description
void	cardLoaded(T object)	Notifies the dashboard that a single object card has been successfully loaded.
void	cardsLoaded()	Indicates that all the cards have been successfully loaded into the dashboard.
void	clear()	Clear - remove all entries.
protected ObjectCard<T>	createCard(T object)	Creates an ObjectCard instance for the specified object, adds a visual representation of the object to the card, and returns the created card.
final ObjectLoader<T>	getDelegatedLoader()
ObjectCardGrid<T>	getGrid()	Retrieves the ObjectCardGrid associated with this dashboard.
List<T>	getList()	Retrieves the list of objects managed by the loader.
Class<T>	getObjectClass()	The class of the instances.
void	refresh()	Refresh the dashboard
void	refresh(T object)	Refreshes the state of the specified object in the dashboard.
void	reload()	Refresh the dashboard by reloading all objects and updating cards.
void	reload(T object)	Refreshes the state of the specified object in the dashboard.
void	setCardCreator(Function<T,ObjectCard<T>> cardCreator)	Sets the card creator function for dynamically generating ObjectCard instances based on objects of type T.

Methods inherited from class com.storedobject.ui.CardDashboard

execute, getCaption, getView, setCaption

Methods inherited from class com.storedobject.ui.ScrollingContent

getContent, getHeader, getMargin, setContent, setHeader, setHeaderHeight, setMargin

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

getTitle, setTitle

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, 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.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

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

addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

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

addDetachListener

Methods inherited from interface com.storedobject.vaadin.ExecutableView

abort, clean, clearAlerts, clicked, close, createMenuItem, error, execute, getApplication, getMenuIconName, getMenuItem, getView, invoke, isCloseable, isFullScreen, isHomeView, log, log, message, returnedFrom, run, setClickable, speak, trackValueChange, tray, valueChanged, warning

Methods inherited from interface com.storedobject.core.FilterMethods

getFilterCondition, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setLoadFilter, setViewFilter, setViewFilter

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

add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

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

getElement

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

isEnabled, setEnabled

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

getChildren, getComponentAt, getComponentCount, indexOf, replace

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

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

getText, getWhiteSpace, setText, setWhiteSpace

Methods inherited from interface com.storedobject.core.ObjectLoader

applyFilter, canContain, getAllowAny, getLinkType, getMaster, getOrderBy, isAllowAny, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, setLinkType, setLinkType, setMaster, setMaster, setOrderBy, setOrderBy

Methods inherited from interface com.storedobject.ui.ObjectLoader

addDataLoadedListener, applyFilterPredicate, clear, get, getCacheLevel, getEffectiveCondition, getFixedFilter, getLoadFilter, getObjectCount, indexOf, load, setExtraFilter, setExtraFilter, setFilter, setFilter, setFixedFilter, setFixedFilter, setFixedFilter, setFixedFilter, size, streamAll, streamFiltered

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Constructor Details

ObjectCardDashboard

public ObjectCardDashboard(Class<T> objectClass)

Constructs an ObjectCardDashboard instance to manage and display object cards.

Parameters:

objectClass - The class type of the objects that will be represented and managed on the dashboard.

ObjectCardDashboard

public ObjectCardDashboard(Class<T> objectClass,
 boolean allowAny)

Constructs a new ObjectCardDashboard instance for managing object-specific cards within the dashboard. This constructor initializes the dashboard based on the provided object class by dynamically creating card instances and managing their lifecycle using an associated loader.

Parameters:

objectClass - The class of the objects this dashboard will manage. Used for dynamically resolving the object type and creating corresponding cards.

allowAny - Determines if the dashboard should allow managing any inherited object of the specified type.

ObjectCardDashboard

public ObjectCardDashboard(String className)
                    throws Exception

Constructs an instance of ObjectCardDashboard using the class name provided. The constructor initializes the dashboard by determining the class type from the given name, sets up the object loader, and loads the necessary data.

Parameters:

className - The name of the class to be used for creating the object cards. The class name may end with "/any" to allow additional flexibility for specifying the inherited object type.

Throws:

Exception - If an error occurs during class loading or initialization.

Method Details

cardsLoaded

public void cardsLoaded()

Indicates that all the cards have been successfully loaded into the dashboard. This method is typically called once the card-loading process is complete, ensuring that the dashboard and its associated components are properly updated to reflect the current state of the loaded data. It can be used to perform any post-loading operations required for maintaining the integrity of the dashboard's structure and visual presentation.

cardLoaded

public void cardLoaded(T object)

Notifies the dashboard that a single object card has been successfully loaded. This method handles actions related to the loading of an individual object card and may trigger other lifecycle updates in the dashboard.

Parameters:

object - The object whose card has been loaded and is ready to be added or displayed in the dashboard.

setCardCreator

public void setCardCreator(Function<T,ObjectCard<T>> cardCreator)

Sets the card creator function for dynamically generating ObjectCard instances based on objects of type T. The dashboard uses the provided function internally to create and manage object-specific cards.

Parameters:

cardCreator - A Function that takes an object of type T as input and returns an ObjectCard<T> instance. This function facilitates the custom generation of cards for objects managed in the dashboard.

createCard

protected ObjectCard<T> createCard(T object)

Creates an ObjectCard instance for the specified object, adds a visual representation of the object to the card, and returns the created card.

Parameters:

object - the object of type T for which the card is to be created. The object is used to generate a displayable representation within the card.

Returns:

an instance of ObjectCard<T> containing the visual representation of the provided object.

getObjectClass

public Class<T> getObjectClass()

Description copied from interface: ObjectLoader

The class of the instances.

Specified by:

getObjectClass in interface ObjectLoader<T extends StoredObject>

Returns:

The class of the instances to load.

getList

public List<T> getList()

Retrieves the list of objects managed by the loader.

Returns:

a List<T> containing the objects managed by this dashboard.

clear

public void clear()

Description copied from interface: ObjectLoader

Clear - remove all entries.

Specified by:

clear in interface ObjectLoader<T extends StoredObject>

reload

public void reload()

Refresh the dashboard by reloading all objects and updating cards.

Specified by:

reload in interface ObjectLoader<T extends StoredObject>

reload

public void reload(T object)

Refreshes the state of the specified object in the dashboard. The associated object is reloaded in the internal list, and its corresponding card in the grid is updated.

Parameters:

object - The object to be refreshed in the dashboard.

refresh

public void refresh()

Refresh the dashboard

refresh

public void refresh(T object)

Refreshes the state of the specified object in the dashboard. If the object exists in the internal list, its corresponding card is updated in the grid.

Parameters:

object - The object to be refreshed in the dashboard.

getGrid

public ObjectCardGrid<T> getGrid()

Retrieves the ObjectCardGrid associated with this dashboard. The ObjectCardGrid is a specialized version of a CardGrid, designed to manage and display cards representing objects of type T.

Overrides:

getGrid in class CardDashboard

Returns:

the ObjectCardGrid<T> instance linked to this dashboard, allowing interaction and management of object-specific cards.

getDelegatedLoader

public final ObjectLoader<T> getDelegatedLoader()

Specified by:

getDelegatedLoader in interface ObjectLoader<T extends StoredObject>