Package com.storedobject.ui

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

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

public class DetailLinkGrid<T extends StoredObject>
extends AbstractLinkGrid<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

Constructor	Description
DetailLinkGrid(ObjectLinkField<T> linkField)
DetailLinkGrid(ObjectLinkField<T> linkField, boolean createContextMenu)
DetailLinkGrid(ObjectLinkField<T> linkField, Iterable<String> columns)
DetailLinkGrid(ObjectLinkField<T> linkField, Iterable<String> columns, boolean createContextMenu)

Method Summary

Modifier and Type	Method	Description
void	add()
boolean	add(T item)
void	cancelEdit()	Cancel the editing if it is active.
protected final boolean	canChange(T item, int editorAction)	Invoked to check whether a change is allowed from the client side or not.
boolean	canDelete(T item)	Check whether an item can be deleted or not.
void	clear()	This method doesn't clear the items.
protected final EditableList<T>	createEditableList()
void	createHeaders()	Create extra header rows if required here by invoking HasColumns.prependHeader() or HasColumns.appendHeader() (typically useful for creating column grouping etc.).
void	delete()
void	edit()
LinkGridButtons<T>	getButtonPanel()
protected com.vaadin.flow.component.HasValue<?,?>	getColumnField(String columnName)	Get the field for the column.
StoredObjectUtility.Link<T>	getLink()
LinkValue<T>	getLinkGrid()
boolean	isColumnEditable(String columnName)	All fields are editable by default unless a field for editing the value of a particular column can not be determined from its ObjectEditor.
boolean	isInvalid()
void	reload()	Reload all entries.
void	reloadAll()
T	selected()	Get the currently selected instance.
final void	setObjectEditor(ObjectEditor<T> editor)
void	setReadOnly(boolean readOnly)	Set read only.

Methods inherited from class com.storedobject.ui.AbstractLinkGrid

applyFilter, constructObjectEditor, createObjectEditor, createView, getField, getItem, getMaster, getName, getSelected, getType, getView, getView, isDetail, isEnabled, reloadedAllNow, setMaster, setOrderBy

Methods inherited from class com.storedobject.ui.EditableObjectGrid

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

Methods inherited from class com.storedobject.ui.AbstractEditableGrid

changed, createEditor, customizeColumn, delete, getColumnOrder, getEditableList, isAdded, isColumnSortable, isDeleted, isEdited, isFromClient, isSavePending, reload, 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, 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

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

getObjectClass, getObjectEditor, getOldValue, isAllowAdd, isAllowDelete, isAllowEdit, isAllowReload, isAllowReloadAll, isReadOnly, itemAppended, itemDeleted, itemInserted, itemReloaded, itemUndeleted, itemUpdated, select, setAllowAdd, setAllowDelete, setAllowEdit, setAllowReload, setAllowReloadAll, setMasterView, 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

DetailLinkGrid

public DetailLinkGrid(ObjectLinkField<T> linkField)

DetailLinkGrid

public DetailLinkGrid(ObjectLinkField<T> linkField,
 boolean createContextMenu)

DetailLinkGrid

public DetailLinkGrid(ObjectLinkField<T> linkField,
 Iterable<String> columns)

DetailLinkGrid

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

Method Details

createHeaders

public void createHeaders()

Description copied from interface: HasColumns

Create extra header rows if required here by invoking HasColumns.prependHeader() or HasColumns.appendHeader() (typically useful for creating column grouping etc.). The default implementation does nothing. This is invoked before HasColumns.createHeader().

getColumnField

protected com.vaadin.flow.component.HasValue<?,?> getColumnField(String columnName)

Description copied from class: EditableObjectGrid

Get the field for the column. (Used while editing the row). In general, it is not required to override this. If this method returns null, field will be created from the respective Object Editor.

Overrides:

getColumnField in class EditableObjectGrid<T extends StoredObject>

Parameters:

columnName - Column name for which field needs to be obtained.

Returns:

Default implementation returns null.

createEditableList

protected final EditableList<T> createEditableList()

Overrides:

createEditableList in class AbstractEditableGrid<T extends StoredObject>

canDelete

public boolean canDelete(T item)

Description copied from interface: EditableDataGrid

Check whether an item can be deleted or not. (This control will be applied only for user interaction).

Parameters:

item - Item to delete.

Returns:

True/false.

add

public boolean add(T item)

Specified by:

add in interface Collection<T extends StoredObject>

Specified by:

add in interface List<T extends StoredObject>

Overrides:

add in class EditableObjectGrid<T extends StoredObject>

add

public void add()

edit

public void edit()

delete

public void delete()

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>

Overrides:

reload in class AbstractLinkGrid<T extends StoredObject>

reloadAll

public void reloadAll()

Specified by:

reloadAll in interface LinkGrid<T extends StoredObject>

Overrides:

reloadAll in class AbstractEditableGrid<T extends StoredObject>

setObjectEditor

public final void setObjectEditor(ObjectEditor<T> editor)

getButtonPanel

public LinkGridButtons<T> getButtonPanel()

getLink

public StoredObjectUtility.Link<T> getLink()

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from class: EditableObjectGrid

Set read only.

Specified by:

setReadOnly in interface LinkGrid<T extends StoredObject>

Overrides:

setReadOnly in class EditableObjectGrid<T extends StoredObject>

Parameters:

readOnly - If true, rows will not be editable.

isColumnEditable

public boolean isColumnEditable(String columnName)

Description copied from class: EditableObjectGrid

All fields are editable by default unless a field for editing the value of a particular column can not be determined from its ObjectEditor.

Specified by:

isColumnEditable in interface EditableDataGrid<T extends StoredObject>

Overrides:

isColumnEditable in class EditableObjectGrid<T extends StoredObject>

Parameters:

columnName - Column name.

Returns:

True/false.

clear

public void clear()

Description copied from class: AbstractEditableGrid

This method doesn't clear the items. Instead, it just invokes the AbstractEditableGrid.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 extends StoredObject>

Specified by:

clear in interface LinkGrid<T extends StoredObject>

Specified by:

clear in interface List<T extends StoredObject>

Specified by:

clear in interface ObjectLoader<T extends StoredObject>

Overrides:

clear in class EditableObjectGrid<T extends StoredObject>

cancelEdit

public void cancelEdit()

Description copied from class: AbstractEditableGrid

Cancel the editing if it is active.

Overrides:

cancelEdit in class EditableObjectGrid<T extends StoredObject>

selected

public T selected()

Description copied from class: DataGrid

Get the currently selected instance. If nothing is selected, a warning message is displayed and null is returned. (If you simply want to a find the selected instance without displaying a warning message, you may use HasColumns.getSelected()).

Specified by:

selected in interface LinkGrid<T extends StoredObject>

Overrides:

selected in class DataGrid<T extends StoredObject>

Returns:

Selected instance or null.

isInvalid

public boolean isInvalid()

getLinkGrid

public LinkValue<T> getLinkGrid()

canChange

protected final boolean canChange(T item,
 int editorAction)

Description copied from class: EditableObjectGrid

Invoked to check whether a change is allowed from the client side or not.

Overrides:

canChange in class EditableObjectGrid<T extends StoredObject>

Parameters:

item - Item to change.

editorAction - Editor action (One of the static values from EditorAction).

Returns:

True if change is acceptable. If returned false, change will be ignored.