scalafx
API
Generated with
scalafx/scalafx/scalafx.stage/Window

Window

scalafx.stage.Window
See theWindow companion object
class Window extends EventTarget, SFXDelegate[Window]

Attributes

Companion
object
Graph
Supertypes
class EventTarget
trait SFXDelegate[Window]
class Object
trait Matchable
class Any
Known subtypes
class PopupWindow
class PopupControl
class ContextMenu
class Tooltip
class Popup
class Stage
class PrimaryStage
class PrimaryStage
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

Concrete methods

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

def eventDispatcher: ObjectProperty[EventDispatcher]

Specifies the event dispatcher for this node.

Specifies the event dispatcher for this node.

Attributes

def eventDispatcher_=(v: EventDispatcher): Unit
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

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

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

def height: ReadOnlyDoubleProperty

The height of this Stage.

The height of this Stage.

Attributes

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

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

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

Called just after the Window has been hidden.

Called just after the Window has been hidden.

Attributes

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

Called just prior to the Window being hidden.

Called just prior to the Window being hidden.

Attributes

def onHiding_=(v: EventHandler[WindowEvent]): Unit
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

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

Called just after the Window is shown.

Called just after the Window is shown.

Attributes

def onShown_=(v: EventHandler[WindowEvent]): Unit
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

def opacity_=(v: Double): Unit
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

def outputScaleX_=(value: Double): Unit
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

def outputScaleY_=(value: Double): Unit
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

def renderScaleX_=(scale: Double): Unit
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

def renderScaleY_=(scale: Double): Unit
def requestFocus(): Unit

Requests that this Window get the input focus.

Requests that this Window get the input focus.

Attributes

def scene: ReadOnlyObjectProperty[Scene]

The Scene to be rendered on this Stage.

The Scene to be rendered on this Stage.

Attributes

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

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

def width: ReadOnlyDoubleProperty

The width of this Stage.

The width of this Stage.

Attributes

def width_=(w: Double): Unit
def x: ReadOnlyDoubleProperty

The horizontal location of this Stage on the screen.

The horizontal location of this Stage on the screen.

Attributes

def x_=(value: Double): Unit
def y: ReadOnlyDoubleProperty

The vertical location of this Stage on the screen.

The vertical location of this Stage on the screen.

Attributes

def y_=(value: Double): Unit

Inherited methods

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
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 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 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
override def toString: String

Attributes

Returns

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

Definition Classes
SFXDelegate -> Any
Inherited from:
SFXDelegate

Concrete fields

override val delegate: Window

JavaFX object to be wrapped.

JavaFX object to be wrapped.

Attributes

Generated with