Package com.storedobject.ui

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

com.storedobject.ui.EditableObjectGrid<T>

com.storedobject.ui.AbstractLinkGrid<T>

All Implemented Interfaces:

Executable, Reentrant, FilterMethods<T>, HasLogic, ObjectLoader<T>, ObjectSearcher<T>, ObjectSetter<T>, ObjectsSetter<T>, EditableDataGrid<T>, LinkGrid<T>, ObjectEditorListener, ObjectGridData<T,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, Consumer<T>, List<T>, SequencedCollection<T>

Direct Known Subclasses:

DetailLinkGrid, ReferenceLinkGrid

public abstract class AbstractLinkGrid<T extends StoredObject>
extends EditableObjectGrid<T>
implements LinkGrid<T>

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

Modifier	Constructor	Description
protected	AbstractLinkGrid(ObjectLinkField<T> linkField, Filtered<T> list, Iterable<String> columns, boolean createContextMenu)
	AbstractLinkGrid(ObjectLinkField<T> linkField, Iterable<String> columns, boolean any, boolean createContextMenu)

Method Summary

Modifier and Type	Method	Description
void	applyFilter()	This method is called whenever a filter condition is changed.
ObjectEditor<T>	constructObjectEditor()
final ObjectEditor<T>	createObjectEditor()
final View	createView()	Create a View to display the grid when executed.
final ObjectLinkField<T>	getField()
final T	getItem(int index)
final StoredObject	getMaster()	Get the current master instance if available.
final String	getName()
final T	getSelected()	Get the selected item.
final int	getType()
final View	getView()	Get the currently active View.
final View	getView(boolean create)	Get the View.
final boolean	isDetail()
final boolean	isEnabled()
void	reload()	Reload all entries.
protected void	reloadedAllNow()	This will be invoked once all items are reloaded.
final void	setMaster(StoredObject master, boolean load)	Set the master instance.
void	setOrderBy(String orderBy, boolean load)	Set the "ORDER BY" clause.

Methods inherited from class com.storedobject.ui.EditableObjectGrid

add, addAll, addAll, addObjectChangedListener, addValueChangeTracker, append, cancelEdit, canChange, clear, createListDataProvider, customizeObjectEditor, deletedNow, doDeleteAction, doInsertAction, doReloadAction, doReloadAllAction, doUndeleteAction, doUpdateAction, editItem, getColumnField, getDelegatedLoader, getEditingItem, getField, getObjectEditor, getRowEditor, insertedNow, isColumnEditable, isReadOnly, isValid, reloadedNow, removeObjectChangedListener, saveEdited, setAutoSaveOnMove, setObjectSetter, setReadOnly, setViewFilter, streamEditableFields, undeletedNow, updatedNow, validateData

Methods inherited from class com.storedobject.ui.AbstractEditableGrid

changed, createEditableList, createEditor, customizeColumn, delete, getColumnOrder, getEditableList, isAdded, isColumnSortable, isDeleted, isEdited, isFromClient, isSavePending, reload, reloadAll, setEditOnSingleClick, setFromClient, streamAdded, streamAll, streamDeleted, streamEdited, update

Methods inherited from class com.storedobject.ui.DataGrid

actionAllowed, canAllowAction, doAppendAction, 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, addViewFilter, 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, 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 java.util.function.Consumer

andThen

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

addDetachListener

Methods inherited from interface com.storedobject.ui.EditableDataGrid

canDelete, canEdit, canPostLedger, canViewLedger

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

addConstructedListener, addItemSelectedListener, addItemsSelectedListener, appendFooter, appendHeader, clearAlerts, clearConstructedListeners, compact, configure, constructed, createColumn, createColumn, createColumn, createColumn, createColumn, createComponentColumn, createDecoratedWindow, createFooters, createHeader, 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, getSOGrid, getTextAlign, 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, streamConstructedListeners, unwrap

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

getElement

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

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 com.storedobject.ui.LinkGrid

add, clear, delete, edit, getButtonPanel, getLink, getLinkGrid, getObjectClass, getObjectEditor, getOldValue, isAllowAdd, isAllowDelete, isAllowEdit, isAllowReload, isAllowReloadAll, isInvalid, isReadOnly, itemAppended, itemDeleted, itemInserted, itemReloaded, itemUndeleted, itemUpdated, reloadAll, select, selected, setAllowAdd, setAllowDelete, setAllowEdit, setAllowReload, setAllowReloadAll, setMasterView, setObjectEditor, setReadOnly, setValue, size, view

Methods inherited from interface java.util.List

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

Methods inherited from interface com.storedobject.ui.ObjectEditorListener

editingCancelled, editingEnded, editingStarted

Methods inherited from interface com.storedobject.ui.ObjectGridData

canSearch, convert, createSearchBuilder, deselect, deselectAll, doLoad, getEntityFilter, getLoadFilter, getObjectClass, getObjectCount, getSearchBuilder, getSelectionModel, isAllowAny, isSearchMode, populate, populate, populate, resetSearch, scrollTo, search, search, search, select, setLoadFilter, setObject, setObjectConsumer, setObjectConsumer, setObjects, setSelectionMode, validateFilterCondition

Methods inherited from interface com.storedobject.core.ObjectLoader

canContain, getAllowAny, getLinkType, getOrderBy, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, setLinkType, setLinkType, setMaster, setOrderBy

Methods inherited from interface com.storedobject.ui.ObjectLoader

addDataLoadedListener, applyFilterPredicate, clear, get, getCacheLevel, getEffectiveCondition, getFixedFilter, indexOf, load, setExtraFilter, setExtraFilter, setFilter, setFilter, setFixedFilter, setFixedFilter, setFixedFilter, setFixedFilter, size, streamAll, streamFiltered

Methods inherited from interface com.storedobject.core.ObjectSetter

accept, setObject

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, configure, configureMatch, filterView, getViewFilter

Constructor Details

AbstractLinkGrid

public AbstractLinkGrid(ObjectLinkField<T> linkField,
 Iterable<String> columns,
 boolean any,
 boolean createContextMenu)

AbstractLinkGrid

protected AbstractLinkGrid(ObjectLinkField<T> linkField,
 Filtered<T> list,
 Iterable<String> columns,
 boolean createContextMenu)

Method Details

reloadedAllNow

protected void reloadedAllNow()

Description copied from class: EditableObjectGrid

This will be invoked once all items are reloaded.

Overrides:

reloadedAllNow in class EditableObjectGrid<T extends StoredObject>

createObjectEditor

public final ObjectEditor<T> createObjectEditor()

Specified by:

createObjectEditor in interface LinkGrid<T extends StoredObject>

Overrides:

createObjectEditor in class EditableObjectGrid<T extends StoredObject>

constructObjectEditor

public ObjectEditor<T> constructObjectEditor()

Specified by:

constructObjectEditor in interface LinkGrid<T extends StoredObject>

Overrides:

constructObjectEditor in class EditableObjectGrid<T extends StoredObject>

getType

public final int getType()

Specified by:

getType in interface LinkGrid<T extends StoredObject>

getName

public final String getName()

Specified by:

getName in interface LinkGrid<T extends StoredObject>

getField

public final ObjectLinkField<T> getField()

Specified by:

getField in interface LinkGrid<T extends StoredObject>

isDetail

public final boolean isDetail()

Specified by:

isDetail in interface LinkGrid<T extends StoredObject>

setMaster

public final void setMaster(StoredObject master,
 boolean load)

Description copied from interface: ObjectLoader

Set the master instance.

Specified by:

setMaster in interface LinkGrid<T extends StoredObject>

Specified by:

setMaster in interface ObjectLoader<T extends StoredObject>

Parameters:

master - Master instance.

load - Whether to immediately reload with this master or not.

getMaster

public final StoredObject getMaster()

Description copied from interface: ObjectLoader

Get the current master instance if available.

Specified by:

getMaster in interface LinkGrid<T extends StoredObject>

Specified by:

getMaster in interface ObjectLoader<T extends StoredObject>

Returns:

Current master instance if available.

isEnabled

public final boolean isEnabled()

Specified by:

isEnabled in interface com.vaadin.flow.component.HasEnabled

Specified by:

isEnabled in interface LinkGrid<T extends StoredObject>

reload

public void reload()

Description copied from interface: ObjectLoader

Reload all entries.

Specified by:

reload in interface LinkGrid<T extends StoredObject>

Specified by:

reload in interface ObjectLoader<T extends StoredObject>

getItem

public final T getItem(int index)

Specified by:

getItem in interface LinkGrid<T extends StoredObject>

Specified by:

getItem in interface ObjectGridData<T extends StoredObject,T extends StoredObject>

getSelected

public final T getSelected()

Description copied from interface: HasColumns

Get the selected item. This will return the item only if a single item is selected.

Specified by:

getSelected in interface HasColumns<T extends StoredObject>

Specified by:

getSelected in interface LinkGrid<T extends StoredObject>

Returns:

Item if that is the only row selected.

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.

Specified by:

createView in interface HasColumns<T extends StoredObject>

Returns:

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

getView

public final View getView()

Description copied from interface: ExecutableView

Get the currently active View. It could be null.

Specified by:

getView in interface ExecutableView

Returns:

Currently active view.

getView

public final 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

Specified by:

getView in interface HasColumns<T extends StoredObject>

Parameters:

create - Whether to create or not.

Returns:

View.

applyFilter

public void applyFilter()

Description copied from interface: FilterMethods

This method is called whenever a filter condition is changed. Methods with default implementation already invoke this method. If any of those methods are overridden, make sure that it invokes this method so that logic to handle filter changes can be coded here.

Specified by:

applyFilter in interface FilterMethods<T extends StoredObject>

Specified by:

applyFilter in interface ObjectLoader<T extends StoredObject>

setOrderBy

public void setOrderBy(String orderBy,
 boolean load)

Description copied from interface: ObjectLoader

Set the "ORDER BY" clause.

Specified by:

setOrderBy in interface ObjectLoader<T extends StoredObject>

Parameters:

orderBy - "ORDER BY" clause to set.

load - Whether to immediately reload with this "ORDER BY" clause or not.