Class Dragboard

java.lang.Object
javafx.scene.input.Clipboard
javafx.scene.input.Dragboard

public class Dragboard extends Clipboard
A drag and drop specific Clipboard.
Since:
JavaFX 2.0
  • Constructor Details

    • Dragboard

      public Dragboard(Scene scene)
  • Method Details

    • getTransferModes

      public final Set<TransferMode> getTransferModes()
      Gets set of transport modes supported by source of this drag opeation.
      Returns:
      set of supported transfer modes
    • setDragView

      public void setDragView(Image image)
      Deprecated.
      Sets the visual representation of data being transfered in a drag and drop gesture. This method should be called only when starting drag and drop operation in the DRAG_DETECTED handler, calling it at other times doesn't have any effect.
      Parameters:
      image - image to use for the drag view
      Since:
      JavaFX 8.0
    • setDragViewOffsetX

      public void setDragViewOffsetX(double offsetX)
      Sets the x position of the cursor of the drag view image. This method should be called only when starting drag and drop operation in the DRAG_DETECTED handler, calling it at other times doesn't have any effect.
      Parameters:
      offsetX - x position of the cursor over the image
      Since:
      JavaFX 8.0
    • setDragViewOffsetY

      public void setDragViewOffsetY(double offsetY)
      Sets the y position of the cursor of the drag view image. This method should be called only when starting drag and drop operation in the DRAG_DETECTED handler, calling it at other times doesn't have any effect.
      Parameters:
      offsetY - y position of the cursor over the image
      Since:
      JavaFX 8.0
    • getDragView

      public Image getDragView()
      Gets the image used as a drag view. This method returns meaningful value only when starting drag and drop operation in the DRAG_DETECTED handler, it returns null at other times.
      Returns:
      the image used as a drag view
      Since:
      JavaFX 8.0
    • getDragViewOffsetX

      public double getDragViewOffsetX()
      Gets the x position of the cursor of the drag view image. This method returns meaningful value only when starting drag and drop operation in the DRAG_DETECTED handler, it returns 0 at other times.
      Returns:
      x position of the cursor over the image
      Since:
      JavaFX 8.0
    • getDragViewOffsetY

      public double getDragViewOffsetY()
      Gets the y position of the cursor of the drag view image. This method returns meaningful value only when starting drag and drop operation in the DRAG_DETECTED handler, it returns 0 at other times.
      Returns:
      y position of the cursor over the image
      Since:
      JavaFX 8.0