com.vaadin.ui.components.grid.GridDropEvent Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.ui.components.grid;
import java.util.Map;
import java.util.Optional;
import com.vaadin.shared.MouseEventDetails;
import com.vaadin.shared.ui.dnd.DropEffect;
import com.vaadin.shared.ui.grid.DropLocation;
import com.vaadin.shared.ui.grid.DropMode;
import com.vaadin.ui.AbstractComponent;
import com.vaadin.ui.Grid;
import com.vaadin.ui.dnd.DragSourceExtension;
import com.vaadin.ui.dnd.event.DropEvent;
/**
* Drop event on an HTML5 drop target {@link Grid} row.
*
* @param
* The Grid bean type.
* @author Vaadin Ltd.
* @see GridDropTarget#addGridDropListener(GridDropListener)
* @since 8.1
*/
public class GridDropEvent extends DropEvent> {
private final T dropTargetRow;
private final DropLocation dropLocation;
/**
* Creates a Grid row drop event.
*
* @param target
* Grid that received the drop.
* @param data
* Map containing all types and corresponding data from the
* {@code
* DataTransfer} object.
* @param dropEffect
* the desired drop effect
* @param dragSourceExtension
* Drag source extension of the component that initiated the drop
* event.
* @param dropTargetRow
* Target row that received the drop, or {@code null} if dropped
* on empty grid or {@link DropMode#ON_GRID} is used
* @param dropLocation
* Location of the drop within the target row.
* @param mouseEventDetails
* mouse event details object containing information about the
* drop event
*/
public GridDropEvent(Grid target, Map data,
DropEffect dropEffect,
DragSourceExtension dragSourceExtension,
T dropTargetRow, DropLocation dropLocation,
MouseEventDetails mouseEventDetails) {
super(target, data, dropEffect, dragSourceExtension, mouseEventDetails);
this.dropTargetRow = dropTargetRow;
this.dropLocation = dropLocation;
}
/**
* Get the row the drop happened on.
*
* If the drop was not on top of a row (see {@link #getDropLocation()}) or
* {@link DropMode#ON_GRID} is used, then returns an empty optional.
*
* @return The row the drop happened on, or an empty optional if drop was
* not on a row
*/
public Optional getDropTargetRow() {
return Optional.ofNullable(dropTargetRow);
}
/**
* Get the location of the drop within the row.
*
* NOTE: the location will be {@link DropLocation#EMPTY} if:
*
* - dropped on an empty grid
* - dropping on rows was not possible because of
* {@link DropMode#ON_GRID } was used
* - {@link DropMode#ON_TOP} is used and the drop happened on empty space
* after last row or on top of the header / footer
*
*
* @return location of the drop in relative to the
* {@link #getDropTargetRow()} or {@link DropLocation#EMPTY} if no
* target row present
* @see GridDropTarget#setDropMode(DropMode)
*/
public DropLocation getDropLocation() {
return dropLocation;
}
}