Package com.vaadin.flow.component.grid

Enum Class Grid.MultiSortPriority

java.lang.Object

java.lang.Enum<Grid.MultiSortPriority>

com.vaadin.flow.component.grid.Grid.MultiSortPriority

All Implemented Interfaces:

Serializable, Comparable<Grid.MultiSortPriority>, Constable

Enclosing class:

Grid<T>

public static enum Grid.MultiSortPriority
extends Enum<Grid.MultiSortPriority>

Multi-sort priority (visually indicated by numbers in column headers) controls how columns are added to the sort order, when a column becomes sorted, or the sort direction of a column is changed.

Use Grid.setMultiSort(boolean, MultiSortPriority) to customize the multi-sort priority of an individual grid.

See Also:

• Grid.setSelectionMode(SelectionMode)
• Grid.setMultiSort(boolean, MultiSortPriority)

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
APPEND	Whenever an unsorted column is sorted, it gets added at the end of the sort order, after all the previously sorted columns.
PREPEND	Whenever an unsorted column is sorted, or the sort direction of a column is changed, that column gets sort priority 1, and all the other sorted columns are updated accordingly.

Method Summary

Modifier and Type	Method	Description
static Grid.MultiSortPriority	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Grid.MultiSortPriority[]	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

APPEND

public static final Grid.MultiSortPriority APPEND

Whenever an unsorted column is sorted, it gets added at the end of the sort order, after all the previously sorted columns. When the sort direction of a column is changed by the user, the priority for all the sorted columns remains unchanged.

PREPEND

public static final Grid.MultiSortPriority PREPEND

Whenever an unsorted column is sorted, or the sort direction of a column is changed, that column gets sort priority 1, and all the other sorted columns are updated accordingly. This is the default behavior of the component.

Method Details

values

public static Grid.MultiSortPriority[] 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 Grid.MultiSortPriority 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