class: Window

[27:7] extends: FxObj

The Window class wraps javafx.stage.Window, the base class for every top-level JavaFX window surface (Stage and, through PopupWindow and PopupControl, ContextMenu and Tooltip). It provides the on-screen geometry (x, y, width, height), opacity, focus and showing state, the backing scene, arbitrary user data, the show/hide lifecycle event handlers, and the render scaling settings. This wrapper is not constructed directly. Concrete window types extend it, mirroring the JavaFX inheritance model, and set this.obj in their own constructors. The event handler and filter methods (addEventHandler, addEventFilter, removeEventHandler, removeEventFilter) and fireEvent are wrapped below; they take an EventType obtained with fx.eventType(...), for example fx.eventType(fxevent.WINDOW_SHOWING). The event-dispatcher internals (getEventDispatcher, setEventDispatcher, buildEventDispatchChain) are intentionally not wrapped here; they are advanced routing hooks rarely used from application code.

Methods

Window ()

Base constructor. Window is abstract and is never instantiated on its own.
setX (double X)

Sets the window x position on screen, in pixels.
- @p X is a double with the x coordinate.
- @r this object for chaining
getX ()

Returns the window x position on screen, in pixels.
- @r A double with the x coordinate.
xProperty ()

Returns the ReadOnlyDoubleProperty backing the x position.
- @r An AJO wrapping ReadOnlyDoubleProperty.
setY (double Y)

Sets the window y position on screen, in pixels.
- @p Y is a double with the y coordinate.
- @r this object for chaining
getY ()

Returns the window y position on screen, in pixels.
- @r A double with the y coordinate.
yProperty ()

Returns the ReadOnlyDoubleProperty backing the y position.
- @r An AJO wrapping ReadOnlyDoubleProperty.
setWidth (double W)

Sets the window width in pixels.
- @p W is a double with the width.
- @r this object for chaining
getWidth ()

Returns the window width in pixels.
- @r A double with the width.
widthProperty ()

Returns the ReadOnlyDoubleProperty backing the width.
- @r An AJO wrapping ReadOnlyDoubleProperty.
setHeight (double H)

Sets the window height in pixels.
- @p H is a double with the height.
- @r this object for chaining
getHeight ()

Returns the window height in pixels.
- @r A double with the height.
heightProperty ()

Returns the ReadOnlyDoubleProperty backing the height.
- @r An AJO wrapping ReadOnlyDoubleProperty.
setOpacity (double Opacity)

Sets the window opacity from 0.0 (transparent) to 1.0 (opaque).
- @p Opacity is a double in the range 0.0 to 1.0.
- @r this object for chaining
getOpacity ()

Returns the window opacity.
- @r A double in the range 0.0 to 1.0.
opacityProperty ()

Returns the DoubleProperty backing the opacity.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
isShowing ()

Returns whether the window is currently showing.
- @r A bool that is true while the window is visible.
showingProperty ()

Returns the ReadOnlyBooleanProperty backing the showing state.
- @r An AJO wrapping ReadOnlyBooleanProperty.
isFocused ()

Returns whether the window currently has input focus.
- @r A bool that is true when the window is focused.
focusedProperty ()

Returns the ReadOnlyBooleanProperty backing the focused state.
- @r An AJO wrapping ReadOnlyBooleanProperty.
requestFocus ()

Requests input focus for this window.
- @r this object for chaining
getScene ()

Returns the scene attached to this window.
- @r An AJO wrapping javafx.scene.Scene, or null when none is set.
sceneProperty ()

Returns the ReadOnlyObjectProperty backing the scene.
- @r An AJO wrapping ReadOnlyObjectProperty.
setUserData (Value)

Sets an arbitrary user data object on this window.
- @p Value is the user data to store, either a primitive, a raw AJO, or null.
- @r this object for chaining
getUserData ()

Returns the user data object set on this window.
- @r The stored user data, or null.
getProperties ()

Returns the general-purpose observable property map for this window, used to attach arbitrary key/value data. The map is created on first access.
- @r An AJO wrapping ObservableMap<Object, Object>.
hasProperties ()

Returns whether this window has a non-empty property map. This avoids creating the map through getProperties() just to test it.
- @r A bool that is true when the property map exists and is non-empty.
centerOnScreen ()

Centers the window on the primary screen.
- @r this object for chaining
sizeToScene ()

Resizes the window to fit the size of its scene content.
- @r this object for chaining
hide ()

Hides the window.
- @r this object for chaining
setOnShowing (callback Cb)

Registers a callback invoked just before the window is shown.
- @p Cb is a callback invoked with a WindowEvent.
- @r this object for chaining
getOnShowing ()

Returns the onShowing handler.
- @r An AJO wrapping javafx.event.EventHandler, or null.
onShowingProperty ()

Returns the ObjectProperty backing the onShowing handler.
- @r An AJO wrapping ObjectProperty.
setOnShown (callback Cb)

Registers a callback invoked just after the window is shown.
- @p Cb is a callback invoked with a WindowEvent.
- @r this object for chaining
getOnShown ()

Returns the onShown handler.
- @r An AJO wrapping javafx.event.EventHandler, or null.
onShownProperty ()

Returns the ObjectProperty backing the onShown handler.
- @r An AJO wrapping ObjectProperty.
setOnHiding (callback Cb)

Registers a callback invoked just before the window is hidden.
- @p Cb is a callback invoked with a WindowEvent.
- @r this object for chaining
getOnHiding ()

Returns the onHiding handler.
- @r An AJO wrapping javafx.event.EventHandler, or null.
onHidingProperty ()

Returns the ObjectProperty backing the onHiding handler.
- @r An AJO wrapping ObjectProperty.
setOnHidden (callback Cb)

Registers a callback invoked just after the window is hidden.
- @p Cb is a callback invoked with a WindowEvent.
- @r this object for chaining
getOnHidden ()

Returns the onHidden handler.
- @r An AJO wrapping javafx.event.EventHandler, or null.
onHiddenProperty ()

Returns the ObjectProperty backing the onHidden handler.
- @r An AJO wrapping ObjectProperty.
setOnCloseRequest (callback Cb)

Registers a callback invoked when the window receives a close request.
- @p Cb is a callback invoked with a WindowEvent.
- @r this object for chaining
getOnCloseRequest ()

Returns the onCloseRequest handler.
- @r An AJO wrapping javafx.event.EventHandler, or null.
onCloseRequestProperty ()

Returns the ObjectProperty backing the onCloseRequest handler.
- @r An AJO wrapping ObjectProperty.
setRenderScaleX (double Scale)

Sets the horizontal render scale for the window.
- @p Scale is a double with the render scale.
- @r this object for chaining
getRenderScaleX ()

Returns the horizontal render scale for the window.
- @r A double with the render scale.
renderScaleXProperty ()

Returns the DoubleProperty backing the horizontal render scale.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
setRenderScaleY (double Scale)

Sets the vertical render scale for the window.
- @p Scale is a double with the render scale.
- @r this object for chaining
getRenderScaleY ()

Returns the vertical render scale for the window.
- @r A double with the render scale.
renderScaleYProperty ()

Returns the DoubleProperty backing the vertical render scale.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
getOutputScaleX ()

Returns the horizontal output scale (the backing screen scale) for the window.
- @r A double with the output scale.
outputScaleXProperty ()

Returns the ReadOnlyDoubleProperty backing the horizontal output scale.
- @r An AJO wrapping ReadOnlyDoubleProperty.
getOutputScaleY ()

Returns the vertical output scale (the backing screen scale) for the window.
- @r A double with the output scale.
outputScaleYProperty ()

Returns the ReadOnlyDoubleProperty backing the vertical output scale.
- @r An AJO wrapping ReadOnlyDoubleProperty.
setForceIntegerRenderScale (bool Force)

Sets whether the render scale is forced to an integer value.
- @p Force is a bool; true forces an integer render scale.
- @r this object for chaining
isForceIntegerRenderScale ()

Returns whether the render scale is forced to an integer value.
- @r A bool that is true when an integer render scale is forced.
forceIntegerRenderScaleProperty ()

Returns the BooleanProperty backing the force-integer-render-scale flag.
- @r An AJO wrapping javafx.beans.property.BooleanProperty.
getWindows ()

Returns the observable list of all currently open windows. This wraps the static JavaFX method Window.getWindows().
- @r An AJO wrapping ObservableList.
addEventHandler (object EventTypeObj, callback Cb)

Adds an event handler for the given event type. The handler fires in the bubbling phase, and multiple handlers may be registered for one type.
- @p EventTypeObj is an event type, obtained from fx.eventType(...), for example fx.eventType(fxevent.WINDOW_SHOWING).
- @p Cb is a callback that receives the event.
- @r A handler reference. Keep it if you intend to remove the handler later with removeEventHandler; otherwise it can be ignored.
removeEventHandler (object EventTypeObj, object Handler)

Removes a handler previously added with addEventHandler. JavaFX matches by identity, so pass the handler reference that addEventHandler returned.
- @p EventTypeObj is an event type, obtained from fx.eventType(...).
- @p Handler is the handler reference returned by addEventHandler.
- @r this object for chaining
addEventFilter (object EventTypeObj, callback Cb)

Adds an event filter for the given event type. Filters fire in the capturing phase, before handlers, so a filter can inspect or consume an event before it reaches its target. This is the only way to intercept an event during capture; there is no convenience setter for filters.
- @p EventTypeObj is an event type, obtained from fx.eventType(...).
- @p Cb is a callback that receives the event.
- @r A filter reference. Keep it if you intend to remove the filter later with removeEventFilter; otherwise it can be ignored.
removeEventFilter (object EventTypeObj, object Handler)

Removes a filter previously added with addEventFilter. Pass the filter reference that addEventFilter returned.
- @p EventTypeObj is an event type, obtained from fx.eventType(...).
- @p Handler is the filter reference returned by addEventFilter.
- @r this object for chaining
fireEvent (object EventObj)

Fires the given event on this window, dispatching it through the normal capture-and-bubble chain.
- @p EventObj is a javafx.event.Event to dispatch.
- @r this object for chaining