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.MultiSelectionModel
- 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.MultiSelectionModel
-
All Implemented Interfaces:
MethodEventSource, ClientConnector, DataGenerator, Extension, Connector, Grid.SelectionModel, Grid.SelectionModel.HasUserSelectionAllowed, Grid.SelectionModel.Multi, Serializable
Enclosing class:
public static class Grid.MultiSelectionModel extends Grid.AbstractSelectionModel implements Grid.SelectionModel.Multi, Grid.SelectionModel.HasUserSelectionAllowedA default implementation of a
Grid.SelectionModel.MultiSee Also:
-
-
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
-
-
Field Summary
Fields Modifier and Type Field and Description static intDEFAULT_MAX_SELECTIONSThe default selection size limit.
-
Fields inherited from class com.vaadin.ui.Grid.AbstractSelectionModel
selection
-
-
Constructor Summary
Constructors Constructor and Description MultiSelectionModel()
-
Method Summary
All Methods Modifier and Type Method and Description booleandeselect(Collection<?> itemIds)Marks items as deselected.
protected booleandeselect(Collection<?> itemIds, boolean refresh)booleandeselect(Object... itemIds)Marks items as deselected.
booleandeselectAll()Marks all the items in the current Container as deselected
protected booleandeselectAll(boolean refresh)protected voidextend(AbstractClientConnector target)Add this extension to the target connector.
Collection<Object>getSelectedRows()Returns a collection of all the currently selected itemIds.
intgetSelectionLimit()Gets the selection limit.
protected MultiSelectionModelStategetState()Returns the shared state for this connector.
protected MultiSelectionModelStategetState(boolean markAsDirty)Returns the shared state for this connector.
booleanisUserSelectionAllowed()Checks if the user is allowed to change the selection.
voidreset()Resets the selection model.
booleanselect(Collection<?> itemIds)Marks items as selected.
protected booleanselect(Collection<?> itemIds, boolean refresh)booleanselect(Object... itemIds)Marks items as selected.
booleanselectAll()Marks all the items in the current Container as selected
protected booleanselectAll(boolean refresh)booleansetSelected(Collection<?> itemIds)Marks items as selected while deselecting all items not in the given Collection.
booleansetSelected(Object... itemIds)Marks items as selected while deselecting all items not in the varargs array.
voidsetSelectionLimit(int selectionLimit)Sets the maximum number of rows that can be selected at once.
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, 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.ui.Grid.SelectionModel
isSelected, setGrid
-
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
-
-
-
-
Field Detail
-
DEFAULT_MAX_SELECTIONS
public static final int DEFAULT_MAX_SELECTIONSThe default selection size limit.
See Also:
-
-
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... itemIds) throws IllegalArgumentExceptionDescription copied from interface:
Grid.SelectionModel.MultiMarks items as selected.
This method does not clear any previous selection state, only adds to it.
Specified by:
selectin interfaceGrid.SelectionModel.MultiParameters:
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
public boolean select(Collection<?> itemIds) throws IllegalArgumentExceptionMarks items as selected.
This method does not clear any previous selection state, only adds to it.
All items might not be selected if the limit set using
setSelectionLimit(int)is exceeded.Specified by:
selectin interfaceGrid.SelectionModel.MultiParameters:
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:
-
select
protected boolean select(Collection<?> itemIds, boolean refresh)
-
setSelectionLimit
public void setSelectionLimit(int selectionLimit)Sets the maximum number of rows that can be selected at once. This is a mechanism to prevent exhausting server memory in situations where users select lots of rows. If the limit is reached, newly selected rows will not become recorded.
Old selections are not discarded if the current number of selected row exceeds the new limit.
The default limit is 1000 rows.
Parameters:
selectionLimit- the non-negative selection limit to setThrows:
IllegalArgumentException- if the limit is negative
-
getSelectionLimit
public int getSelectionLimit()Gets the selection limit.
Returns:
the selection limit
See Also:
-
deselect
public boolean deselect(Object... itemIds) throws IllegalArgumentExceptionDescription copied from interface:
Grid.SelectionModel.MultiMarks items as deselected.
Specified by:
deselectin interfaceGrid.SelectionModel.MultiParameters:
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
public boolean deselect(Collection<?> itemIds) throws IllegalArgumentExceptionDescription copied from interface:
Grid.SelectionModel.MultiMarks items as deselected.
Specified by:
deselectin interfaceGrid.SelectionModel.MultiParameters:
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:
-
deselect
protected boolean deselect(Collection<?> itemIds, boolean refresh)
-
selectAll
public boolean selectAll()Description copied from interface:
Grid.SelectionModel.MultiMarks all the items in the current Container as selected
Specified by:
selectAllin interfaceGrid.SelectionModel.MultiReturns:
trueiff some items were previously not selectedSee Also:
-
selectAll
protected boolean selectAll(boolean refresh)
-
deselectAll
public boolean deselectAll()Description copied from interface:
Grid.SelectionModel.MultiMarks all the items in the current Container as deselected
Specified by:
deselectAllin interfaceGrid.SelectionModel.MultiReturns:
trueiff some items were previously selectedSee Also:
-
deselectAll
protected boolean deselectAll(boolean refresh)
-
getSelectedRows
public Collection<Object> getSelectedRows()Returns a collection of all the currently selected itemIds.
The returned Collection is in order of selection – the item that was first selected will be first in the collection, and so on. Should an item have been selected twice without being deselected in between, it will have remained in its original position.
Specified by:
getSelectedRowsin interfaceGrid.SelectionModelOverrides:
getSelectedRowsin classGrid.AbstractSelectionModelReturns:
a collection of all the currently selected itemIds
-
reset
public void reset()Resets the selection model.
Equivalent to calling
deselectAll()Specified by:
resetin interfaceGrid.SelectionModel
-
setSelected
public boolean setSelected(Collection<?> itemIds) throws IllegalArgumentExceptionDescription copied from interface:
Grid.SelectionModel.MultiMarks items as selected while deselecting all items not in the given Collection.
Specified by:
setSelectedin interfaceGrid.SelectionModel.MultiParameters:
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
public boolean setSelected(Object... itemIds) throws IllegalArgumentExceptionDescription copied from interface:
Grid.SelectionModel.MultiMarks items as selected while deselecting all items not in the varargs array.
Specified by:
setSelectedin interfaceGrid.SelectionModel.MultiParameters:
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
-
getState
protected MultiSelectionModelState 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 MultiSelectionModelState 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
-
-