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.
Interface Grid.SelectionModel.Multi
-
All Superinterfaces:
ClientConnector,Connector,Extension,Grid.SelectionModel,SerializableAll Known Implementing Classes:
Enclosing interface:
public static interface Grid.SelectionModel.Multi extends Grid.SelectionModelA SelectionModel that supports multiple selections to be made.
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.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
-
-
Method Summary
All Methods Modifier and Type Method Description booleandeselect(Object... itemIds)Marks items as deselected.
booleandeselect(Collection<?> itemIds)Marks items as deselected.
booleandeselectAll()Marks all the items in the current Container as deselected
booleanselect(Object... itemIds)Marks items as selected.
booleanselect(Collection<?> itemIds)Marks items as selected.
booleanselectAll()Marks all the items in the current Container as selected
booleansetSelected(Object... itemIds)Marks items as selected while deselecting all items not in the varargs array.
booleansetSelected(Collection<?> itemIds)Marks items as selected while deselecting all items not in the given Collection.
-
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, reset, setGrid
-
-
-
-
Method Detail
-
select
boolean select(Object... itemIds) throws IllegalArgumentExceptionMarks items as selected.
This method does not clear any previous selection state, only adds to it.
Parameters:
itemIds- the itemId(s) to mark as selectedReturns:
trueif the selection state changed.falseif all the given itemIds already were selectedThrows:
IllegalArgumentException- if theitemIdsvarargs array isnullor given itemIds don't exist in the container of GridSee Also:
-
select
boolean select(Collection<?> itemIds) throws IllegalArgumentExceptionMarks items as selected.
This method does not clear any previous selection state, only adds to it.
Parameters:
itemIds- the itemIds to mark as selectedReturns:
trueif the selection state changed.falseif all the given itemIds already were selectedThrows:
IllegalArgumentException- ifitemIdsisnullor given itemIds don't exist in the container of GridSee Also:
-
deselect
boolean deselect(Object... itemIds) throws IllegalArgumentExceptionMarks items as deselected.
Parameters:
itemIds- the itemId(s) to remove from being selectedReturns:
trueif the selection state changed.falseif none the given itemIds were selected previouslyThrows:
IllegalArgumentException- if theitemIdsvarargs array isnullSee Also:
-
deselect
boolean deselect(Collection<?> itemIds) throws IllegalArgumentExceptionMarks items as deselected.
Parameters:
itemIds- the itemId(s) to remove from being selectedReturns:
trueif the selection state changed.falseif none the given itemIds were selected previouslyThrows:
IllegalArgumentException- ifitemIdsisnullSee Also:
-
selectAll
boolean selectAll()Marks all the items in the current Container as selected
Returns:
trueiff some items were previously not selectedSee Also:
-
deselectAll
boolean deselectAll()Marks all the items in the current Container as deselected
Returns:
trueiff some items were previously selectedSee Also:
-
setSelected
boolean setSelected(Collection<?> itemIds) throws IllegalArgumentExceptionMarks items as selected while deselecting all items not in the given Collection.
Parameters:
itemIds- the itemIds to mark as selectedReturns:
trueif the selection state changed.falseif all the given itemIds already were selectedThrows:
IllegalArgumentException- ifitemIdsisnullor given itemIds don't exist in the container of Grid
-
setSelected
boolean setSelected(Object... itemIds) throws IllegalArgumentExceptionMarks items as selected while deselecting all items not in the varargs array.
Parameters:
itemIds- the itemIds to mark as selectedReturns:
trueif the selection state changed.falseif all the given itemIds already were selectedThrows:
IllegalArgumentException- if theitemIdsvarargs array isnullor given itemIds don't exist in the container of Grid
-
-