scalafx.stage

Window

class Window extends EventHandlerDelegate with SFXDelegate[javafx.stage.Window] with EventTarget

Source
Window.scala
Linear Supertypes
EventTarget, SFXDelegate[javafx.stage.Window], EventHandlerDelegate, AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Window
  2. EventTarget
  3. SFXDelegate
  4. EventHandlerDelegate
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Window(delegate: javafx.stage.Window)

    Attributes
    protected

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"

  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"

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. object FilterMagnet

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

  7. object HandlerMagnet

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

  8. 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
  9. 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
  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
    EventHandlerDelegate
  12. def centerOnScreen(): Unit

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

  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  14. val delegate: javafx.stage.Window

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    WindowSFXDelegate
  15. final def eq(arg0: AnyRef): Boolean

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

    Specifies the event dispatcher for this node.

  18. def eventDispatcher_=(v: EventDispatcher): Unit

  19. 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
  20. 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
  21. def fireEvent(event: Event): Unit

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

  22. def focused: ReadOnlyBooleanProperty

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

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

    Since

    9

    See also

    renderScaleY

    renderScaleX

  24. def forceIntegerRenderScale_=(forced: Boolean): Unit

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

    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  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.

  29. def height_=(h: Double): Unit

  30. def hide(): Unit

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

  31. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  32. final def ne(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  35. def onCloseRequest: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

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

  36. def onCloseRequest_=(v: EventHandler[javafx.stage.WindowEvent]): Unit

  37. def onHidden: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

    Called just after the Window has been hidden.

  38. def onHidden_=(v: EventHandler[javafx.stage.WindowEvent]): Unit

  39. def onHiding: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

    Called just prior to the Window being hidden.

  40. def onHiding_=(v: EventHandler[javafx.stage.WindowEvent]): Unit

  41. def onShowing: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

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

  42. def onShowing_=(v: EventHandler[javafx.stage.WindowEvent]): Unit

  43. def onShown: ObjectProperty[EventHandler[javafx.stage.WindowEvent]]

    Called just after the Window is shown.

  44. def onShown_=(v: EventHandler[javafx.stage.WindowEvent]): Unit

  45. def opacity: DoubleProperty

    Defines the opacity of the Stage as a value between 0.

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

  46. def opacity_=(v: Double): Unit

  47. 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.
    Since

    9

    See also

    renderScaleX

  48. def outputScaleX_=(value: Double): Unit

  49. 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.
    Since

    9

    See also

    renderScaleY

  50. def outputScaleY_=(value: Double): Unit

  51. 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
  52. 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
  53. 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

    Since

    9

    See also

    forceIntegerRenderScale

    outputScaleX

  54. def renderScaleX_=(scale: Double): Unit

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

    Since

    9

    See also

    forceIntegerRenderScale

    outputScaleY

  56. def renderScaleY_=(scale: Double): Unit

  57. def requestFocus(): Unit

    Requests that this Window get the input focus.

  58. def scene: ReadOnlyObjectProperty[Scene]

    The Scene to be rendered on this Stage.

  59. def showing: ReadOnlyBooleanProperty

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

  60. def sizeToScene(): Unit

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

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

    Definition Classes
    AnyRef
  62. def toString(): String

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  63. final def wait(arg0: Long, arg1: Int): Unit

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(): Unit

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

    The width of this Stage.

  67. def width_=(w: Double): Unit

  68. def x: ReadOnlyDoubleProperty

    The horizontal location of this Stage on the screen.

  69. def x_=(value: Double): Unit

  70. def y: ReadOnlyDoubleProperty

    The vertical location of this Stage on the screen.

  71. def y_=(value: Double): Unit

Deprecated Value Members

  1. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from EventTarget

Inherited from SFXDelegate[javafx.stage.Window]

Inherited from EventHandlerDelegate

Inherited from AnyRef

Inherited from Any

Ungrouped