Package com.vaadin.v7.ui

Class Grid.MultiSelectionModel

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

com.vaadin.v7.ui.Grid.AbstractGridExtension

com.vaadin.v7.ui.Grid.AbstractSelectionModel

com.vaadin.v7.ui.Grid.MultiSelectionModel

All Implemented Interfaces:

MethodEventSource, ClientConnector, Extension, com.vaadin.shared.Connector, DataGenerator, Grid.SelectionModel, Grid.SelectionModel.HasUserSelectionAllowed, Grid.SelectionModel.Multi, Serializable

Enclosing class:

Grid

@Deprecated
public static class Grid.MultiSelectionModel
extends Grid.AbstractSelectionModel
implements Grid.SelectionModel.Multi, Grid.SelectionModel.HasUserSelectionAllowed

Deprecated.

A default implementation of a SelectionModel.Multi.

See Also:

Serialized Form

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.v7.ui.Grid.SelectionModel

Grid.SelectionModel.HasUserSelectionAllowed, Grid.SelectionModel.Multi, Grid.SelectionModel.None, Grid.SelectionModel.Single

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MAX_SELECTIONS	Deprecated. The default selection size limit.

Fields inherited from class com.vaadin.v7.ui.Grid.AbstractSelectionModel

selection

Constructor Summary

Constructors

Constructor	Description
MultiSelectionModel()	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	deselect(Object... itemIds)	Deprecated. Marks items as deselected.
boolean	deselect(Collection<?> itemIds)	Deprecated. Marks items as deselected.
protected boolean	deselect(Collection<?> itemIds, boolean refresh)	Deprecated.
boolean	deselectAll()	Deprecated. Marks all the items in the current Container as deselected.
protected boolean	deselectAll(boolean refresh)	Deprecated.
protected void	extend(AbstractClientConnector target)	Deprecated.
Collection<Object>	getSelectedRows()	Deprecated. Returns a collection of all the currently selected itemIds.
int	getSelectionLimit()	Deprecated. Gets the selection limit.
protected MultiSelectionModelState	getState()	Deprecated.
protected MultiSelectionModelState	getState(boolean markAsDirty)	Deprecated.
boolean	isUserSelectionAllowed()	Deprecated. Checks if the user is allowed to change the selection.
void	reset()	Deprecated. Resets the selection model.
boolean	select(Object... itemIds)	Deprecated. Marks items as selected.
boolean	select(Collection<?> itemIds)	Deprecated. Marks items as selected.
protected boolean	select(Collection<?> itemIds, boolean refresh)	Deprecated.
boolean	selectAll()	Deprecated. Marks all the items in the current Container as selected.
protected boolean	selectAll(boolean refresh)	Deprecated.
boolean	setSelected(Object... itemIds)	Deprecated. Marks items as selected while deselecting all items not in the varargs array.
boolean	setSelected(Collection<?> itemIds)	Deprecated. Marks items as selected while deselecting all items not in the given Collection.
void	setSelectionLimit(int selectionLimit)	Deprecated. Sets the maximum number of rows that can be selected at once.
void	setUserSelectionAllowed(boolean userSelectionAllowed)	Deprecated. Sets whether the user is allowed to change the selection.

Methods inherited from class com.vaadin.v7.ui.Grid.AbstractSelectionModel

checkItemIdExists, checkItemIdsExist, destroyData, fireSelectionEvent, generateData, getItemId, isSelected, setGrid

Methods inherited from class com.vaadin.v7.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, 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, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

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.server.Extension

remove, setParent

Methods inherited from interface com.vaadin.v7.ui.Grid.SelectionModel

isSelected, setGrid

Field Detail

DEFAULT_MAX_SELECTIONS

public static final int DEFAULT_MAX_SELECTIONS

Deprecated.

The default selection size limit.

See Also:

setSelectionLimit(int), Constant Field Values

Constructor Detail

MultiSelectionModel

public MultiSelectionModel()

Deprecated.

Method Detail

extend

protected void extend(AbstractClientConnector target)

Deprecated.

Overrides:

extend in class Grid.AbstractGridExtension

select

public boolean select(Object... itemIds)
               throws IllegalArgumentException

Deprecated.

Description copied from interface: Grid.SelectionModel.Multi

Marks items as selected.

This method does not clear any previous selection state, only adds to it.

Specified by:

select in interface Grid.SelectionModel.Multi

Parameters:

itemIds - the itemId(s) to mark as selected

Returns:

true if the selection state changed. false if all the given itemIds already were selected

Throws:

IllegalArgumentException - if the itemIds varargs array is null or given itemIds don't exist in the container of Grid

See Also:

Grid.SelectionModel.Multi.deselect(Object...)

select

public boolean select(Collection<?> itemIds)
               throws IllegalArgumentException

Deprecated.

Marks 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:

select in interface Grid.SelectionModel.Multi

Parameters:

itemIds - the itemIds to mark as selected

Returns:

true if the selection state changed. false if all the given itemIds already were selected

Throws:

IllegalArgumentException - if itemIds is null or given itemIds don't exist in the container of Grid

See Also:

Grid.SelectionModel.Multi.deselect(Collection)

select

protected boolean select(Collection<?> itemIds,
                         boolean refresh)

Deprecated.

setSelectionLimit

public void setSelectionLimit(int selectionLimit)

Deprecated.

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 set

Throws:

IllegalArgumentException - if the limit is negative

getSelectionLimit

public int getSelectionLimit()

Deprecated.

Gets the selection limit.

Returns:

the selection limit

See Also:

setSelectionLimit(int)

deselect

public boolean deselect(Object... itemIds)
                 throws IllegalArgumentException

Deprecated.

Description copied from interface: Grid.SelectionModel.Multi

Marks items as deselected.

Specified by:

deselect in interface Grid.SelectionModel.Multi

Parameters:

itemIds - the itemId(s) to remove from being selected

Returns:

true if the selection state changed. false if none the given itemIds were selected previously

Throws:

IllegalArgumentException - if the itemIds varargs array is null

See Also:

Grid.SelectionModel.Multi.select(Object...)

deselect

public boolean deselect(Collection<?> itemIds)
                 throws IllegalArgumentException

Deprecated.

Description copied from interface: Grid.SelectionModel.Multi

Marks items as deselected.

Specified by:

deselect in interface Grid.SelectionModel.Multi

Parameters:

itemIds - the itemId(s) to remove from being selected

Returns:

true if the selection state changed. false if none the given itemIds were selected previously

Throws:

IllegalArgumentException - if itemIds is null

See Also:

Grid.SelectionModel.Multi.select(Collection)

deselect

protected boolean deselect(Collection<?> itemIds,
                           boolean refresh)

Deprecated.

selectAll

public boolean selectAll()

Deprecated.

Description copied from interface: Grid.SelectionModel.Multi

Marks all the items in the current Container as selected.

Specified by:

selectAll in interface Grid.SelectionModel.Multi

Returns:

true if some items were previously not selected

See Also:

Grid.SelectionModel.Multi.deselectAll()

selectAll

protected boolean selectAll(boolean refresh)

Deprecated.

deselectAll

public boolean deselectAll()

Deprecated.

Description copied from interface: Grid.SelectionModel.Multi

Marks all the items in the current Container as deselected.

Specified by:

deselectAll in interface Grid.SelectionModel.Multi

Returns:

true if some items were previously selected

See Also:

Grid.SelectionModel.Multi.selectAll()

deselectAll

protected boolean deselectAll(boolean refresh)

Deprecated.

getSelectedRows

public Collection<Object> getSelectedRows()

Deprecated.

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:

getSelectedRows in interface Grid.SelectionModel

Overrides:

getSelectedRows in class Grid.AbstractSelectionModel

Returns:

a collection of all the currently selected itemIds

reset

public void reset()

Deprecated.

Resets the selection model.

Equivalent to calling deselectAll()

Specified by:

reset in interface Grid.SelectionModel

setSelected

public boolean setSelected(Collection<?> itemIds)
                    throws IllegalArgumentException

Deprecated.

Description copied from interface: Grid.SelectionModel.Multi

Marks items as selected while deselecting all items not in the given Collection.

Specified by:

setSelected in interface Grid.SelectionModel.Multi

Parameters:

itemIds - the itemIds to mark as selected

Returns:

true if the selection state changed. false if all the given itemIds already were selected

Throws:

IllegalArgumentException - if itemIds is null or given itemIds don't exist in the container of Grid

setSelected

public boolean setSelected(Object... itemIds)
                    throws IllegalArgumentException

Deprecated.

Description copied from interface: Grid.SelectionModel.Multi

Marks items as selected while deselecting all items not in the varargs array.

Specified by:

setSelected in interface Grid.SelectionModel.Multi

Parameters:

itemIds - the itemIds to mark as selected

Returns:

true if the selection state changed. false if all the given itemIds already were selected

Throws:

IllegalArgumentException - if the itemIds varargs array is null or given itemIds don't exist in the container of Grid

getState

protected MultiSelectionModelState getState()

Deprecated.

Overrides:

getState in class AbstractClientConnector

getState

protected MultiSelectionModelState getState(boolean markAsDirty)

Deprecated.

Overrides:

getState in class AbstractClientConnector

isUserSelectionAllowed

public boolean isUserSelectionAllowed()

Deprecated.

Description copied from interface: Grid.SelectionModel.HasUserSelectionAllowed

Checks if the user is allowed to change the selection.

Specified by:

isUserSelectionAllowed in interface Grid.SelectionModel.HasUserSelectionAllowed

Returns:

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

setUserSelectionAllowed

public void setUserSelectionAllowed(boolean userSelectionAllowed)

Deprecated.

Description copied from interface: Grid.SelectionModel.HasUserSelectionAllowed

Sets whether the user is allowed to change the selection.

Specified by:

setUserSelectionAllowed in interface Grid.SelectionModel.HasUserSelectionAllowed

Parameters:

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