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 Popup extends PopupWindow with SFXDelegate[javafx.stage.Popup]

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

Instance Constructors

  1. new Popup(delegate: javafx.stage.Popup = new jfxs.Popup)

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 anchorLocation: ObjectProperty[AnchorLocation]

    Specifies the popup anchor point which is used in popup positioning.

    Specifies the popup anchor point which is used in popup positioning.

    Definition Classes
    PopupWindow
  9. def anchorLocation_=(v: AnchorLocation): Unit
    Definition Classes
    PopupWindow
  10. def anchorX: ReadOnlyDoubleProperty

    Specifies the x coordinate of the popup anchor point on the screen.

    Specifies the x coordinate of the popup anchor point on the screen.

    Definition Classes
    PopupWindow
  11. def anchorY: ReadOnlyDoubleProperty

    Specifies the y coordinate of the popup anchor point on the screen.

    Specifies the y coordinate of the popup anchor point on the screen.

    Definition Classes
    PopupWindow
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def autoFix: BooleanProperty

    This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.

    This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.

    Definition Classes
    PopupWindow
  14. def autoFix_=(v: Boolean): Unit
    Definition Classes
    PopupWindow
  15. def autoHide: BooleanProperty

    Specifies whether Popups should auto hide.

    Specifies whether Popups should auto hide.

    Definition Classes
    PopupWindow
  16. def autoHide_=(v: Boolean): Unit
    Definition Classes
    PopupWindow
  17. def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

    Construct an event dispatch chain for this target.

    Construct an event dispatch chain for this target.

    Definition Classes
    EventHandlerDelegate2
  18. 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
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  20. def consumeAutoHidingEvents: BooleanProperty

    Specifies whether the event, which caused the Popup to hide, should be consumed.

    Specifies whether the event, which caused the Popup to hide, should be consumed.

    Definition Classes
    PopupWindow
    Since

    2.2

  21. def consumeAutoHidingEvents_=(v: Boolean): Unit
    Definition Classes
    PopupWindow
  22. def content: ObservableBuffer[Node]
  23. val delegate: javafx.stage.Popup

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    PopupPopupWindowWindowSFXDelegate
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. 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
  26. def eventDispatcher: ObjectProperty[EventDispatcher]

    Specifies the event dispatcher for this node.

    Specifies the event dispatcher for this node.

    Definition Classes
    Window
  27. def eventDispatcher_=(v: EventDispatcher): Unit
    Definition Classes
    Window
  28. def eventHandlerDelegate: EventHandled

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

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

    Definition Classes
    WindowEventHandlerDelegate2
  29. 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
  30. 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
  31. 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
  32. 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

  33. def forceIntegerRenderScale_=(forced: Boolean): Unit
    Definition Classes
    Window
  34. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. 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
  36. def hashCode(): Int

    returns

    The delegate hashcode

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

    The height of this Stage.

    The height of this Stage.

    Definition Classes
    Window
  38. def height_=(h: Double): Unit
    Definition Classes
    Window
  39. 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
  40. def hideOnEscape: BooleanProperty

    Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.

    Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.

    Definition Classes
    PopupWindow
  41. def hideOnEscape_=(v: Boolean): Unit
    Definition Classes
    PopupWindow
  42. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  46. def onAutoHide: ObjectProperty[EventHandler[Event]]

    Called after autoHide is run.

    Called after autoHide is run.

    Definition Classes
    PopupWindow
  47. def onAutoHide_=(v: EventHandler[Event]): Unit
    Definition Classes
    PopupWindow
  48. 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
  49. def onCloseRequest_=(v: EventHandler[javafx.stage.WindowEvent]): Unit
    Definition Classes
    Window
  50. 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
  51. def onHidden_=(v: EventHandler[javafx.stage.WindowEvent]): Unit
    Definition Classes
    Window
  52. 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
  53. def onHiding_=(v: EventHandler[javafx.stage.WindowEvent]): Unit
    Definition Classes
    Window
  54. 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
  55. def onShowing_=(v: EventHandler[javafx.stage.WindowEvent]): Unit
    Definition Classes
    Window
  56. def onShown: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

    Called just after the Window is shown.

    Called just after the Window is shown.

    Definition Classes
    Window
  57. def onShown_=(v: EventHandler[javafx.stage.WindowEvent]): Unit
    Definition Classes
    Window
  58. 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
  59. def opacity_=(v: Double): Unit
    Definition Classes
    Window
  60. 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

  61. def outputScaleX_=(value: Double): Unit
    Definition Classes
    Window
  62. 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

  63. def outputScaleY_=(value: Double): Unit
    Definition Classes
    Window
  64. def ownerNode: ReadOnlyObjectProperty[Node]

    The node which is the owner of this popup.

    The node which is the owner of this popup.

    Definition Classes
    PopupWindow
  65. def ownerWindow: ReadOnlyObjectProperty[javafx.stage.Window]

    The window which is the parent of this popup.

    The window which is the parent of this popup.

    Definition Classes
    PopupWindow
  66. 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
  67. 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
  68. 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

  69. def renderScaleX_=(scale: Double): Unit
    Definition Classes
    Window
  70. 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

  71. def renderScaleY_=(scale: Double): Unit
    Definition Classes
    Window
  72. def requestFocus(): Unit

    Requests that this Window get the input focus.

    Requests that this Window get the input focus.

    Definition Classes
    Window
  73. def scene: ReadOnlyObjectProperty[Scene]

    The Scene to be rendered on this Stage.

    The Scene to be rendered on this Stage.

    Definition Classes
    Window
  74. def show(owner: Window, screenX: Double, screenY: Double): Unit

    Show the Popup at the specified x,y location relative to the screen

    Show the Popup at the specified x,y location relative to the screen

    Definition Classes
    PopupWindow
  75. def show(owner: Window): Unit

    Show the popup.

    Show the popup.

    Definition Classes
    PopupWindow
  76. def show(owner: Node, screenX: Double, screenY: Double): Unit

    Show the Popup at the specified x,y location relative to the screen

    Show the Popup at the specified x,y location relative to the screen

    Definition Classes
    PopupWindow
  77. 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
  78. 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
  79. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  80. def toString(): String

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  81. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  82. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  83. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  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

Deprecated Value Members

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

Inherited from PopupWindow

Inherited from Window

Inherited from EventTarget

Inherited from SFXDelegate[javafx.stage.Popup]

Inherited from EventHandlerDelegate2

Inherited from AnyRef

Inherited from Any

Ungrouped