- All Implemented Interfaces:
EventTarget
- Direct Known Subclasses:
PopupWindow
,Stage
Stage
, PopupWindow
, or other
such top level window.
Window objects must be constructed and modified on the JavaFX Application Thread.
The JavaFX Application Thread is created as part of the startup process for
the JavaFX runtime. See the Application
class and
the Platform.startup(Runnable)
method for more information.
Some Window
properties are read-only, even though they have
corresponding set methods, because they can be changed externally by the
underlying platform, and therefore must not be bindable.
Further, these properties might be ignored on some platforms, depending on
whether or not there is a window manager and how it is configured.
For example, a tiling window manager might ignore the x
and y
properties, or treat them as hints, placing the window in a location of its
choosing.
- Since:
- JavaFX 2.0
-
Property Summary
TypePropertyDescriptionfinal ObjectProperty<EventDispatcher>
Specifies the event dispatcher for this node.final ReadOnlyBooleanProperty
Whether or not thisWindow
has the keyboard or input focus.final 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.final ReadOnlyDoubleProperty
The height of thisWindow
.final ObjectProperty<EventHandler<WindowEvent>>
Called when there is an external request to close thisWindow
.final ObjectProperty<EventHandler<WindowEvent>>
Called just after the Window has been hidden.final ObjectProperty<EventHandler<WindowEvent>>
Called just prior to the Window being hidden.final ObjectProperty<EventHandler<WindowEvent>>
Called just prior to the Window being shown.final ObjectProperty<EventHandler<WindowEvent>>
Called just after the Window is shown.final DoubleProperty
Defines the opacity of theWindow
as a value between 0.0 and 1.0.final ReadOnlyDoubleProperty
The scale that theWindow
will apply to horizontal scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.final ReadOnlyDoubleProperty
The scale that theWindow
will apply to vertical scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.final DoubleProperty
The horizontal scale that theWindow
will use when rendering itsScene
to the rendering buffer.final DoubleProperty
The vertical scale that theWindow
will use when rendering itsScene
to the rendering buffer.final ReadOnlyObjectProperty<Scene>
TheScene
to be rendered on thisWindow
.final ReadOnlyBooleanProperty
Whether or not thisWindow
is showing (that is, open on the user's system).final ReadOnlyDoubleProperty
The width of thisWindow
.final ReadOnlyDoubleProperty
The horizontal location of thisWindow
on the screen.final ReadOnlyDoubleProperty
The vertical location of thisWindow
on the screen. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal <T extends Event>
voidaddEventFilter
(EventType<T> eventType, EventHandler<? super T> eventFilter) Registers an event filter to this node.final <T extends Event>
voidaddEventHandler
(EventType<T> eventType, EventHandler<? super T> eventHandler) Registers an event handler to this node.Construct an event dispatch chain for this window.void
Sets x and y properties on this Window so that it is centered on the curent screen.final ObjectProperty<EventDispatcher>
Specifies the event dispatcher for this node.final void
Fires the specified event.final ReadOnlyBooleanProperty
Whether or not thisWindow
has the keyboard or input focus.final 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.final EventDispatcher
Gets the value of the property eventDispatcher.final double
Gets the value of the property height.final EventHandler<WindowEvent>
Gets the value of the property onCloseRequest.final EventHandler<WindowEvent>
Gets the value of the property onHidden.final EventHandler<WindowEvent>
Gets the value of the property onHiding.final EventHandler<WindowEvent>
Gets the value of the property onShowing.final EventHandler<WindowEvent>
Gets the value of the property onShown.final double
Gets the value of the property opacity.final double
Gets the value of the property outputScaleX.final double
Gets the value of the property outputScaleY.final ObservableMap<Object,
Object> Returns an observable map of properties on this node for use primarily by application developers.final double
Gets the value of the property renderScaleX.final double
Gets the value of the property renderScaleY.final Scene
getScene()
Gets the value of the property scene.Returns a previously set Object property, or null if no such property has been set using thesetUserData(java.lang.Object)
method.final double
getWidth()
Gets the value of the property width.static ObservableList<Window>
Returns a list containing a reference to the currently showing JavaFX windows.final double
getX()
Gets the value of the property x.final double
getY()
Gets the value of the property y.boolean
Tests if Window has properties.final ReadOnlyDoubleProperty
The height of thisWindow
.void
hide()
Attempts to hide this Window by setting the visibility to false.final boolean
Gets the value of the property focused.final boolean
Gets the value of the property forceIntegerRenderScale.final boolean
Gets the value of the property showing.final ObjectProperty<EventHandler<WindowEvent>>
Called when there is an external request to close thisWindow
.final ObjectProperty<EventHandler<WindowEvent>>
Called just after the Window has been hidden.final ObjectProperty<EventHandler<WindowEvent>>
Called just prior to the Window being hidden.final ObjectProperty<EventHandler<WindowEvent>>
Called just prior to the Window being shown.final ObjectProperty<EventHandler<WindowEvent>>
Called just after the Window is shown.final DoubleProperty
Defines the opacity of theWindow
as a value between 0.0 and 1.0.final ReadOnlyDoubleProperty
The scale that theWindow
will apply to horizontal scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.final ReadOnlyDoubleProperty
The scale that theWindow
will apply to vertical scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.final <T extends Event>
voidremoveEventFilter
(EventType<T> eventType, EventHandler<? super T> eventFilter) Unregisters a previously registered event filter from this node.final <T extends Event>
voidremoveEventHandler
(EventType<T> eventType, EventHandler<? super T> eventHandler) Unregisters a previously registered event handler from this node.final DoubleProperty
The horizontal scale that theWindow
will use when rendering itsScene
to the rendering buffer.final DoubleProperty
The vertical scale that theWindow
will use when rendering itsScene
to the rendering buffer.final void
Requests that thisWindow
get the input focus.final ReadOnlyObjectProperty<Scene>
TheScene
to be rendered on thisWindow
.final void
Sets the value of the property eventDispatcher.protected final <T extends Event>
voidsetEventHandler
(EventType<T> eventType, EventHandler<? super T> eventHandler) Sets the handler to use for this event type.final void
setForceIntegerRenderScale
(boolean forced) Sets the value of the property forceIntegerRenderScale.final void
setHeight
(double value) Sets the value of the property height.final void
setOnCloseRequest
(EventHandler<WindowEvent> value) Sets the value of the property onCloseRequest.final void
setOnHidden
(EventHandler<WindowEvent> value) Sets the value of the property onHidden.final void
setOnHiding
(EventHandler<WindowEvent> value) Sets the value of the property onHiding.final void
setOnShowing
(EventHandler<WindowEvent> value) Sets the value of the property onShowing.final void
setOnShown
(EventHandler<WindowEvent> value) Sets the value of the property onShown.final void
setOpacity
(double value) Sets the value of the property opacity.final void
setRenderScaleX
(double scale) Sets the value of the property renderScaleX.final void
setRenderScaleY
(double scale) Sets the value of the property renderScaleY.protected void
Sets the value of thescene
property.void
setUserData
(Object value) Convenience method for setting a single Object property that can be retrieved at a later date.final void
setWidth
(double value) Sets the value of the property width.final void
setX
(double value) Sets the value of the property x.final void
setY
(double value) Sets the value of the property y.protected void
show()
Attempts to show this Window by setting visibility to truefinal ReadOnlyBooleanProperty
Whether or not thisWindow
is showing (that is, open on the user's system).void
Set the width and height of this Window to match the size of the content of this Window's Scene.final ReadOnlyDoubleProperty
The width of thisWindow
.final ReadOnlyDoubleProperty
The horizontal location of thisWindow
on the screen.final ReadOnlyDoubleProperty
The vertical location of thisWindow
on the screen.
-
Property Details
-
outputScaleX
The scale that theWindow
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 theScreen
property is updated. - In response to a change in user preferences for output scaling.
- Since:
- 9
- See Also:
-
outputScaleY
The scale that theWindow
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 theScreen
property is updated. - In response to a change in user preferences for output scaling.
- Since:
- 9
- See Also:
-
forceIntegerRenderScale
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. TherenderScale
properties will be updated directly and simultaneously with any changes in the associatedoutputScale
properties, but the values can be overridden by subsequent calls to thesetRenderScale
setters or through appropriate use of binding. This property will not prevent setting non-integer scales directly using therenderScale
property object or the convenience setter method.- Default value:
- false
- Since:
- 9
- See Also:
-
renderScaleX
The horizontal scale that theWindow
will use when rendering itsScene
to the rendering buffer. This property is automatically updated whenever there is a change in theoutputScaleX
property and can be overridden either by callingsetRenderScaleX()
in response to a listener on theoutputScaleX
property or by binding it appropriately.- Default value:
- outputScaleX
- Since:
- 9
- See Also:
-
renderScaleY
The vertical scale that theWindow
will use when rendering itsScene
to the rendering buffer. This property is automatically updated whenever there is a change in theoutputScaleY
property and can be overridden either by callingsetRenderScaleY()
in response to a listener on theoutputScaleY
property or by binding it appropriately.- Default value:
- outputScaleY
- Since:
- 9
- See Also:
-
x
The horizontal location of thisWindow
on the screen. Changing this attribute will move theWindow
horizontally. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
- See Also:
-
y
The vertical location of thisWindow
on the screen. Changing this attribute will move theWindow
vertically. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
- See Also:
-
width
The width of thisWindow
. Changing this attribute will narrow or widen the width of theWindow
. This value includes any and all decorations which may be added by the Operating System such as resizable frame handles. Typical applications will set theScene
width instead. ThisWindow
will take its width from the scene if it has never been set by the application. Resizing the window by end user does not count as a setting the width by the application. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
- See Also:
-
height
The height of thisWindow
. Changing this attribute will shrink or heighten the height of theWindow
. This value includes any and all decorations which may be added by the Operating System such as the title bar. Typical applications will set theScene
height instead. This window will take its height from the scene if it has never been set by the application. Resizing this window by end user does not count as a setting the height by the application. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
- See Also:
-
focused
Whether or not thisWindow
has the keyboard or input focus.- See Also:
-
scene
TheScene
to be rendered on thisWindow
. There can only be oneScene
on theWindow
at a time, and aScene
can only be on oneWindow
at a time. Setting aScene
on a differentWindow
will cause the oldWindow
to lose the reference before the new one gains it. You may swapScene
s on aWindow
at any time, even if it is an instance ofStage
and withfullScreen
set totrue
.If the width or height of this
Window
have never been set by the application, setting the scene will cause thisWindow
to take its width or height from that scene. Resizing thisWindow
by end user does not count as setting the width or height by the application.An
IllegalStateException
is thrown if this property is set on a thread other than the JavaFX Application Thread.- Default value:
null
- See Also:
-
opacity
Defines the opacity of theWindow
as a value between 0.0 and 1.0. The opacity is reflected across theWindow
, itsDecoration
and itsScene
content. On a JavaFX runtime platform that does not support opacity, assigning a value to this variable will have no visible difference. AWindow
with 0% opacity is fully translucent. Typically, aWindow
with 0% opacity will not receive any mouse events.- Default value:
- 1.0
- See Also:
-
onCloseRequest
Called when there is an external request to close thisWindow
. The installed event handler can prevent window closing by consuming the received event. -
onShowing
Called just prior to the Window being shown.- See Also:
-
onShown
Called just after the Window is shown.- See Also:
-
onHiding
Called just prior to the Window being hidden.- See Also:
-
onHidden
Called just after the Window has been hidden. When theWindow
is hidden, this event handler is invoked allowing the developer to clean up resources or perform other tasks when theWindow
is closed.- See Also:
-
showing
Whether or not thisWindow
is showing (that is, open on the user's system). The Window might be "showing", yet the user might not be able to see it due to the Window being rendered behind another Window or due to the Window being positioned off the monitor.- Default value:
- false
- See Also:
-
eventDispatcher
Specifies the event dispatcher for this node. The default event dispatcher sends the received events to the registered event handlers and filters. When replacing the value with a newEventDispatcher
, the new dispatcher should forward events to the replaced dispatcher to maintain the node's default event handling behavior.
-
-
Constructor Details
-
Window
protected Window()Constructor for subclasses to call.
-
-
Method Details
-
getWindows
Returns a list containing a reference to the currently showing JavaFX windows. The list is unmodifiable - attempting to modify this list will result in anUnsupportedOperationException
being thrown at runtime.- Returns:
- A list containing all windows that are currently showing.
- Since:
- 9
-
sizeToScene
public void sizeToScene()Set the width and height of this Window to match the size of the content of this Window's Scene. -
centerOnScreen
public void centerOnScreen()Sets x and y properties on this Window so that it is centered on the curent screen. The current screen is determined from the intersection of current window bounds and visual bounds of all screens. -
getOutputScaleX
public final double getOutputScaleX()Gets the value of the property outputScaleX.- Property description:
- 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 theScreen
property is updated. - In response to a change in user preferences for output scaling.
- Since:
- 9
-
outputScaleXProperty
The scale that theWindow
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 theScreen
property is updated. - In response to a change in user preferences for output scaling.
- Since:
- 9
- See Also:
-
getOutputScaleY
public final double getOutputScaleY()Gets the value of the property outputScaleY.- Property description:
- 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 theScreen
property is updated. - In response to a change in user preferences for output scaling.
- Since:
- 9
-
outputScaleYProperty
The scale that theWindow
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 theScreen
property is updated. - In response to a change in user preferences for output scaling.
- Since:
- 9
- See Also:
-
setForceIntegerRenderScale
public final void setForceIntegerRenderScale(boolean forced) Sets the value of the property forceIntegerRenderScale.- Property description:
- 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 associatedoutputScale
properties, but the values can be overridden by subsequent calls to thesetRenderScale
setters or through appropriate use of binding. This property will not prevent setting non-integer scales directly using therenderScale
property object or the convenience setter method. - Default value:
- false
- Since:
- 9
-
isForceIntegerRenderScale
public final boolean isForceIntegerRenderScale()Gets the value of the property forceIntegerRenderScale.- Property description:
- 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 associatedoutputScale
properties, but the values can be overridden by subsequent calls to thesetRenderScale
setters or through appropriate use of binding. This property will not prevent setting non-integer scales directly using therenderScale
property object or the convenience setter method. - Default value:
- false
- Since:
- 9
-
forceIntegerRenderScaleProperty
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. TherenderScale
properties will be updated directly and simultaneously with any changes in the associatedoutputScale
properties, but the values can be overridden by subsequent calls to thesetRenderScale
setters or through appropriate use of binding. This property will not prevent setting non-integer scales directly using therenderScale
property object or the convenience setter method.- Default value:
- false
- Since:
- 9
- See Also:
-
setRenderScaleX
public final void setRenderScaleX(double scale) Sets the value of the property renderScaleX.- Property description:
- The horizontal scale that the
Window
will use when rendering itsScene
to the rendering buffer. This property is automatically updated whenever there is a change in theoutputScaleX
property and can be overridden either by callingsetRenderScaleX()
in response to a listener on theoutputScaleX
property or by binding it appropriately. - Default value:
- outputScaleX
- Since:
- 9
-
getRenderScaleX
public final double getRenderScaleX()Gets the value of the property renderScaleX.- Property description:
- The horizontal scale that the
Window
will use when rendering itsScene
to the rendering buffer. This property is automatically updated whenever there is a change in theoutputScaleX
property and can be overridden either by callingsetRenderScaleX()
in response to a listener on theoutputScaleX
property or by binding it appropriately. - Default value:
- outputScaleX
- Since:
- 9
-
renderScaleXProperty
The horizontal scale that theWindow
will use when rendering itsScene
to the rendering buffer. This property is automatically updated whenever there is a change in theoutputScaleX
property and can be overridden either by callingsetRenderScaleX()
in response to a listener on theoutputScaleX
property or by binding it appropriately.- Default value:
- outputScaleX
- Since:
- 9
- See Also:
-
setRenderScaleY
public final void setRenderScaleY(double scale) Sets the value of the property renderScaleY.- Property description:
- The vertical scale that the
Window
will use when rendering itsScene
to the rendering buffer. This property is automatically updated whenever there is a change in theoutputScaleY
property and can be overridden either by callingsetRenderScaleY()
in response to a listener on theoutputScaleY
property or by binding it appropriately. - Default value:
- outputScaleY
- Since:
- 9
-
getRenderScaleY
public final double getRenderScaleY()Gets the value of the property renderScaleY.- Property description:
- The vertical scale that the
Window
will use when rendering itsScene
to the rendering buffer. This property is automatically updated whenever there is a change in theoutputScaleY
property and can be overridden either by callingsetRenderScaleY()
in response to a listener on theoutputScaleY
property or by binding it appropriately. - Default value:
- outputScaleY
- Since:
- 9
-
renderScaleYProperty
The vertical scale that theWindow
will use when rendering itsScene
to the rendering buffer. This property is automatically updated whenever there is a change in theoutputScaleY
property and can be overridden either by callingsetRenderScaleY()
in response to a listener on theoutputScaleY
property or by binding it appropriately.- Default value:
- outputScaleY
- Since:
- 9
- See Also:
-
setX
public final void setX(double value) Sets the value of the property x.- Property description:
- The horizontal location of this
Window
on the screen. Changing this attribute will move theWindow
horizontally. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
-
getX
public final double getX()Gets the value of the property x.- Property description:
- The horizontal location of this
Window
on the screen. Changing this attribute will move theWindow
horizontally. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
-
xProperty
The horizontal location of thisWindow
on the screen. Changing this attribute will move theWindow
horizontally. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
- See Also:
-
setY
public final void setY(double value) Sets the value of the property y.- Property description:
- The vertical location of this
Window
on the screen. Changing this attribute will move theWindow
vertically. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
-
getY
public final double getY()Gets the value of the property y.- Property description:
- The vertical location of this
Window
on the screen. Changing this attribute will move theWindow
vertically. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
-
yProperty
The vertical location of thisWindow
on the screen. Changing this attribute will move theWindow
vertically. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
- See Also:
-
setWidth
public final void setWidth(double value) Sets the value of the property width.- Property description:
- The width of this
Window
. Changing this attribute will narrow or widen the width of theWindow
. This value includes any and all decorations which may be added by the Operating System such as resizable frame handles. Typical applications will set theScene
width instead. ThisWindow
will take its width from the scene if it has never been set by the application. Resizing the window by end user does not count as a setting the width by the application. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
-
getWidth
public final double getWidth()Gets the value of the property width.- Property description:
- The width of this
Window
. Changing this attribute will narrow or widen the width of theWindow
. This value includes any and all decorations which may be added by the Operating System such as resizable frame handles. Typical applications will set theScene
width instead. ThisWindow
will take its width from the scene if it has never been set by the application. Resizing the window by end user does not count as a setting the width by the application. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
-
widthProperty
The width of thisWindow
. Changing this attribute will narrow or widen the width of theWindow
. This value includes any and all decorations which may be added by the Operating System such as resizable frame handles. Typical applications will set theScene
width instead. ThisWindow
will take its width from the scene if it has never been set by the application. Resizing the window by end user does not count as a setting the width by the application. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
- See Also:
-
setHeight
public final void setHeight(double value) Sets the value of the property height.- Property description:
- The height of this
Window
. Changing this attribute will shrink or heighten the height of theWindow
. This value includes any and all decorations which may be added by the Operating System such as the title bar. Typical applications will set theScene
height instead. This window will take its height from the scene if it has never been set by the application. Resizing this window by end user does not count as a setting the height by the application. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
-
getHeight
public final double getHeight()Gets the value of the property height.- Property description:
- The height of this
Window
. Changing this attribute will shrink or heighten the height of theWindow
. This value includes any and all decorations which may be added by the Operating System such as the title bar. Typical applications will set theScene
height instead. This window will take its height from the scene if it has never been set by the application. Resizing this window by end user does not count as a setting the height by the application. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
-
heightProperty
The height of thisWindow
. Changing this attribute will shrink or heighten the height of theWindow
. This value includes any and all decorations which may be added by the Operating System such as the title bar. Typical applications will set theScene
height instead. This window will take its height from the scene if it has never been set by the application. Resizing this window by end user does not count as a setting the height by the application. If thisWindow
is an instance ofStage
, changing this attribute will not visually affect theWindow
whilefullScreen
is true, but will be honored by theWindow
oncefullScreen
becomes false.This property is read-only because it can be changed externally by the underlying platform. Further, setting this property might be ignored on some platforms.
- See Also:
-
requestFocus
public final void requestFocus()Requests that thisWindow
get the input focus. -
isFocused
public final boolean isFocused()Gets the value of the property focused.- Property description:
- Whether or not this
Window
has the keyboard or input focus.
-
focusedProperty
Whether or not thisWindow
has the keyboard or input focus.- See Also:
-
getProperties
Returns an observable map of properties on this node for use primarily by application developers.- Returns:
- an observable map of properties on this node for use primarily by application developers
- Since:
- JavaFX 8u40
-
hasProperties
public boolean hasProperties()Tests if Window has properties.- Returns:
- true if node has properties.
- Since:
- JavaFX 8u40
-
setUserData
Convenience method for setting a single Object property that can be retrieved at a later date. This is functionally equivalent to calling the getProperties().put(Object key, Object value) method. This can later be retrieved by callinggetUserData()
.- Parameters:
value
- The value to be stored - this can later be retrieved by callinggetUserData()
.- Since:
- JavaFX 8u40
-
getUserData
Returns a previously set Object property, or null if no such property has been set using thesetUserData(java.lang.Object)
method.- Returns:
- The Object that was previously set, or null if no property has been set or if null was set.
- Since:
- JavaFX 8u40
-
setScene
Sets the value of thescene
property.The
Scene
to be rendered on thisWindow
. There can only be oneScene
on theWindow
at a time, and aScene
can only be on oneWindow
at a time. Setting aScene
on a differentWindow
will cause the oldWindow
to lose the reference before the new one gains it. You may swapScene
s on aWindow
at any time, even if it is an instance ofStage
and withfullScreen
set totrue
.If the width or height of this
Window
have never been set by the application, setting the scene will cause thisWindow
to take its width or height from that scene. Resizing thisWindow
by end user does not count as setting the width or height by the application.- Default value:
null
- Parameters:
value
- the value for thescene
property- Throws:
IllegalStateException
- if this property is set on a thread other than the JavaFX Application Thread.- See Also:
-
getScene
Gets the value of the property scene.- Property description:
- The
Scene
to be rendered on thisWindow
. There can only be oneScene
on theWindow
at a time, and aScene
can only be on oneWindow
at a time. Setting aScene
on a differentWindow
will cause the oldWindow
to lose the reference before the new one gains it. You may swapScene
s on aWindow
at any time, even if it is an instance ofStage
and withfullScreen
set totrue
.If the width or height of this
Window
have never been set by the application, setting the scene will cause thisWindow
to take its width or height from that scene. Resizing thisWindow
by end user does not count as setting the width or height by the application.An
IllegalStateException
is thrown if this property is set on a thread other than the JavaFX Application Thread. - Default value:
null
-
sceneProperty
TheScene
to be rendered on thisWindow
. There can only be oneScene
on theWindow
at a time, and aScene
can only be on oneWindow
at a time. Setting aScene
on a differentWindow
will cause the oldWindow
to lose the reference before the new one gains it. You may swapScene
s on aWindow
at any time, even if it is an instance ofStage
and withfullScreen
set totrue
.If the width or height of this
Window
have never been set by the application, setting the scene will cause thisWindow
to take its width or height from that scene. Resizing thisWindow
by end user does not count as setting the width or height by the application.An
IllegalStateException
is thrown if this property is set on a thread other than the JavaFX Application Thread.- Default value:
null
- See Also:
-
setOpacity
public final void setOpacity(double value) Sets the value of the property opacity.- Property description:
- Defines the opacity of the
Window
as a value between 0.0 and 1.0. The opacity is reflected across theWindow
, itsDecoration
and itsScene
content. On a JavaFX runtime platform that does not support opacity, assigning a value to this variable will have no visible difference. AWindow
with 0% opacity is fully translucent. Typically, aWindow
with 0% opacity will not receive any mouse events. - Default value:
- 1.0
-
getOpacity
public final double getOpacity()Gets the value of the property opacity.- Property description:
- Defines the opacity of the
Window
as a value between 0.0 and 1.0. The opacity is reflected across theWindow
, itsDecoration
and itsScene
content. On a JavaFX runtime platform that does not support opacity, assigning a value to this variable will have no visible difference. AWindow
with 0% opacity is fully translucent. Typically, aWindow
with 0% opacity will not receive any mouse events. - Default value:
- 1.0
-
opacityProperty
Defines the opacity of theWindow
as a value between 0.0 and 1.0. The opacity is reflected across theWindow
, itsDecoration
and itsScene
content. On a JavaFX runtime platform that does not support opacity, assigning a value to this variable will have no visible difference. AWindow
with 0% opacity is fully translucent. Typically, aWindow
with 0% opacity will not receive any mouse events.- Default value:
- 1.0
- See Also:
-
setOnCloseRequest
Sets the value of the property onCloseRequest.- Property description:
- Called when there is an external request to close this
Window
. The installed event handler can prevent window closing by consuming the received event.
-
getOnCloseRequest
Gets the value of the property onCloseRequest.- Property description:
- Called when there is an external request to close this
Window
. The installed event handler can prevent window closing by consuming the received event.
-
onCloseRequestProperty
Called when there is an external request to close thisWindow
. The installed event handler can prevent window closing by consuming the received event. -
setOnShowing
Sets the value of the property onShowing.- Property description:
- Called just prior to the Window being shown.
-
getOnShowing
Gets the value of the property onShowing.- Property description:
- Called just prior to the Window being shown.
-
onShowingProperty
Called just prior to the Window being shown.- See Also:
-
setOnShown
Sets the value of the property onShown.- Property description:
- Called just after the Window is shown.
-
getOnShown
Gets the value of the property onShown.- Property description:
- Called just after the Window is shown.
-
onShownProperty
Called just after the Window is shown.- See Also:
-
setOnHiding
Sets the value of the property onHiding.- Property description:
- Called just prior to the Window being hidden.
-
getOnHiding
Gets the value of the property onHiding.- Property description:
- Called just prior to the Window being hidden.
-
onHidingProperty
Called just prior to the Window being hidden.- See Also:
-
setOnHidden
Sets the value of the property onHidden.- Property description:
- Called just after the Window has been hidden.
When the
Window
is hidden, this event handler is invoked allowing the developer to clean up resources or perform other tasks when theWindow
is closed.
-
getOnHidden
Gets the value of the property onHidden.- Property description:
- Called just after the Window has been hidden.
When the
Window
is hidden, this event handler is invoked allowing the developer to clean up resources or perform other tasks when theWindow
is closed.
-
onHiddenProperty
Called just after the Window has been hidden. When theWindow
is hidden, this event handler is invoked allowing the developer to clean up resources or perform other tasks when theWindow
is closed.- See Also:
-
isShowing
public final boolean isShowing()Gets the value of the property showing.- Property description:
- Whether or not this
Window
is showing (that is, open on the user's system). The Window might be "showing", yet the user might not be able to see it due to the Window being rendered behind another Window or due to the Window being positioned off the monitor. - Default value:
- false
-
showingProperty
Whether or not thisWindow
is showing (that is, open on the user's system). The Window might be "showing", yet the user might not be able to see it due to the Window being rendered behind another Window or due to the Window being positioned off the monitor.- Default value:
- false
- See Also:
-
show
protected void show()Attempts to show this Window by setting visibility to true- Throws:
IllegalStateException
- if this method is called on a thread other than the JavaFX Application Thread.
-
hide
public void hide()Attempts to hide this Window by setting the visibility to false.- Throws:
IllegalStateException
- if this method is called on a thread other than the JavaFX Application Thread.
-
setEventDispatcher
Sets the value of the property eventDispatcher.- Property description:
- Specifies the event dispatcher for this node. The default event
dispatcher sends the received events to the registered event handlers and
filters. When replacing the value with a new
EventDispatcher
, the new dispatcher should forward events to the replaced dispatcher to maintain the node's default event handling behavior.
-
getEventDispatcher
Gets the value of the property eventDispatcher.- Property description:
- Specifies the event dispatcher for this node. The default event
dispatcher sends the received events to the registered event handlers and
filters. When replacing the value with a new
EventDispatcher
, the new dispatcher should forward events to the replaced dispatcher to maintain the node's default event handling behavior.
-
eventDispatcherProperty
Specifies the event dispatcher for this node. The default event dispatcher sends the received events to the registered event handlers and filters. When replacing the value with a newEventDispatcher
, the new dispatcher should forward events to the replaced dispatcher to maintain the node's default event handling behavior. -
addEventHandler
public final <T extends Event> void addEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Registers an event handler to this node. The handler is called when the node receives anEvent
of the specified type during the bubbling phase of event delivery.- Type Parameters:
T
- the specific event class of the handler- Parameters:
eventType
- the type of the events to receive by the handlereventHandler
- the handler to register- Throws:
NullPointerException
- if the event type or handler is null
-
removeEventHandler
public final <T extends Event> void removeEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Unregisters a previously registered event handler from this node. 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.- Type Parameters:
T
- the specific event class of the handler- Parameters:
eventType
- the event type from which to unregistereventHandler
- the handler to unregister- Throws:
NullPointerException
- if the event type or handler is null
-
addEventFilter
public final <T extends Event> void addEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter) Registers an event filter to this node. The filter is called when the node receives anEvent
of the specified type during the capturing phase of event delivery.- Type Parameters:
T
- the specific event class of the filter- Parameters:
eventType
- the type of the events to receive by the filtereventFilter
- the filter to register- Throws:
NullPointerException
- if the event type or filter is null
-
removeEventFilter
public final <T extends Event> void removeEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter) Unregisters a previously registered event filter from this node. 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.- Type Parameters:
T
- the specific event class of the filter- Parameters:
eventType
- the event type from which to unregistereventFilter
- the filter to unregister- Throws:
NullPointerException
- if the event type or filter is null
-
setEventHandler
protected final <T extends Event> void setEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler) Sets the handler to use for this event type. There can only be one such handler specified at a time. This handler is guaranteed to be called first. This is used for registering the user-defined onFoo event handlers.- Type Parameters:
T
- the specific event class of the handler- Parameters:
eventType
- the event type to associate with the given eventHandlereventHandler
- the handler to register, or null to unregister- Throws:
NullPointerException
- if the event type is null
-
fireEvent
Fires the specified event.This method must be called on the FX user thread.
- Parameters:
event
- the event to fire
-
buildEventDispatchChain
Construct an event dispatch chain for this window.- Specified by:
buildEventDispatchChain
in interfaceEventTarget
- Parameters:
tail
- the initial chain to build from- Returns:
- the resulting event dispatch chain for this window
-