Package com.storedobject.ui

Class ObjectListGrid<T extends StoredObject>

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.ui.DataGrid<T>

com.storedobject.ui.ObjectListGrid<T>

Type Parameters:

T - Type of object instance.

All Implemented Interfaces:

Executable, Reentrant, FilterMethods<T>, HasLogic, ObjectLoader<T>, ObjectLoader<T>, Transactional, ViewFilterSupport<T>, 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:

ObjectGrid, ObjectMemoryGrid

public class ObjectListGrid<T extends StoredObject>
extends DataGrid<T>
implements ObjectLoader<T>

Grid that can be used show a list of StoredObject instances. This implements List and can handle big-sized lists with an internal caching strategy. However, most methods of the List such as the "add" methods and "set" methods have poor performance. If you really want to use those methods to add rows to the grid rather than using the various "load" methods of ObjectLoader, it's better to use the in-memory version of this - ObjectMemoryGrid.

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>

Constructor Summary

Constructors

Constructor	Description
ObjectListGrid(ObjectList<T> objectList, Iterable<String> columns)
ObjectListGrid(Class<T> objectClass)
ObjectListGrid(Class<T> objectClass, boolean any)
ObjectListGrid(Class<T> objectClass, Iterable<String> columns)
ObjectListGrid(Class<T> objectClass, Iterable<String> columns, boolean any)

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addObjectChangedListener(ObjectChangedListener<T> listener)
void	configure(String... attributes)
protected ObjectListProvider<T>	createListDataProvider(DataList<T> data)	Create an instance of ListDataProvider for the given data.
protected void	doDeleteAction(T object)	Carry out the delete action for the object.
protected void	doInsertAction(T object)	Carry out the insert action for the object.
protected void	doUndeleteAction(T object)	Carry out the undelete action for the object.
protected void	doUpdateAction(T object)	Carry out the update action for the object.
Application	getApplication()	Get the current Application.
ObjectListProvider<T>	getDataProvider()
final ObjectListProvider<T>	getDelegatedLoader()
protected boolean	isValid(com.vaadin.flow.data.provider.ListDataProvider<T> dataProvider)
void	load(Collection<T> items)	Load the given instances.
void	load(T object)
void	loaded()	This method will be invoked whenever data is loaded.
void	removeObjectChangedListener(ObjectChangedListener<T> listener)
void	setProcessor(Consumer<T> processor)	Set a processor to process the object loaded into this grid.
void	setViewFilter(Predicate<T> filter)	Set a filter.

Methods inherited from class com.storedobject.ui.DataGrid

actionAllowed, append, canAllowAction, doAppendAction, doReloadAction, doReloadAllAction, getActionPrefix, getObjectClass, itemAppended, itemDeleted, itemInserted, itemReloaded, itemUndeleted, itemUpdated, load, selected, selected, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItems, sort, sort, validateAppend, validateDelete, validateInsert, validateReload, validateUndelete, validateUpdate

Methods inherited from class com.storedobject.vaadin.ListGrid

add, add, addAll, addAll, addViewFilter, clear, clearViewFilters, contains, containsAll, get, getData, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, onAttach, onDetach, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, setData, size, 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, setItemSelectableProvider, setItemsPageable, setItemsPageable, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSelectionPreservationMode, setSortableColumns, setTooltipGenerator, setTooltipPosition, setUniqueKeyProperty, setUniqueKeyProvider, 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.common.Executable

act

Methods inherited from interface com.storedobject.vaadin.ExecutableView

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

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, createHeader, createHeaders, createHierarchyColumn, createHTMLColumn, createHTMLHierarchyColumn, createView, customizeColumn, customizeRenderer, deselect, deselect, executing, 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.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.core.ObjectLoader

applyFilter, canContain, clear, getAllowAny, getLinkType, getMaster, getObjectClass, getOrderBy, isAllowAny, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, reload, 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.common.Reentrant

isReentrant

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

createWindow

Methods inherited from interface com.storedobject.ui.Transactional

commit, execute, getLogic, getTransactionManager, run, setLogic, transact, transact, transactControl, transactControl, transactControl, transactControl

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Methods inherited from interface com.storedobject.ui.util.ViewFilterSupport

configure, configure, configureMatch, filterView, getViewFilter

Constructor Details

ObjectListGrid

public ObjectListGrid(Class<T> objectClass)

ObjectListGrid

public ObjectListGrid(Class<T> objectClass,
 Iterable<String> columns)

ObjectListGrid

public ObjectListGrid(Class<T> objectClass,
 boolean any)

ObjectListGrid

public ObjectListGrid(Class<T> objectClass,
 Iterable<String> columns,
 boolean any)

ObjectListGrid

public ObjectListGrid(ObjectList<T> objectList,
 Iterable<String> columns)

Method Details

setProcessor

public void setProcessor(Consumer<T> processor)

Set a processor to process the object loaded into this grid.

Objects will be passed to this processor before loading into the grid so that you can do your logic-specific computation.

Note: In cached grids, all objects may not get loaded at once. Also, in large grids, objects may get unloaded when scrolling takes place. However, the processor will be invoked again when the unloaded objects are loaded again. Your logic should not depend on any specific ordering of the objects.

Warning: Typically, such processors should not create transactions or do inter-dependent processing.

Parameters:

processor - Processor.

isValid

protected boolean isValid(com.vaadin.flow.data.provider.ListDataProvider<T> dataProvider)

Overrides:

isValid in class DataGrid<T extends StoredObject>

createListDataProvider

protected ObjectListProvider<T> createListDataProvider(DataList<T> data)

Description copied from class: ListGrid

Create an instance of ListDataProvider for the given data. The default implementation creates an instance of Vaadin's implementation. However, a modified implementation can be provided instead.

Overrides:

createListDataProvider in class DataGrid<T extends StoredObject>

Parameters:

data - Data for which data provider needs to be created.

Returns:

An instance of the ListDataProvider.

getDelegatedLoader

public final ObjectListProvider<T> getDelegatedLoader()

Specified by:

getDelegatedLoader in interface ObjectLoader<T extends StoredObject>

getApplication

public Application getApplication()

Description copied from interface: HasColumns

Get the current Application.

Specified by:

getApplication in interface ExecutableView

Specified by:

getApplication in interface HasColumns<T extends StoredObject>

Returns:

Current Application.

getDataProvider

public ObjectListProvider<T> getDataProvider()

Specified by:

getDataProvider in interface ViewFilterSupport<T extends StoredObject>

Overrides:

getDataProvider in class DataGrid<T extends StoredObject>

configure

public void configure(String... attributes)

Specified by:

configure in interface ViewFilterSupport<T extends StoredObject>

load

public void load(T object)

load

public void load(Collection<T> items)

Description copied from interface: ObjectLoader

Load the given instances. Current "load filter" if set will be applied. However, ObjectLoader.getOrderBy() result will be ignored. Also, the value returned by ObjectLoader.getAllowAny() will determine whether instanced of the subclasses to be restricted or not.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Overrides:

load in class DataGrid<T extends StoredObject>

Parameters:

items - Objects to be loaded.

loaded

public void loaded()

This method will be invoked whenever data is loaded.

addObjectChangedListener

public com.vaadin.flow.shared.Registration addObjectChangedListener(ObjectChangedListener<T> listener)

removeObjectChangedListener

public void removeObjectChangedListener(ObjectChangedListener<T> listener)

doInsertAction

protected void doInsertAction(T object)

Description copied from class: DataGrid

Carry out the insert action for the object. The object is already validated.

Overrides:

doInsertAction in class DataGrid<T extends StoredObject>

Parameters:

object - Item that is newly added.

doUpdateAction

protected void doUpdateAction(T object)

Description copied from class: DataGrid

Carry out the update action for the object. The object is already validated.

Overrides:

doUpdateAction in class DataGrid<T extends StoredObject>

Parameters:

object - Item that is updated.

doDeleteAction

protected void doDeleteAction(T object)

Description copied from class: DataGrid

Carry out the delete action for the object. The object is already validated.

Overrides:

doDeleteAction in class DataGrid<T extends StoredObject>

Parameters:

object - Item that is deleted.

doUndeleteAction

protected void doUndeleteAction(T object)

Description copied from class: DataGrid

Carry out the undelete action for the object. The object is already validated.

Overrides:

doUndeleteAction in class DataGrid<T extends StoredObject>

Parameters:

object - Item that is undeleted.

setViewFilter

public void setViewFilter(Predicate<T> filter)

Description copied from class: ListGrid

Set a filter. (All previously added filters will be cleared).

Specified by:

setViewFilter in interface FilterMethods<T extends StoredObject>

Overrides:

setViewFilter in class ListGrid<T extends StoredObject>

Parameters:

filter - Filter to set.