Package com.storedobject.ui
Class ReferenceLinkGrid<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.ReferenceLinkGrid<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>
- See Also:
-
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
ConstructorsConstructorDescriptionReferenceLinkGrid(ObjectLinkField<T> linkField) ReferenceLinkGrid(ObjectLinkField<T> linkField, boolean createContextMenu) ReferenceLinkGrid(ObjectLinkField<T> linkField, Iterable<String> columns) ReferenceLinkGrid(ObjectLinkField<T> linkField, Iterable<String> columns, boolean createContextMenu) -
Method Summary
Modifier and TypeMethodDescriptionvoidadd()booleanvoidThis method is called whenever a filter condition is changed.protected final booleanInvoked to check whether a change is allowed from the client side or not.booleanprotected final EditableList<T> voidCreate extra header rows if required here by invokingHasColumns.prependHeader()orHasColumns.appendHeader()(typically useful for creating column grouping etc.).protected AbstractListProvider<T> createListDataProvider(DataList<T> data) Create an instance ofListDataProviderfor the given data.voidcustomizeColumn(String columnName, com.vaadin.flow.component.grid.Grid.Column<T> column) This method is invoked when the column is actually constructed.voiddelete()protected voiddoDeleteAction(T object) Carry out the delete action for the object.protected voiddoInsertAction(T object) Carry out the insert action for the object.protected voidCarry out the "reload all" action.protected voiddoUndeleteAction(T object) Carry out the undelete action for the object.protected voiddoUpdateAction(T object) Carry out the update action for the object.voidedit()intgetColumnOrder(String columnName) Return value from this method determines the order in which columns are displayed.getLink()booleanCheck whether it allows objects of derived classes or not.booleanprotected booleanvoidreload()Reload all entries.voidvoidsetFromClient(boolean fromClient) voidsetOrderBy(String orderBy, boolean load) Set the "ORDER BY" clause.voidsetReadOnly(boolean readOnly) Set read only.intsize()Get the instances count.Methods inherited from class com.storedobject.ui.AbstractLinkGrid
constructObjectEditor, createObjectEditor, createView, getField, getItem, getMaster, getName, getSelected, getType, getView, getView, isDetail, isEnabled, reloadedAllNow, setMasterMethods inherited from class com.storedobject.ui.EditableObjectGrid
addAll, addAll, addObjectChangedListener, addValueChangeTracker, append, cancelEdit, clear, customizeObjectEditor, deletedNow, doReloadAction, editItem, getColumnField, getDelegatedLoader, getEditingItem, getField, getObjectEditor, getRowEditor, insertedNow, isColumnEditable, isReadOnly, reloadedNow, removeObjectChangedListener, saveEdited, setAutoSaveOnMove, setObjectSetter, setViewFilter, streamEditableFields, undeletedNow, updatedNow, validateDataMethods inherited from class com.storedobject.ui.AbstractEditableGrid
changed, createEditor, delete, getEditableList, isAdded, isColumnSortable, isDeleted, isEdited, isSavePending, reload, setEditOnSingleClick, streamAdded, streamAll, streamDeleted, streamEdited, updateMethods 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, validateUpdateMethods 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, subList, toArray, toArrayMethods inherited from class com.storedobject.vaadin.DataGrid
addConstructedListener, appendFooter, clearConstructedListeners, getColumnByKey, getColumns, getSOGrid, isColumnReorderingAllowed, setColumnReorderingAllowed, streamConstructedListenersMethods 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, updateSelectionModeOnClientMethods 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, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListenerMethods inherited from interface com.storedobject.vaadin.ClickHandler
clicked, doubleClicked, onComponentEvent, rightClickedMethods inherited from interface java.util.Collection
parallelStream, stream, toArrayMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.storedobject.ui.EditableDataGrid
canDelete, canEdit, canPostLedger, canViewLedgerMethods inherited from interface com.storedobject.common.Executable
actMethods 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, warningMethods inherited from interface com.storedobject.core.FilterMethods
getFilterCondition, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setLoadFilter, setViewFilterMethods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndexMethods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListenerMethods 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, customizeRenderer, deselect, deselect, executing, getApplication, getCaption, getColumn, getColumnCaption, getColumnCount, getColumnDetail, getColumnFunction, getColumnHeaderComponent, getColumnMethodName, getColumnNames, 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, unwrapMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods inherited from interface com.vaadin.flow.component.HasEnabled
setEnabledMethods 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, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNameMethods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeNameMethods inherited from interface com.storedobject.ui.LinkGrid
clear, getObjectClass, getObjectEditor, getOldValue, isAllowAdd, isAllowDelete, isAllowEdit, isAllowReload, isAllowReloadAll, isInvalid, isReadOnly, itemAppended, itemDeleted, itemInserted, itemReloaded, itemUndeleted, itemUpdated, select, selected, setAllowAdd, setAllowDelete, setAllowEdit, setAllowReload, setAllowReloadAll, setMasterView, setObjectEditor, setValue, viewMethods inherited from interface java.util.List
addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, reversed, spliteratorMethods inherited from interface com.storedobject.ui.ObjectEditorListener
editingCancelled, editingEnded, editingStartedMethods inherited from interface com.storedobject.ui.ObjectGridData
canSearch, convert, createSearchBuilder, deselect, deselectAll, doLoad, getEntityFilter, getLoadFilter, getObjectClass, getObjectCount, getSearchBuilder, getSelectionModel, isSearchMode, populate, populate, populate, resetSearch, scrollTo, search, search, search, select, setLoadFilter, setObject, setObjectConsumer, setObjectConsumer, setObjects, setSelectionMode, validateFilterConditionMethods 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, setOrderByMethods inherited from interface com.storedobject.ui.ObjectLoader
addDataLoadedListener, applyFilterPredicate, clear, get, getCacheLevel, getEffectiveCondition, getFixedFilter, indexOf, load, setExtraFilter, setExtraFilter, setFilter, setFilter, setFixedFilter, setFixedFilter, setFixedFilter, setFixedFilter, streamAll, streamFilteredMethods inherited from interface com.storedobject.core.ObjectSetter
accept, setObjectMethods inherited from interface com.storedobject.common.Reentrant
isReentrantMethods inherited from interface com.storedobject.vaadin.util.SupportWindowMode
createWindowMethods inherited from interface com.storedobject.ui.Transactional
commit, execute, getLogic, getTransactionManager, run, setLogic, transact, transact, transactControl, transactControl, transactControl, transactControlMethods inherited from interface com.storedobject.vaadin.ValueChangeHandler
valueChangedMethods inherited from interface com.storedobject.ui.util.ViewFilterSupport
configure, configure, configure, configureMatch, filterView, getViewFilter
-
Constructor Details
-
ReferenceLinkGrid
-
ReferenceLinkGrid
-
ReferenceLinkGrid
-
ReferenceLinkGrid
public ReferenceLinkGrid(ObjectLinkField<T> linkField, Iterable<String> columns, boolean createContextMenu)
-
-
Method Details
-
createEditableList
- Overrides:
createEditableListin classAbstractEditableGrid<T extends StoredObject>
-
isValid
- Overrides:
isValidin classEditableObjectGrid<T extends StoredObject>
-
createListDataProvider
Description copied from class:ListGridCreate an instance ofListDataProviderfor the given data. The default implementation creates an instance of Vaadin's implementation. However, a modified implementation can be provided instead.- Overrides:
createListDataProviderin classEditableObjectGrid<T extends StoredObject>- Parameters:
data- Data for which data provider needs to be created.- Returns:
- An instance of the
ListDataProvider.
-
setFromClient
public void setFromClient(boolean fromClient) - Overrides:
setFromClientin classAbstractEditableGrid<T extends StoredObject>
-
isFromClient
public boolean isFromClient()- Overrides:
isFromClientin classAbstractEditableGrid<T extends StoredObject>
-
getColumnOrder
Description copied from interface:HasColumnsReturn 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.- Specified by:
getColumnOrderin interfaceHasColumns<T extends StoredObject>- Overrides:
getColumnOrderin classAbstractEditableGrid<T extends StoredObject>- 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:HasColumnsThis method is invoked when the column is actually constructed.- Specified by:
customizeColumnin interfaceHasColumns<T extends StoredObject>- Overrides:
customizeColumnin classAbstractEditableGrid<T extends StoredObject>- Parameters:
columnName- Column namecolumn- Grid column that may be customized
-
createHeaders
public void createHeaders()Description copied from interface:HasColumnsCreate extra header rows if required here by invokingHasColumns.prependHeader()orHasColumns.appendHeader()(typically useful for creating column grouping etc.). The default implementation does nothing. This is invoked beforeHasColumns.createHeader(). -
getButtonPanel
-
getLink
-
isAllowAny
public boolean isAllowAny()Description copied from interface:ObjectSetterCheck whether it allows objects of derived classes or not. The default implementation returnsfalse.- Returns:
- True/false.
-
contains
-
add
- Specified by:
addin interfaceCollection<T extends StoredObject>- Specified by:
addin interfaceList<T extends StoredObject>- Overrides:
addin classEditableObjectGrid<T extends StoredObject>
-
add
public void add() -
applyFilter
public void applyFilter()Description copied from interface:FilterMethodsThis 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:
applyFilterin interfaceFilterMethods<T extends StoredObject>- Specified by:
applyFilterin interfaceObjectLoader<T extends StoredObject>- Overrides:
applyFilterin classAbstractLinkGrid<T extends StoredObject>
-
setOrderBy
Description copied from interface:ObjectLoaderSet the "ORDER BY" clause.- Specified by:
setOrderByin interfaceObjectLoader<T extends StoredObject>- Overrides:
setOrderByin classAbstractLinkGrid<T extends StoredObject>- Parameters:
orderBy- "ORDER BY" clause to set.load- Whether to immediately reload with this "ORDER BY" clause or not.
-
edit
public void edit() -
delete
public void delete() -
reload
public void reload()Description copied from interface:ObjectLoaderReload all entries.- Specified by:
reloadin interfaceLinkGrid<T extends StoredObject>- Specified by:
reloadin interfaceObjectLoader<T extends StoredObject>- Overrides:
reloadin classAbstractLinkGrid<T extends StoredObject>
-
reloadAll
public void reloadAll()- Specified by:
reloadAllin interfaceLinkGrid<T extends StoredObject>- Overrides:
reloadAllin classAbstractEditableGrid<T extends StoredObject>
-
getSearcher
-
setReadOnly
public void setReadOnly(boolean readOnly) Description copied from class:EditableObjectGridSet read only.- Specified by:
setReadOnlyin interfaceLinkGrid<T extends StoredObject>- Overrides:
setReadOnlyin classEditableObjectGrid<T extends StoredObject>- Parameters:
readOnly- If true, rows will not be editable.
-
size
public int size()Description copied from interface:ObjectLoaderGet the instances count.- Specified by:
sizein interfaceCollection<T extends StoredObject>- Specified by:
sizein interfaceLinkGrid<T extends StoredObject>- Specified by:
sizein interfaceList<T extends StoredObject>- Specified by:
sizein interfaceObjectLoader<T extends StoredObject>- Specified by:
sizein interfaceObjectLoader<T extends StoredObject>- Overrides:
sizein classListGrid<T extends StoredObject>- Returns:
- Count.
-
getLinkGrid
-
doInsertAction
Description copied from class:DataGridCarry out the insert action for the object. The object is already validated.- Overrides:
doInsertActionin classEditableObjectGrid<T extends StoredObject>- Parameters:
object- Item that is newly added.
-
doUpdateAction
Description copied from class:DataGridCarry out the update action for the object. The object is already validated.- Overrides:
doUpdateActionin classEditableObjectGrid<T extends StoredObject>- Parameters:
object- Item that is updated.
-
doDeleteAction
Description copied from class:DataGridCarry out the delete action for the object. The object is already validated.- Overrides:
doDeleteActionin classEditableObjectGrid<T extends StoredObject>- Parameters:
object- Item that is deleted.
-
doUndeleteAction
Description copied from class:DataGridCarry out the undelete action for the object. The object is already validated.- Overrides:
doUndeleteActionin classEditableObjectGrid<T extends StoredObject>- Parameters:
object- Item that is undeleted.
-
doReloadAllAction
protected void doReloadAllAction()Description copied from class:DataGridCarry out the "reload all" action. All validations are already done before invoking this.- Overrides:
doReloadAllActionin classEditableObjectGrid<T extends StoredObject>
-
canChange
Description copied from class:EditableObjectGridInvoked to check whether a change is allowed from the client side or not.- Overrides:
canChangein classEditableObjectGrid<T extends StoredObject>- Parameters:
item- Item to change.editorAction- Editor action (One of the static values fromEditorAction).- Returns:
- True if change is acceptable. If returned false, change will be ignored.
-