scalafx
API
Generated with
scalafx/scalafx/scalafx.application/JFXApp/PrimaryStage

PrimaryStage

scalafx.application.JFXApp.PrimaryStage
class PrimaryStage extends Stage

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
          }
        }
      }
    }
 }

Attributes

Graph
Supertypes
class Stage
class Window
class EventTarget
trait SFXDelegate[Stage]
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any
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"

Attributes

Inherited from:
EventTarget
Supertypes
class Object
trait Matchable
class Any

Value members

Inherited methods

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.

Attributes

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

Attributes

Inherited from:
Stage
def buildEventDispatchChain(tail: EventDispatchChain): EventDispatchChain

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

Construct an event dispatch chain for this target. The event dispatch chain contains event dispatchers which might be interested in processing of events targeted at this EventTarget. This event target is not automatically added to the chain, so if it wants to process events, it needs to add an EventDispatcher for itself to the chain.

In the case the event target is part of some hierarchy, the chain for it is usually built from event dispatchers collected from the root of the hierarchy to the event target.

The event dispatch chain is constructed by modifications to the provided initial event dispatch chain. The returned chain should have the initial chain at its end so the dispatchers should be prepended to the initial chain.

The caller shouldn't assume that the initial chain remains unchanged nor that the returned value will reference a different chain.

Value parameters

tail

the initial chain to build from

Attributes

Returns

the resulting event dispatch chain for this target

See also
Inherited from:
EventTarget
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.

Attributes

Inherited from:
Window
def close(): Unit

Closes this Stage.

Closes this Stage.

Attributes

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 parameters

ref

Object to be compared.

Attributes

Returns

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

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

Specifies the event dispatcher for this node.

Specifies the event dispatcher for this node.

Attributes

Inherited from:
Window
def eventDispatcher_=(v: EventDispatcher): Unit

Attributes

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 parameters

J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value parameters

eventType

type of events that will be handled.

filter

code handling the event, see examples above.

Attributes

Inherited from:
EventTarget
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.

Attributes

Inherited from:
Window
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.

Attributes

Inherited from:
Window
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. 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

Attributes

See also
Since

9

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

Attributes

Inherited from:
Window
def fullScreen: ReadOnlyBooleanProperty

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

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

Attributes

Inherited from:
Stage
def fullScreenExitHint: ObjectProperty[String]

Attributes

Inherited from:
Stage
def fullScreenExitHint_=(value: String): Unit

Attributes

Inherited from:
Stage
def fullScreenExitKey: ObjectProperty[KeyCombination]

Specifies the Full Screen exit key combination

Specifies the Full Screen exit key combination

Attributes

Inherited from:
Stage
def fullScreenExitKey_=(value: KeyCombination): Unit

Attributes

Inherited from:
Stage
def fullScreen_=(value: Boolean): Unit

Attributes

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 parameters

J

type JavaFX delegate of the event

S

ScalaFX type for J type wrapper.

Value parameters

eventType

type of events that will be handled.

handler

code handling the event, see examples above.

Attributes

Returns

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

Inherited from:
EventTarget
override def hashCode: Int

Attributes

Returns

The delegate hashcode

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def height: ReadOnlyDoubleProperty

The height of this Stage.

The height of this Stage.

Attributes

Inherited from:
Window
def height_=(h: Double): Unit

Attributes

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.

Attributes

Inherited from:
Window
def iconified: ReadOnlyBooleanProperty

Defines whether the Stage is iconified or not.

Defines whether the Stage is iconified or not.

Attributes

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.

Attributes

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

Specifies the modality for this stage.

Specifies the modality for this stage.

Attributes

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.

Attributes

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

Specifies the style for this stage.

Specifies the style for this stage.

Attributes

Inherited from:
Stage
def maxHeight: Double

Defines the maximum height of this Stage.

Defines the maximum height of this Stage.

Attributes

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

Attributes

Inherited from:
Stage
def maxWidth: Double

Defines the maximum width of this Stage.

Defines the maximum width of this Stage.

Attributes

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

Attributes

Inherited from:
Stage
def maximized: ReadOnlyBooleanProperty

Defines whether the Stage is maximized or not.

Defines whether the Stage is maximized or not.

Attributes

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

Attributes

Inherited from:
Stage
def minHeight: Double

Defines the minimum height of this Stage.

Defines the minimum height of this Stage.

Attributes

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

Attributes

Inherited from:
Stage
def minWidth: Double

Defines the minimum width of this Stage.

Defines the minimum width of this Stage.

Attributes

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

Attributes

Inherited from:
Stage
def modality: Modality

Retrieves the modality attribute for this stage.

Retrieves the modality attribute for this stage.

Attributes

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.

Attributes

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

Attributes

Inherited from:
Window
def onHidden: ObjectProperty[EventHandler[WindowEvent]]

Called just after the Window has been hidden.

Called just after the Window has been hidden.

Attributes

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

Attributes

Inherited from:
Window
def onHiding: ObjectProperty[EventHandler[WindowEvent]]

Called just prior to the Window being hidden.

Called just prior to the Window being hidden.

Attributes

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

Attributes

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.

Attributes

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

Attributes

Inherited from:
Window
def onShown: ObjectProperty[EventHandler[WindowEvent]]

Called just after the Window is shown.

Called just after the Window is shown.

Attributes

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

Attributes

Inherited from:
Window
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.

Attributes

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

Attributes

Inherited from:
Window
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. 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.

Attributes

See also
Since

9

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

Attributes

Inherited from:
Window
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. 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.

Attributes

See also
Since

9

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

Attributes

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.

Attributes

Inherited from:
Stage
def renderScaleX: DoubleProperty

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

Attributes

See also
Since

9

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

Attributes

Inherited from:
Window
def renderScaleY: DoubleProperty

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

Attributes

See also
Since

9

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

Attributes

Inherited from:
Window
def requestFocus(): Unit

Requests that this Window get the input focus.

Requests that this Window get the input focus.

Attributes

Inherited from:
Window
def resizable: BooleanProperty

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

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

Attributes

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

Attributes

Inherited from:
Stage
def scene: ReadOnlyObjectProperty[Scene]

The Scene to be rendered on this Stage.

The Scene to be rendered on this Stage.

Attributes

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.

Attributes

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.

Attributes

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.

Attributes

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

Attributes

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

Attempts to show or hide this Window.

Attempts to show or hide this Window.

Attributes

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.

Attributes

Inherited from:
Window
def style: StageStyle

Retrieves the style attribute for this stage.

Retrieves the style attribute for this stage.

Attributes

Inherited from:
Stage
def title: StringProperty

Defines the title of the Stage.

Defines the title of the Stage.

Attributes

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

Attributes

Inherited from:
Stage
def toBack(): Unit

Send the Window to the background.

Send the Window to the background.

Attributes

Inherited from:
Stage
def toFront(): Unit

Bring the Window to the foreground.

Bring the Window to the foreground.

Attributes

Inherited from:
Stage
override def toString: String

Attributes

Returns

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

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate
def width: ReadOnlyDoubleProperty

The width of this Stage.

The width of this Stage.

Attributes

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

Attributes

Inherited from:
Window
def x: ReadOnlyDoubleProperty

The horizontal location of this Stage on the screen.

The horizontal location of this Stage on the screen.

Attributes

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

Attributes

Inherited from:
Window
def y: ReadOnlyDoubleProperty

The vertical location of this Stage on the screen.

The vertical location of this Stage on the screen.

Attributes

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

Attributes

Inherited from:
Window

Inherited fields

override val delegate: Stage

JavaFX object to be wrapped.

JavaFX object to be wrapped.

Attributes

Inherited from:
Stage
Generated with