Class/Object

scalafx.scene.input

Clipboard

Related Docs: object Clipboard | package input

Permalink

class Clipboard extends SFXDelegate[javafx.scene.input.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
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Clipboard
  2. SFXDelegate
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    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

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clear(): Unit

    Permalink

    Clears the clipboard of any and all content.

  6. def clone(): AnyRef

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

    Permalink

    Return a copy of the clipboard content.

  8. def content(dataFormat: DataFormat): AnyRef

    Permalink

    Returns the content stored in this clipboard of the given type, or null if there is no content with this type.

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

    Permalink

    Gets the set of DataFormat types on this Clipboard instance which have associated data registered on the clipboard.

  10. def content_=(content: ClipboardContent): Unit

    Permalink

    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

  11. val delegate: javafx.scene.input.Clipboard

    Permalink

    A JavaFX Clipboard to be wrapped.

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

    Definition Classes
    ClipboardSFXDelegate
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(ref: Any): Boolean

    Permalink

    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
  14. def files: Seq[File]

    Permalink

    Gets the list of files from the clipboard which had previously been registered.

  15. def finalize(): Unit

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

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

    Permalink

    Tests whether there is any content on this clipboard of the given DataFormat type.

  18. def hasFiles: Boolean

    Permalink

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

  19. def hasHtml: Boolean

    Permalink

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

  20. def hasImage: Boolean

    Permalink

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

  21. def hasRtf: Boolean

    Permalink

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

  22. def hasString: Boolean

    Permalink

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

  23. def hasUrl: Boolean

    Permalink

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

  24. def hashCode(): Int

    Permalink

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  25. def html: String

    Permalink

    Gets the HTML text String from the clipboard which had previously been registered.

  26. def image: Image

    Permalink

    Gets the Image from the clipboard which had previously been registered.

  27. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. def rtf: String

    Permalink

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

  32. def string: String

    Permalink

    Gets the plain text String from the clipboard which had previously been registered.

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

    Permalink
    Definition Classes
    AnyRef
  34. def toString(): String

    Permalink

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  35. def url: String

    Permalink

    Gets the URL String from the clipboard which had previously been registered.

  36. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

Inherited from AnyRef

Inherited from Any

Ungrouped