scalafx.stage

Stage

Related Docs: object Stage | package stage

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

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

stage = new JFXApp.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], EventHandlerDelegate, AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Stage
  2. Window
  3. EventTarget
  4. SFXDelegate
  5. EventHandlerDelegate
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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. type EventHandled = AnyRef { ... /* 5 definitions in type refinement */ }

    Definition Classes
    EventHandlerDelegate
  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
    EventHandlerDelegate
  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
    EventHandlerDelegate

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. 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
    EventHandlerDelegate
  5. 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
    EventHandlerDelegate
  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
    EventHandlerDelegate
  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
    EventHandlerDelegate
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

    Construct an event dispatch chain for this target.

    Construct an event dispatch chain for this target.

    Definition Classes
    EventHandlerDelegate
  10. 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
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def close(): Unit

    Closes this Stage.

  13. val delegate: javafx.stage.Stage

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    StageWindowSFXDelegate
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. 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
  16. def eventDispatcher: ObjectProperty[EventDispatcher]

    Specifies the event dispatcher for this node.

    Specifies the event dispatcher for this node.

    Definition Classes
    Window
  17. def eventDispatcher_=(v: EventDispatcher): Unit

    Definition Classes
    Window
  18. def eventHandlerDelegate: EventHandled

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

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

    Attributes
    protected
    Definition Classes
    WindowEventHandlerDelegate
  19. 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
    EventHandlerDelegate
  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. 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
  22. 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
  23. def fullScreen: ReadOnlyBooleanProperty

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

  24. def fullScreen_=(value: Boolean): Unit

  25. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  26. 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
    EventHandlerDelegate
  27. def hashCode(): Int

    returns

    The delegate hashcode

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

    The height of this Stage.

    The height of this Stage.

    Definition Classes
    Window
  29. def height_=(h: Double): Unit

    Definition Classes
    Window
  30. 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
  31. def iconified: ReadOnlyBooleanProperty

    Defines whether the Stage is iconified or not.

  32. def icons: ObservableList[Image]

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

  33. def initModality(modality: Modality): Unit

    Specifies the modality for this stage.

  34. def initOwner(owner: Window): Unit

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

  35. def initStyle(style: StageStyle): Unit

    Specifies the style for this stage.

  36. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  37. def maxHeight: Double

    Defines the maximum height of this Stage.

  38. def maxHeight_=(h: Double): Unit

  39. def maxWidth: Double

    Defines the maximum width of this Stage.

  40. def maxWidth_=(w: Double): Unit

  41. def minHeight: Double

    Defines the minimum height of this Stage.

  42. def minHeight_=(h: Double): Unit

  43. def minWidth: Double

    Defines the minimum width of this Stage.

  44. def minWidth_=(w: Double): Unit

  45. def modality: Modality

    Retrieves the modality attribute for this stage.

  46. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  47. final def notify(): Unit

    Definition Classes
    AnyRef
  48. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  49. 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
  50. def onCloseRequest_=(v: EventHandler[javafx.stage.WindowEvent]): Unit

    Definition Classes
    Window
  51. 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
  52. def onHidden_=(v: EventHandler[javafx.stage.WindowEvent]): Unit

    Definition Classes
    Window
  53. 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
  54. def onHiding_=(v: EventHandler[javafx.stage.WindowEvent]): Unit

    Definition Classes
    Window
  55. 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
  56. def onShowing_=(v: EventHandler[javafx.stage.WindowEvent]): Unit

    Definition Classes
    Window
  57. def onShown: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

    Called just after the Window is shown.

    Called just after the Window is shown.

    Definition Classes
    Window
  58. def onShown_=(v: EventHandler[javafx.stage.WindowEvent]): Unit

    Definition Classes
    Window
  59. 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
  60. def opacity_=(v: Double): Unit

    Definition Classes
    Window
  61. def owner: Option[Window]

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

  62. 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
    EventHandlerDelegate
  63. 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
    EventHandlerDelegate
  64. def requestFocus(): Unit

    Requests that this Window get the input focus.

    Requests that this Window get the input focus.

    Definition Classes
    Window
  65. def resizable: BooleanProperty

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

  66. def resizable_=(v: Boolean): Unit

  67. def scene: ReadOnlyObjectProperty[Scene]

    The Scene to be rendered on this Stage.

    The Scene to be rendered on this Stage.

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

    Specify the scene to be used on this stage.

  69. def show(): Unit

    Attempts to show this Window by setting visibility to true.

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

  71. 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
  72. def showing_=(v: Boolean): Unit

    Attempts to show or hide this Window.

  73. 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
  74. def style: StageStyle

    Retrieves the style attribute for this stage.

  75. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  76. def title: StringProperty

    Defines the title of the Stage.

  77. def title_=(v: String): Unit

  78. def toBack(): Unit

    Send the Window to the background.

  79. def toFront(): Unit

    Bring the Window to the foreground.

  80. def toString(): String

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  81. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. def width: ReadOnlyDoubleProperty

    The width of this Stage.

    The width of this Stage.

    Definition Classes
    Window
  85. def width_=(w: Double): Unit

    Definition Classes
    Window
  86. def x: ReadOnlyDoubleProperty

    The horizontal location of this Stage on the screen.

    The horizontal location of this Stage on the screen.

    Definition Classes
    Window
  87. def x_=(value: Double): Unit

    Definition Classes
    Window
  88. def y: ReadOnlyDoubleProperty

    The vertical location of this Stage on the screen.

    The vertical location of this Stage on the screen.

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

    Definition Classes
    Window

Inherited from Window

Inherited from EventTarget

Inherited from SFXDelegate[javafx.stage.Stage]

Inherited from EventHandlerDelegate

Inherited from AnyRef

Inherited from Any

Ungrouped