Package com.vaadin.ui.components.grid

Class GridDragStartEvent<T>

java.lang.Object

java.util.EventObject

com.vaadin.event.ConnectorEvent

com.vaadin.ui.Component.Event

com.vaadin.ui.dnd.event.DragStartEvent<Grid<T>>

com.vaadin.ui.components.grid.GridDragStartEvent<T>

Type Parameters:

T - The Grid bean type.

All Implemented Interfaces:

Serializable

public class GridDragStartEvent<T>
extends DragStartEvent<Grid<T>>

Drag start event on an HTML5 drag source Grid row.

Since:

8.1

Author:

Vaadin Ltd.

See Also:

GridDragSource.addGridDragStartListener(GridDragStartListener), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
GridDragStartEvent(Grid<T> source, EffectAllowed effectAllowed, List<T> draggedItems)	Creates a drag start event.

Method Summary

Modifier and Type	Method	Description
List<T>	getDraggedItems()	Get the dragged row items.

Methods inherited from class com.vaadin.ui.dnd.event.DragStartEvent

getComponent, getEffectAllowed

Methods inherited from class com.vaadin.event.ConnectorEvent

getConnector

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GridDragStartEvent

public GridDragStartEvent(Grid<T> source,
                          EffectAllowed effectAllowed,
                          List<T> draggedItems)

Creates a drag start event.

Parameters:

source - The source grid where the rows are being dragged from.

effectAllowed - Allowed effect from DataTransfer.effectAllowed object.

draggedItems - List of items being dragged.

Method Detail

getDraggedItems

public List<T> getDraggedItems()

Get the dragged row items.

The ordering of the list is the following: first the item that the drag started from, optionally followed by all the other selected rows in first-to-last order on the client side.

Returns:

an unmodifiable list of items that are being dragged.