Interface SelectionModel.Single<T>

Method Detail

• select

  void select​(T item)

  Selects the given item. If another item was already selected, that item is deselected.

  Specified by:

  select in interface SelectionModel<T>

  Parameters:

  item - the item to select, not null

• getSelectedItem

  Optional<T> getSelectedItem()

  Returns the currently selected item, or an empty optional if no item is selected.

  Returns:

  an optional of the selected item if any, an empty optional otherwise

• setSelectedItem

  default void setSelectedItem​(T item)

  Sets the current selection to the given item, or clears selection if given null.

  Parameters:

  item - the item to select or null to clear selection

• deselectAll

  default void deselectAll()

  Description copied from interface: SelectionModel

  Deselects all currently selected items, if any.

  Specified by:

  deselectAll in interface SelectionModel<T>

• getSelectedItems

  default Set<T> getSelectedItems()

  Returns a singleton set of the currently selected item or an empty set if no item is selected.

  Specified by:

  getSelectedItems in interface SelectionModel<T>

  Returns:

  a singleton set of the selected item if any, an empty set otherwise

  See Also:

  getSelectedItem()

• getFirstSelectedItem

  default Optional<T> getFirstSelectedItem()

  Description copied from interface: SelectionModel

  Get first selected data item.

  This is the same as getSelectedItem() in case of single selection and the first selected item from SelectionModel.getSelectedItems() in case of multiselection.

  Specified by:

  getFirstSelectedItem in interface SelectionModel<T>

  Returns:

  the first selected item.

• setDeselectAllowed

  void setDeselectAllowed​(boolean deselectAllowed)

  Sets whether it's allowed to deselect the selected row through the UI. Deselection is allowed by default.

  Parameters:

  deselectAllowed - true if the selected row can be deselected without selecting another row instead; otherwise false.

• isDeselectAllowed

  boolean isDeselectAllowed()

  Gets whether it's allowed to deselect the selected row through the UI.

  Returns:

  true if deselection is allowed; otherwise false