Package com.storedobject.ui

Class ObjectTree<T extends StoredObject>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.grid.Grid<T>

com.vaadin.flow.component.treegrid.TreeGrid<T>

com.storedobject.vaadin.DataTreeGrid<T>

com.storedobject.ui.DataTreeGrid<T>

com.storedobject.ui.ObjectTree<T>

All Implemented Interfaces:

Executable, Reentrant, FilterMethods<T>, HasLogic, ObjectLoader<T>, ObjectSearcher<T>, ObjectSetter<T>, ObjectsSetter<T>, ObjectGridData<T,T>, ObjectLoader<T>, Transactional, ChildVisitor<T,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>>, com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider<T>, Serializable, Runnable, EventListener, Consumer<T>

Direct Known Subclasses:

ObjectTreeBrowser

public class ObjectTree<T extends StoredObject>
extends DataTreeGrid<T>
implements ObjectGridData<T,T>, ChildVisitor<T,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
ObjectTree(boolean large, Class<T> objectClass, Iterable<String> columns, boolean any, int linkType)
ObjectTree(Class<T> objectClass)
ObjectTree(Class<T> objectClass, boolean any)
ObjectTree(Class<T> objectClass, boolean any, int linkType)
ObjectTree(Class<T> objectClass, int linkType)
ObjectTree(Class<T> objectClass, Iterable<String> columns)
ObjectTree(Class<T> objectClass, Iterable<String> columns, boolean any)
ObjectTree(Class<T> objectClass, Iterable<String> columns, boolean any, int linkType)
ObjectTree(Class<T> objectClass, Iterable<String> columns, int linkType)

Method Summary

Modifier and Type	Method	Description
boolean	actionAllowed(String action)	Check whether a specific action is allowed or not.
com.vaadin.flow.shared.Registration	addObjectDataLoadedListener(DataLoadedListener listener)
boolean	canAllowAction(String action)	Same as actionAllowed(String) except that this shows a message to the user about it if the action is not allowed.
void	clear()	Clear - remove all entries.
protected ObjectEditor<T>	createObjectEditor()
void	deselectChildren(T parent, boolean includeGrandChildren)	Deselect all children of the parent item.
protected String	getActionPrefix()	Prefix string that is added to the "action" string to determine the actual UIAction to be checked.
Application	getApplication()	Get the current Application.
final ObjectTreeProvider<T>	getDataProvider()
final ObjectTreeProvider<T>	getDelegatedLoader()
final Logic	getLogic()	Get the logic.
Class<T>	getObjectClass()	Class of the object accepted.
final ObjectEditor<T>	getObjectEditor()
T	getRoot()
com.vaadin.flow.component.Component	getViewComponent()	Get the component for creating the view - See HasColumns.getView(boolean) and ExecutableView.getView().
List<T>	listRoots()	Retrieves a list of root elements in the hierarchical structure.
void	loaded()
void	selectChildren(T parent, boolean includeGrandChildren)	Select all children of the parent item.
void	setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)
final void	setLogic(Logic logic)	Set the logic.
void	setNewObjectGenerator(NewObject<T> newObject)
void	setObject(T object)	Set the object.
void	setObjectEditor(ObjectEditor<T> editor)
void	setObjectSetter(ObjectSetter<T> setter)
final void	setRoots(ObjectIterator<T> roots)
final void	setRoots(T... roots)
void	setSplitView()
Stream<T>	streamChildren(T parent)	Produces a stream of child elements for the given parent element.

Methods inherited from class com.storedobject.vaadin.DataTreeGrid

addConstructedListener, addHierarchyColumn, appendFooter, clearConstructedListeners, createHierarchyColumn, createHTMLHierarchyColumn, getColumnByKey, getColumns, getSOGrid, isColumnReorderingAllowed, isColumnSortable, setColumnReorderingAllowed, streamConstructedListeners

Methods inherited from class com.vaadin.flow.component.treegrid.TreeGrid

addCollapseListener, addComponentHierarchyColumn, addExpandListener, collapse, collapse, collapse, collapseRecursively, collapseRecursively, createDefaultArrayUpdater, expand, expand, expand, expandRecursively, expandRecursively, getDataCommunicator, getGenericDataView, getItemsWithChildrenRecursively, getLazyDataView, getListDataView, isExpanded, scrollToEnd, scrollToIndex, scrollToIndex, scrollToItem, setColumns, setDataProvider, setDataProvider, setHierarchyColumn, setHierarchyColumn, setItems, setItems, setItems, setItems, setItems, setUniqueKeyDataGenerator

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, createEditor, createSortingComparator, deselect, deselectAll, getAriaLabel, getArrayUpdater, getBeanType, getClassNameGenerator, getColumnByInternalId, getColumnLayers, getColumnRendering, getDefaultColumnFactory, getDefaultHeaderRow, getDragFilter, getDropFilter, getDropMode, getEditor, getEmptyStateComponent, getEmptyStateText, getFooterRows, getHeaderRows, getNestedNullBehavior, getPageSize, getPartNameGenerator, getPropertySet, getSelectedItems, getSelectionMode, getSelectionModel, getSelectionPreservationMode, getSortOrder, getTooltipPosition, getUniqueKeyProperty, getUniqueKeyProvider, initConnector, insertColumnLayer, isAllRowsVisible, isDetailsVisible, isDetailsVisibleOnClick, isMultiSort, isRowsDraggable, onAttach, onDataProviderChange, onDetach, onEnabledStateChanged, prependFooterRow, prependHeaderRow, recalculateColumnWidths, removeAllColumns, removeAllFooterRows, removeAllHeaderRows, removeColumn, removeColumnByKey, removeColumnLayer, removeColumns, removeFooterRow, removeHeaderRow, removeThemeVariants, scrollToStart, select, setAllRowsVisible, setAriaLabel, setClassNameGenerator, setColumnKey, setColumnOrder, setColumnOrder, setColumnRendering, setColumns, setDefaultMultiSortPriority, setDetailsVisible, setDetailsVisibleOnClick, setDragDataGenerator, setDragFilter, setDropFilter, setDropMode, setEmptyStateComponent, setEmptyStateText, setItemDetailsRenderer, 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.ui.util.ChildVisitor

listChildren, streamRoots, visitAll, visitAll, visitAll, visitAll, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

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.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.storedobject.core.FilterMethods

getFilterCondition, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setLoadFilter, setViewFilter, 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, createView, customizeColumn, customizeRenderer, deselect, deselect, executing, getCaption, getColumn, getColumnCaption, getColumnCount, getColumnDetail, getColumnFunction, getColumnHeaderComponent, getColumnMethodName, getColumnNames, getColumnOrder, getColumnSorter, getColumnTemplate, getConfigureButton, getDataClass, getDefinedColumnCount, getFixedColumnWidth, getMenuItem, getObjectRendered, getObjectUnwrapped, getRelativeColumnWidth, getRenderedColumnNames, getSelected, getSOGrid, getTextAlign, getView, 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

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider

getTreeData, setItems, setItems, setTreeData

Methods inherited from interface com.vaadin.flow.data.provider.HasLazyDataView

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

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

Methods inherited from interface com.storedobject.core.ObjectLoader

applyFilter, canContain, getAllowAny, getLinkType, getMaster, getOrderBy, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, reload, setLinkType, setLinkType, setMaster, setMaster, setOrderBy, 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, getTransactionManager, run, transact, transact, transactControl, transactControl, transactControl, transactControl

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Constructor Details

ObjectTree

public ObjectTree(Class<T> objectClass)

ObjectTree

public ObjectTree(Class<T> objectClass,
 int linkType)

ObjectTree

public ObjectTree(Class<T> objectClass,
 Iterable<String> columns,
 int linkType)

ObjectTree

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

ObjectTree

public ObjectTree(Class<T> objectClass,
 boolean any,
 int linkType)

ObjectTree

public ObjectTree(Class<T> objectClass,
 boolean any)

ObjectTree

public ObjectTree(Class<T> objectClass,
 Iterable<String> columns,
 boolean any)

ObjectTree

public ObjectTree(Class<T> objectClass,
 Iterable<String> columns,
 boolean any,
 int linkType)

ObjectTree

public ObjectTree(boolean large,
 Class<T> objectClass,
 Iterable<String> columns,
 boolean any,
 int linkType)

Method Details

getDelegatedLoader

public final ObjectTreeProvider<T> getDelegatedLoader()

Specified by:

getDelegatedLoader in interface ObjectLoader<T extends StoredObject>

getDataProvider

public final ObjectTreeProvider<T> getDataProvider()

Specified by:

getDataProvider in interface com.vaadin.flow.data.provider.hierarchy.HasHierarchicalDataProvider<T extends StoredObject>

Overrides:

getDataProvider in class com.vaadin.flow.component.treegrid.TreeGrid<T extends StoredObject>

getObjectClass

public Class<T> getObjectClass()

Description copied from interface: ObjectSetter

Class of the object accepted. The default implementation returns null.

Specified by:

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

Specified by:

getObjectClass in interface ObjectLoader<T extends StoredObject>

Specified by:

getObjectClass in interface ObjectSetter<T extends StoredObject>

Returns:

Class of the object.

addObjectDataLoadedListener

public com.vaadin.flow.shared.Registration addObjectDataLoadedListener(DataLoadedListener listener)

setItemLabelGenerator

public void setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)

setLogic

public final void setLogic(Logic logic)

Description copied from interface: HasLogic

Set the logic. This will be invoked by the ApplicationServer when the Logic is executed.

Specified by:

setLogic in interface HasLogic

Specified by:

setLogic in interface Transactional

Parameters:

logic - Logic to set

getLogic

public final Logic getLogic()

Description copied from interface: HasLogic

Get the logic.

Specified by:

getLogic in interface HasLogic

Specified by:

getLogic in interface Transactional

Returns:

Logic

loaded

public void loaded()

getViewComponent

public com.vaadin.flow.component.Component getViewComponent()

Description copied from interface: HasColumns

Get the component for creating the view - See HasColumns.getView(boolean) and ExecutableView.getView().

Specified by:

getViewComponent in interface HasColumns<T extends StoredObject>

Returns:

The component for the view. By default, the grid itself is returned.

setSplitView

public void setSplitView()

clear

public void clear()

Description copied from interface: ObjectLoader

Clear - remove all entries.

Specified by:

clear in interface ObjectLoader<T extends StoredObject>

setObject

public void setObject(T object)

Description copied from interface: ObjectSetter

Set the object.

Specified by:

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

Specified by:

setObject in interface ObjectSetter<T extends StoredObject>

Parameters:

object - Object to set.

setObjectSetter

public void setObjectSetter(ObjectSetter<T> setter)

Specified by:

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

getRoot

public T getRoot()

listRoots

public List<T> listRoots()

Description copied from interface: ChildVisitor

Retrieves a list of root elements in the hierarchical structure. This method provides a collection of elements that serve as entry points or origins in the structure.

Specified by:

listRoots in interface ChildVisitor<T extends StoredObject,T extends StoredObject>

Returns:

a List of elements of type P representing the root elements

streamChildren

public Stream<T> streamChildren(T parent)

Description copied from interface: ChildVisitor

Produces a stream of child elements for the given parent element. This allows traversal or processing of direct child elements in a hierarchical structure.

Specified by:

streamChildren in interface ChildVisitor<T extends StoredObject,T extends StoredObject>

Parameters:

parent - the parent element whose children are to be streamed

Returns:

a stream of child elements directly associated with the specified parent

setRoots

@SafeVarargs
public final void setRoots(T... roots)

setRoots

public final void setRoots(ObjectIterator<T> roots)

getApplication

public Application getApplication()

Description copied from interface: HasColumns

Get the current Application.

Specified by:

getApplication in interface ExecutableView

Specified by:

getApplication in interface HasColumns<T extends StoredObject>

Returns:

Current Application.

setObjectEditor

public void setObjectEditor(ObjectEditor<T> editor)

getObjectEditor

public final ObjectEditor<T> getObjectEditor()

createObjectEditor

protected ObjectEditor<T> createObjectEditor()

setNewObjectGenerator

public void setNewObjectGenerator(NewObject<T> newObject)

selectChildren

public void selectChildren(T parent,
 boolean includeGrandChildren)

Select all children of the parent item.

Parameters:

parent - Parent item.

includeGrandChildren - Whether recursively include grand-children or not.

deselectChildren

public void deselectChildren(T parent,
 boolean includeGrandChildren)

Deselect all children of the parent item.

Parameters:

parent - Parent item.

includeGrandChildren - Whether recursively include grand-children or not.

getActionPrefix

protected String getActionPrefix()

Prefix string that is added to the "action" string to determine the actual UIAction to be checked. See actionAllowed(String). For example, POBrowser returns the value "PO" for this method.

Returns:

Prefix string. The default implementation returns null. That means that all the actions are allowed.

actionAllowed

public boolean actionAllowed(String action)

Check whether a specific action is allowed or not. An action is defined in the UI logic as a keyword like "SEND-ITEMS", "PLACE-ORDER", "RECEIVE-ITEMS", "PRINT-VOUCHER", etc. and there could be corresponding access control applicable within the logic. The user's groups determine whether that user can carry out that action or not. This method returns true/false to denote that the user can carry out the action or not. However, it is up to the logic to decide the course of action.

The user's groups can be configured to allow various UI actions (UIAction. Each UIAction represents a unique "action" string (UIAction.getAction()) and that value should be equal to getActionPrefix() + "-" + action in order to allow that action.

Parameters:

action - Action string.

Returns:

True/false. Please note that it will always return true if getActionPrefix() returns null.

canAllowAction

public boolean canAllowAction(String action)

Same as actionAllowed(String) except that this shows a message to the user about it if the action is not allowed.

Parameters:

action - Action string.

Returns:

True/false.