Package com.storedobject.vaadin

Interface ObjectColumnCreator<T>

Type Parameters:

T - Data type of the grid

All Known Implementing Classes:

SOColumnCreator

public interface ObjectColumnCreator<T>

Interface that defines the "column creator" for DataGrid and DataTreeGrid.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
default void	close()	This will be invoked when the process of "column creation" is over.
default ObjectColumnCreator<T>	create(HasColumns<T> grid)	Create a "column creator" for the given grid.
default String	getColumnCaption(String columnName)	Get the header text for the given column.
default Function<T,?>	getColumnFunction(String columnName)	Get the function that is used to generate the content of a particular column.
default Method	getColumnMethod(String columnName)	Get the method that is used to generate the content of a particular column.
default Stream<String>	getColumnNames()	Get the column names for the grid.
default int	getColumnOrder(String columnName)	Get the order of the column to be displayed in the grid.
default com.vaadin.flow.component.grid.ColumnTextAlign	getColumnTextAlign(String columnName, Class<?> valueType)	Get the text alignment of a particular column.
default Class<?>	getColumnValueType(String columnName)	Get the value type of particular column.

Method Details

create

default ObjectColumnCreator<T> create(HasColumns<T> grid)

Create a "column creator" for the given grid.

Parameters:

grid - The grid for which columns need to be created.

Returns:

Column creator. The default implementation return the self reference.

getColumnNames

default Stream<String> getColumnNames()

Get the column names for the grid.

Returns:

Stream of column names.

getColumnMethod

default Method getColumnMethod(String columnName)

Get the method that is used to generate the content of a particular column.

Parameters:

columnName - Name of the column

Returns:

Method. Default implementation returns null.

getColumnFunction

default Function<T,?> getColumnFunction(String columnName)

Get the function that is used to generate the content of a particular column.

Parameters:

columnName - Name of the column

Returns:

Function. Default implementation returns null.

getColumnOrder

default int getColumnOrder(String columnName)

Get the order of the column to be displayed in the grid. It could be any integer number and lower numbered columns will be on the left side.

Parameters:

columnName - Name of the column

Returns:

An integer number representing the order. Default implementation returns Integer.MIN_VALUE.

getColumnCaption

default String getColumnCaption(String columnName)

Get the header text for the given column.

Parameters:

columnName - Name of the column

Returns:

Header text. Default implementation returns the value from ApplicationEnvironment.createLabel(String).

getColumnTextAlign

default com.vaadin.flow.component.grid.ColumnTextAlign getColumnTextAlign(String columnName,
 Class<?> valueType)

Get the text alignment of a particular column.

Parameters:

columnName - Name of the column

valueType - Value type of the column (If the value tye can not be determined, it will be null)

Returns:

Text alignment. Default implementation returns START if the value type is null or non-numeric.

getColumnValueType

default Class<?> getColumnValueType(String columnName)

Get the value type of particular column.

Parameters:

columnName - Name of the column

Returns:

Value type. The default implementation returns null.

close

default void close()

This will be invoked when the process of "column creation" is over. Default implementation does nothing.