Clipboard

Represents an operating system clipboard, on which data may be placed during, for example, cut, copy, and paste operations.

To access the general system clipboard, use the following code:

val clipboard = Clipboard.systemClipboard

There is only ever one instance of the system clipboard in the application, so it is perfectly acceptable to stash a reference to it somewhere handy if you so choose.

The Clipboard operates on the concept of having a single conceptual item on the clipboard at any one time -- though it may be placed on the clipboard in different formats.

Example use:

val clipboard = Clipboard.systemClipboard
val content = new ClipboardContent()
content.putString("Some text")
content.putHtml("Some text")
clipboard.content = content

Alternative use:

Clipboard.systemClipboard.content = ClipboardContent(
  DataFormat.PlainText -> "Some text",
  DataFormat.Html -> "Some text"
)

Caution when putting files into the clipboard. The recommended method is:

val content = new ClipboardContent()
content.putString("Some text")

Wraps a JavaFX Clipboard.

Source: Clipboard.scala

Linear Supertypes

SFXDelegate[javafx.scene.input.Clipboard], AnyRef, Any

Known Subclasses

Dragboard

Type Hierarchy

Instance Constructors

new Clipboard(delegate: javafx.scene.input.Clipboard)

Creates a new Clipboard from a JavaFX one.
Creates a new Clipboard from a JavaFX one.
delegate
A JavaFX Clipboard to be wrapped. Its default value is a new JavaFX Clipboard.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clear(): Unit

Clears the clipboard of any and all content.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def content: ClipboardContent

Return a copy of the clipboard content.
def content(dataFormat: DataFormat): AnyRef

Returns the content stored in this clipboard of the given type, or null if there is no content with this type.
def contentTypes: Set[javafx.scene.input.DataFormat]

Gets the set of DataFormat types on this Clipboard instance which have associated data registered on the clipboard.
def content_=(content: ClipboardContent): Unit

Puts content onto the clipboard.
Puts content onto the clipboard.
This call will always result in clearing all previous content from the clipboard, and replacing it with whatever content is specified in the supplied ClipboardContent map.

Exceptions thrown
java.lang.NullPointerException - if null data reference is passed for any format
val delegate: javafx.scene.input.Clipboard

A JavaFX Clipboard to be wrapped.
A JavaFX Clipboard to be wrapped. Its default value is a new JavaFX Clipboard.

Definition Classes
Clipboard → SFXDelegate
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(ref: Any): Boolean

Verifies if a object is equals to this delegate.
Verifies if a object is equals to this delegate.
ref
Object to be compared.
returns
if the other object is equals to this delegate or not.

Definition Classes
SFXDelegate → AnyRef → Any
def files: Seq[File]

Gets the list of files from the clipboard which had previously been registered.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hasContent(dataFormat: DataFormat): Boolean

Tests whether there is any content on this clipboard of the given DataFormat type.
def hasFiles: Boolean

Gets whether an list of files (DataFormat.Files) has been registered on this Clipboard.
def hasHtml: Boolean

Gets whether an HTML text String (DataFormat.Html) has been registered on this Clipboard.
def hasImage: Boolean

Gets whether an Image (DataFormat.Image) has been registered on this Clipboard.
def hasRtf: Boolean

Gets whether an RTF String (DataFormat.Rtf) has been registered on this Clipboard.
def hasString: Boolean

Gets whether a plain text String (DataFormat.PlainText) has been registered on this Clipboard.
def hasUrl: Boolean

Gets whether a url String (DataFormat.Url) has been registered on this Clipboard.
def hashCode(): Int

returns
The delegate hashcode

Definition Classes
SFXDelegate → AnyRef → Any
def html: String

Gets the HTML text String from the clipboard which had previously been registered.
def image: Image

Gets the Image from the clipboard which had previously been registered.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def rtf: String

Gets the RTF text String from the clipboard which had previously been registered.
def string: String

Gets the plain text String from the clipboard which had previously been registered.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

returns
Returns the original delegate's toString() adding a [SFX] prefix.

Definition Classes
SFXDelegate → AnyRef → Any
def url: String

Gets the URL String from the clipboard which had previously been registered.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Clipboard | package input

class Clipboard extends SFXDelegate[javafx.scene.input.Clipboard]

Instance Constructors

new Clipboard(delegate: javafx.scene.input.Clipboard)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clear(): Unit

def clone(): AnyRef

def content: ClipboardContent

def content(dataFormat: DataFormat): AnyRef

def contentTypes: Set[javafx.scene.input.DataFormat]

def content_=(content: ClipboardContent): Unit

val delegate: javafx.scene.input.Clipboard

final def eq(arg0: AnyRef): Boolean

def equals(ref: Any): Boolean

def files: Seq[File]

def finalize(): Unit

final def getClass(): Class[_]

def hasContent(dataFormat: DataFormat): Boolean

def hasFiles: Boolean

def hasHtml: Boolean

def hasImage: Boolean

def hasRtf: Boolean

def hasString: Boolean

def hasUrl: Boolean

def hashCode(): Int

def html: String

def image: Image

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def rtf: String

def string: String

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def url: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from SFXDelegate[javafx.scene.input.Clipboard]

Inherited from AnyRef

Inherited from Any

Ungrouped