PrimaryStage

class PrimaryStage extends Stage

Simple helper class for construction of primary application stages.

Simple helper class for construction of primary application stages.

The primary stage has to wrap an instance of a JavaFX primary stage created by JavaFX when application is initialized.

 object SimpleScalaFXApp extends JFXApp {
    stage = new PrimaryStage {
      title = "Simple ScalaFX App"
      scene = new Scene {
        root = new StackPane {
          padding = Insets(20)
          content = new Rectangle {
            width = 200
            height = 200
            fill = Color.DEEPSKYBLUE
          }
        }
      }
    }
 }
class Stage
class Window
trait EventTarget
trait SFXDelegate[Stage]
class Object
trait Matchable
class Any

Type members

Inherited classlikes

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

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
Inherited from
EventHandlerDelegate2
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"

Inherited from
EventHandlerDelegate2
sealed trait FilterMagnet[J <: Event, S <: SFXDelegate[J]]

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"

Inherited from
EventHandlerDelegate2
sealed trait HandlerMagnet[J <: Event, S <: SFXDelegate[J]]

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"

Inherited from
EventHandlerDelegate2

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"

Inherited from
EventHandlerDelegate2

Value members

Inherited methods

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

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

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

Type Params
E

Event class

Value Params
eventHandler

the filter to register that will filter event

eventType

the type of the events to receive by the filter

Inherited from
EventHandlerDelegate2
def addEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the handler to register that will manipulate event

eventType

the type of the events to receive by the handler

Inherited from
EventHandlerDelegate2

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.

Inherited from
Stage
def alwaysOnTop_=(value: Boolean): Unit
Inherited from
Stage
def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

Construct an event dispatch chain for this target.

Construct an event dispatch chain for this target.

Inherited from
EventHandlerDelegate2
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.

Inherited from
Window
def close(): Unit

Closes this Stage.

Closes this Stage.

Inherited from
Stage
override def equals(ref: Any): Boolean

Verifies if a object is equals to this delegate.

Verifies if a object is equals to this delegate.

Value Params
ref

Object to be compared.

Returns

if the other object is equals to this delegate or not.

Definition Classes
Inherited from
SFXDelegate
def eventDispatcher: ObjectProperty[EventDispatcher]

Specifies the event dispatcher for this node.

Specifies the event dispatcher for this node.

Inherited from
Window
def eventDispatcher_=(v: EventDispatcher): Unit
Inherited from
Window
Definition Classes
Inherited from
Window
def filterEvent[J <: Event, S <: Event & SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

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

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") }
Type Params
J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value Params
eventType

type of events that will be handled.

filter

code handling the event, see examples above.

Inherited from
EventHandlerDelegate2
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.

Inherited from
Window

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

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

Inherited from
Window

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.

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

See also
Since

9

Inherited from
Window
def forceIntegerRenderScale_=(forced: Boolean): Unit
Inherited from
Window

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

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

Inherited from
Stage
Inherited from
Stage
def fullScreenExitHint_=(value: String): Unit
Inherited from
Stage
def fullScreenExitKey: ObjectProperty[KeyCombination]

Specifies the Full Screen exit key combination

Specifies the Full Screen exit key combination

Inherited from
Stage
Inherited from
Stage
def fullScreen_=(value: Boolean): Unit
Inherited from
Stage
def handleEvent[J <: Event, S <: Event & SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

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.

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") }
Type Params
J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value Params
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

Inherited from
EventHandlerDelegate2
override def hashCode: Int
Returns

The delegate hashcode

Definition Classes
Inherited from
SFXDelegate

The height of this Stage.

The height of this Stage.

Inherited from
Window
def height_=(h: Double): Unit
Inherited from
Window
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.

Inherited from
Window

Defines whether the Stage is iconified or not.

Defines whether the Stage is iconified or not.

Inherited from
Stage
def icons: ObservableBuffer[Image]

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

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

Inherited from
Stage
def initModality(modality: Modality): Unit

Specifies the modality for this stage.

Specifies the modality for this stage.

Inherited from
Stage
def initOwner(owner: Window): Unit

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

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

Inherited from
Stage
def initStyle(style: StageStyle): Unit

Specifies the style for this stage.

Specifies the style for this stage.

Inherited from
Stage
def maxHeight: Double

Defines the maximum height of this Stage.

Defines the maximum height of this Stage.

Inherited from
Stage
def maxHeight_=(h: Double): Unit
Inherited from
Stage
def maxWidth: Double

Defines the maximum width of this Stage.

Defines the maximum width of this Stage.

Inherited from
Stage
def maxWidth_=(w: Double): Unit
Inherited from
Stage

Defines whether the Stage is maximized or not.

Defines whether the Stage is maximized or not.

Inherited from
Stage
def maximized_=(value: Boolean): Unit
Inherited from
Stage
def minHeight: Double

Defines the minimum height of this Stage.

Defines the minimum height of this Stage.

Inherited from
Stage
def minHeight_=(h: Double): Unit
Inherited from
Stage
def minWidth: Double

Defines the minimum width of this Stage.

Defines the minimum width of this Stage.

Inherited from
Stage
def minWidth_=(w: Double): Unit
Inherited from
Stage

Retrieves the modality attribute for this stage.

Retrieves the modality attribute for this stage.

Inherited from
Stage
def onCloseRequest: ObjectProperty[EventHandler[WindowEvent]]

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

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

Inherited from
Window
def onCloseRequest_=(v: EventHandler[WindowEvent]): Unit
Inherited from
Window
def onHidden: ObjectProperty[EventHandler[WindowEvent]]

Called just after the Window has been hidden.

Called just after the Window has been hidden.

Inherited from
Window
def onHidden_=(v: EventHandler[WindowEvent]): Unit
Inherited from
Window
def onHiding: ObjectProperty[EventHandler[WindowEvent]]

Called just prior to the Window being hidden.

Called just prior to the Window being hidden.

Inherited from
Window
def onHiding_=(v: EventHandler[WindowEvent]): Unit
Inherited from
Window
def onShowing: ObjectProperty[EventHandler[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.

Inherited from
Window
def onShowing_=(v: EventHandler[WindowEvent]): Unit
Inherited from
Window
def onShown: ObjectProperty[EventHandler[WindowEvent]]

Called just after the Window is shown.

Called just after the Window is shown.

Inherited from
Window
def onShown_=(v: EventHandler[WindowEvent]): Unit
Inherited from
Window

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.

Inherited from
Window
def opacity_=(v: Double): Unit
Inherited from
Window

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:

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.

See also
Since

9

Inherited from
Window
def outputScaleX_=(value: Double): Unit
Inherited from
Window

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:

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.

See also
Since

9

Inherited from
Window
def outputScaleY_=(value: Double): Unit
Inherited from
Window
def owner: Option[Window]

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

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

Inherited from
Stage
def removeEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the filter to unregister

eventType

the event type from which to unregister

Inherited from
EventHandlerDelegate2
def removeEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

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.

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.

Type Params
E

Event class

Value Params
eventHandler

the handler to unregister

eventType

the event type from which to unregister

Inherited from
EventHandlerDelegate2

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.

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

See also
Since

9

Inherited from
Window
def renderScaleX_=(scale: Double): Unit
Inherited from
Window

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.

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

See also
Since

9

Inherited from
Window
def renderScaleY_=(scale: Double): Unit
Inherited from
Window
def requestFocus(): Unit

Requests that this Window get the input focus.

Requests that this Window get the input focus.

Inherited from
Window

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

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

Inherited from
Stage
def resizable_=(v: Boolean): Unit
Inherited from
Stage

The Scene to be rendered on this Stage.

The Scene to be rendered on this Stage.

Inherited from
Window
def scene_=(s: Scene): Unit

Specify the scene to be used on this stage.

Specify the scene to be used on this stage.

Inherited from
Stage
def show(): Unit

Attempts to show this Window by setting visibility to true.

Attempts to show this Window by setting visibility to true.

Inherited from
Stage
def showAndWait(): Unit

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.

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.

Inherited from
Stage

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).

Inherited from
Window
def showing_=(v: Boolean): Unit

Attempts to show or hide this Window.

Attempts to show or hide this Window.

Inherited from
Stage
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.

Inherited from
Window

Retrieves the style attribute for this stage.

Retrieves the style attribute for this stage.

Inherited from
Stage

Defines the title of the Stage.

Defines the title of the Stage.

Inherited from
Stage
def title_=(v: String): Unit
Inherited from
Stage
def toBack(): Unit

Send the Window to the background.

Send the Window to the background.

Inherited from
Stage
def toFront(): Unit

Bring the Window to the foreground.

Bring the Window to the foreground.

Inherited from
Stage
override def toString: String
Returns

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

Definition Classes
Inherited from
SFXDelegate

The width of this Stage.

The width of this Stage.

Inherited from
Window
def width_=(w: Double): Unit
Inherited from
Window

The horizontal location of this Stage on the screen.

The horizontal location of this Stage on the screen.

Inherited from
Window
def x_=(value: Double): Unit
Inherited from
Window

The vertical location of this Stage on the screen.

The vertical location of this Stage on the screen.

Inherited from
Window
def y_=(value: Double): Unit
Inherited from
Window

Inherited fields

override val delegate: Stage
Inherited from
Stage