Package com.storedobject.vaadin

Interface HasColumns<T>

Type Parameters:

T - Bean type of the Grid/TreeGrid.

All Superinterfaces:

ClickHandler, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<? extends com.vaadin.flow.component.Component>>, EventListener, ExecutableView, com.vaadin.flow.component.HasValue.ValueChangeListener, Runnable, Serializable, SupportWindowMode, ValueChangeHandler

All Known Subinterfaces:

ObjectGridData<T,ROOT>

All Known Implementing Classes:

AbstractAssembly, AbstractCheckListForestBrowser, AbstractEditableGrid, AbstractInvoiceBrowser, AbstractLinkGrid, AbstractObjectForest, AbstractReceiveMaterialReturned, AbstractReceiveMaterialTransferred, AbstractRequestMaterial, AbstractReturnMaterial, AbstractSale, AbstractSendAndReceiveMaterial, ActionGrid, ApproveTransaction, Assembly, AssemblyDataPickup, AssemblyReceipt, BaseCustomerInvoiceBrowser, BaseObjectForest, BaseProcessMaterialRequest, BaseReceiveMaterialRequested, BaseRequestMaterial, BaseSupplierInvoiceBrowser, CheckListForestBrowser, CrossServerManager, CustomerInvoiceBrowser, DataGrid, DataGrid, DataTreeGrid, DataTreeGrid, DataView, DefineAssembly, DetailLinkGrid, EditableGrid, EditableObjectGrid, FileManager, FileViewer, FileViewerGrid, GRN, ItemMovementView, ItemsSentForRepair, JournalVoucherBrowser, JournalVoucherView, JSONGrid, ListEditor, ListGrid, LocateItem, LocationMonitoring, ManageBiometric, ManageSalutation, ManageSuffix, MemoSystem, MessageGrid, MultiSelectGrid, MultiSelectStock, ObjectBrowser, ObjectBrowserEditor, ObjectBrowserViewer, ObjectComparisonGrid, ObjectForest, ObjectForestBrowser, ObjectForestEditor, ObjectForestViewer, ObjectGrid, ObjectHistoryGrid, ObjectListEditor, ObjectListGrid, ObjectMemoryGrid, ObjectSearchBrowser, ObjectTree, ObjectTreeBrowser, ObjectTreeEditor, ObjectTreeViewer, PackingUnitBrowser, POBrowser, POItemBrowser, ProcessMaterialRequest, QueryGrid, ReceiveAndBin, ReceiveMaterialRequested, ReceiveMaterialReturned, ReceiveMaterialTransferred, ReferenceLinkGrid, RequestMaterial, RequestTool, RestrictedSystemUserBrowser, ReturnMaterial, ReturnTool, Sale, SelectGrid, SelectStock, SendItemsForRepair, StatementView, StatusGrid, SupplierInvoiceBrowser, SupportSystem, SystemUserGroupBrowser, TextContentBrowser, ToolMonitoring, TransferMaterial, UnitDefinitionBrowser, ViewAssembly, ViewAssemblyDefinition, ViewGrid, ViewGrid, XGrid, XMLGrid

public interface HasColumns<T>
extends ExecutableView, SupportWindowMode

Common interface for DataGrid and DataTreeGrid. (Other implementations of Grid may also implement this).

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HasColumns.SOGrid<T>	This class takes care of creation of the columns in the grid.

Nested classes/interfaces inherited from interface com.storedobject.vaadin.ClickHandler

ClickHandler.ModifiedClickEvent<C extends com.vaadin.flow.component.Component>

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.
default void	addItemSelectedListener(ItemSelectedListener<T> itemSelectedListener)	Add an "item selected listener" to the grid.
default void	addItemsSelectedListener(ItemsSelectedListener<T> itemsSelectedListener)	Add an "items selected listener" to the grid.
default GridRow	appendFooter()	Append a footer row.
default GridRow	appendHeader()	Append a header row.
default void	clearAlerts()	Clear all alters owned by this view.
void	clearConstructedListeners()	Clear all ConstructedListeners.
default void	compact()	Set the "theme" to make the appearance of this grid compact.
default void	configure()	Configure the columns.
default void	constructed()	This method is invoked once all the columns are built and the grid is ready to display.
default boolean	createColumn(String columnName)	Create a column for the given column name.
default boolean	createColumn(String columnName, com.vaadin.flow.data.renderer.Renderer<T> renderer)	Create a column that generates data through a custom renderer.
default boolean	createColumn(String columnName, Method method)	Create a column uses a method to determine its data.
default boolean	createColumn(String columnName, String template, Function<T,?>... functions)	Create a column that uses one or more functions to generate its column value.
default boolean	createColumn(String columnName, Function<T,?>... functions)	Create a column that uses one or more functions to generate its column value.
default <C extends com.vaadin.flow.component.Component> boolean	createComponentColumn(String columnName, Function<T,C> componentProvider)	Create a Component column that uses Component provided by the function as its column value.
default Window	createDecoratedWindow(View view)	This method creates a decorated Window.
default void	createFooters()	Create footer rows if required here by invoking appendFooter() or prependFooter().
default com.vaadin.flow.component.Component	createHeader()	You can have a "header row" (as the first row) that covers the whole grid.
default void	createHeaders()	Create extra header rows if required here by invoking prependHeader() or appendHeader() (typically useful for creating column grouping etc.).
default com.vaadin.flow.component.grid.Grid.Column<T>	createHierarchyColumn(String columnName, com.vaadin.flow.function.ValueProvider<T,?> valueProvider)	Add the hierarchy column.
default boolean	createHTMLColumn(String columnName, Function<T,?> htmlFunction)	Create an HTML column that uses HTML emitted by the function as its column value.
default com.vaadin.flow.component.grid.Grid.Column<T>	createHTMLHierarchyColumn(String columnName, Function<T,?> htmlFunction)	Add an HTML hierarchy column.
default View	createView()	Create a View to display the grid when executed.
default void	customizeColumn(String columnName, com.vaadin.flow.component.grid.Grid.Column<T> column)	This method is invoked when the column is actually constructed.
default void	customizeRenderer(String columnName, com.vaadin.flow.data.renderer.LitRenderer<T> renderer)	Customize the renderer for the given column.
default void	deselect(Iterable<T> items)	Deselect rows.
default void	deselect(Iterator<T> items)	Deselect rows.
default boolean	executing()	Check if this grid is currently being displayed or not through the associated view.
default <A extends Application> A	getApplication()	Get the current Application.
default String	getCaption()	Caption used when displaying it in a View.
default com.vaadin.flow.component.grid.Grid.Column<T>	getColumn(String columnName)	Get the column for the given column name.
default String	getColumnCaption(String columnName)	Get the text to display in the header.
default int	getColumnCount()	Get the column count of the grid.
default GridColumnDetail<T>	getColumnDetail(String columnName)	Get column details.
default Function<T,?>	getColumnFunction(String columnName)	Return a Function for generating column data.
default com.vaadin.flow.component.Component	getColumnHeaderComponent(String columnName)	Get the header component for the specified column.
default String	getColumnMethodName(String columnName)	Get the name of the method to determine column data.
default Stream<String>	getColumnNames()	This method is invoked to find out the names of the columns to be generated.
default int	getColumnOrder(String columnName)	Return value from this method determines the order in which columns are displayed.
default Comparator<T>	getColumnSorter(String columnName)	Get a "sorter" for the column.
default String	getColumnTemplate(String columnName)	Get the template for the given column name.
default ButtonIcon	getConfigureButton()	Get the "configure button" that can be added somewhere in your user interface, usually as the first component of the "header row".
default Class<T>	getDataClass()	Get the data class of the grid.
default int	getDefinedColumnCount()	Get the number of columns that are already defined/created.
default String	getFixedColumnWidth(String columnName)	This method is invoked when the real column is created to determine whether the column requires "fixed and inflexible width" or not.
default ApplicationMenuItem	getMenuItem()	Get the menu item for this when displayed as view.
default T	getObjectRendered()	Get the currently rendered object.
default T	getObjectUnwrapped()	Get the currently rendered unwrapped object.
default int	getRelativeColumnWidth(String columnName)	This method is invoked when the real column is created to determine the relative width of the column.
default T	getSelected()	Get the selected item.
HasColumns.SOGrid<T>	getSOGrid()	This method is invoked multiple times.
default com.vaadin.flow.component.grid.ColumnTextAlign	getTextAlign(String columnName)	Determines the text alignment of the column.
default View	getView(boolean create)	Get the View.
default com.vaadin.flow.component.Component	getViewComponent()	Get the component for creating the view - See getView(boolean) and ExecutableView.getView().
default boolean	ignoreCaseForColumnSorting(String columnName)	This will be invoked for those columns that are sortable and contains text values.
default boolean	includeColumn(String columnName)	Determines the respective column should be created or note.
default boolean	isColumnFrozen(String columnName)	Check the frozen attribute of a given column.
default boolean	isColumnResizable(String columnName)	Check the resizable attribute of a given column.
default boolean	isColumnSortable(String columnName)	Check if the column is in-memory and back-end sortable.
default boolean	isColumnVisible(String columnName)	Check the visibility attribute of a given column.
default GridRow	prependFooter()	Prepend a footer row.
default GridRow	prependHeader()	Prepend a header row.
default void	refresh()	Refresh the whole grid.
default void	refresh(T item)	Refresh a particular item in the grid.
default void	refresh(T item, boolean refreshChildren)	Refresh a particular item in the tree grid.
default void	removeItemSelectedListener(ItemSelectedListener<T> itemSelectedListener)	Remove an "item selected listener" that was previously added to the grid.
default void	render(T object)	This method is invoked just before each row is rendered.
default void	select(Iterable<T> items)	Select rows.
default void	select(Iterator<T> items)	Select rows.
default void	setCaption(String caption)	Set caption used when displaying the grid in a View.
default void	setColumnFrozen(String columnName, boolean frozen)	Set the frozen attribute of a given column.
default void	setColumnResizable(String columnName, boolean resizable)	Set the resizable attribute of a given column.
default void	setColumnVisible(String columnName, boolean visible)	Set the visibility attribute of a given column.
default void	setMethodHandlerHost(Object host)	Set some other object to supply the column methods.
default void	sort(com.vaadin.flow.component.grid.GridSortOrder<T>... sortOrders)	Sort the columns as defined in the "sort order definitions" passed.
default void	sort(String... columnNames)	Sort the given columns in ascending order.
default com.vaadin.flow.component.grid.GridSortOrder<T>	sortOrder(String columnName)	Create "sort order" definition for the given column name.
default com.vaadin.flow.component.grid.GridSortOrder<T>	sortOrder(String columnName, boolean ascending)	Create "sort order" definition for the given column name.
Stream<ConstructedListener>	streamConstructedListeners()	Get the stream of ConstructedListeners what were added to this.
default T	unwrap(T object)	Sometimes the row object being rendered may be embedded in another object and just before rendering the row's column details, it may have to be unwrapped.

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

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.vaadin.util.SupportWindowMode

createWindow

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Method Details

addConstructedListener

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

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

Parameters:

constructedListener - Listener.

Returns:

Registration.

streamConstructedListeners

Stream<ConstructedListener> streamConstructedListeners()

Get the stream of ConstructedListeners what were added to this.

Returns:

Stream of ConstructedListeners.

clearConstructedListeners

void clearConstructedListeners()

Clear all ConstructedListeners.

constructed

default void constructed()

This method is invoked once all the columns are built and the grid is ready to display.

createHeader

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

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

createHeaders

default void createHeaders()

Create extra header rows if required here by invoking prependHeader() or appendHeader() (typically useful for creating column grouping etc.). Default implementation does nothing. This is invoked before createHeader().

createFooters

default void createFooters()

Create footer rows if required here by invoking appendFooter() or prependFooter(). Default implementation does nothing.

prependHeader

default GridRow prependHeader()

Prepend a header row. See createHeaders().

Returns:

Row created.

appendHeader

default GridRow appendHeader()

Append a header row. See createHeaders().

Returns:

Row created.

prependFooter

default GridRow prependFooter()

Prepend a footer row. See createFooters().

Returns:

Row created.

appendFooter

default GridRow appendFooter()

Append a footer row. See createFooters().

Returns:

Row created.

getColumnNames

default Stream<String> getColumnNames()

This method is invoked to find out the names of the columns to be generated. However, this will not be invoked if the column names are already passed in the constructor of the HasColumns.SOGrid. The default implementation returns null (however, this behaviour can be changed by setting up an appropriate ApplicationEnvironment that can create a customized ObjectColumnCreator.getColumnNames()) and in that case, columns names will be determined through getXXX and isXXX methods of the Bean type.

Returns:

Column names to be constructed.

customizeColumn

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

This method is invoked when the column is actually constructed.

Parameters:

columnName - Column name

column - Grid column that may be customized

createView

default View createView()

Create a View to display the grid when executed. If this method returns null, a default View will be created.

Returns:

A View with this grid as the component. Default implementation returns null.

createDecoratedWindow

default Window createDecoratedWindow(View view)

This method creates a decorated Window. This may be invoked from the SupportWindowMode.createWindow(View) method to return a decorated window.

This method is never invoked. However, it can be used within the SupportWindowMode.createWindow(View) method.

Parameters:

view - View for which the window to be created.

Returns:

Decorated window.

compact

default void compact()

Set the "theme" to make the appearance of this grid compact. It uses less space than normal and more rows will be visible.

getObjectRendered

default T getObjectRendered()

Get the currently rendered object. This method is useful when you have your own methods mapped for column values, and you want to do any special setup or computation.

Returns:

Currently rendered object.

render

default void render(T object)

This method is invoked just before each row is rendered. You can do special set up or computation at this stage.

Parameters:

object - Currently rendered object.

getObjectUnwrapped

default T getObjectUnwrapped()

Get the currently rendered unwrapped object. See unwrap(Object).

Returns:

Currently rendered unwrapped object.

unwrap

default T unwrap(T object)

Sometimes the row object being rendered may be embedded in another object and just before rendering the row's column details, it may have to be unwrapped. This method is invoked when the row is rendered and just before the rendering function is applied. The default implementation returns the same object.

Parameters:

object - Currently rendered object.

Returns:

Unwrapped object.

setColumnResizable

default void setColumnResizable(String columnName,
 boolean resizable)

Set the resizable attribute of a given column.

Parameters:

columnName - Name of the column

resizable - Whether resizable or not

isColumnResizable

default boolean isColumnResizable(String columnName)

Check the resizable attribute of a given column.

Parameters:

columnName - Name of the column

Returns:

Whether resizable or not

setColumnVisible

default void setColumnVisible(String columnName,
 boolean visible)

Set the visibility attribute of a given column.

Parameters:

columnName - Name of the column

visible - Whether visible or not

isColumnVisible

default boolean isColumnVisible(String columnName)

Check the visibility attribute of a given column.

Parameters:

columnName - Name of the column

Returns:

Whether visible or not

setColumnFrozen

default void setColumnFrozen(String columnName,
 boolean frozen)

Set the frozen attribute of a given column.

Parameters:

columnName - Name of the column

frozen - Whether frozen or not

isColumnFrozen

default boolean isColumnFrozen(String columnName)

Check the frozen attribute of a given column.

Parameters:

columnName - Name of the column

Returns:

Whether frozen or not

getConfigureButton

default ButtonIcon getConfigureButton()

Get the "configure button" that can be added somewhere in your user interface, usually as the first component of the "header row". The grid columns can be configured by clicking this button.

Returns:

Configure button.

getRelativeColumnWidth

default int getRelativeColumnWidth(String columnName)

This method is invoked when the real column is created to determine the relative width of the column. It can be any positive integer and applied relative to the values returned for other columns. A value of zero means that the column width is fixed.

Note: This is set to the column via the Grid.Column.setFlexGrow(int) method. So, if you directly use the Grid.Column.setFlexGrow(int) method, this can be overridden.

Parameters:

columnName - Name of the column.

Returns:

Default implementation returns -1, meaning the value should not be applied.

getFixedColumnWidth

default String getFixedColumnWidth(String columnName)

This method is invoked when the real column is created to determine whether the column requires "fixed and inflexible width" or not. The value returned should be a CSS compatible width attribute such as "80px" etc.

Parameters:

columnName - Name of the column.

Returns:

Default implementation returns null, meaning the value should not be applied.

getColumnCount

default int getColumnCount()

Get the column count of the grid.

Returns:

Number of columns.

getDataClass

default Class<T> getDataClass()

Get the data class of the grid.

Returns:

Data class.

refresh

default void refresh()

Refresh the whole grid.

refresh

default void refresh(T item)

Refresh a particular item in the grid.

Parameters:

item - Item

refresh

default void refresh(T item,
 boolean refreshChildren)

Refresh a particular item in the tree grid. (This method is applicable only for tree grids).

Parameters:

item - Item

refreshChildren - Whether refresh children or not

getColumnDetail

default GridColumnDetail<T> getColumnDetail(String columnName)

Get column details.

Parameters:

columnName - Column name.

Returns:

Column detail. Null is returned if columns are not yet created.

getColumnFunction

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

Return a Function for generating column data. If this method returns a non-null value, it will be used for rendering the column values unless a getXXX(T object)/isXXX(T object) method exists in the grid itself.

Parameters:

columnName - Column name

Returns:

Default implementation returns null.

getColumnMethodName

default String getColumnMethodName(String columnName)

Get the name of the method to determine column data. Normally, existence of getXXX(T object) or isXXX(T object) methods are checked to determine the method. However, this method can specify that otherwise. If the method name doesn't start with a lowercase character, "get" and "is" prefixes are added to the method name returned to check the existence of the method.

Parameters:

columnName - Column name

Returns:

Name of the method. By default, it returns the same column name.

createColumn

default boolean createColumn(String columnName)

Create a column for the given column name. If the column name is "XXX", it first determines if a getXXX(T object) or isXXX(T object) method is already defined in the grid or not for generating data for this column. If not, it calls the getColumnFunction("XXX") to determine if any Function is defined for this purpose. If not found, it calls the getColumnMethod("XXX") to determine.

Parameters:

columnName - Column name

Returns:

Whether a new column can be created or not.

createColumn

default boolean createColumn(String columnName,
 Function<T,?>... functions)

Create a column that uses one or more functions to generate its column value. It generates a multi-line output with result of each function in separate line unless a template is already defined for this column using getColumnTemplate method.

Parameters:

columnName - Column name

functions - Functions that take object as a parameter and returns some sort of value. Values are stringified before displaying. (Application Environment may be set up to control how the stringification process by defining it in the toDisplay(...) method).

Returns:

Whether a new column can be created or not.

createComponentColumn

default <C extends com.vaadin.flow.component.Component>
boolean createComponentColumn(String columnName,
 Function<T,C> componentProvider)

Create a Component column that uses Component provided by the function as its column value.

Note: Component columns must be used with caution because it can cause slow grid performance if the grid has too many rows.

Type Parameters:

C - Type of component.

Parameters:

columnName - Column name

componentProvider - Function that takes object as a parameter and returns a Component.

Returns:

Whether a new column can be created or not.

createHTMLColumn

default boolean createHTMLColumn(String columnName,
 Function<T,?> htmlFunction)

Create an HTML column that uses HTML emitted by the function as its column value.

Parameters:

columnName - Column name

htmlFunction - Function that takes object as a parameter and returns HTML text.

Returns:

Whether a new column can be created or not.

createColumn

default boolean createColumn(String columnName,
 String template,
 Function<T,?>... functions)

Create a column that uses one or more functions to generate its column value. The output is formatted using the "template" passed. The template can contain any HTML text and placeholders such as <1>, <2>, <3> ... These placeholders will be replaced by the values returned by the functions.

Parameters:

columnName - Column name

template - Template

functions - Functions that take object as a parameter and returns some sort of value. Values are stringified before displaying. (Application Environment may be set up to control how the stringification process by defining it in the toDisplay(...) method).

Returns:

Whether a new column can be created or not.

createColumn

default boolean createColumn(String columnName,
 Method method)

Create a column uses a method to determine its data. The method must be either available in the grid itself or must be available in the object. If it is available in the grid itself, it should take object as the only parameter.

Parameters:

columnName - Column name

method - Method

Returns:

Whether a new column can be created or not.

createColumn

default boolean createColumn(String columnName,
 com.vaadin.flow.data.renderer.Renderer<T> renderer)

Create a column that generates data through a custom renderer.

Parameters:

columnName - Column name

renderer - Renderer.

Returns:

Whether a new column can be created or not.

getColumnTemplate

default String getColumnTemplate(String columnName)

Get the template for the given column name. (This will not be invoked for HTML columns).

Template: Please see createColumn(String, String, Function[]).

Parameters:

columnName - Column name

Returns:

The default implementation returns null.

customizeRenderer

default void customizeRenderer(String columnName,
 com.vaadin.flow.data.renderer.LitRenderer<T> renderer)

Customize the renderer for the given column. This will be invoked when the renderer for the column is ready. This method is useful when you are creating HTML columns using templating mechanism (eiter using createColumn(String, String, Function[]) or by returning appropriate values from getColumnTemplate(String) and not via createHTMLColumn(String, Function)) and you want to have features like "click" etc. on the column values.

Note: This method will not be invoked for HTML columns.

Parameters:

columnName - Column name

renderer - Renderer for the column.

getColumnOrder

default int getColumnOrder(String columnName)

Return value from this method determines the order in which columns are displayed. Numbers do not have to be continuous, columns with lower numbers are displayed first.

Parameters:

columnName - Column name.

Returns:

An integer number that denotes the column order.

includeColumn

default boolean includeColumn(String columnName)

Determines the respective column should be created or note. This is useful when columns are autogenerated, but you want to eliminate some columns.

Parameters:

columnName - Column name

Returns:

Default implementation returns true for all columns.

isColumnSortable

default boolean isColumnSortable(String columnName)

Check if the column is in-memory and back-end sortable.

Parameters:

columnName - Column name

Returns:

Default implementation returns true.

getColumnSorter

default Comparator<T> getColumnSorter(String columnName)

Get a "sorter" for the column. This method will be invoked only if isColumnSortable(String) returns true. Default implementation returns null. If this method returns non-null, it will be used for sorting the column. Else, if the column's value is an instance of Comparable, that will be used for sorting the column. Otherwise, a case-insensitive string sorting will be carried out for the value returned by the ApplicationEnvironment.toDisplay(Object) method for the corresponding column value.

Parameters:

columnName - Column name

Returns:

A Comparator to compare column values.

ignoreCaseForColumnSorting

default boolean ignoreCaseForColumnSorting(String columnName)

This will be invoked for those columns that are sortable and contains text values. If returned true from this method, case-insensitive sorting will be carried out.

Parameters:

columnName - Column name

Returns:

Default implementation returns true.

getTextAlign

default com.vaadin.flow.component.grid.ColumnTextAlign getTextAlign(String columnName)

Determines the text alignment of the column.

Parameters:

columnName - Column name

Returns:

Default implementation returns START for all columns.

getColumnHeaderComponent

default com.vaadin.flow.component.Component getColumnHeaderComponent(String columnName)

Get the header component for the specified column. If no header component is defined, getHeader method will be invoked to create a text-based header.

Parameters:

columnName - Column name

Returns:

Default implementation returns null.

getColumnCaption

default String getColumnCaption(String columnName)

Get the text to display in the header. This will be invoked only if getColumnHeaderComponent(java.lang.String) returns null.

Parameters:

columnName - Column name

Returns:

Text to display as header. By default, it tries to determine this from the Application Environment.

getDefinedColumnCount

default int getDefinedColumnCount()

Get the number of columns that are already defined/created.

Returns:

Number of columns already defined via some createColumn/addColumn method.

setMethodHandlerHost

default void setMethodHandlerHost(Object host)

Set some other object to supply the column methods. If such an object is set, for column method look up, this object also will be used before checking in the gird itself.

Parameters:

host - An object containing getXXX / isXXX methods for the respective column names.

getView

default View getView(boolean create)

Description copied from interface: ExecutableView

Get the View. Create it if it doesn't exist.

Specified by:

getView in interface ExecutableView

Parameters:

create - Whether to create or not.

Returns:

View.

getCaption

default String getCaption()

Caption used when displaying it in a View. If no caption was set using setCaption method, a label for the Bean's class is determined from the Application Environment.

Specified by:

getCaption in interface ExecutableView

Returns:

Caption

setCaption

default void setCaption(String caption)

Set caption used when displaying the grid in a View.

Specified by:

setCaption in interface ExecutableView

Parameters:

caption - Caption

getMenuItem

default ApplicationMenuItem getMenuItem()

Get the menu item for this when displayed as view. This is the menu item displayed by the Application when its view is activated.

Returns:

Menu item. May return null it the menu item is not yet created.

configure

default void configure()

Configure the columns.

select

default void select(Iterable<T> items)

Select rows.

Parameters:

items - Items to be selected.

select

default void select(Iterator<T> items)

Select rows.

Parameters:

items - Items to be selected.

deselect

default void deselect(Iterable<T> items)

Deselect rows.

Parameters:

items - Items to be deselected.

deselect

default void deselect(Iterator<T> items)

Deselect rows.

Parameters:

items - Items to be deselected.

getSelected

default T getSelected()

Get the selected item. This will return the item only if a single item is selected.

Returns:

Item if that is the only row selected.

getColumn

default com.vaadin.flow.component.grid.Grid.Column<T> getColumn(String columnName)

Get the column for the given column name.

Parameters:

columnName - Name of the column

Returns:

Column for the corresponding column name.

getApplication

default <A extends Application> A getApplication()

Get the current Application.

Specified by:

getApplication in interface ExecutableView

Type Parameters:

A - Application type

Returns:

Current Application.

executing

default boolean executing()

Check if this grid is currently being displayed or not through the associated view.

Returns:

True if it is being displayed through the associated view, otherwise false.

createHierarchyColumn

default 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. Note: This method is invoked only for Tree type grids.

Parameters:

columnName - Name of the column

valueProvider - Value provider for the column

Returns:

Column created.

createHTMLHierarchyColumn

default 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. Note: This method is invoked only for Tree type grids.

Parameters:

columnName - Name of the column

htmlFunction - Function that returns HTML content

Returns:

Column created.

clearAlerts

default void clearAlerts()

Description copied from interface: ExecutableView

Clear all alters owned by this view.

Specified by:

clearAlerts in interface ExecutableView

getSOGrid

HasColumns.SOGrid<T> getSOGrid()

This method is invoked multiple times. So, the HasColumns.SOGrid instance created must be assigned to a variable and returned whenever asked for.

Returns:

SO Grid

addItemSelectedListener

default void addItemSelectedListener(ItemSelectedListener<T> itemSelectedListener)

Add an "item selected listener" to the grid. Whenever a row is selected, this listener will be notified via ItemSelectedListener.itemSelected(Component, Object).

Parameters:

itemSelectedListener - Listener

addItemsSelectedListener

default void addItemsSelectedListener(ItemsSelectedListener<T> itemsSelectedListener)

Add an "items selected listener" to the grid. Whenever one or more rows are selected or deselected, this listener will be notified via ItemsSelectedListener.itemsSelected(Component, Set).

Parameters:

itemsSelectedListener - Listener

removeItemSelectedListener

default void removeItemSelectedListener(ItemSelectedListener<T> itemSelectedListener)

Remove an "item selected listener" that was previously added to the grid. See addItemSelectedListener(ItemSelectedListener).

Parameters:

itemSelectedListener - Listener

sortOrder

default com.vaadin.flow.component.grid.GridSortOrder<T> sortOrder(String columnName)

Create "sort order" definition for the given column name. (It will be an "ascending order" definition). This method is useful to use as parameters to sort(GridSortOrder[]).

Parameters:

columnName - Column name

Returns:

Sort order definition.

sortOrder

default com.vaadin.flow.component.grid.GridSortOrder<T> sortOrder(String columnName,
 boolean ascending)

Create "sort order" definition for the given column name. This method is useful to use as parameters to sort(GridSortOrder[]).

Parameters:

columnName - Column name

ascending - True for ascending order and false for descending order.

Returns:

Sort order definition.

sort

default void sort(com.vaadin.flow.component.grid.GridSortOrder<T>... sortOrders)

Sort the columns as defined in the "sort order definitions" passed. Typically, it is easy to write something like this to sort:
sort(sort("Age", false), sort("FirstName"));
This will sort "Age" column in the descending order and then, the "FirstName" column in the ascending order.

Parameters:

sortOrders - Sort order definitions.

sort

default void sort(String... columnNames)

Sort the given columns in ascending order.

Parameters:

columnNames - Column names.

getViewComponent

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

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

Returns:

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