Package com.storedobject.vaadin

Class ListGrid<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>

Type Parameters:

T - Data type of 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:

ActionGrid, DatabaseMonitor, DataGrid, ItemMovementView, JournalVoucherView, ObjectComparisonGrid, QueryGrid, ReceiveAndBin, SelectGrid, StatementView, ViewGrid

public class ListGrid<T>
extends DataGrid<T>
implements List<T>

A grid that implements a List data model.

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
ListGrid(Class<T> objectClass)	Constructor.
ListGrid(Class<T> objectClass, Iterable<String> columns)	Constructor.
ListGrid(Class<T> objectClass, List<T> data)	Constructor.
ListGrid(Class<T> objectClass, List<T> data, Iterable<String> columns)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	add(int index, T item)
boolean	add(T item)
boolean	addAll(int index, Collection<? extends T> collection)
boolean	addAll(Collection<? extends T> collection)
void	addViewFilter(Predicate<T> filter)	Add a filter.
void	clear()
void	clearViewFilters()	Clear all filters.
boolean	contains(Object item)
boolean	containsAll(Collection<?> collection)
protected com.vaadin.flow.data.provider.ListDataProvider<T>	createListDataProvider(DataList<T> data)	Create an instance of ListDataProvider for the given data.
T	get(int index)
List<T>	getData()	Get the data of this list.
com.vaadin.flow.data.provider.ListDataProvider<T>	getDataProvider()
int	indexOf(Object item)
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object item)
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int index)
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
protected void	onDetach(com.vaadin.flow.component.DetachEvent detachEvent)
T	remove(int index)
boolean	remove(Object item)
boolean	removeAll(Collection<?> collection)
boolean	removeIf(Predicate<? super T> filter)
void	replaceAll(UnaryOperator<T> operator)
boolean	retainAll(Collection<?> collection)
T	set(int index, T item)
void	setData(List<T> data)	Set the data of this list.
void	setViewFilter(Predicate<T> filter)	Set a filter.
int	size()
void	sort(Comparator<? super T> comparator)
List<T>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<T1> T1[]	toArray(T1[] a)

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, 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, createHeader, createHeaders, createHierarchyColumn, createHTMLColumn, createHTMLHierarchyColumn, createView, 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

Constructor Details

ListGrid

public ListGrid(Class<T> objectClass)

Constructor.

Parameters:

objectClass - Class of objects stored.

ListGrid

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

Constructor.

Parameters:

objectClass - Class of objects stored.

columns - Column names.

ListGrid

public ListGrid(Class<T> objectClass,
 List<T> data)

Constructor.

Parameters:

objectClass - Class of objects stored.

data - Data to be set. Same data may be used on multiple ListGrids.

ListGrid

public ListGrid(Class<T> objectClass,
 List<T> data,
 Iterable<String> columns)

Constructor.

Parameters:

objectClass - Class of objects stored.

data - Data to be set. Same data may be used on multiple ListGrids.

columns - Column names.

Method Details

getData

public List<T> getData()

Get the data of this list. If the data is not an instance of DataList and is directly manipulated, HasColumns.refresh() or HasColumns.refresh(Object) should be invoked to reflect the changes on the grid.

Returns:

Data of this list.

setData

public void setData(List<T> data)

Set the data of this list.

Parameters:

data - Data to be set. Same data may be used on multiple ListGrids.

createListDataProvider

protected com.vaadin.flow.data.provider.ListDataProvider<T> createListDataProvider(DataList<T> data)

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.

Parameters:

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

Returns:

An instance of the ListDataProvider.

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.grid.Grid<T>

onDetach

protected void onDetach(com.vaadin.flow.component.DetachEvent detachEvent)

Overrides:

onDetach in class com.vaadin.flow.component.grid.Grid<T>

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface List<T>

contains

public boolean contains(Object item)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface List<T>

iterator

@Nonnull
public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface List<T>

toArray

@Nonnull
public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

toArray

@Nonnull
public <T1> T1[] toArray(@Nonnull
 T1[] a)

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

add

public boolean add(T item)

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

remove

public boolean remove(Object item)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

containsAll

public boolean containsAll(@Nonnull
 Collection<?> collection)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface List<T>

addAll

public boolean addAll(@Nonnull
 Collection<? extends T> collection)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface List<T>

addAll

public boolean addAll(int index,
 @Nonnull
 Collection<? extends T> collection)

Specified by:

addAll in interface List<T>

removeAll

public boolean removeAll(@Nonnull
 Collection<?> collection)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface List<T>

removeIf

public boolean removeIf(Predicate<? super T> filter)

Specified by:

removeIf in interface Collection<T>

retainAll

public boolean retainAll(@Nonnull
 Collection<?> collection)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface List<T>

replaceAll

public void replaceAll(UnaryOperator<T> operator)

Specified by:

replaceAll in interface List<T>

sort

public void sort(Comparator<? super T> comparator)

Specified by:

sort in interface List<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

get

public T get(int index)

Specified by:

get in interface List<T>

set

public T set(int index,
 T item)

Specified by:

set in interface List<T>

add

public void add(int index,
 T item)

Specified by:

add in interface List<T>

remove

public T remove(int index)

Specified by:

remove in interface List<T>

indexOf

public int indexOf(Object item)

Specified by:

indexOf in interface List<T>

lastIndexOf

public int lastIndexOf(Object item)

Specified by:

lastIndexOf in interface List<T>

listIterator

@Nonnull
public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

listIterator

@Nonnull
public ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T>

subList

@Nonnull
public List<T> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<T>

getDataProvider

public com.vaadin.flow.data.provider.ListDataProvider<T> getDataProvider()

Overrides:

getDataProvider in class com.vaadin.flow.component.grid.Grid<T>

setViewFilter

public void setViewFilter(Predicate<T> filter)

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

Parameters:

filter - Filter to set.

addViewFilter

public void addViewFilter(Predicate<T> filter)

Add a filter.

Parameters:

filter - Filter to add.

clearViewFilters

public void clearViewFilters()

Clear all filters.