Package com.storedobject.ui

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

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

ObjectTreeEditor, ObjectTreeViewer

public class ObjectTreeBrowser<T extends StoredObject>
extends ObjectTree<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.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>

Field Summary

Fields

Modifier and Type	Field	Description
protected Button	add
protected Button	audit
protected final ButtonLayout	buttonPanel
protected Button	delete
protected Button	edit
protected Button	excel
protected Button	exit
protected Button	reload
protected Button	report
protected Button	view

Constructor Summary

Constructors

Constructor	Description
ObjectTreeBrowser(Class<T> objectClass)
ObjectTreeBrowser(Class<T> objectClass, int actions)
ObjectTreeBrowser(Class<T> objectClass, int actions, String caption)
ObjectTreeBrowser(Class<T> objectClass, Iterable<String> columns)
ObjectTreeBrowser(Class<T> objectClass, Iterable<String> columns, int actions)
ObjectTreeBrowser(Class<T> objectClass, Iterable<String> columns, int actions, String caption)
ObjectTreeBrowser(Class<T> objectClass, String caption)
ObjectTreeBrowser(String className)

Method Summary

Modifier and Type	Method	Description
protected void	addExtraButtons()
protected boolean	canAdd(T parentObject)
protected boolean	canDelete(T object)
protected boolean	canEdit(T object)
void	clicked(com.vaadin.flow.component.Component c)	Default implementation, does nothing.
static <O extends StoredObject> ObjectTreeBrowser<O>	create(Class<O> objectClass)
static <O extends StoredObject> ObjectTreeBrowser<O>	create(Class<O> objectClass, int actions)
static <O extends StoredObject> ObjectTreeBrowser<O>	create(Class<O> objectClass, int actions, String title)
static <O extends StoredObject> ObjectTreeBrowser<O>	create(Class<O> objectClass, Iterable<String> columns, int actions, String title)
protected void	createExtraButtons()
com.vaadin.flow.component.Component	createHeader()	You can have a "header row" (as the first row) that covers the whole grid.
protected int	filterActions(int actions)
protected boolean	isActionAllowed(String action)
void	load(int linkType, StoredObject master, String condition, String orderedBy, boolean any)	Load the links of the given "master" instance.
void	load(String condition, String orderedBy, boolean any)	Load the instances.
protected void	removeAllowedAction(String action)
void	setSplitView()

Methods inherited from class com.storedobject.ui.ObjectTree

actionAllowed, addObjectDataLoadedListener, canAllowAction, clear, createObjectEditor, deselectChildren, getActionPrefix, getApplication, getDataProvider, getDelegatedLoader, getLogic, getObjectClass, getObjectEditor, getRoot, getViewComponent, listRoots, loaded, selectChildren, setItemLabelGenerator, setLogic, setNewObjectGenerator, setObject, setObjectEditor, setObjectSetter, setRoots, setRoots, visitChildren

Methods inherited from class com.storedobject.ui.DataTreeGrid

scrollTo

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, getColumnLayers, getColumnRendering, getDefaultColumnFactory, getDefaultHeaderRow, getDragFilter, getDropFilter, getDropMode, getEditor, getEmptyStateComponent, getEmptyStateText, getFooterRows, getHeaderRows, getNestedNullBehavior, getPageSize, getPartNameGenerator, getPropertySet, getSelectedItems, getSelectionMode, getSelectionModel, getSelectionPreservationMode, getSortOrder, 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, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSelectionPreservationMode, setSortableColumns, setTooltipGenerator, 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.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, 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, 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, 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, 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

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Field Details

buttonPanel

protected final ButtonLayout buttonPanel

add

protected Button add

edit

protected Button edit

delete

protected Button delete

reload

protected Button reload

view

protected Button view

report

protected Button report

excel

protected Button excel

audit

protected Button audit

exit

protected Button exit

Constructor Details

ObjectTreeBrowser

public ObjectTreeBrowser(Class<T> objectClass)

ObjectTreeBrowser

public ObjectTreeBrowser(Class<T> objectClass,
 String caption)

ObjectTreeBrowser

public ObjectTreeBrowser(Class<T> objectClass,
 int actions)

ObjectTreeBrowser

public ObjectTreeBrowser(Class<T> objectClass,
 int actions,
 String caption)

ObjectTreeBrowser

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

ObjectTreeBrowser

public ObjectTreeBrowser(Class<T> objectClass,
 Iterable<String> columns,
 int actions)

ObjectTreeBrowser

public ObjectTreeBrowser(Class<T> objectClass,
 Iterable<String> columns,
 int actions,
 String caption)

ObjectTreeBrowser

public ObjectTreeBrowser(String className)
                  throws Exception

Throws:

Exception

Method Details

create

public static <O extends StoredObject>
ObjectTreeBrowser<O> create(Class<O> objectClass)

create

public static <O extends StoredObject>
ObjectTreeBrowser<O> create(Class<O> objectClass,
 int actions)

create

public static <O extends StoredObject>
ObjectTreeBrowser<O> create(Class<O> objectClass,
 int actions,
 String title)

create

public static <O extends StoredObject>
ObjectTreeBrowser<O> create(Class<O> objectClass,
 Iterable<String> columns,
 int actions,
 String title)

createHeader

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

Description copied from interface: HasColumns

You can have a "header row" (as the first row) that covers the whole grid. Typically, such a row is to show your own buttons or components to customize the grid. The default implementation returns null and thus, no such row is created. (Please note that HasColumns.createHeaders()} is invoked before this method for adding other header rows just above the main header row. This may be used for column grouping etc.)

Returns:

Component to be used as the "header row".

isActionAllowed

protected boolean isActionAllowed(String action)

removeAllowedAction

protected void removeAllowedAction(String action)

filterActions

protected int filterActions(int actions)

createExtraButtons

protected void createExtraButtons()

addExtraButtons

protected void addExtraButtons()

load

public void load(int linkType,
 StoredObject master,
 String condition,
 String orderedBy,
 boolean any)

Description copied from interface: ObjectLoader

Load the links of the given "master" instance. Current "load filter" if set will be applied.

Parameters:

linkType - Link type.

master - Master instance.

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

load

public void load(String condition,
 String orderedBy,
 boolean any)

Description copied from interface: ObjectLoader

Load the instances. Current "load filter" if set will be applied. If "master" is already set, "links" of the "master" will be loaded.

Parameters:

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

setSplitView

public void setSplitView()

Overrides:

setSplitView in class ObjectTree<T extends StoredObject>

canDelete

protected boolean canDelete(T object)

canEdit

protected boolean canEdit(T object)

canAdd

protected boolean canAdd(T parentObject)

clicked

public void clicked(com.vaadin.flow.component.Component c)

Description copied from interface: ExecutableView

Default implementation, does nothing.

Parameters:

c - Component