Package com.storedobject.vaadin

Class HasColumns.SOGrid<T>

java.lang.Object

com.storedobject.vaadin.HasColumns.SOGrid<T>

Type Parameters:

T - Bean type of the grid

Enclosing interface:

HasColumns<T>

public static class HasColumns.SOGrid<T>
extends Object

This class takes care of creation of the columns in the grid. In order to have behaviours of HasColumns, an instance of this class is required and should be returned to the HasColumns.getSOGrid() method. (See the source code of DataGrid and DataTreeGrid classes to get an idea). Also, the following methods of the grid must be overridden: Grid.setColumnReorderingAllowed(boolean), Grid.isColumnReorderingAllowed(), Grid.getColumns(), @Grid.getColumnByKey(String). These methods should check whether the grid is rendered using rendered() method and if not rendered, these method calls to be delegated into this class.

Constructor Summary

Constructors

Constructor	Description
SOGrid(com.vaadin.flow.component.grid.Grid<T> grid, Class<T> objectClass, Iterable<String> columns)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	acceptColumn(com.vaadin.flow.component.grid.Grid.Column<T> column, String columnName)	This will be invoked when each column is constructed.
protected com.vaadin.flow.component.grid.Grid.Column<T>	constructColumn(String columnName, com.vaadin.flow.component.grid.Grid<T> grid, com.vaadin.flow.data.renderer.Renderer<T> renderer, com.vaadin.flow.function.ValueProvider<T,Comparable> valueProviderForComparator, Comparator<T> comparator)	This is where the column is finally constructed.
com.vaadin.flow.component.grid.Grid.Column<T>	getColumnByKey(String columnKey)	Get the column of the grid for the given key.
List<com.vaadin.flow.component.grid.Grid.Column<T>>	getColumns()	Get the columns of the grid.
protected String	getDefaultThemes()	Get the default themes to be set.
boolean	isColumnReorderingAllowed()	Check whether the column reordering is allowed or not.
boolean	rendered()	Check whether the rendering is already done.
void	setColumnReorderingAllowed(boolean allowColumnReordering)	Set whether column reordering is allowed or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SOGrid

public SOGrid(com.vaadin.flow.component.grid.Grid<T> grid,
 Class<T> objectClass,
 Iterable<String> columns)

Constructor.

Parameters:

grid - Grid for which SO grid is being created

objectClass - Data class of the grid

columns - Iterable list of column names (maybe null)

Method Details

getDefaultThemes

protected String getDefaultThemes()

Get the default themes to be set. The default is "row-stripes wrap-cell-content". This could be overridden in HasColumns.constructed() method if required.

Returns:

Default themes.

isColumnReorderingAllowed

public boolean isColumnReorderingAllowed()

Check whether the column reordering is allowed or not. (Delegated method).

Returns:

True if column reordering is allowed.

setColumnReorderingAllowed

public void setColumnReorderingAllowed(boolean allowColumnReordering)

Set whether column reordering is allowed or not. (Delegated method).

Parameters:

allowColumnReordering - True if column reordering is allowed.

getColumns

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

Get the columns of the grid. (Delegated method).

Returns:

Columns of the grid.

getColumnByKey

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

Get the column of the grid for the given key. (Delegated method).

Parameters:

columnKey - Column key

Returns:

Column for the key.

constructColumn

protected com.vaadin.flow.component.grid.Grid.Column<T> constructColumn(String columnName,
 com.vaadin.flow.component.grid.Grid<T> grid,
 com.vaadin.flow.data.renderer.Renderer<T> renderer,
 com.vaadin.flow.function.ValueProvider<T,Comparable> valueProviderForComparator,
 Comparator<T> comparator)

This is where the column is finally constructed. If you have another implementation, this method can be overridden. (For example, an "editable" grid such as Vaadin's GridPro, may construct an "editable" column). One of the parameters valueProviderForComparator and comparator will be null because their values are mutually exclusive.

Parameters:

columnName - Name of the column

grid - Grid for which column needs to be created.

renderer - Renderer for the column

valueProviderForComparator - Value provider for setting the comparator used for in-memory sorting (Could be null)

comparator - Comparator used for sorting this column (Could be null)

Returns:

Column created. Default implementation use the Grid.addColumn(Renderer) method to create the column and set the comparator if it is not null.

acceptColumn

public void acceptColumn(com.vaadin.flow.component.grid.Grid.Column<T> column,
 String columnName)

This will be invoked when each column is constructed. (If you directly create any columns using addColumn methods of the Grid, then it is highly recommended invoking this method for those columns. Also, make sure that a unique column name is used because column name will be used as the column key of the grid).

Parameters:

column - Column that is constructed

columnName - Name of the column

rendered

public boolean rendered()

Check whether the rendering is already done.

Returns:

True if the rendering is done.