Package com.storedobject.ui

Class CardDashboard<T>

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<T>

Type Parameters:

T - The type of object associated with the cards in the dashboard.

All Implemented Interfaces:

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

Direct Known Subclasses:

ModuleMenu, ObjectCardDashboard

public class CardDashboard<T>
extends ScrollingContent
implements ExecutableView, CloseableView

The CardDashboard class represents a dashboard composed of interactive cards laid out on a grid. It extends the functionality of the ScrollingContent class and implements the ExecutableView and CloseableView interfaces. This allows the dashboard to be part of an application's interactive view system with capabilities to execute and manage its lifecycle.

The CardDashboard is designed to display a collection of cards organized using a grid layout, and its caption can be dynamically set. It also includes an inner view component that manages display-specific details and interactions related to its content. The caption updates are propagated to the view if it exists.

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
CardDashboard(String caption, CardGrid<T> grid)	Constructs a new CardDashboard instance with the specified caption and grid layout.

Method Summary

Modifier and Type	Method	Description
final com.vaadin.flow.shared.Registration	addCardSelectedListener(Consumer<Card<T>> listener)	Adds a card selection listener to the dashboard's associated CardGrid.
void	execute(View lock)	Execute the associated view by locking another view (the locked view will not be selectable until this view is closed).
String	getCaption()	Get the caption for this view.
Stream<Card<T>>	getCards()	Retrieves a stream of Card objects managed by the associated CardGrid.
CardGrid<T>	getGrid()	Retrieves the CardGrid associated with this CardDashboard.
Card<T>	getSelectedCard()	Retrieves the currently selected card from the associated grid.
Stream<Card<T>>	getSelectedCards()	Retrieves a stream of the currently selected cards from the associated CardGrid.
final com.vaadin.flow.component.grid.Grid.SelectionMode	getSelectionMode()	Retrieves the current selection mode of the Grid associated with this dashboard.
View	getView(boolean create)	Get the View.
void	ignoreSelection()	Disables card selection in the associated grid.
boolean	isIgnoreSelection()	Checks whether card selection is currently being ignored in the associated grid.
void	selectAllCards(boolean select)	Toggles the selection state of all cards within the dashboard's grid.
void	setCaption(String caption)	Set the caption
final void	setSelectionMode(com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)	Configures the selection mode for the grid within the CardDashboard.

Methods inherited from class com.storedobject.ui.ScrollingContent

add, add, add, addComponentAsFirst, addComponentAtIndex, getChildren, getComponentAt, getComponentCount, getContent, getHeader, getMargin, indexOf, remove, remove, removeAll, replace, 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, 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.vaadin.flow.component.HasElement

getElement

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

isEnabled, setEnabled

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.vaadin.ValueChangeHandler

valueChanged

Constructor Details

CardDashboard

public CardDashboard(String caption,
 CardGrid<T> grid)

Constructs a new CardDashboard instance with the specified caption and grid layout. This constructor initializes the dashboard by associating it with the given CardGrid. The provided grid is set as the scrollable content of the dashboard, and it is linked back to the dashboard using the setDashboard method. Additionally, the caption for the dashboard is set, and it can be dynamically modified later.

Parameters:

caption - the display caption for the dashboard. If null or blank, a default value ("Dashboard") is used.

grid - the CardGrid that organizes and manages the cards displayed in the dashboard. This grid is essential for layout and content management within the dashboard.

Method Details

setCaption

public void setCaption(String caption)

Description copied from interface: ExecutableView

Set the caption

Specified by:

setCaption in interface ExecutableView

Parameters:

caption - Caption

getCaption

public String getCaption()

Description copied from interface: ExecutableView

Get the caption for this view.

Specified by:

getCaption in interface ExecutableView

Returns:

Caption.

getGrid

public CardGrid<T> getGrid()

Retrieves the CardGrid associated with this CardDashboard. The CardGrid organizes and manages the layout and content of the cards displayed within the dashboard.

Returns:

the CardGrid instance linked to this CardDashboard.

execute

public void execute(View lock)

Description copied from interface: ExecutableView

Execute the associated view by locking another view (the locked view will not be selectable until this view is closed). The locked view acts as its "parent" and it will automatically get selected when this view closes.

Specified by:

execute in interface ExecutableView

Parameters:

lock - View to be locked.

getView

public View getView(boolean create)

Description copied from interface: ExecutableView

Get the View. Create it if it doesn't exist.

Specified by:

getView in interface ExecutableView

Parameters:

create - Whether to create or not.

Returns:

View.

setSelectionMode

public final void setSelectionMode(com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)

Configures the selection mode for the grid within the CardDashboard. The selection mode determines how cards in the grid can be selected (e.g., single, multi, or none).

Parameters:

selectionMode - the Grid.SelectionMode that specifies the card selection behavior in the grid. Must not be null.

getSelectionMode

public final com.vaadin.flow.component.grid.Grid.SelectionMode getSelectionMode()

Retrieves the current selection mode of the Grid associated with this dashboard. The selection mode determines how items within the grid can be selected (e.g., single, multiple, or none).

Returns:

the current Grid.SelectionMode of the associated Grid.

addCardSelectedListener

public final com.vaadin.flow.shared.Registration addCardSelectedListener(Consumer<Card<T>> listener)

Adds a card selection listener to the dashboard's associated CardGrid. The listener is triggered whenever a card is selected in the grid.

Parameters:

listener - a Consumer that processes the Card selected by the user. This listener is invoked with the selected card as its input.

Returns:

a Registration object that can be used to remove the listener if it is no longer needed.

selectAllCards

public void selectAllCards(boolean select)

Toggles the selection state of all cards within the dashboard's grid. This method delegates the operation to the CardGrid associated with the CardDashboard. It allows for selecting or deselecting all cards simultaneously based on the specified parameter. This operation is only effective if the grid's selection mode is set to Grid.SelectionMode.MULTI.

Parameters:

select - a boolean value indicating the desired selection state for all cards. If true, all cards in the grid will be selected; if false, all cards will be deselected.

getSelectedCard

public Card<T> getSelectedCard()

Retrieves the currently selected card from the associated grid. The selected card is managed by the CardGrid linked to this dashboard.

Returns:

the selected Card, or null if no card is selected.

getSelectedCards

public Stream<Card<T>> getSelectedCards()

Retrieves a stream of the currently selected cards from the associated CardGrid.

Returns:

a Stream of Card objects that are currently selected in the grid.

getCards

public Stream<Card<T>> getCards()

Retrieves a stream of Card objects managed by the associated CardGrid. This method is used to access and iterate through all the cards currently organized within the grid layout of the dashboard.

Returns:

a Stream of Card<T> instances representing the cards in the grid.

ignoreSelection

public void ignoreSelection()

Disables card selection in the associated grid. When this method is invoked, it prevents the grid from processing any card selection events, effectively ignoring selection input or state changes.

This can be useful in scenarios where card selection functionality needs to be temporarily suspended without altering the grid's selection state.

Use case: When you have clickable components inside the cards, you may not want to fire the selection events when the user clicks on them. In such cases, you can temporarily suspend card selection to avoid unintended behavior. This is typically achieved by invoking this method from within your click-handlers. It will be automatically enabled again when your click-handlers complete their execution.

isIgnoreSelection

public boolean isIgnoreSelection()

Checks whether card selection is currently being ignored in the associated grid. When this method returns true, card selection events are not processed, effectively disabling selection functionality for the grid.

Returns:

true if card selection is being ignored; false otherwise