Package com.vaadin.flow.component.dnd

Class DragStartEvent<T extends com.vaadin.flow.component.Component>

java.lang.Object
java.util.EventObject
com.vaadin.flow.component.ComponentEvent<T>
com.vaadin.flow.component.dnd.AbstractDnDEvent<T>
com.vaadin.flow.component.dnd.DragStartEvent<T>
Type Parameters:
T - Type of the component that is dragged.
All Implemented Interfaces:
Serializable
@DomEvent("dragstart") public class DragStartEvent<T extends com.vaadin.flow.component.Component> extends AbstractDnDEvent<T>
HTML5 drag start event, fired when the user starts dragging a drag source.
Since:
2.0
Author:
Vaadin Ltd
See Also:

  • Field Summary

    Fields inherited from class java.util.EventObject

    source

  • Constructor Summary

    Constructors
    Constructor
    Description
    DragStartEvent(T source, boolean fromClient, int clientX, int clientY, int offsetX, int offsetY)
    Creates a drag start event.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getOffsetX()
    Gets the x coordinate of the mouse pointer relative to the drag source element when the drag started.
    int
    getOffsetY()
    Gets the y coordinate of the mouse pointer relative to the drag source element when the drag started.
    void
    setDragData(Object data)
    Set server side drag data for this started drag operation.

    Methods inherited from class com.vaadin.flow.component.dnd.AbstractDnDEvent

    getClientX, getClientY, getComponent

    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 Details

    • DragStartEvent

      public DragStartEvent(T source, boolean fromClient, @EventData("event.clientX") int clientX, @EventData("event.clientY") int clientY, @EventData("event.offsetX") int offsetX, @EventData("event.offsetY") int offsetY)
      Creates a drag start event.
      Parameters:
      source - Component that is dragged.
      fromClient - true if the event originated from the client side, false otherwise
      clientX - the x coordinate of the mouse pointer relative to the viewport
      clientY - the y coordinate of the mouse pointer relative to the viewport
      offsetX - the x coordinate of the mouse pointer relative to the drag source element
      offsetY - the y coordinate of the mouse pointer relative to the drag source element

  • Method Details

    • getOffsetX

      public int getOffsetX()
      Gets the x coordinate of the mouse pointer relative to the drag source element when the drag started.

      This is useful for maintaining the relative grab position when positioning dropped items.

      Returns:
      the x coordinate relative to the drag source element
      Since:
      25.1

    • getOffsetY

      public int getOffsetY()
      Gets the y coordinate of the mouse pointer relative to the drag source element when the drag started.

      This is useful for maintaining the relative grab position when positioning dropped items.

      Returns:
      the y coordinate relative to the drag source element
      Since:
      25.1

    • setDragData

      public void setDragData(Object data)
      Set server side drag data for this started drag operation. This data is available in the drop event and can be used to transfer data between drag source and DropTarget if they are in the same UI.

      This method is a shorthand for DragSource.setDragData(Object) and overrides any previously set drag data.

      Parameters:
      data - Data to transfer to drop event.
      See Also: