JavaFX 24 · javafx.stage.Window · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private class	Window.SceneModel
private class	Window.TKBoundsConfigurator Caches all requested bounds settings and applies them at once during the next pulse.

Field Summary

Modifier and Type	Field and Description
private static final float	CENTER_ON_SCREEN_X_FRACTION
private static final float	CENTER_ON_SCREEN_Y_FRACTION
private ObjectProperty<EventDispatcher>	eventDispatcher Specifies the event dispatcher for this node.
private ReadOnlyBooleanWrapper	focused Whether or not this `Window` has the keyboard or input focus.
private int	focusGrabCounter
private BooleanProperty	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.
pack-priv boolean	hasBeenVisible
private ReadOnlyDoubleWrapper	height The height of this `Window`.
private boolean	heightExplicit
private WindowEventDispatcher	internalEventDispatcher
private ObjectProperty<EventHandler<WindowEvent>>	onCloseRequest Called when there is an external request to close this `Window`.
private ObjectProperty<EventHandler<WindowEvent>>	onHidden Called just after the Window has been hidden.
private ObjectProperty<EventHandler<WindowEvent>>	onHiding Called just prior to the Window being hidden.
private ObjectProperty<EventHandler<WindowEvent>>	onShowing Called just prior to the Window being shown.
private ObjectProperty<EventHandler<WindowEvent>>	onShown Called just after the Window is shown.
private DoubleProperty	opacity Defines the opacity of the `Window` as a value between 0.0 and 1.0.
private ReadOnlyDoubleWrapper	outputScaleX 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.
private ReadOnlyDoubleWrapper	outputScaleY 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.
private TKStage	peer
private Window.TKBoundsConfigurator	peerBoundsConfigurator
private WindowPeerListener	peerListener
private ObservableMap<Object, Object>	properties
private DoubleProperty	renderScaleX The horizontal scale that the `Window` will use when rendering its `Scene` to the rendering buffer.
private DoubleProperty	renderScaleY The vertical scale that the `Window` will use when rendering its `Scene` to the rendering buffer.
private Window.SceneModel	scene The `Scene` to be rendered on this `Window`.
private final ReadOnlyObjectWrapper<Screen>	screen
private ReadOnlyBooleanWrapper	showing Whether or not this `Window` is showing (that is, open on the user's system).
private boolean	sizeToScene Indicates if a user requested the window to be sized to match the scene size.
private static ObservableList<Window>	unmodifiableWindows
private static final Object	USER_DATA_KEY
private ReadOnlyDoubleWrapper	width The width of this `Window`.
private boolean	widthExplicit
private WindowHelper	windowHelper
private static ObservableList<Window>	windows A list of all the currently _showing_ windows.
private ReadOnlyDoubleWrapper	x The horizontal location of this `Window` on the screen.
private boolean	xExplicit
private ReadOnlyDoubleWrapper	y The vertical location of this `Window` on the screen.
private boolean	yExplicit

Access	Constructor and Description
protected	Window() Constructor for subclasses to call.

Method Summary

Modifier and Type	Method and Description
public final <T extends Event> void	addEventFilter(final EventType<T> the type of the events received by the filter eventType, final EventHandler<? super T> the event filter eventFilter) Overrides default javafx.event.EventTarget.addEventFilter. Registers an event filter for this target.
public final <T extends Event> void	addEventHandler(final EventType<T> the type of the events received by the handler eventType, final EventHandler<? super T> the event handler eventHandler) Overrides default javafx.event.EventTarget.addEventHandler. Registers an event handler for this target.
private void	adjustSize(boolean selfSizePriority)
pack-priv final void	applyBounds()
public EventDispatchChain	buildEventDispatchChain(EventDispatchChain the initial chain to build from tail) Implements javafx.event.EventTarget.buildEventDispatchChain. Construct an event dispatch chain for this target.
public void	centerOnScreen() Sets x and y properties on this Window so that it is centered on the current screen.
pack-priv WindowEventDispatcher	createInternalEventDispatcher()
pack-priv void	decreaseFocusGrabCounter()
private void	doVisibleChanged(boolean visible)
private void	doVisibleChanging(boolean visible)
public final ObjectProperty<EventDispatcher>	eventDispatcherProperty()
public final void	fireEvent(Event the event to fire event) Fires the specified event.
private void	focusChanged(final boolean newIsFocused)
public final ReadOnlyBooleanProperty	focusedProperty()
public final BooleanProperty	forceIntegerRenderScaleProperty()
public final EventDispatcher	getEventDispatcher()
public final double	getHeight()
pack-priv WindowEventDispatcher	getInternalEventDispatcher()
public final EventHandler<WindowEvent>	getOnCloseRequest()
public final EventHandler<WindowEvent>	getOnHidden()
public final EventHandler<WindowEvent>	getOnHiding()
public final EventHandler<WindowEvent>	getOnShowing()
public final EventHandler<WindowEvent>	getOnShown()
public final double	getOpacity()
public final double	getOutputScaleX()
public final double	getOutputScaleY()
pack-priv TKStage	getPeer()
pack-priv WindowPeerListener	getPeerListener()
public final ObservableMap<Object, Object>	Returns: an observable map of properties on this node for use primarily by application developers getProperties() Returns an observable map of properties on this node for use primarily by application developers.
public final double	getRenderScaleX()
public final double	getRenderScaleY()
public final Scene	getScene()
public Object	Returns: The Object that was previously set, or null if no property has been set or if null was set. getUserData() Returns a previously set Object property, or null if no such property has been set using the `Window#setUserData(java.lang.Object)` method.
public final double	getWidth()
pack-priv Window	getWindowOwner()
public static ObservableList<Window>	Returns: A list containing all windows that are currently showing. getWindows() Returns a list containing a reference to the currently showing JavaFX windows.
private Screen	getWindowScreen()
public final double	getX()
public final double	getY()
public boolean	Returns: true if node has properties. hasProperties() Tests if Window has properties.
public final ReadOnlyDoubleProperty	heightProperty()
public void	hide() Attempts to hide this Window by setting the visibility to false.
pack-priv void	increaseFocusGrabCounter()
private void	initializeInternalEventDispatcher()
public final boolean	isFocused()
public final boolean	isForceIntegerRenderScale()
public final boolean	isShowing()
pack-priv boolean	Returns: true if allowed, false otherwise isSizeToSceneAllowed() Determines whether the `sizeToScene()` request is allowed or not.
pack-priv void	notifyLocationChanged(double the new window x position newX, double the new window y position newY) Notification from the windowing system that the window's position has changed.
private void	notifyScreenChanged(Object from, Object to)
pack-priv void	notifySizeChanged(double the new window width newWidth, double the new window height newHeight) Notification from the windowing system that the window's size has changed.
public final ObjectProperty<EventHandler<WindowEvent>>	onCloseRequestProperty()
public final ObjectProperty<EventHandler<WindowEvent>>	onHiddenProperty()
public final ObjectProperty<EventHandler<WindowEvent>>	onHidingProperty()
public final ObjectProperty<EventHandler<WindowEvent>>	onShowingProperty()
public final ObjectProperty<EventHandler<WindowEvent>>	onShownProperty()
public final DoubleProperty	opacityProperty()
public final ReadOnlyDoubleProperty	outputScaleXProperty()
public final ReadOnlyDoubleProperty	outputScaleYProperty()
public final <T extends Event> void	removeEventFilter(final EventType<T> the event type from which to unregister eventType, final EventHandler<? super T> the event filter eventFilter) Overrides default javafx.event.EventTarget.removeEventFilter. Unregisters a previously registered event filter from this target.
public final <T extends Event> void	removeEventHandler(final EventType<T> the event type from which to unregister eventType, final EventHandler<? super T> the event handler eventHandler) Overrides default javafx.event.EventTarget.removeEventHandler. Unregisters a previously registered event handler from this target.
public final DoubleProperty	renderScaleXProperty()
public final DoubleProperty	renderScaleYProperty()
public final void	requestFocus() Requests that this `Window` get the input focus.
public final ReadOnlyObjectProperty<Scene>	sceneProperty()
private ReadOnlyObjectProperty<Screen>	screenProperty()
public final void	setEventDispatcher(EventDispatcher value)
protected final < the specific event class of the handler T extends Event> void	setEventHandler(final EventType<T> the event type to associate with the given eventHandler eventType, final EventHandler<? super T> the handler to register, or null to unregister eventHandler) Sets the handler to use for this event type.
pack-priv final void	setFocused(boolean value)
public final void	setForceIntegerRenderScale(boolean forced)
public final void	setHeight(double value)
public final void	setOnCloseRequest(EventHandler<WindowEvent> value)
public final void	setOnHidden(EventHandler<WindowEvent> value)
public final void	setOnHiding(EventHandler<WindowEvent> value)
public final void	setOnShowing(EventHandler<WindowEvent> value)
public final void	setOnShown(EventHandler<WindowEvent> value)
public final void	setOpacity(double value)
pack-priv void	setPeer(TKStage peer)
pack-priv void	setPeerListener(WindowPeerListener peerListener)
public final void	setRenderScaleX(double scale)
public final void	setRenderScaleY(double scale)
protected void	setScene(Scene the value for the `scene` property value) Sets the value of the `scene` property.
private void	setShowing(boolean value)
public void	setUserData(Object The value to be stored - this can later be retrieved by calling `Window#getUserData()`. value) Convenience method for setting a single Object property that can be retrieved at a later date.
public final void	setWidth(double value)
public final void	setX(double value)
pack-priv void	setXInternal(double value)
public final void	setY(double value)
pack-priv void	setYInternal(double value)
protected void	show() Attempts to show this Window by setting visibility to true
public final ReadOnlyBooleanProperty	showingProperty()
public void	sizeToScene() Set the width and height of this Window to match the size of the content of this Window's Scene.
private void	updateOutputScales(double sx, double sy)
pack-priv void	updateRenderScales(double sx, double sy)
public final ReadOnlyDoubleProperty	widthProperty()
public final ReadOnlyDoubleProperty	xProperty()
public final ReadOnlyDoubleProperty	yProperty()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class Window

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary