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.
Class MultiSelectionModelConnector.MultiSelectionModel
- java.lang.Object
-
- com.vaadin.client.connectors.AbstractSelectionModelConnector.AbstractSelectionModel
-
- com.vaadin.client.connectors.MultiSelectionModelConnector.MultiSelectionModel
-
All Implemented Interfaces:
HasUserSelectionAllowed<JsonObject>,SelectionModel<JsonObject>,SelectionModel.Multi<JsonObject>,SelectionModel.Multi.Batched<JsonObject>Enclosing class:
protected class MultiSelectionModelConnector.MultiSelectionModel extends AbstractSelectionModelConnector.AbstractSelectionModel implements SelectionModel.Multi.Batched<JsonObject>, HasUserSelectionAllowed<JsonObject>The default multi selection model used for this connector.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vaadin.client.widget.grid.selection.SelectionModel
SelectionModel.Multi<T>, SelectionModel.None<T>, SelectionModel.Single<T>
-
Nested classes/interfaces inherited from interface com.vaadin.client.widget.grid.selection.SelectionModel.Multi
SelectionModel.Multi.Batched<T>
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedMultiSelectionModel()
-
Method Summary
All Methods Modifier and Type Method Description voidcommitBatchSelect()Commits and ends a batch selection.
protected ComplexRenderer<Boolean>createSelectionColumnRenderer(Grid<JsonObject> grid)Creates a selection column renderer.
booleandeselect(JsonObject... rows)Deselects one or more rows.
booleandeselect(Collection<JsonObject> rows)Deselect all rows in a
Collection.booleandeselectAll()De-selects all rows.
Collection<JsonObject>getDeselectedRowsBatch()Gets all the rows that would become deselected in this batch.
Collection<JsonObject>getSelectedRowsBatch()Gets all the rows that would become selected in this batch.
Renderer<Boolean>getSelectionColumnRenderer()Return the
Rendererresponsible for rendering the selection column.booleanisBeingBatchSelected()Checks whether or not a batch has been started.
booleanisUserSelectionAllowed()Checks if the user is allowed to change the selection.
protected booleanmarkAsSelected(DataSource.RowHandle<JsonObject> row, boolean selected)Marks the given row to be selected or deselected.
booleanselect(JsonObject... rows)Selects one or more rows.
booleanselect(Collection<JsonObject> rows)Select all rows in a
Collection.voidselectAll()Selects all available rows, sends request to server to select everything.
voidsetGrid(Grid<JsonObject> grid)Tells this SelectionModel which Grid it belongs to.
voidsetUserSelectionAllowed(boolean userSelectionAllowed)Sets whether the user is allowed to change the selection.
voidstartBatchSelect()Starts a batch selection.
-
Methods inherited from class com.vaadin.client.connectors.AbstractSelectionModelConnector.AbstractSelectionModel
getSelectedRows, isSelected, reset
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.client.widget.grid.selection.SelectionModel
getSelectedRows, isSelected, reset
-
-
-
-
Method Detail
-
setGrid
public void setGrid(Grid<JsonObject> grid)Description copied from interface:
SelectionModelTells this SelectionModel which Grid it belongs to.
Implementations are free to have this be a no-op. This method is called internally by Grid.
Specified by:
setGridin interfaceSelectionModel<JsonObject>Overrides:
setGridin classAbstractSelectionModelConnector.AbstractSelectionModelParameters:
grid- aGridinstance;nullwhen removing from Grid
-
createSelectionColumnRenderer
protected ComplexRenderer<Boolean> createSelectionColumnRenderer(Grid<JsonObject> grid)Creates a selection column renderer. This method can be overridden to use a custom renderer or use
nullto disable the selection column.Parameters:
grid- the grid for this selection modelReturns:
selection column renderer or
nullif not needed
-
selectAll
public void selectAll()Selects all available rows, sends request to server to select everything.
-
getSelectionColumnRenderer
public Renderer<Boolean> getSelectionColumnRenderer()Description copied from interface:
SelectionModelReturn the
Rendererresponsible for rendering the selection column.Specified by:
getSelectionColumnRendererin interfaceSelectionModel<JsonObject>Returns:
a renderer instance. If null is returned, a selection column will not be drawn.
-
select
public boolean select(JsonObject... rows)Selects one or more rows.
Specified by:
selectin interfaceSelectionModel.Multi<JsonObject>Parameters:
rows-Gridrow objectsReturns:
falseif rows is empty, elsetrue
-
deselect
public boolean deselect(JsonObject... rows)Deselects one or more rows.
Specified by:
deselectin interfaceSelectionModel.Multi<JsonObject>Parameters:
rows- Grid row objectsReturns:
falseif rows is empty, elsetrue
-
deselectAll
public boolean deselectAll()De-selects all rows.
Specified by:
deselectAllin interfaceSelectionModel.Multi<JsonObject>Returns:
always
true
-
select
public boolean select(Collection<JsonObject> rows)Select all rows in a
Collection.Specified by:
selectin interfaceSelectionModel.Multi<JsonObject>Parameters:
rows- a collection of Grid row objectsReturns:
falseif rows is empty, elsetrue
-
markAsSelected
protected boolean markAsSelected(DataSource.RowHandle<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 notReturns:
trueif selected status changed;falseif not
-
deselect
public boolean deselect(Collection<JsonObject> rows)Deselect all rows in a
Collection.Specified by:
deselectin interfaceSelectionModel.Multi<JsonObject>Parameters:
rows- a collection of Grid row objectsReturns:
falseif rows is empty, elsetrue
-
startBatchSelect
public void startBatchSelect()Description copied from interface:
SelectionModel.Multi.BatchedStarts a batch selection.
Any commands to any select or deselect method will be batched into one, and a final selection event will be fired when
SelectionModel.Multi.Batched.commitBatchSelect()is called.Note:
SelectionChangeEventswill still be fired for each selection/deselection. You should check whether the event is a part of a batch or not withSelectionEvent.isBatchedSelection().Specified by:
startBatchSelectin interfaceSelectionModel.Multi.Batched<JsonObject>
-
commitBatchSelect
public void commitBatchSelect()Description copied from interface:
SelectionModel.Multi.BatchedCommits and ends a batch selection.
Any and all selections and deselections since the last invocation of
SelectionModel.Multi.Batched.startBatchSelect()will be fired at once as one collatedSelectionEvent.Specified by:
commitBatchSelectin interfaceSelectionModel.Multi.Batched<JsonObject>
-
isBeingBatchSelected
public boolean isBeingBatchSelected()Description copied from interface:
SelectionModel.Multi.BatchedChecks whether or not a batch has been started.
Specified by:
isBeingBatchSelectedin interfaceSelectionModel.Multi.Batched<JsonObject>Returns:
trueiff a batch has been started
-
getSelectedRowsBatch
public Collection<JsonObject> getSelectedRowsBatch()Description copied from interface:
SelectionModel.Multi.BatchedGets all the rows that would become selected in this batch.
Specified by:
getSelectedRowsBatchin interfaceSelectionModel.Multi.Batched<JsonObject>Returns:
a collection of the rows that would become selected
-
getDeselectedRowsBatch
public Collection<JsonObject> getDeselectedRowsBatch()Description copied from interface:
SelectionModel.Multi.BatchedGets all the rows that would become deselected in this batch.
Specified by:
getDeselectedRowsBatchin interfaceSelectionModel.Multi.Batched<JsonObject>Returns:
a collection of the rows that would become deselected
-
isUserSelectionAllowed
public boolean isUserSelectionAllowed()Description copied from interface:
HasUserSelectionAllowedChecks if the user is allowed to change the selection.
Specified by:
isUserSelectionAllowedin interfaceHasUserSelectionAllowed<JsonObject>Returns:
trueif the user is allowed to change the selection,falseotherwise
-
setUserSelectionAllowed
public void setUserSelectionAllowed(boolean userSelectionAllowed)Description copied from interface:
HasUserSelectionAllowedSets whether the user is allowed to change the selection.
Specified by:
setUserSelectionAllowedin interfaceHasUserSelectionAllowed<JsonObject>Parameters:
userSelectionAllowed-trueif the user is allowed to change the selection,falseotherwise
-
-