com.vaadin.fluent.api

Interface FluentGrid<THIS extends FluentGrid<THIS,ITEM>,ITEM>

Type Parameters:

THIS - Self-referential generic THIS

ITEM - the item object type in the listing

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, FluentAbstractComponent<THIS>, FluentAbstractListing<THIS,ITEM>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentComponent.FluentFocusable<THIS>, FluentContextClickNotifier<THIS>, FluentHasComponents<THIS>, FluentHasDataProvider<THIS,ITEM>, FluentHasItems<THIS,ITEM>, FluentSizeable<THIS>, FluentSortNotifier<THIS,com.vaadin.data.provider.GridSortOrder<ITEM>>, com.vaadin.ui.HasComponents, com.vaadin.data.HasDataProvider<ITEM>, com.vaadin.data.HasItems<ITEM>, Iterable<com.vaadin.ui.Component>, Serializable, com.vaadin.server.Sizeable, com.vaadin.event.SortEvent.SortNotifier<com.vaadin.data.provider.GridSortOrder<ITEM>>

All Known Subinterfaces:

FluentTreeGrid<THIS,ITEM>

All Known Implementing Classes:

FGrid, FTreeGrid

public interface FluentGrid<THIS extends FluentGrid<THIS,ITEM>,ITEM>
extends FluentAbstractListing<THIS,ITEM>, FluentHasComponents<THIS>, FluentHasDataProvider<THIS,ITEM>, FluentSortNotifier<THIS,com.vaadin.data.provider.GridSortOrder<ITEM>>

The base interface for fluent versions of Grid

See Also:

Grid

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentHasComponents

FluentHasComponents.FluentComponentAttachDetachNotifier<THIS extends FluentHasComponents<THIS>>

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

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

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

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

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

Modifier and Type	Method and Description
default THIS	withColumnOrder(com.vaadin.ui.Grid.Column<ITEM,?>... columns) Sets a new column order for the grid.
default THIS	withColumnOrder(String... columnIds) Sets a new column order for the grid based on their column ids.
default THIS	withColumnReorderingAllowed(boolean columnReorderingAllowed) Sets whether or not column reordering is allowed.
default THIS	withColumnResizeMode(com.vaadin.shared.ui.grid.ColumnResizeMode mode) Sets the column resize mode to use.
default THIS	withColumns(String... columnIds) Sets the columns and their order based on their column ids.
default THIS	withDataProvider(com.vaadin.ui.Grid.FetchItemsCallback<ITEM> fetchItems, com.vaadin.server.SerializableSupplier<Integer> sizeCallback) Sets a CallbackDataProvider using the given fetch items callback and a size callback.
default THIS	withDefaultHeaderRow(com.vaadin.ui.components.grid.HeaderRow row) Sets the default row of the header.
default THIS	withDescriptionGenerator(com.vaadin.ui.components.grid.DescriptionGenerator<ITEM> descriptionGenerator) Sets the description generator that is used for generating descriptions for rows.
default THIS	withDetailsGenerator(com.vaadin.ui.components.grid.DetailsGenerator<ITEM> generator) Sets the details component generator.
default THIS	withFooterVisible(boolean footerVisible) Sets the visibility of the Footer in this Grid.
default THIS	withFrozenColumnCount(int numberOfColumns) Sets the number of frozen columns in this grid.
default THIS	withHeaderVisible(boolean headerVisible) Sets the visibility of the Header in this Grid.
default THIS	withHeightByRows(double rows) Sets the number of rows that should be visible in Grid's body.
default THIS	withItemClickListener(com.vaadin.ui.components.grid.ItemClickListener<? super ITEM> listener) Adds an item click listener.
default THIS	withRowHeight(double rowHeight) Sets the height of a row.
default THIS	withSelectionListener(com.vaadin.event.selection.SelectionListener<ITEM> listener) Adds a selection listener to the current selection model.
default THIS	withSelectionMode(com.vaadin.ui.Grid.SelectionMode selectionMode) Sets the grid's selection mode.
default THIS	withSort(com.vaadin.ui.Grid.Column<ITEM,?> column) Sort this Grid in ascending order by a specified column.
default THIS	withSort(com.vaadin.ui.Grid.Column<ITEM,?> column, com.vaadin.shared.data.sort.SortDirection direction) Sort this Grid in user-specified direction by a column.
default THIS	withSort(String columnId) Sort this Grid in ascending order by a specified column defined by id.
default THIS	withSort(String columnId, com.vaadin.shared.data.sort.SortDirection direction) Sort this Grid in a user-specified direction by a column defined by id.
default THIS	withSortOrder(com.vaadin.data.provider.GridSortOrderBuilder<ITEM> builder) Sets the sort order to use, given a GridSortOrderBuilder.
default THIS	withSortOrder(List<com.vaadin.data.provider.GridSortOrder<ITEM>> order) Sets the sort order to use.
default THIS	withStyleGenerator(com.vaadin.ui.StyleGenerator<ITEM> styleGenerator) Sets the style generator that is used for generating class names for rows in this grid.

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractComponent

withCaption, withCaptionAsHtml, withComponentError, withData, withDescription, withDescription, withLocale, withResponsive, withShortcutListener, withStyleName

Methods inherited from interface com.vaadin.fluent.api.FluentClientConnector

withAttachListener, withDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentContextClickNotifier

withContextClickListener

Methods inherited from interface com.vaadin.event.ContextClickEvent.ContextClickNotifier

addContextClickListener, removeContextClickListener

Methods inherited from interface com.vaadin.fluent.api.FluentComponent.FluentFocusable

withTabIndex

Methods inherited from interface com.vaadin.ui.Component.Focusable

focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.ui.HasComponents

iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.fluent.api.FluentHasDataProvider

withDataProvider, withItems

Methods inherited from interface com.vaadin.data.HasDataProvider

setDataProvider, setItems

Methods inherited from interface com.vaadin.fluent.api.FluentHasItems

withItems, withItems

Methods inherited from interface com.vaadin.data.HasItems

getDataProvider, setItems, setItems

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.fluent.api.FluentSortNotifier

withSortListener

Methods inherited from interface com.vaadin.event.SortEvent.SortNotifier

addSortListener

Method Detail

withItemClickListener

default THIS withItemClickListener(com.vaadin.ui.components.grid.ItemClickListener<? super ITEM> listener)

Adds an item click listener. The listener is called when an item of this Grid is clicked.

Parameters:

listener - the item click listener, not null

Returns:

this for method chaining

See Also:

Grid.addItemClickListener(ItemClickListener)

withSelectionListener

default THIS withSelectionListener(com.vaadin.event.selection.SelectionListener<ITEM> listener)
                            throws UnsupportedOperationException

Adds a selection listener to the current selection model.

NOTE: If selection mode is switched with Grid.setSelectionMode(SelectionMode), then this listener is not triggered anymore when selection changes!

This is a shorthand for grid.getSelectionModel().addSelectionListener(). To get more detailed selection events, use Grid.getSelectionModel() and either SingleSelectionModel.addSingleSelectionListener(SingleSelectionListener) or MultiSelectionModel.addMultiSelectionListener(MultiSelectionListener) depending on the used selection mode.

Parameters:

listener - the listener to add

Returns:

this for method chaining

Throws:

UnsupportedOperationException - if selection has been disabled with Grid.SelectionMode.NONE

See Also:

Grid.addSelectionListener(SelectionListener)

withColumnOrder

default THIS withColumnOrder(com.vaadin.ui.Grid.Column<ITEM,?>... columns)

Sets a new column order for the grid. All columns which are not ordered here will remain in the order they were before as the last columns of grid.

Parameters:

columns - the columns in the order they should be

Returns:

this for method chaining

See Also:

Grid.setColumnOrder(Column...)

withColumnOrder

default THIS withColumnOrder(String... columnIds)

Sets a new column order for the grid based on their column ids. All columns which are not ordered here will remain in the order they were before as the last columns of grid.

Parameters:

columnIds - the column ids in the order they should be

Returns:

this for method chaining

See Also:

Grid.setColumnOrder(String...)

withColumnReorderingAllowed

default THIS withColumnReorderingAllowed(boolean columnReorderingAllowed)

Sets whether or not column reordering is allowed. Default value is false.

Parameters:

columnReorderingAllowed - specifies whether column reordering is allowed

Returns:

this for method chaining

See Also:

Grid.setColumnReorderingAllowed(boolean)

withColumnResizeMode

default THIS withColumnResizeMode(com.vaadin.shared.ui.grid.ColumnResizeMode mode)

Sets the column resize mode to use. The default mode is ColumnResizeMode.ANIMATED.

Parameters:

mode - a ColumnResizeMode value

Returns:

this for method chaining

See Also:

Grid.setColumnResizeMode(ColumnResizeMode)

withColumns

default THIS withColumns(String... columnIds)

Sets the columns and their order based on their column ids. Columns currently in this grid that are not present in the list of column ids are removed. This includes any column that has no id. Similarly, any new column in columns will be added to this grid. New columns can only be added for a Grid created using Grid.Grid(Class) or Grid.withPropertySet(PropertySet).

Parameters:

columnIds - the column ids to set

Returns:

this for method chaining

See Also:

Grid.setColumns(String...)

withDataProvider

default THIS withDataProvider(com.vaadin.ui.Grid.FetchItemsCallback<ITEM> fetchItems,
                              com.vaadin.server.SerializableSupplier<Integer> sizeCallback)

Sets a CallbackDataProvider using the given fetch items callback and a size callback.

This method is a shorthand for making a CallbackDataProvider that handles a partial Query object.

Parameters:

fetchItems - a callback for fetching items

sizeCallback - a callback for getting the count of items

Returns:

this for method chaining

See Also:

Grid.setDataProvider(FetchItemsCallback, SerializableSupplier), CallbackDataProvider

withDefaultHeaderRow

default THIS withDefaultHeaderRow(com.vaadin.ui.components.grid.HeaderRow row)

Sets the default row of the header. The default row is a special header row that displays column captions and sort indicators. By default Grid has a single row which is also the default row. When a header row is set as the default row, any existing cell content is replaced by the column captions.

Parameters:

row - the new default row, or null for no default row

Returns:

this for method chaining

Throws:

IllegalArgumentException - if the header does not contain the row

See Also:

Grid.setDefaultHeaderRow(HeaderRow)

withDescriptionGenerator

default THIS withDescriptionGenerator(com.vaadin.ui.components.grid.DescriptionGenerator<ITEM> descriptionGenerator)

Sets the description generator that is used for generating descriptions for rows.

Parameters:

descriptionGenerator - the row description generator to set, or null to remove a previously set generator

Returns:

this for method chaining

See Also:

Grid.setDescriptionGenerator(DescriptionGenerator)

withDetailsGenerator

default THIS withDetailsGenerator(com.vaadin.ui.components.grid.DetailsGenerator<ITEM> generator)

Sets the details component generator.

Parameters:

generator - the generator for details components

Returns:

this for method chaining

See Also:

Grid.setDetailsGenerator(DetailsGenerator)

withFooterVisible

default THIS withFooterVisible(boolean footerVisible)

Sets the visibility of the Footer in this Grid.

Parameters:

footerVisible - true if visible; false if not

Returns:

this for method chaining

See Also:

Grid.setFooterVisible(boolean)

withHeaderVisible

default THIS withHeaderVisible(boolean headerVisible)

Sets the visibility of the Header in this Grid.

Parameters:

headerVisible - true if visible; false if not

Returns:

this for method chaining

See Also:

Grid.setHeaderVisible(boolean)

withFrozenColumnCount

default THIS withFrozenColumnCount(int numberOfColumns)

Sets the number of frozen columns in this grid. Setting the count to 0 means that no data columns will be frozen, but the built-in selection checkbox column will still be frozen if it's in use. Setting the count to -1 will also disable the selection column.

NOTE: this count includes hidden columns in the count.

The default value is 0.

Parameters:

numberOfColumns - the number of columns that should be frozen

Returns:

this for method chaining

Throws:

IllegalArgumentException - if the column count is less than -1 or greater than the number of visible columns

See Also:

Grid.setFrozenColumnCount(int)

withHeightByRows

default THIS withHeightByRows(double rows)

Sets the number of rows that should be visible in Grid's body. This method will set the height mode to be HeightMode.ROW.

Parameters:

rows - The height in terms of number of rows displayed in Grid's body. If Grid doesn't contain enough rows, white space is displayed instead. If null is given, then Grid's height is undefined

Returns:

this for method chaining

Throws:

IllegalArgumentException - if rows is zero or less

IllegalArgumentException - if rows is infinite

IllegalArgumentException - if rows is NaN

See Also:

Grid.setHeightByRows(double)

withRowHeight

default THIS withRowHeight(double rowHeight)

Sets the height of a row. If -1 (default), the row height is calculated based on the theme for an empty row before the Grid is displayed.

Note that all header, body and footer rows get the same height if explicitly set. In automatic mode, each section is calculated separately based on an empty row of that type.

Parameters:

rowHeight - The height of a row in pixels or -1 for automatic calculation

Returns:

this for method chaining

See Also:

Grid.setRowHeight(double)

withSelectionMode

default THIS withSelectionMode(com.vaadin.ui.Grid.SelectionMode selectionMode)

Sets the grid's selection mode.

The built-in selection models are:

• Grid.SelectionMode.SINGLE -< SingleSelectionModelImpl, the default model
• Grid.SelectionMode.MULTI -< MultiSelectionModelImpl, with checkboxes in the first column for selection
• Grid.SelectionMode.NONE -< NoSelectionModel, preventing selection

To use your custom selection model, you can use Grid.setSelectionModel(GridSelectionModel), see existing selection model implementations for example.

Parameters:

selectionMode - the selection mode to switch to, not null

Returns:

this for method chaining

See Also:

Grid.setSelectionMode(SelectionMode)

withSortOrder

default THIS withSortOrder(com.vaadin.data.provider.GridSortOrderBuilder<ITEM> builder)

Sets the sort order to use, given a GridSortOrderBuilder. Shorthand for setSortOrder(builder.build()).

Parameters:

builder - the sort builder to retrieve the sort order from

Returns:

this for method chaining

Throws:

NullPointerException - if builder is null

See Also:

GridSortOrderBuilder, Grid.setSortOrder(GridSortOrderBuilder)

withSortOrder

default THIS withSortOrder(List<com.vaadin.data.provider.GridSortOrder<ITEM>> order)

Sets the sort order to use.

Parameters:

order - a sort order list.

Returns:

this for method chaining

Throws:

IllegalArgumentException - if order is null

See Also:

Grid.setSortOrder(List)

withStyleGenerator

default THIS withStyleGenerator(com.vaadin.ui.StyleGenerator<ITEM> styleGenerator)

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

Parameters:

styleGenerator - the row style generator to set, not null

Returns:

this for method chaining

Throws:

NullPointerException - if styleGenerator is null

See Also:

StyleGenerator, Grid.setStyleGenerator(StyleGenerator)

withSort

default THIS withSort(com.vaadin.ui.Grid.Column<ITEM,?> column)

Sort this Grid in ascending order by a specified column.

Parameters:

column - a column to sort against

Returns:

this for method chaining

See Also:

Grid.sort(Column)

withSort

default THIS withSort(com.vaadin.ui.Grid.Column<ITEM,?> column,
                      com.vaadin.shared.data.sort.SortDirection direction)

Sort this Grid in user-specified direction by a column.

Parameters:

column - a column to sort against

direction - a sort order value (ascending/descending)

Returns:

this for method chaining

See Also:

Grid.sort(Column, SortDirection)

withSort

default THIS withSort(String columnId)

Sort this Grid in ascending order by a specified column defined by id.

Parameters:

columnId - the id of the column to sort against

Returns:

this for method chaining

See Also:

Grid.sort(String)

withSort

default THIS withSort(String columnId,
                      com.vaadin.shared.data.sort.SortDirection direction)

Sort this Grid in a user-specified direction by a column defined by id.

Parameters:

columnId - the id of the column to sort against

direction - a sort order value (ascending/descending)

Returns:

this for method chaining

See Also:

Grid.sort(String, SortDirection)