Package com.storedobject.vaadin

Class DataTreeGrid<T>

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>

Type Parameters:

T - Bean type

All Implemented Interfaces:

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

Direct Known Subclasses:

DataTreeGrid

@CssImport("./so/grid/styles.css")
public class DataTreeGrid<T>
extends com.vaadin.flow.component.treegrid.TreeGrid<T>
implements HasColumns<T>

Enhancement to Vaadin's TreeGrid to handle Java Beans in a specialized way. Please note that this is not supporting the functionality supported by Vaadin's Bean TreeGrid but has similar functionality. The main difference in use is that instead of addColumn methods, one should use the createColumn methods. createColumn methods just return whether column can be created or not but, columns are created at a later stage when all columns are defined and the ordinal of columns is determined. If you want to customize any Column, it can be done in customizeColumn(String, Column) method or by invoking methods provided in this claas (See the implementation of the interface HasColumns). Each column has a "column name" and it gets mapped to the Bean's getXXX method just like in Vaadin's Bean Grid. However, if a getXXX method is available in the DataGrid itself, that will be used for sourcing the data for the respective column. Each column uses its respective column name as the key.

Author:

Syam

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
DataTreeGrid(Class<T> objectClass)	Constructor that will generate columns from the Bean's properties.
DataTreeGrid(Class<T> objectClass, Iterable<String> columns)	Constructor that will generate columns from the column names passed.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addConstructedListener(ConstructedListener constructedListener)	Add a ConstructedListener so that we will be informed about when the columns are constructed.
com.vaadin.flow.component.grid.Grid.Column<T>	addHierarchyColumn(com.vaadin.flow.function.ValueProvider<T,?> valueProvider)	This method always return null.
GridRow	appendFooter()	Append a footer row.
void	clearConstructedListeners()	Clear all ConstructedListeners.
com.vaadin.flow.component.grid.Grid.Column<T>	createHierarchyColumn(String columnName, com.vaadin.flow.function.ValueProvider<T,?> valueProvider)	Add the hierarchy column.
com.vaadin.flow.component.grid.Grid.Column<T>	createHTMLHierarchyColumn(String columnName, Function<T,?> htmlFunction)	Add an HTML hierarchy column.
final com.vaadin.flow.component.grid.Grid.Column<T>	getColumnByKey(String columnKey)
final List<com.vaadin.flow.component.grid.Grid.Column<T>>	getColumns()
final HasColumns.SOGrid<T>	getSOGrid()	For internal use only.
boolean	isColumnReorderingAllowed()
boolean	isColumnSortable(String columnName)	Check if a particular column is sortable or not.
void	setColumnReorderingAllowed(boolean allowColumnReordering)
Stream<ConstructedListener>	streamConstructedListeners()	Get the stream of ConstructedListeners what were added to this.

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, getDataProvider, 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.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

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

addDetachListener

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

addItemSelectedListener, addItemsSelectedListener, appendHeader, clearAlerts, compact, configure, constructed, createColumn, createColumn, createColumn, createColumn, createColumn, createComponentColumn, createDecoratedWindow, createFooters, createHeader, createHeaders, createHTMLColumn, createView, 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, getSelected, getTextAlign, getView, getViewComponent, ignoreCaseForColumnSorting, includeColumn, isColumnFrozen, isColumnResizable, isColumnVisible, prependFooter, prependHeader, refresh, refresh, refresh, removeItemSelectedListener, render, select, select, setCaption, setColumnFrozen, setColumnResizable, setColumnVisible, setMethodHandlerHost, sort, sort, sortOrder, sortOrder, 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.vaadin.util.SupportWindowMode

createWindow

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Constructor Details

DataTreeGrid

public DataTreeGrid(Class<T> objectClass)

Constructor that will generate columns from the Bean's properties.

Parameters:

objectClass - Bean type

DataTreeGrid

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

Constructor that will generate columns from the column names passed.

Parameters:

objectClass - Bean type

columns - Column names

Method Details

isColumnSortable

public boolean isColumnSortable(String columnName)

Check if a particular column is sortable or not. (By default, sorting is off.)

Specified by:

isColumnSortable in interface HasColumns<T>

Parameters:

columnName - Column name

Returns:

True or false.

getSOGrid

public final HasColumns.SOGrid<T> getSOGrid()

For internal use only.

Specified by:

getSOGrid in interface HasColumns<T>

Returns:

SO grid.

addConstructedListener

public com.vaadin.flow.shared.Registration addConstructedListener(ConstructedListener constructedListener)

Description copied from interface: HasColumns

Add a ConstructedListener so that we will be informed about when the columns are constructed.

Specified by:

addConstructedListener in interface HasColumns<T>

Parameters:

constructedListener - Listener.

Returns:

Registration.

streamConstructedListeners

public Stream<ConstructedListener> streamConstructedListeners()

Description copied from interface: HasColumns

Get the stream of ConstructedListeners what were added to this.

Specified by:

streamConstructedListeners in interface HasColumns<T>

Returns:

Stream of ConstructedListeners.

clearConstructedListeners

public void clearConstructedListeners()

Description copied from interface: HasColumns

Clear all ConstructedListeners.

Specified by:

clearConstructedListeners in interface HasColumns<T>

isColumnReorderingAllowed

public boolean isColumnReorderingAllowed()

Overrides:

isColumnReorderingAllowed in class com.vaadin.flow.component.grid.Grid<T>

setColumnReorderingAllowed

public void setColumnReorderingAllowed(boolean allowColumnReordering)

Overrides:

setColumnReorderingAllowed in class com.vaadin.flow.component.grid.Grid<T>

getColumns

public final List<com.vaadin.flow.component.grid.Grid.Column<T>> getColumns()

Overrides:

getColumns in class com.vaadin.flow.component.grid.Grid<T>

getColumnByKey

public final com.vaadin.flow.component.grid.Grid.Column<T> getColumnByKey(String columnKey)

Overrides:

getColumnByKey in class com.vaadin.flow.component.grid.Grid<T>

addHierarchyColumn

public com.vaadin.flow.component.grid.Grid.Column<T> addHierarchyColumn(com.vaadin.flow.function.ValueProvider<T,?> valueProvider)

This method always return null. Instead of this method, use createHierarchyColumn(String, ValueProvider).

Overrides:

addHierarchyColumn in class com.vaadin.flow.component.treegrid.TreeGrid<T>

Parameters:

valueProvider - Value provider for column values

Returns:

null

createHierarchyColumn

public com.vaadin.flow.component.grid.Grid.Column<T> createHierarchyColumn(String columnName,
 com.vaadin.flow.function.ValueProvider<T,?> valueProvider)

Add the hierarchy column. If this or any of its cousin method is never called, the first column created will be made the hierarchy column.

Specified by:

createHierarchyColumn in interface HasColumns<T>

Parameters:

columnName - Name of the column

valueProvider - Value provider for the column

Returns:

Column created.

createHTMLHierarchyColumn

public com.vaadin.flow.component.grid.Grid.Column<T> createHTMLHierarchyColumn(String columnName,
 Function<T,?> htmlFunction)

Add an HTML hierarchy column. If this or any of its cousin method is never called, the first column created will be made the hierarchy column.

Specified by:

createHTMLHierarchyColumn in interface HasColumns<T>

Parameters:

columnName - Name of the column

htmlFunction - Function that returns HTML content

Returns:

Column created.

appendFooter

public GridRow appendFooter()

Description copied from interface: HasColumns

Append a footer row. See HasColumns.createFooters().

Specified by:

appendFooter in interface HasColumns<T>

Returns:

Row created.