Class Dragboard

java.lang.Object

javafx.scene.input.Clipboard

javafx.scene.input.Dragboard

public final class Dragboard
extends Clipboard

A drag and drop specific Clipboard.

Since:

JavaFX 2.0

Method Summary

Modifier and Type	Method	Description
Image	getDragView()	Gets the image used as a drag view.
double	getDragViewOffsetX()	Gets the x position of the cursor of the drag view image.
double	getDragViewOffsetY()	Gets the y position of the cursor of the drag view image.
final Set<TransferMode>	getTransferModes()	Gets set of transport modes supported by source of this drag operation.
void	setDragView(Image image)	Sets the visual representation of data being transferred in a drag and drop gesture.
void	setDragView(Image image, double offsetX, double offsetY)	Sets the visual representation of data being transferred in a drag and drop gesture.
void	setDragViewOffsetX(double offsetX)	Sets the x position of the cursor of the drag view image.
void	setDragViewOffsetY(double offsetY)	Sets the y position of the cursor of the drag view image.

Methods declared in class Clipboard

clear, getContent, getContentTypes, getFiles, getHtml, getImage, getRtf, getString, getSystemClipboard, getUrl, hasContent, hasFiles, hasHtml, hasImage, hasRtf, hasString, hasUrl, setContent

Modifier and Type	Method	Description
final void	clear()	Clears the clipboard of any and all content.
final Object	getContent(DataFormat dataFormat)	Returns the content stored in this clipboard of the given type, or null if there is no content with this type.
final Set<DataFormat>	getContentTypes()	Gets the set of DataFormat types on this Clipboard instance which have associated data registered on the clipboard.
final List<File>	getFiles()	Gets the List of Files from the clipboard which had previously been registered.
final String	getHtml()	Gets the HTML text String from the clipboard which had previously been registered.
final Image	getImage()	Gets the Image from the clipboard which had previously been registered.
final String	getRtf()	Gets the RTF text String from the clipboard which had previously been registered.
final String	getString()	Gets the plain text String from the clipboard which had previously been registered.
static Clipboard	getSystemClipboard()	Gets the current system clipboard, through which data can be stored and retrieved.
final String	getUrl()	Gets the URL String from the clipboard which had previously been registered.
final boolean	hasContent(DataFormat dataFormat)	Tests whether there is any content on this clipboard of the given DataFormat type.
final boolean	hasFiles()	Gets whether an List of Files (DataFormat.FILES) has been registered on this Clipboard.
final boolean	hasHtml()	Gets whether an HTML text String (DataFormat.HTML) has been registered on this Clipboard.
final boolean	hasImage()	Gets whether an Image (DataFormat.IMAGE) has been registered on this Clipboard.
final boolean	hasRtf()	Gets whether an RTF String (DataFormat.RTF) has been registered on this Clipboard.
final boolean	hasString()	Gets whether a plain text String (DataFormat.PLAIN_TEXT) has been registered on this Clipboard.
final boolean	hasUrl()	Gets whether a url String (DataFormat.URL) has been registered on this Clipboard.
final boolean	setContent(Map<DataFormat, Object> content)	Puts content onto the clipboard.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getTransferModes

public final Set<TransferMode> getTransferModes()

Gets set of transport modes supported by source of this drag operation.

Returns:

set of supported transfer modes

setDragView

public void setDragView(Image image,
 double offsetX,
 double offsetY)

Sets the visual representation of data being transferred in a drag and drop gesture. Uses the given image for the drag view with the offsetX and offsetY specifying cursor position over the 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:

image - image to use for the drag view

offsetX - x position of the cursor over the image

offsetY - y position of the cursor over the image

Since:

JavaFX 8.0

setDragView

public void setDragView(Image image)

Sets the visual representation of data being transferred 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