com.vaadin.ui

Class Grid.Column<T,V>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

com.vaadin.ui.AbstractListing.AbstractListingExtension<T>

com.vaadin.ui.Grid.AbstractGridExtension<T>

com.vaadin.ui.Grid.Column<T,V>

Type Parameters:

T - the grid bean type

V - the column value type

All Implemented Interfaces:

DataGenerator<T>, MethodEventSource, ClientConnector, Extension, Connector, Serializable

Enclosing class:

Grid<T>

public static class Grid.Column<T,V>
extends Grid.AbstractGridExtension<T>

This extension manages the configuration and data communication for a Column inside of a Grid component.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Column(ValueProvider<T,V> valueProvider, Renderer<? super V> renderer) Constructs a new Column configuration with given renderer and value provider.

Method Summary

Modifier and Type	Method and Description
protected void	checkColumnIsAttached() Checks if column is attached and throws an IllegalStateException if it is not.
Grid.Column<T,V>	clearExpandRatio() Clears the expand ratio for this column.
void	generateData(T data, elemental.json.JsonObject jsonObject) Adds custom data for the given item to its serialized JsonObject representation.
String	getCaption() Gets the header caption for this column.
SerializableComparator<T>	getComparator(SortDirection sortDirection) Gets the comparator to use with in-memory sorting for this column when sorting in the given direction.
DescriptionGenerator<T>	getDescriptionGenerator() Gets the description generator that is used for generating descriptions for cells.
Binder.Binding<T,?>	getEditorBinding() Gets the binder binding that is currently used for this column.
int	getExpandRatio() Returns the column's expand ratio.
protected Grid<T>	getGrid() Gets the grid that this column belongs to.
String	getHidingToggleCaption() Gets the caption of the hiding toggle for this column.
String	getId() Returns the user-defined identifier for this column.
double	getMaximumWidth() Returns the maximum width for this column.
double	getMinimumWidth() Return the minimum width for this column.
Stream<QuerySortOrder>	getSortOrder(SortDirection direction) Gets the sort orders to use with back-end sorting for this column when sorting in the given direction.
protected ColumnState	getState() Returns the shared state for this connector.
protected ColumnState	getState(boolean markAsDirty) Returns the shared state for this connector.
StyleGenerator<T>	getStyleGenerator() Gets the style generator that is used for generating styles for cells.
SerializableFunction<T,? extends V>	getValueProvider() Gets the function used to produce the value for data in this column based on the row item.
double	getWidth() Returns the width (in pixels).
boolean	isEditable() Gets whether this Column has a component displayed in Editor or not.
boolean	isHidable() Returns whether this column can be hidden by the user.
boolean	isHidden() Returns whether this column is hidden.
boolean	isResizable() Returns whether this column can be resized by the user.
boolean	isSortable() Gets whether the user can sort this column or not.
boolean	isWidthUndefined() Returns whether this column has an undefined width.
protected void	readDesign(org.jsoup.nodes.Element design, DesignContext designContext) Reads the design attributes for this column from given element.
Grid.Column<T,V>	setCaption(String caption) Sets the header caption for this column.
Grid.Column<T,V>	setComparator(SerializableComparator<T> comparator) Sets a comparator to use with in-memory sorting with this column.
Grid.Column<T,V>	setDescriptionGenerator(DescriptionGenerator<T> cellDescriptionGenerator) Sets the description generator that is used for generating descriptions for cells in this column.
Grid.Column<T,V>	setEditable(boolean editable) Sets whether this Column has a component displayed in Editor or not.
Grid.Column<T,V>	setEditorBinding(Binder.Binding<T,?> binding) Sets an editor binding for this column.
<F,C extends HasValue<F> & Component> Grid.Column<T,V>	setEditorComponent(C editorComponent) Sets a component to use for editing values of this columns in the editor row.
<C extends HasValue<V> & Component> Grid.Column<T,V>	setEditorComponent(C editorComponent, Setter<T,V> setter) Sets a component and setter to use for editing values of this column in the editor row.
Grid.Column<T,V>	setExpandRatio(int expandRatio) Sets the ratio with which the column expands.
Grid.Column<T,V>	setHidable(boolean hidable) Sets whether this column can be hidden by the user.
Grid.Column<T,V>	setHidden(boolean hidden) Hides or shows the column.
Grid.Column<T,V>	setHidingToggleCaption(String hidingToggleCaption) Sets the caption of the hiding toggle for this column.
Grid.Column<T,V>	setId(String id) Sets the user-defined identifier to map this column.
Grid.Column<T,V>	setMaximumWidth(double pixels) Sets the maximum width for this column.
Grid.Column<T,V>	setMinimumWidth(double pixels) Sets the minimum width for this column.
Grid.Column<T,V>	setRenderer(Renderer<? super V> renderer) Sets the Renderer for this Column.
Grid.Column<T,V>	setResizable(boolean resizable) Sets whether this column can be resized by the user.
Grid.Column<T,V>	setSortable(boolean sortable) Sets whether the user can sort this column or not.
Grid.Column<T,V>	setSortOrderProvider(SortOrderProvider provider) Sets the sort orders when sorting this column.
Grid.Column<T,V>	setSortProperty(String... properties) Sets strings describing back end properties to be used when sorting this column.
Grid.Column<T,V>	setStyleGenerator(StyleGenerator<T> cellStyleGenerator) Sets the style generator that is used for generating class names for cells in this column.
Grid.Column<T,V>	setWidth(double pixelWidth) Sets the width (in pixels).
Grid.Column<T,V>	setWidthUndefined() Marks the column width as undefined.
protected void	writeDesign(org.jsoup.nodes.Element element, DesignContext designContext) Writes the design attributes for this column into given element.

Methods inherited from class com.vaadin.ui.Grid.AbstractGridExtension

addComponentToGrid, extend, getInternalIdForColumn, getParent, removeComponentFromGrid

Methods inherited from class com.vaadin.ui.AbstractListing.AbstractListingExtension

getData, refresh, remove

Methods inherited from class com.vaadin.server.AbstractExtension

extend, getSupportedParentType, setParent

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, attach, beforeClientResponse, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.data.provider.DataGenerator

destroyAllData, destroyData, refreshData

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

Column

protected Column(ValueProvider<T,V> valueProvider,
                 Renderer<? super V> renderer)

Constructs a new Column configuration with given renderer and value provider.

Parameters:

valueProvider - the function to get values from items, not null

renderer - the type of value, not null

Method Detail

generateData

public void generateData(T data,
                         elemental.json.JsonObject jsonObject)

Description copied from interface: DataGenerator

Adds custom data for the given item to its serialized JsonObject representation. This JSON object will be sent to client-side DataProvider.

Parameters:

data - the data item being serialized

jsonObject - the JSON object being sent to the client

getState

protected ColumnState getState()

Description copied from class: AbstractClientConnector

Returns the shared state for this connector. The shared state object is shared between the server connector and the client connector. Changes are only communicated from the server to the client and not in the other direction.

As a side effect, marks the connector dirty so any changes done to the state will be sent to the client. Use getState(false) to avoid marking the connector as dirty.

Overrides:

getState in class Grid.AbstractGridExtension<T>

Returns:

The shared state for this connector. Never null.

getState

protected ColumnState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class Grid.AbstractGridExtension<T>

Parameters:

markAsDirty - true if the connector should automatically be marked dirty, false otherwise

Returns:

The shared state for this connector. Never null.

See Also:

AbstractClientConnector.getState()

getId

public String getId()

Returns the user-defined identifier for this column.

Returns:

the identifier string

setId

public Grid.Column<T,V> setId(String id)

Sets the user-defined identifier to map this column. The identifier can be used for example in Grid.getColumn(String).

The id is also used as the backend sort property for this column if no sort property or sort order provider has been set for this column.

Parameters:

id - the identifier string

Returns:

this column

See Also:

setSortProperty(String...), setSortOrderProvider(SortOrderProvider)

getValueProvider

public SerializableFunction<T,? extends V> getValueProvider()

Gets the function used to produce the value for data in this column based on the row item.

Returns:

the value provider function

Since:

8.0.3

setSortable

public Grid.Column<T,V> setSortable(boolean sortable)

Sets whether the user can sort this column or not.

Parameters:

sortable - true if the column can be sorted by the user; false if not

Returns:

this column

isSortable

public boolean isSortable()

Gets whether the user can sort this column or not.

Returns:

true if the column can be sorted by the user; false if not

setCaption

public Grid.Column<T,V> setCaption(String caption)

Sets the header caption for this column.

Parameters:

caption - the header caption, not null

Returns:

this column

getCaption

public String getCaption()

Gets the header caption for this column.

Returns:

header caption

setComparator

public Grid.Column<T,V> setComparator(SerializableComparator<T> comparator)

Sets a comparator to use with in-memory sorting with this column. Sorting with a back-end is done using setSortProperty(String...).

Parameters:

comparator - the comparator to use when sorting data in this column

Returns:

this column

getComparator

public SerializableComparator<T> getComparator(SortDirection sortDirection)

Gets the comparator to use with in-memory sorting for this column when sorting in the given direction.

Parameters:

sortDirection - the direction this column is sorted by

Returns:

comparator for this column

setSortProperty

public Grid.Column<T,V> setSortProperty(String... properties)

Sets strings describing back end properties to be used when sorting this column.

By default, the column id will be used as the sort property.

Parameters:

properties - the array of strings describing backend properties

Returns:

this column

setSortOrderProvider

public Grid.Column<T,V> setSortOrderProvider(SortOrderProvider provider)

Sets the sort orders when sorting this column. The sort order provider is a function which provides QuerySortOrder objects to describe how to sort by this column.

By default, the column id will be used as the sort property.

Parameters:

provider - the function to use when generating sort orders with the given direction

Returns:

this column

getSortOrder

public Stream<QuerySortOrder> getSortOrder(SortDirection direction)

Gets the sort orders to use with back-end sorting for this column when sorting in the given direction.

Parameters:

direction - the sorting direction

Returns:

stream of sort orders

See Also:

setSortProperty(String...), setId(String), setSortOrderProvider(SortOrderProvider)

setStyleGenerator

public Grid.Column<T,V> setStyleGenerator(StyleGenerator<T> cellStyleGenerator)

Sets the style generator that is used for generating class names for cells in this column. Returning null from the generator results in no custom style name being set.

Parameters:

cellStyleGenerator - the cell style generator to set, not null

Returns:

this column

Throws:

NullPointerException - if cellStyleGenerator is null

getStyleGenerator

public StyleGenerator<T> getStyleGenerator()

Gets the style generator that is used for generating styles for cells.

Returns:

the cell style generator

setDescriptionGenerator

public Grid.Column<T,V> setDescriptionGenerator(DescriptionGenerator<T> cellDescriptionGenerator)

Sets the description generator that is used for generating descriptions for cells in this column.

Parameters:

cellDescriptionGenerator - the cell description generator to set, or null to remove a previously set generator

Returns:

this column

getDescriptionGenerator

public DescriptionGenerator<T> getDescriptionGenerator()

Gets the description generator that is used for generating descriptions for cells.

Returns:

the cell description generator, or null if no generator is set

setExpandRatio

public Grid.Column<T,V> setExpandRatio(int expandRatio)
                                throws IllegalStateException

Sets the ratio with which the column expands.

By default, all columns expand equally (treated as if all of them had an expand ratio of 1). Once at least one column gets a defined expand ratio, the implicit expand ratio is removed, and only the defined expand ratios are taken into account.

If a column has a defined width (setWidth(double)), it overrides this method's effects.

Example: A grid with three columns, with expand ratios 0, 1 and 2, respectively. The column with a ratio of 0 is exactly as wide as its contents requires. The column with a ratio of 1 is as wide as it needs, plus a third of any excess space, because we have 3 parts total, and this column reserves only one of those. The column with a ratio of 2, is as wide as it needs to be, plus two thirds of the excess width.

Parameters:

expandRatio - the expand ratio of this column. 0 to not have it expand at all. A negative number to clear the expand value.

Throws:

IllegalStateException - if the column is no longer attached to any grid

See Also:

setWidth(double)

getExpandRatio

public int getExpandRatio()

Returns the column's expand ratio.

Returns:

the column's expand ratio

See Also:

setExpandRatio(int)

clearExpandRatio

public Grid.Column<T,V> clearExpandRatio()
                                  throws IllegalStateException

Clears the expand ratio for this column.

Equal to calling setExpandRatio(-1)

Throws:

IllegalStateException - if the column is no longer attached to any grid

getWidth

public double getWidth()
                throws IllegalStateException

Returns the width (in pixels). By default a column is 100px wide.

Returns:

the width in pixels of the column

Throws:

IllegalStateException - if the column is no longer attached to any grid

setWidth

public Grid.Column<T,V> setWidth(double pixelWidth)
                          throws IllegalStateException,
                                 IllegalArgumentException

Sets the width (in pixels).

This overrides any configuration set by any of setExpandRatio(int), setMinimumWidth(double) or setMaximumWidth(double).

Parameters:

pixelWidth - the new pixel width of the column

Returns:

the column itself

Throws:

IllegalStateException - if the column is no longer attached to any grid

IllegalArgumentException - thrown if pixel width is less than zero

isWidthUndefined

public boolean isWidthUndefined()

Returns whether this column has an undefined width.

Returns:

whether the width is undefined

Throws:

IllegalStateException - if the column is no longer attached to any grid

Since:

7.6

setWidthUndefined

public Grid.Column<T,V> setWidthUndefined()

Marks the column width as undefined. An undefined width means the grid is free to resize the column based on the cell contents and available space in the grid.

Returns:

the column itself

setMinimumWidth

public Grid.Column<T,V> setMinimumWidth(double pixels)
                                 throws IllegalStateException

Sets the minimum width for this column.

This defines the minimum guaranteed pixel width of the column when it is set to expand.

Throws:

IllegalStateException - if the column is no longer attached to any grid

See Also:

setExpandRatio(int)

getMinimumWidth

public double getMinimumWidth()

Return the minimum width for this column.

Returns:

the minimum width for this column

See Also:

setMinimumWidth(double)

setMaximumWidth

public Grid.Column<T,V> setMaximumWidth(double pixels)

Sets the maximum width for this column.

This defines the maximum allowed pixel width of the column when it is set to expand.

Parameters:

pixels - the maximum width

Throws:

IllegalStateException - if the column is no longer attached to any grid

See Also:

setExpandRatio(int)

getMaximumWidth

public double getMaximumWidth()

Returns the maximum width for this column.

Returns:

the maximum width for this column

See Also:

setMaximumWidth(double)

setResizable

public Grid.Column<T,V> setResizable(boolean resizable)

Sets whether this column can be resized by the user.

Parameters:

resizable - true if this column should be resizable, false otherwise

Throws:

IllegalStateException - if the column is no longer attached to any grid

Since:

7.6

getHidingToggleCaption

public String getHidingToggleCaption()

Gets the caption of the hiding toggle for this column.

Returns:

the caption for the hiding toggle for this column

Since:

7.5.0

See Also:

setHidingToggleCaption(String)

setHidingToggleCaption

public Grid.Column<T,V> setHidingToggleCaption(String hidingToggleCaption)

Sets the caption of the hiding toggle for this column. Shown in the toggle for this column in the grid's sidebar when the column is hidable.

The default value is null, and in that case the column's header caption is used.

NOTE: setting this to empty string might cause the hiding toggle to not render correctly.

Parameters:

hidingToggleCaption - the text to show in the column hiding toggle

Returns:

the column itself

Since:

7.5.0

setHidden

public Grid.Column<T,V> setHidden(boolean hidden)

Hides or shows the column. By default columns are visible before explicitly hiding them.

Parameters:

hidden - true to hide the column, false to show

Returns:

this column

Throws:

IllegalStateException - if the column is no longer attached to any grid

Since:

7.5.0

isHidden

public boolean isHidden()

Returns whether this column is hidden. Default is false.

Returns:

true if the column is currently hidden, false otherwise

Since:

7.5.0

setHidable

public Grid.Column<T,V> setHidable(boolean hidable)

Sets whether this column can be hidden by the user. Hidable columns can be hidden and shown via the sidebar menu.

Parameters:

hidable - true iff the column may be hidable by the user via UI interaction

Returns:

this column

Since:

7.5.0

isHidable

public boolean isHidable()

Returns whether this column can be hidden by the user. Default is false.

Note: the column can be programmatically hidden using setHidden(boolean) regardless of the returned value.

Returns:

true if the user can hide the column, false if not

Since:

7.5.0

isResizable

public boolean isResizable()

Returns whether this column can be resized by the user. Default is true.

Note: the column can be programmatically resized using setWidth(double) and setWidthUndefined() regardless of the returned value.

Returns:

true if this column is resizable, false otherwise

Since:

7.6

setEditable

public Grid.Column<T,V> setEditable(boolean editable)

Sets whether this Column has a component displayed in Editor or not. A column can only be editable if an editor component or binding has been set.

Parameters:

editable - true if column is editable; false if not

Returns:

this column

See Also:

setEditorComponent(HasValue, Setter), #setEditorBinding(Binding)

isEditable

public boolean isEditable()

Gets whether this Column has a component displayed in Editor or not.

Returns:

true if the column displays an editor component; false if not

setEditorBinding

public Grid.Column<T,V> setEditorBinding(Binder.Binding<T,?> binding)

Sets an editor binding for this column. The Binder.Binding is used when a row is in editor mode to define how to populate an editor component based on the edited row and how to update an item based on the value in the editor component.

To create a binding to use with a column, define a binding for the editor binder (grid.getEditor().getBinder()) using e.g. Binder.forField(HasValue). You can also use setEditorComponent(HasValue, Setter) if no validator or converter is needed for the binding.

The HasValue that the binding is defined to use must be a Component.

Parameters:

binding - the binding to use for this column

Returns:

this column

See Also:

setEditorComponent(HasValue, Setter), Binder.Binding, Grid.getEditor(), Editor.getBinder()

getEditorBinding

public Binder.Binding<T,?> getEditorBinding()

Gets the binder binding that is currently used for this column.

Returns:

the used binder binding, or null if no binding is configured

See Also:

#setEditorBinding(Binding)

setEditorComponent

public <C extends HasValue<V> & Component> Grid.Column<T,V> setEditorComponent(C editorComponent,
                                                                               Setter<T,V> setter)

Sets a component and setter to use for editing values of this column in the editor row. This is a shorthand for use in simple cases where no validator or converter is needed. Use #setEditorBinding(Binding) to support more complex cases.

Note: The same component cannot be used for multiple columns.

Parameters:

editorComponent - the editor component

setter - a setter that stores the component value in the row item

Returns:

this column

See Also:

#setEditorBinding(Binding), Grid.getEditor(), Binder.bind(HasValue, ValueProvider, Setter)

setEditorComponent

public <F,C extends HasValue<F> & Component> Grid.Column<T,V> setEditorComponent(C editorComponent)

Sets a component to use for editing values of this columns in the editor row. This method can only be used if the column has an id and the Grid has been created using Grid.Grid(Class) or some other way that allows finding properties based on property names.

This is a shorthand for use in simple cases where no validator or converter is needed. Use #setEditorBinding(Binding) to support more complex cases.

Note: The same component cannot be used for multiple columns.

Parameters:

editorComponent - the editor component

Returns:

this column

See Also:

#setEditorBinding(Binding), Grid.getEditor(), Binder.bind(HasValue, String), Grid.Grid(Class)

setRenderer

public Grid.Column<T,V> setRenderer(Renderer<? super V> renderer)

Sets the Renderer for this Column. Setting the renderer will cause all currently available row data to be recreated and sent to the client.

Parameters:

renderer - the new renderer

Returns:

this column

Since:

8.0.3

getGrid

protected Grid<T> getGrid()

Gets the grid that this column belongs to.

Returns:

the grid that this column belongs to, or null if this column has not yet been associated with any grid

checkColumnIsAttached

protected void checkColumnIsAttached()
                              throws IllegalStateException

Checks if column is attached and throws an IllegalStateException if it is not.

Throws:

IllegalStateException - if the column is no longer attached to any grid

writeDesign

protected void writeDesign(org.jsoup.nodes.Element element,
                           DesignContext designContext)

Writes the design attributes for this column into given element.

Parameters:

element - Element to write attributes into

designContext - the design context

Since:

7.5.0

readDesign

protected void readDesign(org.jsoup.nodes.Element design,
                          DesignContext designContext)

Reads the design attributes for this column from given element.

Parameters:

design - Element to read attributes from

designContext - the design context

Since:

7.5.0