com.vaadin.ui.Grid.SelectionModel.Single API 7.7.16 | Vaadin

You're viewing an older version of Framework JavaDoc. Please see version 7.7.46 for the latest.

com.vaadin.ui.

All Superinterfaces:

ClientConnector, Connector, Extension, Grid.SelectionModel, Serializable

All Known Implementing Classes:

Grid.SingleSelectionModel

Enclosing interface:

Grid.SelectionModel
```
public static interface Grid.SelectionModel.Single
extends Grid.SelectionModel
```
A SelectionModel that supports for only single rows to be selected at a time.
This interface has a contract of having the same behavior, no matter how the selection model is interacted with. In other words, if something is forbidden to do in e.g. the user interface, it must also be forbidden to do in the server-side and client-side APIs.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.vaadin.ui.Grid.SelectionModel
  Grid.SelectionModel.HasUserSelectionAllowed, Grid.SelectionModel.Multi, Grid.SelectionModel.None, Grid.SelectionModel.Single
- Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
  ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Method Summary

All Methods
Modifier and Type	Method and Description
`Object`	`getSelectedRow()` Gets the item id of the currently selected item.
`boolean`	`isDeselectAllowed()` Sets whether it's allowed to deselect the selected row through the UI.
`boolean`	`select(Object itemId)` Marks an item as selected.
`void`	`setDeselectAllowed(boolean deselectAllowed)` Sets whether it's allowed to deselect the selected row through the UI.

Methods inherited from interface com.vaadin.ui.Grid.SelectionModel
getSelectedRows, isSelected, reset, setGrid

Methods inherited from interface com.vaadin.server.Extension
remove, 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
  - select
```
boolean select(Object itemId)
        throws IllegalStateException,
               IllegalArgumentException
```
    Marks an item as selected.
    
    Parameters:
    
    itemId - the itemId to mark as selected; null for deselect
    
    Returns:
    
    true if the selection state changed. false if the itemId already was selected
    
    Throws:
    
    IllegalStateException - if the selection was illegal. One such reason might be that the given id was null, indicating a deselect, but implementation doesn't allow deselecting. re-selecting something
    
    IllegalArgumentException - if given itemId does not exist in the container of Grid
  - getSelectedRow
```
Object getSelectedRow()
```
    Gets the item id of the currently selected item.
    
    Returns:
    
    the item id of the currently selected item, or null if nothing is selected
  - setDeselectAllowed
```
void setDeselectAllowed(boolean deselectAllowed)
```
    Sets whether it's allowed to deselect the selected row through the UI. Deselection is allowed by default.
    
    Parameters:
    
    deselectAllowed - true if the selected row can be deselected without selecting another row instead; otherwise false.
  - isDeselectAllowed
```
boolean isDeselectAllowed()
```
    Sets whether it's allowed to deselect the selected row through the UI.
    
    Returns:
    
    true if deselection is allowed; otherwise false