com.vaadin.ui.components.grid

Class TreeGridDropEvent<T>

java.lang.Object

java.util.EventObject

com.vaadin.event.ConnectorEvent

com.vaadin.ui.Component.Event

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

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

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

Type Parameters:

T - The TreeGrid bean type.

All Implemented Interfaces:

Serializable

public class TreeGridDropEvent<T>
extends GridDropEvent<T>

Drop event on an HTML5 drop target TreeGrid row.

Since:

8.1

Author:

Vaadin Ltd.

See Also:

TreeGridDropTarget.addTreeGridDropListener(TreeGridDropListener), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
TreeGridDropEvent(TreeGrid<T> target, Map<String,String> data, DropEffect dropEffect, DragSourceExtension<? extends AbstractComponent> dragSourceExtension, T dropTargetRow, DropLocation dropLocation, MouseEventDetails mouseEventDetails, Integer depth, Boolean collapsed) Creates a TreeGrid row drop event.

Method Summary

Modifier and Type	Method and Description
Optional<Integer>	getDropTargetRowDepth() Gets the depth of the drop target row in the hierarchy.
Optional<Boolean>	isDropTargetRowCollapsed() Tells whether the drop target row is collapsed.

Methods inherited from class com.vaadin.ui.components.grid.GridDropEvent

getDropLocation, getDropTargetRow

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

getComponent, getDataTransferData, getDataTransferData, getDataTransferText, getDragData, getDragSourceComponent, getDragSourceExtension, getDropEffect, getMouseEventDetails

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

TreeGridDropEvent

public TreeGridDropEvent(TreeGrid<T> target,
                         Map<String,String> data,
                         DropEffect dropEffect,
                         DragSourceExtension<? extends AbstractComponent> dragSourceExtension,
                         T dropTargetRow,
                         DropLocation dropLocation,
                         MouseEventDetails mouseEventDetails,
                         Integer depth,
                         Boolean collapsed)

Creates a TreeGrid row drop event.

Parameters:

target - TreeGrid that received the drop.

data - Map containing all types and corresponding data from the DataTransfer object.

dropEffect - the desired drop effect

dragSourceExtension - Drag source extension of the component that initiated the drop event.

dropTargetRow - Target row that received the drop, or null if dropped on empty grid

dropLocation - Location of the drop within the target row.

mouseEventDetails - Mouse event details object containing information about the drop event

depth - depth of the row in the hierarchy

collapsed - whether the target row is collapsed

Method Detail

getDropTargetRowDepth

public Optional<Integer> getDropTargetRowDepth()

Gets the depth of the drop target row in the hierarchy.

Returns:

the depth of the drop target row in the hierarchy

isDropTargetRowCollapsed

public Optional<Boolean> isDropTargetRowCollapsed()

Tells whether the drop target row is collapsed.

Returns:

true if the drop target row is collapsed, false otherwise