Package com.storedobject.vaadin

Class SelectGrid<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.grid.Grid<T>

com.storedobject.vaadin.DataGrid<T>

com.storedobject.vaadin.ListGrid<T>

com.storedobject.vaadin.SelectGrid<T>

Type Parameters:

T - Type of object in the grid.

All Implemented Interfaces:

ClickHandler, ExecutableView, HasColumns<T>, SupportWindowMode, ValueChangeHandler, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.grid.Grid<T>>, 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.Focusable<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValue.ValueChangeListener, com.vaadin.flow.data.event.SortEvent.SortNotifier<com.vaadin.flow.component.grid.Grid<T>,com.vaadin.flow.component.grid.GridSortOrder<T>>, com.vaadin.flow.data.provider.HasDataGenerators<T>, com.vaadin.flow.data.provider.HasDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridDataView<T>>, com.vaadin.flow.data.provider.HasLazyDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridLazyDataView<T>>, com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.grid.dataview.GridListDataView<T>>, Serializable, Iterable<T>, Runnable, Collection<T>, EventListener, List<T>, SequencedCollection<T>

Direct Known Subclasses:

MultiSelectGrid, SelectStock

public class SelectGrid<T>
extends ListGrid<T>

A grid to be shown in a window with "Proceed/Cancel" buttons to select an entry. When the "Proceed" button is pressed, the selected entry is passed to a Consumer that can be set.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.grid.Grid

com.vaadin.flow.component.grid.Grid.AbstractGridExtension<T>, com.vaadin.flow.component.grid.Grid.Column<T>, com.vaadin.flow.component.grid.Grid.DataCommunicatorBuilder<T,U extends com.vaadin.flow.data.provider.ArrayUpdater>, com.vaadin.flow.component.grid.Grid.MultiSortPriority, com.vaadin.flow.component.grid.Grid.NestedNullBehavior, com.vaadin.flow.component.grid.Grid.SelectionMode, com.vaadin.flow.component.grid.Grid.SpringData, com.vaadin.flow.component.grid.Grid.UpdateQueue

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

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

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

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

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

HasColumns.SOGrid<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final ButtonLayout	buttonLayout	The button layout at the top.
protected final Button	cancel	The "Cancel" button.
protected final Button	proceed	The "Proceed" button.

Constructor Summary

Constructors

Constructor	Description
SelectGrid(Class<T> objectClass, List<T> items)	Constructor.
SelectGrid(Class<T> objectClass, List<T> items, Iterable<String> columns)	Constructor.
SelectGrid(Class<T> objectClass, List<T> items, Iterable<String> columns, Consumer<T> consumer)	Constructor.
SelectGrid(Class<T> objectClass, List<T> items, Consumer<T> consumer)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addExtraButtons()	Add extra buttons if required.
protected void	cancel()	This will be invoked when the "Cancel" button is pressed.
final com.vaadin.flow.component.Component	createHeader()	You can have a "header row" (as the first row) that covers the whole grid.
final View	createView()	Create a View to display the grid when executed.
void	execute(View lock)	Execute the associated view by locking another view (the locked view will not be selectable until this view is closed).
protected void	process(Set<T> selected)	This method is never called.
protected void	process(T selected)	This will be invoked when the "Proceed" button is pressed and no "consumer" is set.
void	setEmptyRowsMessage(String emptyRowsMessage)	Set the message to be displayed when no rows exist while executing.
protected boolean	validate()	This method is called just before closing the grid's view and before the selected item/items are handed over to the consumer.

Methods inherited from class com.storedobject.vaadin.ListGrid

add, add, addAll, addAll, addViewFilter, clear, clearViewFilters, contains, containsAll, createListDataProvider, get, getData, getDataProvider, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, onAttach, onDetach, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, setData, setViewFilter, size, sort, subList, toArray, toArray

Methods inherited from class com.storedobject.vaadin.DataGrid

addConstructedListener, appendFooter, clearConstructedListeners, getColumnByKey, getColumns, getSOGrid, isColumnReorderingAllowed, setColumnReorderingAllowed, streamConstructedListeners

Methods inherited from class com.vaadin.flow.component.grid.Grid

addCellFocusListener, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumnReorderListener, addColumnResizeListener, addColumns, addComponentColumn, addContextMenu, addDataGenerator, addDragEndListener, addDragStartListener, addDropListener, addFirstHeaderRow, addItemClickListener, addItemDoubleClickListener, addSelectionListener, addSortListener, addThemeVariants, addValueProvider, appendFooterRow, appendHeaderRow, asMultiSelect, asSingleSelect, compareMaybeComparables, configureBeanType, createColumn, createColumnId, createDefaultArrayUpdater, createEditor, createSortingComparator, deselect, deselectAll, getAriaLabel, getArrayUpdater, getBeanType, getClassNameGenerator, getColumnByInternalId, getColumnLayers, getColumnRendering, getDataCommunicator, getDefaultColumnFactory, getDefaultHeaderRow, getDragFilter, getDropFilter, getDropMode, getEditor, getEmptyStateComponent, getEmptyStateText, getFooterRows, getGenericDataView, getHeaderRows, getLazyDataView, getListDataView, getNestedNullBehavior, getPageSize, getPartNameGenerator, getPropertySet, getSelectedItems, getSelectionMode, getSelectionModel, getSelectionPreservationMode, getSortOrder, getTooltipPosition, getUniqueKeyProperty, getUniqueKeyProvider, initConnector, insertColumnLayer, isAllRowsVisible, isDetailsVisible, isDetailsVisibleOnClick, isMultiSort, isRowsDraggable, onDataProviderChange, onEnabledStateChanged, prependFooterRow, prependHeaderRow, recalculateColumnWidths, removeAllColumns, removeAllFooterRows, removeAllHeaderRows, removeColumn, removeColumnByKey, removeColumnLayer, removeColumns, removeFooterRow, removeHeaderRow, removeThemeVariants, scrollToEnd, scrollToIndex, scrollToItem, scrollToStart, select, setAllRowsVisible, setAriaLabel, setClassNameGenerator, setColumnKey, setColumnOrder, setColumnOrder, setColumnRendering, setColumns, setDataProvider, setDefaultMultiSortPriority, setDetailsVisible, setDetailsVisibleOnClick, setDragDataGenerator, setDragFilter, setDropFilter, setDropMode, setEmptyStateComponent, setEmptyStateText, setItemDetailsRenderer, setItems, setItems, setItems, setItems, setItemSelectableProvider, setItemsPageable, setItemsPageable, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSelectionPreservationMode, setSortableColumns, setTooltipGenerator, setTooltipPosition, setUniqueKeyProperty, setUniqueKeyProvider, sort, updateSelectionModeOnClient

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, 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.BlurNotifier

addBlurListener

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

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

addDetachListener

Methods inherited from interface com.storedobject.vaadin.ExecutableView

abort, clean, clicked, close, createMenuItem, error, execute, 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.Focusable

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

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

addFocusListener

Methods inherited from interface com.storedobject.vaadin.HasColumns

addItemSelectedListener, addItemsSelectedListener, appendHeader, clearAlerts, compact, configure, constructed, createColumn, createColumn, createColumn, createColumn, createColumn, createComponentColumn, createDecoratedWindow, createFooters, createHeaders, createHierarchyColumn, createHTMLColumn, createHTMLHierarchyColumn, customizeColumn, customizeRenderer, deselect, deselect, executing, getApplication, getCaption, getColumn, getColumnCaption, getColumnCount, getColumnDetail, getColumnFunction, getColumnHeaderComponent, getColumnMethodName, getColumnNames, getColumnOrder, getColumnSorter, getColumnTemplate, getConfigureButton, getDataClass, getDefinedColumnCount, getFixedColumnWidth, getMenuItem, getObjectRendered, getObjectUnwrapped, getRelativeColumnWidth, getRenderedColumnNames, getSelected, getTextAlign, getView, getViewComponent, ignoreCaseForColumnSorting, includeColumn, isColumnFrozen, isColumnResizable, isColumnSortable, isColumnVisible, prependFooter, prependHeader, refresh, refresh, refresh, removeItemSelectedListener, render, select, select, setCaption, setColumnFrozen, setColumnResizable, setColumnVisible, setMethodHandlerHost, sort, sort, sortOrder, sortOrder, unwrap

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.data.provider.HasLazyDataView

setItems, setItems

Methods inherited from interface com.vaadin.flow.data.provider.HasListDataView

setItems, setItems

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

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, reversed, spliterator

Methods inherited from interface com.storedobject.vaadin.util.SupportWindowMode

createWindow

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Field Details

buttonLayout

protected final ButtonLayout buttonLayout

The button layout at the top.

proceed

protected final Button proceed

The "Proceed" button.

cancel

protected final Button cancel

The "Cancel" button.

Constructor Details

SelectGrid

public SelectGrid(Class<T> objectClass,
 List<T> items)

Constructor.

Parameters:

objectClass - Type of object in the grid.

items - Items of the grid.

SelectGrid

public SelectGrid(Class<T> objectClass,
 List<T> items,
 Iterable<String> columns)

Constructor.

Parameters:

objectClass - Type of object in the grid.

items - Items of the grid.

columns - Column names of the grid.

SelectGrid

public SelectGrid(Class<T> objectClass,
 List<T> items,
 Consumer<T> consumer)

Constructor.

Parameters:

objectClass - Type of object in the grid.

items - Items of the grid.

consumer - Consumer to consume the selected item.

SelectGrid

public SelectGrid(Class<T> objectClass,
 List<T> items,
 Iterable<String> columns,
 Consumer<T> consumer)

Constructor.

Parameters:

objectClass - Type of object in the grid.

items - Items of the grid.

columns - Column names of the grid.

consumer - Consumer to consume the selected item.

Method Details

createHeader

public final com.vaadin.flow.component.Component createHeader()

Description copied from interface: HasColumns

You can have a "header row" (as the first row) that covers the whole grid. Typically, such a row is to show your own buttons or components to customize the grid. The default implementation returns null, and thus, no such row is created. (Please note that HasColumns.createHeaders()} is invoked before this method for adding other header rows just above the main header row. This may be used for column grouping etc.)

Returns:

Component to be used as the "header row".

addExtraButtons

public void addExtraButtons()

Add extra buttons if required. You can add anything to buttonLayout.

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.

Parameters:

lock - View to be locked.

cancel

protected void cancel()

This will be invoked when the "Cancel" button is pressed. The default action is to abort the View.

process

protected void process(Set<T> selected)

This method is never called.

Parameters:

selected - Selected item.

process

protected void process(T selected)

This will be invoked when the "Proceed" button is pressed and no "consumer" is set. (View will have already closed before calling this).

Parameters:

selected - Selected item.

createView

public final View createView()

Description copied from interface: HasColumns

Create a View to display the grid when executed. If this method returns null, a default View will be created.

Returns:

A View with this grid as the component. Default implementation returns null.

setEmptyRowsMessage

public void setEmptyRowsMessage(String emptyRowsMessage)

Set the message to be displayed when no rows exist while executing. If set to null, no message will be displayed.

Parameters:

emptyRowsMessage - Message to be displayed.

validate

protected boolean validate()

This method is called just before closing the grid's view and before the selected item/items are handed over to the consumer. If false is returned from this method grid's view will not be closed and consumer will not be fed with the item/items.

Returns:

True/false. Default implementation returns true.