com.vaadin.ui.components.grid.selection
Interface SelectionModel

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

SelectionModel.Multi, SelectionModel.None, SelectionModel.Single

All Known Implementing Classes:

AbstractSelectionModel, MultiSelectionModel, NoSelectionModel, SingleSelectionModel

public interface SelectionModel
extends java.io.Serializable

The server-side interface that controls Grid's selection state.

Since:

7.4

Author:

Vaadin Ltd

Nested Class Summary

static interface	SelectionModel.Multi A SelectionModel that supports multiple selections to be made.
static interface	SelectionModel.None A SelectionModel that does not allow for rows to be selected.
static interface	SelectionModel.Single A SelectionModel that supports for only single rows to be selected at a time.

Method Summary

java.util.Collection<java.lang.Object>	getSelectedRows() Returns a collection of all the currently selected itemIds.
boolean	isSelected(java.lang.Object itemId) Checks whether an item is selected or not.
void	reset() Resets the SelectiomModel to an initial state.
void	setGrid(Grid grid) Injects the current Grid instance into the SelectionModel.

Method Detail

isSelected

boolean isSelected(java.lang.Object itemId)

Checks whether an item is selected or not.

Parameters:

itemId - the item id to check for

Returns:

true iff the item is selected

getSelectedRows

java.util.Collection<java.lang.Object> getSelectedRows()

Returns a collection of all the currently selected itemIds.

Returns:

a collection of all the currently selected itemIds

setGrid

void setGrid(Grid grid)

Injects the current Grid instance into the SelectionModel.

Note: This method should not be called manually.

Parameters:

grid - the Grid in which the SelectionModel currently is, or null when a selection model is being detached from a Grid.

reset

void reset()

Resets the SelectiomModel to an initial state.

Most often this means that the selection state is cleared, but implementations are free to interpret the "initial state" as they wish. Some, for example, may want to keep the first selected item as selected.