class Scene extends SFXDelegate[javafx.scene.Scene]
- Alphabetic
- By Inheritance
- Scene
- SFXDelegate
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Scene(parent: Parent, fill: Paint)
Creates a Scene for a specific root Node with a fill.
Creates a Scene for a specific root Node with a fill.
- parent
The root node of the scene graph
- fill
The fill
- new Scene(parent: Parent, width: Double, height: Double, fill: Paint)
Creates a Scene for a specific root Node with a specific size and fill.
Creates a Scene for a specific root Node with a specific size and fill.
- parent
The root node of the scene graph
- width
The width of the scene
- height
The height of the scene
- fill
The fill
- new Scene(width: Double, height: Double, depthBuffer: Boolean, antiAliasing: SceneAntialiasing)
Creates a Scene with a
Group
as parent, with a dimension of width and height, specifies whether a depth buffer is created for this scene and specifies the required scene anti-aliasing.Creates a Scene with a
Group
as parent, with a dimension of width and height, specifies whether a depth buffer is created for this scene and specifies the required scene anti-aliasing.- width
The width of the scene
- height
The height of the scene
- depthBuffer
The depth buffer flag
- antiAliasing
The required scene anti-aliasing.
- new Scene(parent: Parent, width: Double, height: Double, depthBuffer: Boolean, antiAliasing: SceneAntialiasing)
Constructs a scene consisting of a root, with a dimension of width and height, specifies whether a depth buffer is created for this scene and specifies the required scene anti-aliasing.
Constructs a scene consisting of a root, with a dimension of width and height, specifies whether a depth buffer is created for this scene and specifies the required scene anti-aliasing.
- parent
The root node of the scene graph
- width
The width of the scene
- height
The height of the scene
- depthBuffer
The depth buffer flag
- antiAliasing
The required scene anti-aliasing.
- new Scene(width: Double, height: Double, depthBuffer: Boolean)
Creates a Scene with a
Group
as parent, with a dimension of width and height, and specifies whether a depth buffer is created for this scene.Creates a Scene with a
Group
as parent, with a dimension of width and height, and specifies whether a depth buffer is created for this scene.- width
The width of the scene
- height
The height of the scene
- depthBuffer
The depth buffer flag
- new Scene(parent: Parent, width: Double, height: Double, depthBuffer: Boolean)
Constructs a scene consisting of a root, with a dimension of width and height, and specifies whether a depth buffer is created for this scene.
Constructs a scene consisting of a root, with a dimension of width and height, and specifies whether a depth buffer is created for this scene.
- parent
The root node of the scene graph
- width
The width of the scene
- height
The height of the scene
- depthBuffer
The depth buffer flag
- new Scene(parent: Parent, width: Double, height: Double)
Creates a Scene for a specific root Node with a specific size.
Creates a Scene for a specific root Node with a specific size.
- parent
The root node of the scene graph
- width
The width of the scene
- height
The height of the scene
- new Scene(parent: Parent)
Creates a Scene for a specific root Node.
Creates a Scene for a specific root Node.
- parent
The root node of the scene graph
- new Scene(width: Double, height: Double)
Creates a Scene with a Group as root Node with a specific size.
Creates a Scene with a Group as root Node with a specific size.
- width
The width of the scene
- height
The height of the scene
- new Scene(delegate: javafx.scene.Scene = new jfxs.Scene(new jfxs.Group()))
Create a new ScalaFX Scene with JavaFX Scene as delegate.
Create a new ScalaFX Scene with JavaFX Scene as delegate.
- delegate
JavaFX Scene delegated. Its default value is a JavaFX Scene with a Group as root Node.
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
- def accelerators: ObservableMap[KeyCombination, Runnable]
Gets the list of accelerators for this Scene.
- def addMnemonic(m: Mnemonic): Unit
Registers the specified mnemonic.
Registers the specified mnemonic.
- m
The Mnemonic
- def antialiasing: SceneAntialiasing
Returns scene's antialiasing setting.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def camera: ObjectProperty[javafx.scene.Camera]
Specifies the type of camera use for rendering this
Scene
. - def camera_=(v: Camera): Unit
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def content: ObservableList[javafx.scene.Node]
Returns Content's Node children from this Scene's
root
. - def content_=(n: Node): Unit
Sets a Node child, replacing the prior content.
Sets a Node child, replacing the prior content. If you want append to current content, use
add
or similar.- n
Node child to replace prior content.
- def content_=(c: Iterable[Node]): Unit
Sets the list of Nodes children from this Scene's
root
, replacing the prior content.Sets the list of Nodes children from this Scene's
root
, replacing the prior content. If you want append to current content, useadd
or similar.- c
list of Nodes children from this Scene's
root
to replace prior content.
- def cursor: ObjectProperty[javafx.scene.Cursor]
Defines the mouse cursor for this
Scene
. - def cursor_=(v: Cursor): Unit
- val delegate: javafx.scene.Scene
JavaFX object to be wrapped.
JavaFX object to be wrapped.
- Definition Classes
- Scene → SFXDelegate
- def depthBuffer: Boolean
Retrieves the depth buffer attribute for this scene.
- def effectiveNodeOrientation: ReadOnlyObjectProperty[NodeOrientation]
The effective node orientation of a scene resolves the inheritance of node orientation, returning either left-to-right or right-to-left.
- 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 eventDispatcher: ObjectProperty[EventDispatcher]
Specifies the event dispatcher for this scene.
- def eventDispatcher_=(v: EventDispatcher): Unit
- def fill: ObjectProperty[Paint]
Defines the background fill of this Scene.
- def fill_=(v: Paint): Unit
- def focusOwner: ReadOnlyObjectProperty[javafx.scene.Node]
The scene's current focus owner node.
The scene's current focus owner node. This node's "focused" variable might be false if this scene has no window, or if the window is inactive (window.focused == false).
- Since
2.2
- def getChildren: ObservableBuffer[javafx.scene.Node]
Returns Nodes children from this Scene's
root
. - final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getMnemonics: ObservableMap[KeyCombination, ObservableList[Mnemonic]]
Gets the list of mnemonics for this
Scene
. - def hashCode(): Int
- returns
The delegate hashcode
- Definition Classes
- SFXDelegate → AnyRef → Any
- def height: ReadOnlyDoubleProperty
The height of this Scene
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def lookup(selector: String): Option[Node]
Looks for any node within the scene graph based on the specified CSS selector.
Looks for any node within the scene graph based on the specified CSS selector.
- selector
The css selector to look up
- returns
A scala.Some containing the Node in the scene which matches the CSS selector, or scala.None if none is found.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nodeOrientation: ObjectProperty[NodeOrientation]
- def nodeOrientation_=(v: NodeOrientation): Unit
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onContextMenuRequested: ObjectProperty[EventHandler[_ >: ContextMenuEvent]]
Defines a function to be called when a mouse button has been clicked (pressed and released) on this
Scene
. - def onContextMenuRequested_=(v: EventHandler[_ >: ContextMenuEvent]): Unit
- def onDragDetected: ObjectProperty[EventHandler[_ >: MouseEvent]]
Defines a function to be called when drag gesture has been detected.
- def onDragDetected_=(v: EventHandler[_ >: MouseEvent]): Unit
- def onDragDone: ObjectProperty[EventHandler[_ >: DragEvent]]
Defines a function to be called when this
Scene
is a drag and drop gesture source after its data has been dropped on a drop target. - def onDragDone_=(v: EventHandler[_ >: DragEvent]): Unit
- def onDragDropped: ObjectProperty[EventHandler[_ >: DragEvent]]
Defines a function to be called when the mouse button is released on this
Scene
during drag and drop gesture. - def onDragDropped_=(v: EventHandler[_ >: DragEvent]): Unit
- def onDragEntered: ObjectProperty[EventHandler[_ >: DragEvent]]
Defines a function to be called when drag gesture enters this Scene.
- def onDragEntered_=(v: EventHandler[_ >: DragEvent]): Unit
- def onDragExited: ObjectProperty[EventHandler[_ >: DragEvent]]
Defines a function to be called when drag gesture exits this Scene.
- def onDragExited_=(v: EventHandler[_ >: DragEvent]): Unit
- def onDragOver: ObjectProperty[EventHandler[_ >: DragEvent]]
Defines a function to be called when drag gesture progresses within this
Scene
. - def onDragOver_=(v: EventHandler[_ >: DragEvent]): Unit
- def onInputMethodTextChanged: ObjectProperty[EventHandler[_ >: InputMethodEvent]]
Defines a function to be called when this
Node
has input focus and the input method text has changed. - def onInputMethodTextChanged_=(v: EventHandler[_ >: InputMethodEvent]): Unit
- def onKeyPressed: ObjectProperty[EventHandler[_ >: KeyEvent]]
Defines a function to be called when some
Node
of thisScene
has input focus and a key has been pressed. - def onKeyPressed_=(v: EventHandler[_ >: KeyEvent]): Unit
- def onKeyReleased: ObjectProperty[EventHandler[_ >: KeyEvent]]
Defines a function to be called when some
Node
of thisScene
has input focus and a key has been released. - def onKeyReleased_=(v: EventHandler[_ >: KeyEvent]): Unit
- def onKeyTyped: ObjectProperty[EventHandler[_ >: KeyEvent]]
Defines a function to be called when some
Node
of thisScene
has input focus and a key has been typed. - def onKeyTyped_=(v: EventHandler[_ >: KeyEvent]): Unit
- def onMouseClicked: ObjectProperty[EventHandler[_ >: MouseEvent]]
Defines a function to be called when a mouse button has been clicked (pressed and released) on this
Scene
. - def onMouseClicked_=(v: EventHandler[_ >: MouseEvent]): Unit
- def onMouseDragEntered: ObjectProperty[EventHandler[_ >: MouseDragEvent]]
Defines a function to be called when a full press-drag-release gesture enters this
Scene
. - def onMouseDragEntered_=(v: EventHandler[_ >: MouseDragEvent]): Unit
- def onMouseDragExited: ObjectProperty[EventHandler[_ >: MouseDragEvent]]
Defines a function to be called when a full press-drag-release gesture exits this
Scene
. - def onMouseDragExited_=(v: EventHandler[_ >: MouseDragEvent]): Unit
- def onMouseDragOver: ObjectProperty[EventHandler[_ >: MouseDragEvent]]
Defines a function to be called when a full press-drag-release gesture progresses within this
Scene
. - def onMouseDragOver_=(v: EventHandler[_ >: MouseDragEvent]): Unit
- def onMouseDragReleased: ObjectProperty[EventHandler[_ >: MouseDragEvent]]
Defines a function to be called when a full press-drag-release gesture ends within this
Scene
. - def onMouseDragReleased_=(v: EventHandler[_ >: MouseDragEvent]): Unit
- def onMouseDragged: ObjectProperty[EventHandler[_ >: MouseEvent]]
Defines a function to be called when a mouse button is pressed on this
Scene
and then dragged. - def onMouseDragged_=(v: EventHandler[_ >: MouseEvent]): Unit
- def onMouseEntered: ObjectProperty[EventHandler[_ >: MouseEvent]]
Defines a function to be called when the mouse enters this
Scene
. - def onMouseEntered_=(v: EventHandler[_ >: MouseEvent]): Unit
- def onMouseExited: ObjectProperty[EventHandler[_ >: MouseEvent]]
Defines a function to be called when the mouse exits this
Scene
. - def onMouseExited_=(v: EventHandler[_ >: MouseEvent]): Unit
- def onMouseMoved: ObjectProperty[EventHandler[_ >: MouseEvent]]
Defines a function to be called when mouse cursor moves within this
Scene
but no buttons have been pushed. - def onMouseMoved_=(v: EventHandler[_ >: MouseEvent]): Unit
- def onMousePressed: ObjectProperty[EventHandler[_ >: MouseEvent]]
Defines a function to be called when a mouse button has been pressed on this
Scene
. - def onMousePressed_=(v: EventHandler[_ >: MouseEvent]): Unit
- def onMouseReleased: ObjectProperty[EventHandler[_ >: MouseEvent]]
Defines a function to be called when a mouse button has been released on this
Scene
. - def onMouseReleased_=(v: EventHandler[_ >: MouseEvent]): Unit
- def onRotate: ObjectProperty[EventHandler[_ >: RotateEvent]]
Defines a function to be called when user performs a rotation action.
Defines a function to be called when user performs a rotation action.
- Since
2.2
- def onRotate_=(v: EventHandler[_ >: RotateEvent]): Unit
- def onRotationFinished: ObjectProperty[EventHandler[_ >: RotateEvent]]
Defines a function to be called when a rotation gesture ends.
Defines a function to be called when a rotation gesture ends.
- Since
2.2
- def onRotationFinished_=(v: EventHandler[_ >: RotateEvent]): Unit
- def onRotationStarted: ObjectProperty[EventHandler[_ >: RotateEvent]]
Defines a function to be called when a rotation gesture starts.
Defines a function to be called when a rotation gesture starts.
- Since
2.2
- def onRotationStarted_=(v: EventHandler[_ >: RotateEvent]): Unit
- def onScroll: ObjectProperty[EventHandler[_ >: ScrollEvent]]
Defines a function to be called when user performs a scrolling action.
- def onScrollFinished: ObjectProperty[EventHandler[_ >: ScrollEvent]]
Defines a function to be called when a Scroll gesture ends.
Defines a function to be called when a Scroll gesture ends.
- Since
2.2
- def onScrollFinished_=(v: EventHandler[_ >: ScrollEvent]): Unit
- def onScrollStarted: ObjectProperty[EventHandler[_ >: ScrollEvent]]
Defines a function to be called when a Scroll gesture starts.
Defines a function to be called when a Scroll gesture starts.
- Since
2.2
- def onScrollStarted_=(v: EventHandler[_ >: ScrollEvent]): Unit
- def onScroll_=(v: EventHandler[_ >: ScrollEvent]): Unit
- def onSwipeDown: ObjectProperty[EventHandler[_ >: SwipeEvent]]
Defines a function to be called when a Swipe Down gesture starts.
Defines a function to be called when a Swipe Down gesture starts.
- Since
2.2
- def onSwipeDown_=(v: EventHandler[_ >: SwipeEvent]): Unit
- def onSwipeLeft: ObjectProperty[EventHandler[_ >: SwipeEvent]]
Defines a function to be called when a Swipe Down gesture starts.
Defines a function to be called when a Swipe Down gesture starts.
- Since
2.2
- def onSwipeLeft_=(v: EventHandler[_ >: SwipeEvent]): Unit
- def onSwipeRight: ObjectProperty[EventHandler[_ >: SwipeEvent]]
Defines a function to be called when a Swipe Right gesture starts.
Defines a function to be called when a Swipe Right gesture starts.
- Since
2.2
- def onSwipeRight_=(v: EventHandler[_ >: SwipeEvent]): Unit
- def onSwipeUp: ObjectProperty[EventHandler[_ >: SwipeEvent]]
Defines a function to be called when a Swipe Up gesture starts.
Defines a function to be called when a Swipe Up gesture starts.
- Since
2.2
- def onSwipeUp_=(v: EventHandler[_ >: SwipeEvent]): Unit
- def onTouchMoved: ObjectProperty[EventHandler[_ >: TouchEvent]]
Defines a function to be called when user performs a Touch Moved action.
Defines a function to be called when user performs a Touch Moved action.
- Since
2.2
- def onTouchMoved_=(v: EventHandler[_ >: TouchEvent]): Unit
- def onTouchPressed: ObjectProperty[EventHandler[_ >: TouchEvent]]
Defines a function to be called when user performs a Touch Pressed action.
Defines a function to be called when user performs a Touch Pressed action.
- Since
2.2
- def onTouchPressed_=(v: EventHandler[_ >: TouchEvent]): Unit
- def onTouchReleased: ObjectProperty[EventHandler[_ >: TouchEvent]]
Defines a function to be called when user performs a Touch Released action.
Defines a function to be called when user performs a Touch Released action.
- Since
2.2
- def onTouchReleased_=(v: EventHandler[_ >: TouchEvent]): Unit
- def onTouchStationary: ObjectProperty[EventHandler[_ >: TouchEvent]]
Defines a function to be called when user performs a Touch Stationary action.
Defines a function to be called when user performs a Touch Stationary action.
- Since
2.2
- def onTouchStationary_=(v: EventHandler[_ >: TouchEvent]): Unit
- def onZoom: ObjectProperty[EventHandler[_ >: ZoomEvent]]
Defines a function to be called when user performs a Touch action.
Defines a function to be called when user performs a Touch action.
- Since
2.2
- def onZoomFinished: ObjectProperty[EventHandler[_ >: ZoomEvent]]
Defines a function to be called when a Zoom gesture ends.
Defines a function to be called when a Zoom gesture ends.
- Since
2.2
- def onZoomFinished_=(v: EventHandler[_ >: ZoomEvent]): Unit
- def onZoomStarted: ObjectProperty[EventHandler[_ >: ZoomEvent]]
Defines a function to be called when a Zoom gesture starts.
Defines a function to be called when a Zoom gesture starts.
- Since
2.2
- def onZoomStarted_=(v: EventHandler[_ >: ZoomEvent]): Unit
- def onZoom_=(v: EventHandler[_ >: ZoomEvent]): Unit
- def removeMnemonic(m: Mnemonic): Unit
Unregisters the specified mnemonic.
Unregisters the specified mnemonic.
- m
The Mnemonic to be removed.
- def root: ObjectProperty[javafx.scene.Parent]
Returns the root Node of the scene graph
- def root_=(v: Parent): Unit
Sets the root Node of the scene graph
- def snapshot(callback: (SnapshotResult) => Unit, image: WritableImage): Unit
Takes a snapshot of this scene at the next frame and calls the specified callback method when the image is ready.
Takes a snapshot of this scene at the next frame and calls the specified callback method when the image is ready.
- callback
A function to be called when the image is ready.
- image
The writable image that will be used to hold the rendered scene.
- Since
2.2
- def snapshot(image: WritableImage): WritableImage
Takes a snapshot of this scene and returns the rendered image when it is ready.
Takes a snapshot of this scene and returns the rendered image when it is ready.
- image
The writable image that will be used to hold the rendered scene.
- returns
the rendered image
- Since
2.2
- def startDragAndDrop(transferModes: TransferMode*): Dragboard
Confirms a potential drag and drop gesture that is recognized over this
Scene
.Confirms a potential drag and drop gesture that is recognized over this
Scene
.- transferModes
The supported
TransferMode
(s) of thisNode
- returns
A
Dragboard
to place thisScene
's data on
- def startFullDrag(): Unit
Starts a full press-drag-release gesture with this scene as gesture source.
- def stylesheets: ObservableList[String]
Gets an observable list of string URLs linking to the stylesheets to use with this Parent's contents.
- def stylesheets_=(c: Iterable[String]): Unit
Sets the list of stylesheets URLs, replacing the prior content.
Sets the list of stylesheets URLs, replacing the prior content. If you want append to current content, use
add
or similar.- c
list of stylesheets URLs to replace prior content.
- 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 userAgentStylesheet: ObjectProperty[String]
The URL of the user-agent stylesheet that will be used by this Scene in place of the the platform-default user-agent stylesheet.
The URL of the user-agent stylesheet that will be used by this Scene in place of the the platform-default user-agent stylesheet. If the URL does not resolve to a valid location, the platform-default user-agent stylesheet will be used.
For additional information about using CSS with the scene graph, see the CSS Reference Guide.
- returns
The URL of the user-agent stylesheet that will be used by this SubScene, or null if has not been set.
- def userAgentStylesheet_=(url: String): Unit
Set the URL of the user-agent stylesheet that will be used by this Scene in place of the the platform-default user-agent stylesheet.
Set the URL of the user-agent stylesheet that will be used by this Scene in place of the the platform-default user-agent stylesheet. If the URL does not resolve to a valid location, the platform-default user-agent stylesheet will be used.
For additional information about using CSS with the scene graph, see the CSS Reference Guide.
- url
The URL is a hierarchical URI of the form
[scheme:][//authority][path]
. If the URL does not have a[scheme:]
component, the URL is considered to be the[path]
component only. Any leading '/' character of the[path]
is ignored and the[path]
is treated as a path relative to the root of the application's classpath.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def width: ReadOnlyDoubleProperty
The width of this Scene
- def window: ReadOnlyObjectProperty[Window]
The
Window
for this Scene - def x: ReadOnlyDoubleProperty
The horizontal location of this
Scene
on theWindow
. - def y: ReadOnlyDoubleProperty
The vertical location of this
Scene
on theWindow
.
ScalaFX is a UI DSL written within the Scala Language that sits on top of JavaFX 2.x and and JavaFX 8. This means that every ScalaFX application is also a valid Scala application. By extension it supports full interoperability with Java and can run anywhere the Java Virtual Machine (JVM) and JavaFX 2.0 or JavaFX 8 are supported.
Package Structure
ScalaFX package structure corresponds to JavaFX package structure, for instance
scalafx.animation
corresponds tojavafx.animation
.Example Usage
A basic ScalaFX application is created creating an object that is an instance of
JFXApp
. Following Java FX theatre metaphor, it contains astage
that contains ascene
. Astage
roughly corresponds to a window in a typical UI environment. Thescene
holds UI content presented to the user. In the example below, the content is a pane with a singlelabel
component.