Package com.storedobject.ui

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

com.storedobject.ui.AbstractEditableGrid<T>

Type Parameters:

T - Type of object to edit.

All Implemented Interfaces:

Executable, Reentrant, HasLogic, 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:

EditableGrid, EditableObjectGrid

@CssImport(value="./so/editable-grid/styles.css",
           themeFor="vaadin-grid")
public abstract class AbstractEditableGrid<T>
extends DataGrid<T>

An editable grid. It internally maintains an EditableList that provides status information on each row of the grid. (See getEditableList()).

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.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
AbstractEditableGrid(Class<T> objectClass, Filtered<T> list)	Constructor that will generate columns from the Bean's properties.
AbstractEditableGrid(Class<T> objectClass, Filtered<T> list, Iterable<String> columns)	Constructor that will generate columns from the column names passed.

Method Summary

Modifier and Type	Method	Description
boolean	add(T item)
protected abstract void	cancelEdit()	Cancel the editing if it is active.
void	changed(T item, int changeAction)	This method is invoked whenever any change happens so that other UI elements can be updated.
void	clear()	This method doesn't clear the items.
protected EditableList<T>	createEditableList()
protected final com.vaadin.flow.component.grid.editor.Editor<T>	createEditor()
void	customizeColumn(String columnName, com.vaadin.flow.component.grid.Grid.Column<T> column)	This method is invoked when the column is actually constructed.
void	delete(T item)
boolean	editItem(T item)	Edit an item.
int	getColumnOrder(String columnName)	Return value from this method determines the order in which columns are displayed.
final EditableList<T>	getEditableList()	Get the editable list maintained by this grid.
com.vaadin.flow.component.HasValue<?,?>	getField(String columnName)	Get the field for the given column name.
final boolean	isAdded(T item)
boolean	isColumnSortable(String columnName)	Check if the column is in-memory and back-end sortable.
final boolean	isDeleted(T item)
final boolean	isEdited(T item)
boolean	isFromClient()
boolean	isSavePending()
protected boolean	isValid(com.vaadin.flow.data.provider.ListDataProvider<T> dataProvider)
void	reload(T object)
void	reloadAll()
void	setEditOnSingleClick(boolean editOnSingleClick)	Normally editing is started when double-clicked on the row.
void	setFromClient(boolean fromClient)
Stream<T>	streamAdded()
Stream<T>	streamAll()
Stream<T>	streamDeleted()
Stream<T>	streamEdited()
void	update(T item)

Methods inherited from class com.storedobject.ui.DataGrid

actionAllowed, append, canAllowAction, createListDataProvider, doAppendAction, doDeleteAction, doInsertAction, doReloadAction, doReloadAllAction, doUndeleteAction, doUpdateAction, getActionPrefix, getDataProvider, getObjectClass, itemAppended, itemDeleted, itemInserted, itemReloaded, itemUndeleted, itemUpdated, load, 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, addAll, addAll, addViewFilter, clearViewFilters, contains, containsAll, get, getData, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, onAttach, onDetach, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, setData, setViewFilter, 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, createSortingComparator, deselect, deselectAll, getAriaLabel, getArrayUpdater, getBeanType, getClassNameGenerator, 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, 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, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSelectionPreservationMode, setSortableColumns, setTooltipGenerator, 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.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, customizeRenderer, deselect, deselect, executing, getApplication, getCaption, getColumn, getColumnCaption, getColumnCount, getColumnDetail, getColumnFunction, getColumnHeaderComponent, getColumnMethodName, getColumnNames, getColumnSorter, getColumnTemplate, getConfigureButton, getDataClass, getDefinedColumnCount, getFixedColumnWidth, getMenuItem, getObjectRendered, getObjectUnwrapped, getRelativeColumnWidth, getSelected, getTextAlign, getView, getViewComponent, ignoreCaseForColumnSorting, includeColumn, isColumnFrozen, isColumnResizable, 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.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

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

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

configure, configure, configure, configureMatch, filterView, getViewFilter

Constructor Details

AbstractEditableGrid

public AbstractEditableGrid(Class<T> objectClass,
 Filtered<T> list)

Constructor that will generate columns from the Bean's properties.

Parameters:

objectClass - Bean type

list - List

AbstractEditableGrid

public AbstractEditableGrid(Class<T> objectClass,
 Filtered<T> list,
 Iterable<String> columns)

Constructor that will generate columns from the column names passed.

Parameters:

objectClass - Bean type

list - List

columns - Column names

Method Details

setEditOnSingleClick

public void setEditOnSingleClick(boolean editOnSingleClick)

Normally editing is started when double-clicked on the row. This setting allows editing on single-click.

Parameters:

editOnSingleClick - True/false.

createEditableList

protected EditableList<T> createEditableList()

isValid

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

Overrides:

isValid in class DataGrid<T>

setFromClient

public void setFromClient(boolean fromClient)

isFromClient

public boolean isFromClient()

getEditableList

public final EditableList<T> getEditableList()

Get the editable list maintained by this grid.

Returns:

Editable list instance.

getField

public com.vaadin.flow.component.HasValue<?,?> getField(String columnName)

Get the field for the given column name.

Parameters:

columnName - Name of the column for which field is required.

Returns:

Field if found, otherwise null is returned.

editItem

public boolean editItem(T item)

Edit an item. Default implementation doesn't do anything and returns false. This method is invoked whenever a row is double-clicked (or single-clicked when setEditOnSingleClick(boolean) is set).

Parameters:

item - Item to be edited.

Returns:

True if the editing is started, otherwise false.

isColumnSortable

public boolean isColumnSortable(String columnName)

Description copied from interface: HasColumns

Check if the column is in-memory and back-end sortable.

Parameters:

columnName - Column name

Returns:

Default implementation returns true.

createEditor

protected final com.vaadin.flow.component.grid.editor.Editor<T> createEditor()

Overrides:

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

getColumnOrder

public int getColumnOrder(String columnName)

Description copied from interface: HasColumns

Return value from this method determines the order in which columns are displayed. Numbers do not have to be continuous, columns with lower numbers are displayed first.

Parameters:

columnName - Column name.

Returns:

An integer number that denotes the column order.

customizeColumn

public void customizeColumn(String columnName,
 com.vaadin.flow.component.grid.Grid.Column<T> column)

Description copied from interface: HasColumns

This method is invoked when the column is actually constructed.

Parameters:

columnName - Column name

column - Grid column that may be customized

cancelEdit

protected abstract void cancelEdit()

Cancel the editing if it is active.

clear

public void clear()

This method doesn't clear the items. Instead, it just invokes the fireChanged(Object, int) method with null as the item value and EditorAction.ALL as the "change action". Subclasses should implement the real "clear" functionality.

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

Overrides:

clear in class ListGrid<T>

add

public boolean add(T item)

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

Overrides:

add in class ListGrid<T>

delete

public void delete(T item)

update

public void update(T item)

reload

public void reload(T object)

reloadAll

public void reloadAll()

changed

public void changed(T item,
 int changeAction)

This method is invoked whenever any change happens so that other UI elements can be updated.

Parameters:

item - Item that is changed. For changes affecting more than one item, this will be null.

changeAction - Change action (One of the static values defined in the EditorAction). For changes affecting more than one item, this will be EditorAction.ALL.

isAdded

public final boolean isAdded(T item)

isDeleted

public final boolean isDeleted(T item)

isEdited

public final boolean isEdited(T item)

streamAll

public Stream<T> streamAll()

streamAdded

public Stream<T> streamAdded()

streamEdited

public Stream<T> streamEdited()

streamDeleted

public Stream<T> streamDeleted()

isSavePending

public boolean isSavePending()