Package com.vaadin.flow.component.grid

Class GridSortOrderBuilder<T>

java.lang.Object

com.vaadin.flow.data.provider.SortOrderBuilder<GridSortOrder<T>,Grid.Column<T>>

com.vaadin.flow.component.grid.GridSortOrderBuilder<T>

Type Parameters:

T - the type of the grid

All Implemented Interfaces:

Serializable

public class GridSortOrderBuilder<T>
extends SortOrderBuilder<GridSortOrder<T>,Grid.Column<T>>

Helper classes with fluent API for constructing GridSortOrder lists. When the sort order is ready to be passed on, calling SortOrderBuilder.build() will create the list of sort orders.

Author:

Vaadin Ltd.

See Also:

• GridSortOrder
• thenAsc(com.vaadin.flow.component.grid.Grid.Column)
• thenDesc(com.vaadin.flow.component.grid.Grid.Column)
• SortOrderBuilder.build()
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GridSortOrderBuilder()

Method Summary

Modifier and Type	Method	Description
protected GridSortOrder<T>	createSortOrder(Grid.Column<T> by, SortDirection direction)	Creates a sort order object with the given parameters.
GridSortOrderBuilder<T>	thenAsc(Grid.Column<T> by)	Appends sorting with ascending sort direction.
GridSortOrderBuilder<T>	thenDesc(Grid.Column<T> by)	Appends sorting with descending sort direction.

Methods inherited from class com.vaadin.flow.data.provider.SortOrderBuilder

build

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GridSortOrderBuilder

public GridSortOrderBuilder()

Method Details

thenAsc

public GridSortOrderBuilder<T> thenAsc(Grid.Column<T> by)

Description copied from class: SortOrderBuilder

Appends sorting with ascending sort direction.

Overrides:

thenAsc in class SortOrderBuilder<GridSortOrder<T>,Grid.Column<T>>

Parameters:

by - the object to sort by

Returns:

this sort builder

thenDesc

public GridSortOrderBuilder<T> thenDesc(Grid.Column<T> by)

Description copied from class: SortOrderBuilder

Appends sorting with descending sort direction.

Overrides:

thenDesc in class SortOrderBuilder<GridSortOrder<T>,Grid.Column<T>>

Parameters:

by - the object to sort by

Returns:

this sort builder

createSortOrder

protected GridSortOrder<T> createSortOrder(Grid.Column<T> by,
 SortDirection direction)

Description copied from class: SortOrderBuilder

Creates a sort order object with the given parameters.

Specified by:

createSortOrder in class SortOrderBuilder<GridSortOrder<T>,Grid.Column<T>>

Parameters:

by - the object to sort by

direction - the sort direction

Returns:

the sort order object