Class DataTransfer

java.lang.Object
com.google.gwt.core.client.JavaScriptObject
com.google.gwt.dom.client.DataTransfer

public class DataTransfer extends JavaScriptObject
Class representing DataTransfer interface.

Experimental API: This API is still under development and is subject to change.

See Also:
  • Constructor Details

    • DataTransfer

      protected DataTransfer()
      Required constructor for GWT compiler to function.
  • Method Details

    • clearData

      public final void clearData()
      Remove all data from the current drag sequence.
      See Also:
    • clearData

      public final void clearData(String format)
      Remove the data for the specified format for all drag events in the current drag sequence.
      Parameters:
      format - the format, which is usually the mime-type of the associated data
      See Also:
    • getData

      public final String getData(String format)
      Get the data for the specified format. The data may have been set in a previous drag event that is part of the current drag sequence.
      Parameters:
      format - the format, which is usually the mime-type of the data
      Returns:
      the data for the specified format
      See Also:
    • setData

      public final void setData(String format, String data)
      Set the data for the specified format to associate with all drag events in the current drag and drop sequence. The data can be read using getData(String) from any subsequent drag events in this sequence (such as the drop event).

      The format is usually the mime-type of the data, but can also be text.

      Parameters:
      format - the format, which is usually the mime-type of the data
      data - the data to associate with the format
      See Also:
    • setDragImage

      public final void setDragImage(Element element, int x, int y)
      Specify the element to use to update the drag feedback.
      Parameters:
      element - the feedback image
      x - the x offset of the cursor
      y - the y offset of the cursor
      See Also:
    • setDropEffect

      public final void setDropEffect(DataTransfer.DropEffect dropEffect)
      Specify the drop effect to use on dragenter or dragover events.
      Parameters:
      dropEffect - the drop effect to display.