javafx.scene.input

Class ClipboardContent

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<DataFormat,java.lang.Object>

javafx.scene.input.ClipboardContent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<DataFormat,java.lang.Object>

public class ClipboardContent
extends java.util.HashMap<DataFormat,java.lang.Object>

Data container for Clipboard data. It can hold multiple data in several data formats.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
ClipboardContent()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.io.File>	getFiles() Gets the List of Files from the clipboard which had previously been registered.
java.lang.String	getHtml() Gets the HTML text String from the clipboard which had previously been registered.
Image	getImage() Gets the Image from the clipboard which had previously been registered.
java.lang.String	getRtf() Gets the RTF text String from the clipboard which had previously been registered.
java.lang.String	getString() Gets the plain text String from the clipboard which had previously been registered.
java.lang.String	getUrl() Gets the URL String from the clipboard which had previously been registered.
boolean	hasFiles() Gets whether an List of Files (DataFormat.FILES) has been registered on this Clipboard.
boolean	hasHtml() Gets whether an HTML text String (DataFormat.HTML) has been registered on this Clipboard.
boolean	hasImage() Gets whether an Image (DataFormat.IMAGE) has been registered on this Clipboard.
boolean	hasRtf() Gets whether an RTF String (DataFormat.RTF) has been registered on this Clipboard.
boolean	hasString() Gets whether a plain text String (DataFormat.PLAIN_TEXT) has been registered on this Clipboard.
boolean	hasUrl() Gets whether a url String (DataFormat.URL) has been registered on this Clipboard.
boolean	putFiles(java.util.List<java.io.File> files) Puts an List of Files onto the Clipboard.
boolean	putFilesByPath(java.util.List<java.lang.String> filePaths) Puts an List of Files onto the Clipboard, based on the file path.
boolean	putHtml(java.lang.String s) Puts an HTML text String onto the Clipboard.
boolean	putImage(Image i) Puts an Image onto the Clipboard.
boolean	putRtf(java.lang.String rtf) Puts an RTF text String onto the Clipboard.
boolean	putString(java.lang.String s) Puts a plain text String onto the Clipboard.
boolean	putUrl(java.lang.String url) Puts a URL String onto the Clipboard.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

ClipboardContent

public ClipboardContent()

Method Detail

hasString

public final boolean hasString()

Gets whether a plain text String (DataFormat.PLAIN_TEXT) has been registered on this Clipboard.

Returns:

true if hasContent(DataFormat.PLAIN_TEXT) returns true, false otherwise

putString

public final boolean putString(java.lang.String s)

Puts a plain text String onto the Clipboard. This is equivalent to invoking setContent(DataFormat.PLAIN_TEXT, s). Setting this value to null effectively clears it from the clipboard.

Parameters:

s - The string to place. This may be null.

Returns:

True if the string was successfully placed on the clipboard.

Throws:

java.lang.NullPointerException - if null reference is passed

getString

public final java.lang.String getString()

Gets the plain text String from the clipboard which had previously been registered. This is equivalent to invoking getContent(DataFormat.PLAIN_TEXT). If no such entry exists, null is returned.

Returns:

The String on the clipboard associated with DataFormat.PLAIN_TEXT, or null if there is not one.

hasUrl

public final boolean hasUrl()

Gets whether a url String (DataFormat.URL) has been registered on this Clipboard.

Returns:

true if hasContent(DataFormat.URL) returns true, false otherwise

putUrl

public final boolean putUrl(java.lang.String url)

Puts a URL String onto the Clipboard. This is equivalent to invoking setContent(DataFormat.URL, s). Setting this value to null effectively clears it from the clipboard.

Parameters:

url - The string to place. This may be null.

Returns:

True if the string was successfully placed on the clipboard.

Throws:

java.lang.NullPointerException - if null reference is passed

getUrl

public final java.lang.String getUrl()

Gets the URL String from the clipboard which had previously been registered. This is equivalent to invoking getContent(DataFormat.URL). If no such entry exists, null is returned.

Returns:

The String on the clipboard associated with DataFormat.URL, or null if there is not one.

hasHtml

public final boolean hasHtml()

Gets whether an HTML text String (DataFormat.HTML) has been registered on this Clipboard.

Returns:

true if hasContent(DataFormat.HTML) returns true, false otherwise

putHtml

public final boolean putHtml(java.lang.String s)

Puts an HTML text String onto the Clipboard. This is equivalent to invoking setContent(DataFormat.HTML, s). Setting this value to null effectively clears it from the clipboard.

Parameters:

s - The string to place. This may be null.

Returns:

True if the string was successfully placed on the clipboard.

Throws:

java.lang.NullPointerException - if null reference is passed

getHtml

public final java.lang.String getHtml()

Gets the HTML text String from the clipboard which had previously been registered. This is equivalent to invoking getContent(DataFormat.HTML). If no such entry exists, null is returned.

Returns:

The String on the clipboard associated with DataFormat.HTML, or null if there is not one.

hasRtf

public final boolean hasRtf()

Gets whether an RTF String (DataFormat.RTF) has been registered on this Clipboard.

Returns:

true if hasContent(DataFormat.RTF) returns true, false otherwise

putRtf

public final boolean putRtf(java.lang.String rtf)

Puts an RTF text String onto the Clipboard. This is equivalent to invoking setContent(DataFormat.RTF, s). Setting this value to null effectively clears it from the clipboard.

Parameters:

rtf - The string to place. This may be null.

Returns:

True if the string was successfully placed on the clipboard.

Throws:

java.lang.NullPointerException - if null reference is passed

getRtf

public final java.lang.String getRtf()

Gets the RTF text String from the clipboard which had previously been registered. This is equivalent to invoking getContent(DataFormat.RTF). If no such entry exists, null is returned.

Returns:

The String on the clipboard associated with DataFormat.RTF, or null if there is not one.

hasImage

public final boolean hasImage()

Gets whether an Image (DataFormat.IMAGE) has been registered on this Clipboard.

Returns:

true if hasContent(DataFormat.IMAGE) returns true, false otherwise

putImage

public final boolean putImage(Image i)

Puts an Image onto the Clipboard. This is equivalent to invoking setContent(DataFormat.IMAGE, image). Setting this value to null effectively clears it from the clipboard. When an image is placed on the clipboard in this manner, an operating system dependent image is loaded onto the clipboard (such as TIFF on mac or DIB on Windows).

Parameters:

i - The image to place. This may be null.

Returns:

True if the image was successfully placed on the clipboard.

Throws:

java.lang.NullPointerException - if null reference is passed

getImage

public final Image getImage()

Gets the Image from the clipboard which had previously been registered. This is equivalent to invoking getContent(DataFormat.IMAGE). If no such entry exists, null is returned.

Returns:

The Image on the clipboard associated with DataFormat.IMAGE, or null if there is not one.

hasFiles

public final boolean hasFiles()

Gets whether an List of Files (DataFormat.FILES) has been registered on this Clipboard.

Returns:

true if hasContent(DataFormat.FILES) returns true, false otherwise

putFiles

public final boolean putFiles(java.util.List<java.io.File> files)

Puts an List of Files onto the Clipboard. This is equivalent to invoking setContent(DataFormat.FILES, files). Setting this value to null effectively clears it from the clipboard.

Parameters:

files - The files to place. This may be null.

Returns:

True if the files were successfully placed on the clipboard.

Throws:

java.lang.NullPointerException - if null reference is passed

putFilesByPath

public final boolean putFilesByPath(java.util.List<java.lang.String> filePaths)

Puts an List of Files onto the Clipboard, based on the file path. This is simply a convenience method which constructs a List of Files and invokes the putFiles(java.util.List) method.

Parameters:

filePaths - The files to place. This may be null.

Returns:

True if the files were successfully placed on the clipboard.

Throws:

java.lang.NullPointerException - if null reference is passed

getFiles

public final java.util.List<java.io.File> getFiles()

Gets the List of Files from the clipboard which had previously been registered. This is equivalent to invoking getContent(DataFormat.FILES). If no such entry exists, null is returned.

Returns:

The List of Files on the clipboard associated with DataFormat.FILES, or null if there is not one.