scalafx
API
Generated with
scalafx/scalafx/scalafx.scene/scalafx.scene.input

scalafx.scene.input

package scalafx.scene.input

Wraps `javafx.scene.input` package.

Attributes

Members list

Type members

Classlikes

object Clipboard

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Clipboard.type
class Clipboard(val delegate: Clipboard) extends SFXDelegate[Clipboard]

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

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("<b>Some</b> text")
 clipboard.content = content

Alternative use:

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

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

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

Wraps a $JFX $URL0 $FC.

Value parameters

delegate

A $JFX $FC to be wrapped. Its default value is a new $JFX $FC.

Attributes

Constructor

Creates a new $FC from a $JFX one.

Companion
object
Supertypes
trait SFXDelegate[Clipboard]
class Object
trait Matchable
class Any
Known subtypes
class Dragboard
object ClipboardContent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class ClipboardContent(val delegate: ClipboardContent) extends SFXDelegate[ClipboardContent]

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

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

Example use:

 val content = new ClipboardContent()
 content.putString("Some text")
 content.putHtml("<b>Some</b> text")

Alternative use:

  val content = ClipboardContent(
    DataFormat.PlainText -> "Some text",
    DataFormat.Html -> "<b>Some</b> text"
  )

Caution when putting files into the clipboard. The recommended way is to use putFiles method:

 content.putFiles(Seq(new File("one"), new File("two"))) *

When using with DataFormat.Files you have to use Java List as a container, which is less convenient:

 import scala.jdk.CollectionConverters.*

 val content = ClipboardContent(
   DataFormat.Files -> Seq(new File("one"), new File("two")).asJava,
 )

Wraps a $JFX $URL0 $FC.

Value parameters

delegate

A $JFX $FC to be wrapped. Its default value is a new $JFX $FC.

Attributes

Constructor

Creates a new $FC from a $JFX one.

Companion
object
Supertypes
trait SFXDelegate[ClipboardContent]
trait Map[DataFormat, AnyRef]
trait MapOps[DataFormat, AnyRef, Map, Map[DataFormat, AnyRef]]
trait Shrinkable[DataFormat]
trait Builder[(DataFormat, AnyRef), Map[DataFormat, AnyRef]]
trait Growable[(DataFormat, AnyRef)]
trait Clearable
trait Cloneable[Map[DataFormat, AnyRef]]
trait Cloneable
trait Map[DataFormat, AnyRef]
trait Equals
trait MapFactoryDefaults[DataFormat, AnyRef, Map, Iterable]
trait MapOps[DataFormat, AnyRef, Map, Map[DataFormat, AnyRef]]
trait PartialFunction[DataFormat, AnyRef]
trait DataFormat => AnyRef
trait Iterable[(DataFormat, AnyRef)]
trait Iterable[(DataFormat, AnyRef)]
trait IterableFactoryDefaults[(DataFormat, AnyRef), Iterable]
trait IterableOps[(DataFormat, AnyRef), Iterable, Map[DataFormat, AnyRef]]
trait IterableOnceOps[(DataFormat, AnyRef), Iterable, Map[DataFormat, AnyRef]]
trait IterableOnce[(DataFormat, AnyRef)]
class Object
trait Matchable
class Any
Show all
object ContextMenuEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class ContextMenuEvent(val delegate: ContextMenuEvent) extends InputEvent, SFXDelegate[ContextMenuEvent]

Attributes

Companion
object
Supertypes
class InputEvent
class Event
trait SFXDelegate[ContextMenuEvent]
class Object
trait Matchable
class Any
Show all
object DataFormat

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
DataFormat.type
class DataFormat(val delegate: DataFormat) extends SFXDelegate[DataFormat]

Data format identifier used as means of identifying the data stored on a clipboard/dragboard.

Data format identifier used as means of identifying the data stored on a clipboard/dragboard.

Wraps a $JFX $URL0 $FC.

Value parameters

delegate

A $JFX $FC to be wrapped. Its default value is a new $JFX $FC.

Attributes

Constructor

Creates a new $FC from a $JFX one.

Companion
object
Supertypes
trait SFXDelegate[DataFormat]
class Object
trait Matchable
class Any
object DragEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
DragEvent.type
class DragEvent(val delegate: DragEvent) extends InputEvent, SFXDelegate[DragEvent]

Attributes

Companion
object
Supertypes
class InputEvent
class Event
trait SFXDelegate[DragEvent]
class Object
trait Matchable
class Any
Show all
object Dragboard

Object companion for scalafx.scene.input.Dragboard.

Object companion for scalafx.scene.input.Dragboard.

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Dragboard.type
class Dragboard(val delegate: Dragboard) extends Clipboard, SFXDelegate[Dragboard]

Wraps a JavaFX http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/Clipboard.html Clipboard.

Wraps a JavaFX http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/Clipboard.html Clipboard.

Value parameters

delegate

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

Attributes

Constructor

Creates a new Clipboard from a JavaFX one.

Companion
object
Supertypes
class Clipboard
trait SFXDelegate[Dragboard]
class Object
trait Matchable
class Any
object GestureEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class GestureEvent(val delegate: GestureEvent) extends InputEvent, SFXDelegate[GestureEvent]

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/GestureEvent.html

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/GestureEvent.html

Attributes

Companion
object
Supertypes
class InputEvent
class Event
trait SFXDelegate[GestureEvent]
class Object
trait Matchable
class Any
Show all
Known subtypes
class ScrollEvent
class SwipeEvent
class ZoomEvent
object InputEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
InputEvent.type
class InputEvent(val delegate: InputEvent) extends Event, SFXDelegate[InputEvent]

Attributes

Companion
object
Supertypes
class Event
trait SFXDelegate[InputEvent]
class Object
trait Matchable
class Any
Known subtypes
class DragEvent
class GestureEvent
class ScrollEvent
class SwipeEvent
class ZoomEvent
class KeyEvent
class MouseEvent
class RotateEvent
class TouchEvent
Show all
object InputIncludes extends InputIncludes

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait InputIncludes

Contains implcit methods to convert from `javafx.scene.input` Classes/Traits to their ScalaFX counterparts.

Contains implcit methods to convert from `javafx.scene.input` Classes/Traits to their ScalaFX counterparts.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object InputIncludes
trait Includes
object Includes
object InputMethodEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class InputMethodEvent(val delegate: InputMethodEvent) extends InputEvent, SFXDelegate[InputMethodEvent]

Attributes

Companion
object
Supertypes
class InputEvent
class Event
trait SFXDelegate[InputMethodEvent]
class Object
trait Matchable
class Any
Show all
object InputMethodHighlight extends SFXEnumDelegateCompanion[InputMethodHighlight, InputMethodHighlight]

Wrapper for javafx.scene.input.InputMethodHighlight

Wrapper for javafx.scene.input.InputMethodHighlight

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait SFXEnumDelegateCompanion[InputMethodHighlight, InputMethodHighlight]
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class InputMethodHighlight(val delegate: InputMethodHighlight) extends SFXEnumDelegate[InputMethodHighlight]

Attributes

Companion
object
Supertypes
trait SFXEnumDelegate[InputMethodHighlight]
trait SFXDelegate[InputMethodHighlight]
class Object
trait Matchable
class Any
Known subtypes
object SelectedRaw
object UnselectedRaw
object InputMethodTextRun

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class InputMethodTextRun(val delegate: InputMethodTextRun) extends SFXDelegate[InputMethodTextRun]

Attributes

Companion
object
Supertypes
trait SFXDelegate[InputMethodTextRun]
class Object
trait Matchable
class Any
object KeyCharacterCombination

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class KeyCharacterCombination(val delegate: KeyCharacterCombination) extends KeyCombination, SFXDelegate[KeyCharacterCombination]

Attributes

Companion
object
Supertypes
trait SFXDelegate[KeyCharacterCombination]
class Object
trait Matchable
class Any
object KeyCode extends SFXEnumDelegateCompanion[KeyCode, KeyCode]

Wrapper for javafx.scene.input.KeyCode

Wrapper for javafx.scene.input.KeyCode

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
KeyCode.type
sealed abstract class KeyCode(val delegate: KeyCode) extends SFXEnumDelegate[KeyCode]

Attributes

Companion
object
Supertypes
trait SFXEnumDelegate[KeyCode]
trait SFXDelegate[KeyCode]
class Object
trait Matchable
class Any
Known subtypes
object A
object Accept
object Add
object Again
object AllCandidates
object Alphanumeric
object Alt
object AltGraph
object Ampersand
object Asterisk
object At
object B
object BackQuote
object BackSlash
object BackSpace
object Begin
object Braceleft
object Braceright
object C
object Cancel
object Caps
object ChannelDown
object ChannelUp
object Circumflex
object Clear
object CloseBracket
object CodeInput
object Colon
object ColoredKey0
object ColoredKey1
object ColoredKey2
object ColoredKey3
object Comma
object Command
object Compose
object ContextMenu
object Control
object Convert
object Copy
object Cut
object D
object DeadAbovedot
object DeadAbovering
object DeadAcute
object DeadBreve
object DeadCaron
object DeadCedilla
object DeadDiaeresis
object DeadGrave
object DeadIota
object DeadMacron
object DeadOgonek
object DeadTilde
object Decimal
object Delete
object Digit0
object Digit1
object Digit2
object Digit3
object Digit4
object Digit5
object Digit6
object Digit7
object Digit8
object Digit9
object Divide
object Dollar
object Down
object E
object EjectToggle
object End
object Enter
object Equals
object Escape
object EuroSign
object F
object F1
object F10
object F11
object F12
object F13
object F14
object F15
object F16
object F17
object F18
object F19
object F2
object F20
object F21
object F22
object F23
object F24
object F3
object F4
object F5
object F6
object F7
object F8
object F9
object FastFwd
object Final
object Find
object FullWidth
object G
object GameA
object GameB
object GameC
object GameD
object Greater
object H
object HalfWidth
object Help
object Hiragana
object Home
object I
object Info
object Insert
object J
object JapaneseRoman
object K
object KPDown
object KPLeft
object KPRight
object KPUp
object Kana
object KanaLock
object Kanji
object Katakana
object L
object Left
object Less
object M
object Meta
object Minus
object Modechange
object Multiply
object Mute
object N
object Nonconvert
object NumLock
object NumberSign
object Numpad0
object Numpad1
object Numpad2
object Numpad3
object Numpad4
object Numpad5
object Numpad6
object Numpad7
object Numpad8
object Numpad9
object O
object OpenBracket
object P
object PageDown
object PageUp
object Paste
object Pause
object Period
object Play
object Plus
object Pound
object Power
object Printscreen
object Props
object Q
object Quote
object Quotedbl
object R
object Record
object Rewind
object Right
object S
object ScrollLock
object Semicolon
object Separator
object Shift
object Shortcut
object Slash
object Softkey0
object Softkey1
object Softkey2
object Softkey3
object Softkey4
object Softkey5
object Softkey6
object Softkey7
object Softkey8
object Softkey9
object Space
object Star
object Stop
object Subtract
object T
object Tab
object TrackNext
object TrackPrev
object U
object Undefined
object Underscore
object Undo
object Up
object V
object VolumeDown
object VolumeUp
object W
object Windows
object X
object Y
object Z
Show all
object KeyCodeCombination

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class KeyCodeCombination(val delegate: KeyCodeCombination) extends KeyCombination, SFXDelegate[KeyCodeCombination]

Attributes

Companion
object
Supertypes
trait SFXDelegate[KeyCodeCombination]
class Object
trait Matchable
class Any
object KeyCombination

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class KeyCombination extends SFXDelegate[KeyCombination]

Attributes

Companion
object
Supertypes
trait SFXDelegate[KeyCombination]
class Object
trait Matchable
class Any
Known subtypes
object KeyEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
KeyEvent.type
class KeyEvent(val delegate: KeyEvent) extends InputEvent, SFXDelegate[KeyEvent]

Attributes

Companion
object
Supertypes
class InputEvent
class Event
trait SFXDelegate[KeyEvent]
class Object
trait Matchable
class Any
Show all
object Mnemonic

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Mnemonic.type
class Mnemonic(val delegate: Mnemonic) extends FireDelegate[Mnemonic], SFXDelegate[Mnemonic]

Attributes

Companion
object
Supertypes
trait FireDelegate[Mnemonic]
trait SFXDelegate[Mnemonic]
class Object
trait Matchable
class Any
object MouseButton extends SFXEnumDelegateCompanion[MouseButton, MouseButton]

Wrapper for javafx.scene.input.MouseButton

Wrapper for javafx.scene.input.MouseButton

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class MouseButton(val delegate: MouseButton) extends SFXEnumDelegate[MouseButton]

Attributes

Companion
object
Supertypes
trait SFXEnumDelegate[MouseButton]
trait SFXDelegate[MouseButton]
class Object
trait Matchable
class Any
Known subtypes
object Back
object Forward
object Middle
object None
object Primary
object Secondary
Show all
object MouseDragEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class MouseDragEvent(val delegate: MouseDragEvent) extends MouseEvent, SFXDelegate[MouseDragEvent]

Attributes

Companion
object
Supertypes
class MouseEvent
class InputEvent
class Event
trait SFXDelegate[MouseDragEvent]
class Object
trait Matchable
class Any
Show all
object MouseEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
MouseEvent.type
class MouseEvent(val delegate: MouseEvent) extends InputEvent, SFXDelegate[MouseEvent]

Attributes

Companion
object
Supertypes
class InputEvent
class Event
trait SFXDelegate[MouseEvent]
class Object
trait Matchable
class Any
Show all
Known subtypes
object PickResult

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
PickResult.type
class PickResult(val delegate: PickResult) extends SFXDelegate[PickResult]

A container for the result of a pick event. Wrapper for JavaFX's PickResult.

A container for the result of a pick event. Wrapper for JavaFX's PickResult.

Attributes

Companion
object
Supertypes
trait SFXDelegate[PickResult]
class Object
trait Matchable
class Any
object RotateEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class RotateEvent(val delegate: RotateEvent) extends InputEvent, SFXDelegate[RotateEvent]

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/RotateEvent.html

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/RotateEvent.html

Attributes

Companion
object
Supertypes
class InputEvent
class Event
trait SFXDelegate[RotateEvent]
class Object
trait Matchable
class Any
Show all
object ScrollEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class ScrollEvent(val delegate: ScrollEvent) extends GestureEvent, SFXDelegate[ScrollEvent]

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/ScrollEvent.html

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/ScrollEvent.html

Attributes

Companion
object
Supertypes
class GestureEvent
class InputEvent
class Event
trait SFXDelegate[ScrollEvent]
class Object
trait Matchable
class Any
Show all
object SwipeEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
SwipeEvent.type
class SwipeEvent(val delegate: SwipeEvent) extends GestureEvent, SFXDelegate[SwipeEvent]

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/SwipeEvent.html

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/SwipeEvent.html

Attributes

Companion
object
Supertypes
class GestureEvent
class InputEvent
class Event
trait SFXDelegate[SwipeEvent]
class Object
trait Matchable
class Any
Show all
object TouchEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
TouchEvent.type
class TouchEvent(val delegate: TouchEvent) extends InputEvent, SFXDelegate[TouchEvent]

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/TouchEvent.html

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/TouchEvent.html

Attributes

Companion
object
Supertypes
class InputEvent
class Event
trait SFXDelegate[TouchEvent]
class Object
trait Matchable
class Any
Show all
object TouchPoint

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
TouchPoint.type
class TouchPoint(val delegate: TouchPoint) extends SFXDelegate[TouchPoint]

Attributes

Companion
object
Supertypes
trait SFXDelegate[TouchPoint]
class Object
trait Matchable
class Any
object TransferMode extends SFXEnumDelegateCompanion[TransferMode, TransferMode]

Wrapper for javafx.scene.input.TransferMode

Wrapper for javafx.scene.input.TransferMode

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait SFXEnumDelegateCompanion[TransferMode, TransferMode]
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class TransferMode(val delegate: TransferMode) extends SFXEnumDelegate[TransferMode]

Attributes

Companion
object
Supertypes
trait SFXEnumDelegate[TransferMode]
trait SFXDelegate[TransferMode]
class Object
trait Matchable
class Any
Known subtypes
object Copy
object Link
object Move
object ZoomEvent

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
ZoomEvent.type
class ZoomEvent(val delegate: ZoomEvent) extends GestureEvent, SFXDelegate[ZoomEvent]

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/ZoomEvent.html

Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/scene/input/ZoomEvent.html

Attributes

Companion
object
Supertypes
class GestureEvent
class InputEvent
class Event
trait SFXDelegate[ZoomEvent]
class Object
trait Matchable
class Any
Show all
Generated with