Package com.vaadin.flow.component.shared

Enum Class SelectionPreservationMode

java.lang.Object

java.lang.Enum<SelectionPreservationMode>

com.vaadin.flow.component.shared.SelectionPreservationMode

All Implemented Interfaces:

Serializable, Comparable<SelectionPreservationMode>, Constable

public enum SelectionPreservationMode
extends Enum<SelectionPreservationMode>

Represents selection preservation mode. Determines what happens with the selection when DataProvider.refreshAll() is called.

These enums should be used in SelectionPreservationHandler.setSelectionPreservationMode(SelectionPreservationMode) to switch between the implemented selection preservation modes.

Author:

Vaadin Ltd.

See Also:

• SelectionPreservationHandler

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISCARD	Selection preservation mode that clears selection when DataProvider.refreshAll() is called.
PRESERVE_ALL	Selection preservation mode that preserves all selected items when DataProvider.refreshAll() is called.
PRESERVE_EXISTING	Selection preservation mode that only preserves the selected items that still exist after DataProvider.refreshAll() is called.

Method Summary

Modifier and Type	Method	Description
static SelectionPreservationMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SelectionPreservationMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PRESERVE_ALL

public static final SelectionPreservationMode PRESERVE_ALL

Selection preservation mode that preserves all selected items when DataProvider.refreshAll() is called.

PRESERVE_EXISTING

public static final SelectionPreservationMode PRESERVE_EXISTING

Selection preservation mode that only preserves the selected items that still exist after DataProvider.refreshAll() is called.

DISCARD

public static final SelectionPreservationMode DISCARD

Selection preservation mode that clears selection when DataProvider.refreshAll() is called.

Method Details

values

public static SelectionPreservationMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SelectionPreservationMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null