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.client.connectors.grid.
Class MultiSelectionModelConnector
- java.lang.Object
-
- com.vaadin.client.ui.AbstractConnector
-
- com.vaadin.client.extensions.AbstractExtensionConnector
-
- com.vaadin.client.connectors.grid.AbstractSelectionModelConnector
-
- com.vaadin.client.connectors.grid.MultiSelectionModelConnector
-
All Implemented Interfaces:
com.google.gwt.event.shared.EventHandler,StateChangeEvent.StateChangeHandler,ServerConnector,Connector,SerializableDirect Known Subclasses:
public class MultiSelectionModelConnector extends AbstractSelectionModelConnectorConnector for server side multiselection model implementation.
This selection model displays a selection column
Grid.SelectionColumnas the first column of the grid.Implementation detail: The Grid selection is updated immediately on client side, without waiting for the server response.
Since:
8.0
Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected classMultiSelectionModelConnector.MultiSelectionModelClient side multiselection model implementation.
-
Constructor Summary
Constructors Constructor Description MultiSelectionModelConnector()
-
Method Summary
All Methods Modifier and Type Method Description protected MultiSelectionModelConnector.MultiSelectionModelcreateSelectionModel()Creates an instance of MultiSelectionModel.
MultiSelectionModelStategetState()Returns the shared state object for this connector.
protected voidinitSelectionModel()Initializes the selection model and sets it to the grid.
protected booleanisAllSelected()Returns whether all items are selected or not.
protected booleanisSelected(elemental.json.JsonObject item)Returns whether the given item selected in grid or not.
protected voidonSelectAllEvent(SelectAllEvent<elemental.json.JsonObject> event)Handler for selecting / deselecting all grid rows.
voidonUnregister()Event called when connector has been unregistered.
protected voidupdateAllRowsSelected(boolean selected)Update selection for all grid rows.
protected voidupdateRowSelected(DataSource.RowHandle<elemental.json.JsonObject> row, boolean selected)Marks the given row to be selected or deselected.
protected voidupdateSelectAllCheckBox()Called whenever there has been a state update for select all checkbox visibility or all have been selected or deselected.
-
Methods inherited from class com.vaadin.client.connectors.grid.AbstractSelectionModelConnector
extend, getGrid, getParent, getSpaceSelectionHandler
-
Methods inherited from class com.vaadin.client.extensions.AbstractExtensionConnector
setParent
-
Methods inherited from class com.vaadin.client.ui.AbstractConnector
addStateChangeHandler, addStateChangeHandler, createState, doInit, ensureHandlerManager, fireEvent, forceStateChange, getChildren, getConnection, getConnectorId, getResourceUrl, getRpcImplementations, getRpcProxy, getStateType, getTag, hasEventListener, init, isEnabled, onStateChanged, registerRpc, removeStateChangeHandler, removeStateChangeHandler, setChildren, setTag, unregisterRpc, updateEnabledState
-
-
-
-
Method Detail
-
initSelectionModel
protected void initSelectionModel()Description copied from class:
AbstractSelectionModelConnectorInitializes the selection model and sets it to the grid.
This method is only invoked once by
AbstractSelectionModelConnector.extend(ServerConnector)inAbstractSelectionModelConnectorwhen the grid is available viaAbstractSelectionModelConnector.getGrid()and the selection model should be taken into use.Specified by:
-
createSelectionModel
protected MultiSelectionModelConnector.MultiSelectionModel createSelectionModel()Creates an instance of MultiSelectionModel. Method provided overriding features of the selection model without copying all logic.
Returns:
selection model instance, not
nullSince:
8.1
-
onUnregister
public void onUnregister()Description copied from interface:
ServerConnectorEvent called when connector has been unregistered.
Specified by:
onUnregisterin interfaceServerConnectorOverrides:
-
getState
public MultiSelectionModelState getState()Description copied from class:
AbstractConnectorReturns the shared state object for this connector. Override this method to define the shared state type for your connector.
Specified by:
getStatein interfaceServerConnectorOverrides:
getStatein classAbstractSelectionModelConnectorReturns:
the current shared state (never null)
-
updateSelectAllCheckBox
protected void updateSelectAllCheckBox()Called whenever there has been a state update for select all checkbox visibility or all have been selected or deselected.
-
isAllSelected
protected boolean isAllSelected()Returns whether all items are selected or not.
Returns:
trueif all items are selected,falseif not
-
onSelectAllEvent
protected void onSelectAllEvent(SelectAllEvent<elemental.json.JsonObject> event)Handler for selecting / deselecting all grid rows.
Parameters:
event- the select all event from grid
-
updateAllRowsSelected
protected void updateAllRowsSelected(boolean selected)Update selection for all grid rows.
Parameters:
selected-truefor marking all rows selected,falsefor not selected
-
isSelected
protected boolean isSelected(elemental.json.JsonObject item)Description copied from class:
AbstractSelectionModelConnectorReturns whether the given item selected in grid or not.
Overrides:
isSelectedin classAbstractSelectionModelConnectorParameters:
item- the item to checkReturns:
trueif selectedfalseif not
-
updateRowSelected
protected void updateRowSelected(DataSource.RowHandle<elemental.json.JsonObject> row, boolean selected)Marks the given row to be selected or deselected. Returns true if the value actually changed.
Note: If selection model is in batch select state, the row will be pinned on select.
Parameters:
row- row handleselected-trueif row should be selected;falseif not
-
-