com.vaadin.ui.components.grid

Interface GridSelectionModel<T>

Type Parameters:

T - the grid bean type

All Superinterfaces:

ClientConnector, Connector, Extension, SelectionModel<T>, Serializable

All Known Subinterfaces:

MultiSelectionModel<T>, SingleSelectionModel<T>

All Known Implementing Classes:

AbstractSelectionModel, MultiSelectionModelImpl, NoSelectionModel, SingleSelectionModelImpl, Tree.TreeMultiSelectionModel

public interface GridSelectionModel<T>
extends SelectionModel<T>, Extension

The server-side interface that controls Grid's selection state. SelectionModel should extend Grid.AbstractGridExtension.

Since:

8.0

Author:

Vaadin Ltd

See Also:

AbstractSelectionModel, SingleSelectionModel, MultiSelectionModel

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.data.SelectionModel

SelectionModel.Multi<T>, SelectionModel.Single<T>

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

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

Method Summary

Modifier and Type	Method and Description
boolean	isUserSelectionAllowed() Checks if the user is allowed to change the selection.
void	remove() Removes this selection model from the grid.
void	setUserSelectionAllowed(boolean allowed) Sets whether the user is allowed to change the selection.

Methods inherited from interface com.vaadin.data.SelectionModel

addSelectionListener, deselect, deselectAll, getFirstSelectedItem, getSelectedItems, isSelected, select

Methods inherited from interface com.vaadin.server.Extension

setParent

Methods inherited from interface com.vaadin.server.ClientConnector

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

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Method Detail

remove

void remove()

Removes this selection model from the grid.

Must call super Extension.remove() to detach the extension, and fire an selection change event for the selection model (with an empty selection).

Specified by:

remove in interface Extension

setUserSelectionAllowed

void setUserSelectionAllowed(boolean allowed)

Sets whether the user is allowed to change the selection.

The check is done only for the client side actions. It doesn't affect selection requests sent from the server side.

Parameters:

allowed - true if the user is allowed to change the selection, false otherwise

isUserSelectionAllowed

boolean isUserSelectionAllowed()

Checks if the user is allowed to change the selection.

The check is done only for the client side actions. It doesn't affect selection requests sent from the server side.

Returns:

true if the user is allowed to change the selection, false otherwise