Packages

  • package root

    ScalaFX is a UI DSL written within the Scala Language that sits on top of JavaFX 2.x and and JavaFX 8.

    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 to javafx.animation.

    Example Usage

    A basic ScalaFX application is created creating an object that is an instance of JFXApp3. Following Java FX theatre metaphor, it contains a stage that contains a scene. A stage roughly corresponds to a window in a typical UI environment. The scene holds UI content presented to the user. In the example below, the content is a pane with a single label component.

    package hello
    
    import scalafx.application.JFXApp3
    import scalafx.geometry.Insets
    import scalafx.scene.Scene
    import scalafx.scene.control.Label
    import scalafx.scene.layout.BorderPane
    
    object HelloWorld extends JFXApp3 {
    
      override def start(): Unit = {
        stage = new JFXApp3.PrimaryStage {
          title = "Hello"
          scene = new Scene {
            root = new BorderPane {
              padding = Insets(75)
              center = new Label("Hello World")
            }
          }
        }
      }
    }
    Definition Classes
    root
  • package scalafx

    Base package for ScalaFX classes.

    Base package for ScalaFX classes.

    Definition Classes
    root
  • package stage

    Wraps javafx.stage package.

    Wraps javafx.stage package.

    Definition Classes
    scalafx
  • DirectoryChooser
  • FileChooser
  • Modality
  • Popup
  • PopupWindow
  • Screen
  • Stage
  • StageIncludes
  • StageStyle
  • Window
  • WindowEvent

class Stage extends Window with SFXDelegate[javafx.stage.Stage]

The primary stage for your application has to be created by wrapping the JFXApp3.stage object.

stage = new JFXApp3.PrimaryStage {
// your definitions
}
Any further stage would be simply instantiated by the no-arg constructor.

Source
Stage.scala
Linear Supertypes
Window, EventTarget, SFXDelegate[javafx.stage.Stage], EventHandlerDelegate2, AnyRef, Any
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Stage
  2. Window
  3. EventTarget
  4. SFXDelegate
  5. EventHandlerDelegate2
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Stage(style: javafx.stage.StageStyle)

    Creates a new instance of Stage.

  2. new Stage(delegate: javafx.stage.Stage = new jfxs.Stage)

Type Members

  1. trait EventHandled extends AnyRef

    Trait used for handle events manipulation.

    Trait used for handle events manipulation. JavaFX class wrapped must have methods defined in scalafx.event.EventHandlerDelegate2.EventHandled Type:

    def addEventHandler   [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
    def removeEventHandler[E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
    def addEventFilter    [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
    def removeEventFilter [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
    def buildEventDispatchChain(chain: jfxe.EventDispatchChain): jfxe.EventDispatchChain
    Definition Classes
    EventHandlerDelegate2
  2. sealed trait FilterMagnet[J <: javafx.event.Event, S <: SFXDelegate[J]] extends AnyRef

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate2
  3. sealed trait HandlerMagnet[J <: javafx.event.Event, S <: SFXDelegate[J]] extends AnyRef

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate2

Value Members

  1. object FilterMagnet

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate2
  2. object HandlerMagnet

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate2
  3. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def ##: Int
    Definition Classes
    AnyRef → Any
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Registers an event filter to this task.

    Registers an event filter to this task. Registered event filters get an event before any associated event handlers.

    E

    Event class

    eventType

    the type of the events to receive by the filter

    eventHandler

    the filter to register that will filter event

    Definition Classes
    EventHandlerDelegate2
  7. def addEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Registers an event handler to this task.

    Registers an event handler to this task. Any event filters are first processed, then the specified onFoo event handlers, and finally any event handlers registered by this method. As with other events in the scene graph, if an event is consumed, it will not continue dispatching.

    E

    Event class

    eventType

    the type of the events to receive by the handler

    eventHandler

    the handler to register that will manipulate event

    Definition Classes
    EventHandlerDelegate2
  8. def alwaysOnTop: ReadOnlyBooleanProperty

    Defines whether this Stage is kept on top of other windows.

    Defines whether this Stage is kept on top of other windows.

    If some other window is already always-on-top then the relative order between these windows is unspecified (depends on platform).

    There are differences in behavior between applications if a security manager is present. Applications with permissions are allowed to set "always on top" flag on a Stage. In applications without the proper permissions, an attempt to set the flag will be ignored and the property value will be restored to "false".

    The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.

  9. def alwaysOnTop_=(value: Boolean): Unit
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

    Construct an event dispatch chain for this target.

    Construct an event dispatch chain for this target.

    Definition Classes
    EventHandlerDelegate2
  12. def centerOnScreen(): Unit

    Sets x and y properties on this Window so that it is centered on the screen.

    Sets x and y properties on this Window so that it is centered on the screen.

    Definition Classes
    Window
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  14. def close(): Unit

    Closes this Stage.

  15. val delegate: javafx.stage.Stage

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    StageWindowSFXDelegate
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. 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
  18. def eventDispatcher: ObjectProperty[EventDispatcher]

    Specifies the event dispatcher for this node.

    Specifies the event dispatcher for this node.

    Definition Classes
    Window
  19. def eventDispatcher_=(v: EventDispatcher): Unit
    Definition Classes
    Window
  20. def eventHandlerDelegate: EventHandled

    Returns a object that implements scalafx.event.EventHandlerDelegate2.EventHandled.

    Returns a object that implements scalafx.event.EventHandlerDelegate2.EventHandled.

    Definition Classes
    WindowEventHandlerDelegate2
  21. def filterEvent[J <: Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

    Registers an event filter.

    Registers an event filter. Registered event filters get an event before any associated event handlers.

    Example of filtering mouse events

    pane.filterEvent(MouseEvent.Any) {
      me: MouseEvent => {
        me.eventType match {
          case MouseEvent.MousePressed => {
            ...
          }
          case MouseEvent.MouseDragged => {
            ...
          }
          case _ => {
            ...
          }
        }
      }
    }

    or

    pane.filterEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
    J

    type JavaFX delegate of the event

    S

    ScalaFX type for J type wrapper.

    eventType

    type of events that will be handled.

    filter

    code handling the event, see examples above.

    Definition Classes
    EventHandlerDelegate2
  22. def fireEvent(event: Event): Unit

    Whether or not this Window has the keyboard or input focus.

    Whether or not this Window has the keyboard or input focus.

    Definition Classes
    Window
  23. def focused: ReadOnlyBooleanProperty

    Whether or not this Window has the keyboard or input focus.

    Whether or not this Window has the keyboard or input focus.

    Definition Classes
    Window
  24. def forceIntegerRenderScale: BooleanProperty

    Boolean property that controls whether only integer render scales are set by default by the system when there is a change in the associated output scale.

    Boolean property that controls whether only integer render scales are set by default by the system when there is a change in the associated output scale. The renderScale properties will be updated directly and simultaneously with any changes in the associated outputScale properties, but the values can be overridden by subsequent calls to the setRenderScale setters or through appropriate use of binding. This property will not prevent setting non-integer scales directly using the renderScale property object or the convenience setter method.

    Default value is false

    Definition Classes
    Window
    Since

    9

    See also

    renderScaleX

    renderScaleY

  25. def forceIntegerRenderScale_=(forced: Boolean): Unit
    Definition Classes
    Window
  26. def fullScreen: ReadOnlyBooleanProperty

    Specifies whether this Stage should be a full-screen, undecorated window.

  27. def fullScreenExitHint: ObjectProperty[String]
  28. def fullScreenExitHint_=(value: String): Unit
  29. def fullScreenExitKey: ObjectProperty[KeyCombination]

    Specifies the Full Screen exit key combination

  30. def fullScreenExitKey_=(value: KeyCombination): Unit
  31. def fullScreen_=(value: Boolean): Unit
  32. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def handleEvent[J <: Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

    Registers an event handler.

    Registers an event handler. The handler is called when the node receives an Event of the specified type during the bubbling phase of event delivery.

    Example of handling mouse events

    pane.handleEvent(MouseEvent.Any) {
      me: MouseEvent => {
        me.eventType match {
          case MouseEvent.MousePressed => ...
          case MouseEvent.MouseDragged => ...
          case _                       => {}
        }
      }
    }

    or

    pane.handleEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
    J

    type JavaFX delegate of the event

    S

    ScalaFX type for J type wrapper.

    eventType

    type of events that will be handled.

    handler

    code handling the event, see examples above.

    returns

    Returns a subscription that can be used to cancel/remove this event handler

    Definition Classes
    EventHandlerDelegate2
  34. def hashCode(): Int

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  35. def height: ReadOnlyDoubleProperty

    The height of this Stage.

    The height of this Stage.

    Definition Classes
    Window
  36. def height_=(h: Double): Unit
    Definition Classes
    Window
  37. def hide(): Unit

    Attempts to hide this Window by setting the visibility to false.

    Attempts to hide this Window by setting the visibility to false.

    Definition Classes
    Window
  38. def iconified: ReadOnlyBooleanProperty

    Defines whether the Stage is iconified or not.

  39. def icons: ObservableBuffer[Image]

    Gets the icon images to be used in the window decorations and when minimized.

  40. def initModality(modality: Modality): Unit

    Specifies the modality for this stage.

  41. def initOwner(owner: Window): Unit

    Specifies the owner Window for this stage, or null for a top-level, unowned stage.

  42. def initStyle(style: StageStyle): Unit

    Specifies the style for this stage.

  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. def maxHeight: Double

    Defines the maximum height of this Stage.

  45. def maxHeight_=(h: Double): Unit
  46. def maxWidth: Double

    Defines the maximum width of this Stage.

  47. def maxWidth_=(w: Double): Unit
  48. def maximized: ReadOnlyBooleanProperty

    Defines whether the Stage is maximized or not.

  49. def maximized_=(value: Boolean): Unit
  50. def minHeight: Double

    Defines the minimum height of this Stage.

  51. def minHeight_=(h: Double): Unit
  52. def minWidth: Double

    Defines the minimum width of this Stage.

  53. def minWidth_=(w: Double): Unit
  54. def modality: Modality

    Retrieves the modality attribute for this stage.

  55. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  56. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  57. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  58. def onCloseRequest: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

    Called when there is an external request to close this Window.

    Called when there is an external request to close this Window.

    Definition Classes
    Window
  59. def onCloseRequest_=(v: EventHandler[javafx.stage.WindowEvent]): Unit
    Definition Classes
    Window
  60. def onHidden: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

    Called just after the Window has been hidden.

    Called just after the Window has been hidden.

    Definition Classes
    Window
  61. def onHidden_=(v: EventHandler[javafx.stage.WindowEvent]): Unit
    Definition Classes
    Window
  62. def onHiding: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

    Called just prior to the Window being hidden.

    Called just prior to the Window being hidden.

    Definition Classes
    Window
  63. def onHiding_=(v: EventHandler[javafx.stage.WindowEvent]): Unit
    Definition Classes
    Window
  64. def onShowing: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

    Called just prior to the Window being shown, even if the menu has no items to show.

    Called just prior to the Window being shown, even if the menu has no items to show.

    Definition Classes
    Window
  65. def onShowing_=(v: EventHandler[javafx.stage.WindowEvent]): Unit
    Definition Classes
    Window
  66. def onShown: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

    Called just after the Window is shown.

    Called just after the Window is shown.

    Definition Classes
    Window
  67. def onShown_=(v: EventHandler[javafx.stage.WindowEvent]): Unit
    Definition Classes
    Window
  68. def opacity: DoubleProperty

    Defines the opacity of the Stage as a value between 0.0 and 1.0.

    Defines the opacity of the Stage as a value between 0.0 and 1.0.

    Definition Classes
    Window
  69. def opacity_=(v: Double): Unit
    Definition Classes
    Window
  70. def outputScaleX: ReadOnlyDoubleProperty

    The scale that the Window will apply to horizontal scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.

    The scale that the Window will apply to horizontal scene coordinates in all stages of rendering and compositing the output to the screen or other destination device. This property is updated asynchronously by the system at various times including:

    • Window creation
    • At some point during moving a window to a new Screen which may be before or after the Screen property is updated.
    • In response to a change in user preferences for output scaling.
    Definition Classes
    Window
    Since

    9

    See also

    renderScaleX

  71. def outputScaleX_=(value: Double): Unit
    Definition Classes
    Window
  72. def outputScaleY: ReadOnlyDoubleProperty

    The scale that the Window will apply to vertical scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.

    The scale that the Window will apply to vertical scene coordinates in all stages of rendering and compositing the output to the screen or other destination device. This property is updated asynchronously by the system at various times including:

    • Window creation
    • At some point during moving a window to a new Screen which may be before or after the Screen property is updated.
    • In response to a change in user preferences for output scaling.
    Definition Classes
    Window
    Since

    9

    See also

    renderScaleY

  73. def outputScaleY_=(value: Double): Unit
    Definition Classes
    Window
  74. def owner: Option[Window]

    Retrieves a scala.Some with the owner Window for this stage, or scala.None for an unowned stage.

  75. def removeEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Unregisters a previously registered event filter from this task.

    Unregisters a previously registered event filter from this task. One filter might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the filter.

    E

    Event class

    eventType

    the event type from which to unregister

    eventHandler

    the filter to unregister

    Definition Classes
    EventHandlerDelegate2
  76. def removeEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Unregisters a previously registered event handler from this task.

    Unregisters a previously registered event handler from this task. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.

    E

    Event class

    eventType

    the event type from which to unregister

    eventHandler

    the handler to unregister

    Definition Classes
    EventHandlerDelegate2
  77. def renderScaleX: DoubleProperty

    The horizontal scale that the Window will use when rendering its Scene to the rendering buffer.

    The horizontal scale that the Window will use when rendering its Scene to the rendering buffer. This property is automatically updated whenever there is a change in the outputScaleX property and can be overridden either by calling setRenderScaleX() in response to a listener on the outputScaleX property or by binding it appropriately.

    Default value is outputScaleX

    Definition Classes
    Window
    Since

    9

    See also

    outputScaleX

    forceIntegerRenderScale

  78. def renderScaleX_=(scale: Double): Unit
    Definition Classes
    Window
  79. def renderScaleY: DoubleProperty

    The vertical scale that the Window will use when rendering its Scene to the rendering buffer.

    The vertical scale that the Window will use when rendering its Scene to the rendering buffer. This property is automatically updated whenever there is a change in the outputScaleY property and can be overridden either by calling setRenderScaleY() in response to a listener on the outputScaleY property or by binding it appropriately.

    DefaultValue is outputScaleY

    Definition Classes
    Window
    Since

    9

    See also

    outputScaleY

    forceIntegerRenderScale

  80. def renderScaleY_=(scale: Double): Unit
    Definition Classes
    Window
  81. def requestFocus(): Unit

    Requests that this Window get the input focus.

    Requests that this Window get the input focus.

    Definition Classes
    Window
  82. def resizable: BooleanProperty

    Defines whether the Stage is resizable or not by the user.

  83. def resizable_=(v: Boolean): Unit
  84. def scene: ReadOnlyObjectProperty[Scene]

    The Scene to be rendered on this Stage.

    The Scene to be rendered on this Stage.

    Definition Classes
    Window
  85. def scene_=(s: Scene): Unit

    Specify the scene to be used on this stage.

  86. def show(): Unit

    Attempts to show this Window by setting visibility to true.

  87. def showAndWait(): Unit

    Shows this stage and waits for it to be hidden (closed) before returning to the caller.

    Shows this stage and waits for it to be hidden (closed) before returning to the caller. This method temporarily blocks processing of the current event, and starts a nested event loop to handle other events. This method must be called on the FX Application thread.

  88. def showing: ReadOnlyBooleanProperty

    Whether or not this Stage is showing (that is, open on the user's system).

    Whether or not this Stage is showing (that is, open on the user's system).

    Definition Classes
    Window
  89. def showing_=(v: Boolean): Unit

    Attempts to show or hide this Window.

  90. def sizeToScene(): Unit

    Set the width and height of this Window to match the size of the content of this Window's Scene.

    Set the width and height of this Window to match the size of the content of this Window's Scene.

    Definition Classes
    Window
  91. def style: StageStyle

    Retrieves the style attribute for this stage.

  92. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  93. def title: StringProperty

    Defines the title of the Stage.

  94. def title_=(v: String): Unit
  95. def toBack(): Unit

    Send the Window to the background.

  96. def toFront(): Unit

    Bring the Window to the foreground.

  97. def toString(): String

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  98. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  99. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  100. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  101. def width: ReadOnlyDoubleProperty

    The width of this Stage.

    The width of this Stage.

    Definition Classes
    Window
  102. def width_=(w: Double): Unit
    Definition Classes
    Window
  103. def x: ReadOnlyDoubleProperty

    The horizontal location of this Stage on the screen.

    The horizontal location of this Stage on the screen.

    Definition Classes
    Window
  104. def x_=(value: Double): Unit
    Definition Classes
    Window
  105. def y: ReadOnlyDoubleProperty

    The vertical location of this Stage on the screen.

    The vertical location of this Stage on the screen.

    Definition Classes
    Window
  106. def y_=(value: Double): Unit
    Definition Classes
    Window

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Window

Inherited from EventTarget

Inherited from SFXDelegate[javafx.stage.Stage]

Inherited from EventHandlerDelegate2

Inherited from AnyRef

Inherited from Any

Ungrouped