Package com.storedobject.vaadin

Class GridColumnDetail<T>

java.lang.Object

com.storedobject.vaadin.GridColumnDetail<T>

Type Parameters:

T - Bean type of the grid.

public final class GridColumnDetail<T>
extends Object

This class keeps extra information about Grid.Column.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
String	getCaption()	Get the header caption.
com.vaadin.flow.component.grid.Grid.Column<T>	getColumn()	Get the associated grid column.
String	getLabel()	Retrieves the label of the grid column.
Function<T,?>	getValueFunction()	Get the function that can compute the rendering value associated with column.
Class<?>	getValueType()	Get the value type.
void	setCaption(String caption)	Set the header caption.
void	setLabel(String label)	Sets the label of the grid column.
void	setVisible(boolean visible)	Set the column visible.

Methods inherited from class java.lang.Object

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

Method Details

getColumn

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

Get the associated grid column.

Returns:

Grid column.

getCaption

public String getCaption()

Get the header caption.

Returns:

Header caption. For component columns, this returns null.

setCaption

public void setCaption(String caption)

Set the header caption.

Parameters:

caption - Header caption.

getValueFunction

public Function<T,?> getValueFunction()

Get the function that can compute the rendering value associated with column. For multivalued columns, the function returns an array of values.

Returns:

Value function.

getValueType

public Class<?> getValueType()

Get the value type.

Returns:

Value type.

setVisible

public void setVisible(boolean visible)

Set the column visible.

Note: This is the recommended way to make the column visible because it will update the context menu of the configurator too.

Parameters:

visible - True/false.

getLabel

public String getLabel()

Retrieves the label of the grid column. If the label is not set (null), it returns the caption instead.

Note: Label is used as the menu label inside the HasColumns.getConfigureButton()'s menu.

Returns:

The label of the grid column, or the caption if the name is null.

setLabel

public void setLabel(String label)

Sets the label of the grid column.

Note: Label is used as the menu label inside the HasColumns.getConfigureButton()'s menu.

Parameters:

label - The Label to set for the grid column.