We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.ui.
Class Grid.SingleSelectionModel
- java.lang.Object
-
- com.vaadin.server.AbstractClientConnector
-
- com.vaadin.server.AbstractExtension
-
- com.vaadin.ui.Grid.AbstractGridExtension
-
- com.vaadin.ui.Grid.AbstractSelectionModel
-
- com.vaadin.ui.Grid.SingleSelectionModel
-
All Implemented Interfaces:
MethodEventSource,ClientConnector,DataGenerator,Extension,Connector,Grid.SelectionModel,Grid.SelectionModel.HasUserSelectionAllowed,Grid.SelectionModel.Single,SerializableEnclosing class:
public static class Grid.SingleSelectionModel extends Grid.AbstractSelectionModel implements Grid.SelectionModel.Single, Grid.SelectionModel.HasUserSelectionAllowedA default implementation of a
Grid.SelectionModel.SingleSee Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener
-
Nested classes/interfaces inherited from interface com.vaadin.ui.Grid.SelectionModel
Grid.SelectionModel.HasUserSelectionAllowed, Grid.SelectionModel.Multi, Grid.SelectionModel.None, Grid.SelectionModel.Single
-
-
Field Summary
-
Fields inherited from class com.vaadin.ui.Grid.AbstractSelectionModel
selection
-
-
Constructor Summary
Constructors Constructor Description SingleSelectionModel()
-
Method Summary
All Methods Modifier and Type Method Description protected voidextend(AbstractClientConnector target)Add this extension to the target connector.
ObjectgetSelectedRow()Gets the item id of the currently selected item.
protected SingleSelectionModelStategetState()Returns the shared state for this connector.
protected SingleSelectionModelStategetState(boolean markAsDirty)Returns the shared state for this connector.
booleanisDeselectAllowed()Sets whether it's allowed to deselect the selected row through the UI.
booleanisUserSelectionAllowed()Checks if the user is allowed to change the selection.
voidreset()Resets the selection state.
booleanselect(Object itemId)Marks an item as selected.
protected booleanselect(Object itemId, boolean refresh)voidsetDeselectAllowed(boolean deselectAllowed)Sets whether it's allowed to deselect the selected row through the UI.
voidsetUserSelectionAllowed(boolean userSelectionAllowed)Sets whether the user is allowed to change the selection.
-
Methods inherited from class com.vaadin.ui.Grid.AbstractSelectionModel
checkItemIdExists, checkItemIdsExist, destroyData, fireSelectionEvent, generateData, getItemId, getSelectedRows, isSelected, setGrid
-
Methods inherited from class com.vaadin.ui.Grid.AbstractGridExtension
addComponentToGrid, getColumn, getParentGrid, refreshRow, remove, removeComponentFromGrid
-
Methods inherited from class com.vaadin.server.AbstractExtension
getParent, 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
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
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
-
Methods inherited from interface com.vaadin.ui.Grid.SelectionModel
getSelectedRows, isSelected, setGrid
-
-
-
-
Method Detail
-
extend
protected void extend(AbstractClientConnector target)Description copied from class:
AbstractExtensionAdd this extension to the target connector. This method is protected to allow subclasses to require a more specific type of target.
Overrides:
extendin classGrid.AbstractGridExtensionParameters:
target- the connector to attach this extension to
-
select
public boolean select(Object itemId)Description copied from interface:
Grid.SelectionModel.SingleMarks an item as selected.
Specified by:
selectin interfaceGrid.SelectionModel.SingleParameters:
itemId- the itemId to mark as selected;nullfor deselectReturns:
trueif the selection state changed.falseif the itemId already was selected
-
select
protected boolean select(Object itemId, boolean refresh)
-
getSelectedRow
public Object getSelectedRow()Description copied from interface:
Grid.SelectionModel.SingleGets the item id of the currently selected item.
Specified by:
getSelectedRowin interfaceGrid.SelectionModel.SingleReturns:
the item id of the currently selected item, or
nullif nothing is selected
-
reset
public void reset()Resets the selection state.
If an item is selected, it will become deselected.
Specified by:
resetin interfaceGrid.SelectionModel
-
setDeselectAllowed
public void setDeselectAllowed(boolean deselectAllowed)Description copied from interface:
Grid.SelectionModel.SingleSets whether it's allowed to deselect the selected row through the UI. Deselection is allowed by default.
Specified by:
setDeselectAllowedin interfaceGrid.SelectionModel.SingleParameters:
deselectAllowed-trueif the selected row can be deselected without selecting another row instead; otherwisefalse.
-
isDeselectAllowed
public boolean isDeselectAllowed()Description copied from interface:
Grid.SelectionModel.SingleSets whether it's allowed to deselect the selected row through the UI.
Specified by:
isDeselectAllowedin interfaceGrid.SelectionModel.SingleReturns:
trueif deselection is allowed; otherwisefalse
-
getState
protected SingleSelectionModelState getState()Description copied from class:
AbstractClientConnectorReturns 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:
getStatein classAbstractClientConnectorReturns:
The shared state for this connector. Never null.
-
getState
protected SingleSelectionModelState getState(boolean markAsDirty)Description copied from class:
AbstractClientConnectorReturns the shared state for this connector.
Overrides:
getStatein classAbstractClientConnectorParameters:
markAsDirty- true if the connector should automatically be marked dirty, false otherwiseReturns:
The shared state for this connector. Never null.
See Also:
-
isUserSelectionAllowed
public boolean isUserSelectionAllowed()Description copied from interface:
Grid.SelectionModel.HasUserSelectionAllowedChecks if the user is allowed to change the selection.
Specified by:
isUserSelectionAllowedin interfaceGrid.SelectionModel.HasUserSelectionAllowedReturns:
trueif the user is allowed to change the selection,falseotherwise
-
setUserSelectionAllowed
public void setUserSelectionAllowed(boolean userSelectionAllowed)Description copied from interface:
Grid.SelectionModel.HasUserSelectionAllowedSets whether the user is allowed to change the selection.
Specified by:
setUserSelectionAllowedin interfaceGrid.SelectionModel.HasUserSelectionAllowedParameters:
userSelectionAllowed-trueif the user is allowed to change the selection,falseotherwise
-
-