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