Package com.vaadin.flow.component.grid

Class ColumnReorderEvent<T>

java.lang.Object

java.util.EventObject

com.vaadin.flow.component.ComponentEvent<Grid<T>>

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

Type Parameters:

T - the grid bean type

All Implemented Interfaces:

Serializable

@DomEvent("column-reorder-all-columns")
public class ColumnReorderEvent<T>
extends ComponentEvent<Grid<T>>

Event fired when the columns in the Grid are reordered.

Author:

Vaadin Ltd

See Also:

Grid.addColumnReorderListener(com.vaadin.flow.component.ComponentEventListener), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ColumnReorderEvent(Grid<T> source, boolean fromClient, elemental.json.JsonArray columnIDs)	Creates a new column reorder event.
ColumnReorderEvent(Grid<T> source, boolean fromClient, List<Grid.Column<T>> columns)	Creates a new column reorder event.

Method Summary

Modifier and Type	Method	Description
List<Grid.Column<T>>	getColumns()	Gets the new order of the columns.

Methods inherited from class com.vaadin.flow.component.ComponentEvent

getSource, isFromClient, unregisterListener

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnReorderEvent

public ColumnReorderEvent(Grid<T> source,
                          boolean fromClient,
                          @EventData("event.detail.columns")
                          elemental.json.JsonArray columnIDs)

Creates a new column reorder event.

Parameters:

source - the component that fired the event

fromClient - true if the event was originally fired on the client, false if the event originates from server-side logic

columnIDs - the internal column IDs; automatically translated to proper Grid Column instances.

ColumnReorderEvent

public ColumnReorderEvent(Grid<T> source,
                          boolean fromClient,
                          List<Grid.Column<T>> columns)

Creates a new column reorder event.

Parameters:

source - the component that fired the event

fromClient - true if the event was originally fired on the client, false if the event originates from server-side logic

columns - the newly ordered Grid columns. Not null, may be empty.

Method Detail

getColumns

public List<Grid.Column<T>> getColumns()

Gets the new order of the columns.

Returns:

the list of columns, not null, unmodifiable.