Class MultiSelectionModelConnector.MultiSelectionModel

Constructor Detail

• MultiSelectionModel

  protected MultiSelectionModel()

Method Detail

• setGrid

  public void setGrid​(Grid<JsonObject> grid)

  Description copied from interface: SelectionModel

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

  setGrid in interface SelectionModel<JsonObject>

  Overrides:

  setGrid in class AbstractSelectionModelConnector.AbstractSelectionModel

  Parameters:

  grid - a Grid instance; null when 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 null to disable the selection column.

  Parameters:

  grid - the grid for this selection model

  Returns:

  selection column renderer or null if 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: SelectionModel

  Return the Renderer responsible for rendering the selection column.

  Specified by:

  getSelectionColumnRenderer in interface SelectionModel<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:

  select in interface SelectionModel.Multi<JsonObject>

  Parameters:

  rows - Grid row objects

  Returns:

  false if rows is empty, else true

• deselect

  public boolean deselect​(JsonObject... rows)

  Deselects one or more rows.

  Specified by:

  deselect in interface SelectionModel.Multi<JsonObject>

  Parameters:

  rows - Grid row objects

  Returns:

  false if rows is empty, else true

• deselectAll

  public boolean deselectAll()

  De-selects all rows.

  Specified by:

  deselectAll in interface SelectionModel.Multi<JsonObject>

  Returns:

  always true

• select

  public boolean select​(Collection<JsonObject> rows)

  Select all rows in a Collection.

  Specified by:

  select in interface SelectionModel.Multi<JsonObject>

  Parameters:

  rows - a collection of Grid row objects

  Returns:

  false if rows is empty, else true

• 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 handle

  selected - true if row should be selected; false if not

  Returns:

  true if selected status changed; false if not

• deselect

  public boolean deselect​(Collection<JsonObject> rows)

  Deselect all rows in a Collection.

  Specified by:

  deselect in interface SelectionModel.Multi<JsonObject>

  Parameters:

  rows - a collection of Grid row objects

  Returns:

  false if rows is empty, else true

• startBatchSelect

  public void startBatchSelect()

  Description copied from interface: SelectionModel.Multi.Batched

  Starts 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: SelectionChangeEvents will still be fired for each selection/deselection. You should check whether the event is a part of a batch or not with SelectionEvent.isBatchedSelection().

  Specified by:

  startBatchSelect in interface SelectionModel.Multi.Batched<JsonObject>

• commitBatchSelect

  public void commitBatchSelect()

  Description copied from interface: SelectionModel.Multi.Batched

  Commits 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 collated SelectionEvent.

  Specified by:

  commitBatchSelect in interface SelectionModel.Multi.Batched<JsonObject>

• isBeingBatchSelected

  public boolean isBeingBatchSelected()

  Description copied from interface: SelectionModel.Multi.Batched

  Checks whether or not a batch has been started.

  Specified by:

  isBeingBatchSelected in interface SelectionModel.Multi.Batched<JsonObject>

  Returns:

  true iff a batch has been started

• getSelectedRowsBatch

  public Collection<JsonObject> getSelectedRowsBatch()

  Description copied from interface: SelectionModel.Multi.Batched

  Gets all the rows that would become selected in this batch.

  Specified by:

  getSelectedRowsBatch in interface SelectionModel.Multi.Batched<JsonObject>

  Returns:

  a collection of the rows that would become selected

• getDeselectedRowsBatch

  public Collection<JsonObject> getDeselectedRowsBatch()

  Description copied from interface: SelectionModel.Multi.Batched

  Gets all the rows that would become deselected in this batch.

  Specified by:

  getDeselectedRowsBatch in interface SelectionModel.Multi.Batched<JsonObject>

  Returns:

  a collection of the rows that would become deselected

• isUserSelectionAllowed

  public boolean isUserSelectionAllowed()

  Description copied from interface: HasUserSelectionAllowed

  Checks if the user is allowed to change the selection.

  Specified by:

  isUserSelectionAllowed in interface HasUserSelectionAllowed<JsonObject>

  Returns:

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

• setUserSelectionAllowed

  public void setUserSelectionAllowed​(boolean userSelectionAllowed)

  Description copied from interface: HasUserSelectionAllowed

  Sets whether the user is allowed to change the selection.

  Specified by:

  setUserSelectionAllowed in interface HasUserSelectionAllowed<JsonObject>

  Parameters:

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