JavaFX 25 · com.sun.javafx.tk.quantum.WindowStage · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static List<WindowStage>	activeWindows
private Window	deadWindow
protected Stage	fxStage
private boolean	isAlwaysOnTop
private boolean	isClosePostponed
private boolean	isInFullScreen
private boolean	isPopupStage
private boolean	isPrimaryStage
private static final Locale	LOCALE
private Modality	modality
private GlassStage	owner
protected Window	platformWindow
private static Map<Window, WindowStage>	platformWindows
private static final ResourceBundle	RESOURCES
private boolean	rtl
private KeyCombination	savedFullScreenExitKey
private StageStyle	style
private boolean	transparent
private OverlayWarning	warning

Access	Constructor and Description
public	WindowStage(Window peerWindow, final StageStyle stageStyle, Modality modality, TKStage owner)

Method Summary

Modifier and Type	Method and Description
pack-priv static void	addActiveWindow(WindowStage window)
private void	applyFullScreen()
public void	close() Overrides com.sun.javafx.tk.quantum.GlassStage.close. Implements com.sun.javafx.tk.TKStage.close.
public void	closePostponed() Overrides default com.sun.javafx.tk.TKStage.closePostponed.
private void	computeAndSetBackground(List<Stop> stops)
public TKScene	createTKScene(boolean depthBuffer, boolean msaa) Implements com.sun.javafx.tk.TKStage.createTKScene. Creates a Scene peer that can be displayed in this Stage peer.
private static void	disposeScenePainter(ViewScene oldScene)
pack-priv void	exitFullScreen()
pack-priv static Image	findBestImage(List<E> icons, int width, int height)
pack-priv static WindowStage	findWindowStage(Window platformWindow)
pack-priv void	fullscreenChanged(final boolean fs)
public float	getOutputScaleX() Implements com.sun.javafx.tk.TKStage.getOutputScaleX.
public float	getOutputScaleY() Implements com.sun.javafx.tk.TKStage.getOutputScaleY.
protected GlassStage	getOwner()
public float	getPlatformScaleX() Implements com.sun.javafx.tk.TKStage.getPlatformScaleX.
public float	getPlatformScaleY() Implements com.sun.javafx.tk.TKStage.getPlatformScaleY.
public final Window	getPlatformWindow()
public long	getRawHandle() Implements com.sun.javafx.tk.TKStage.getRawHandle. Return a handle to the native platform window id.
public final KeyCombination	getSavedFullScreenExitKey()
pack-priv StageStyle	getStyle()
protected ViewScene	getViewScene()
public boolean	grabFocus() Implements com.sun.javafx.tk.TKStage.grabFocus. Grabs focus on this window.
pack-priv final void	handleFocusDisabled()
public final WindowStage	init(GlassSystemMenu sysmenu)
private void	initPlatformWindow()
pack-priv boolean	isVisible() Overrides com.sun.javafx.tk.quantum.GlassStage.isVisible.
public boolean	needsUpdateWindow()
private void	notifyHeaderButtonMetricsChanged()
public void	postponeClose() Overrides default com.sun.javafx.tk.TKStage.postponeClose.
public void	releaseInput() Implements com.sun.javafx.tk.TKStage.releaseInput. Native keyboard for text input is no longer necessary.
pack-priv static void	removeActiveWindow(WindowStage window)
public void	requestFocus() Overrides com.sun.javafx.tk.quantum.GlassStage.requestFocus. Implements com.sun.javafx.tk.TKStage.requestFocus.
public void	requestFocus(FocusCause cause) Overrides com.sun.javafx.tk.quantum.GlassStage.requestFocus. Implements com.sun.javafx.tk.TKStage.requestFocus.
public void	requestInput(String text, int type, double width, double height, double Mxx, double Mxy, double Mxz, double Mxt, double Myx, double Myy, double Myz, double Myt, double Mzx, double Mzy, double Mzz, double Mzt) Implements com.sun.javafx.tk.TKStage.requestInput. Requests text input in form of native keyboard for text component contained by this Window.
protected void	requestToFront()
public void	setAlwaysOnTop(boolean alwaysOnTop) Implements com.sun.javafx.tk.TKStage.setAlwaysOnTop.
public void	setBounds(float x, float y, boolean xSet, boolean ySet, float w, float h, float cw, float ch, float xGravity, float yGravity, float renderScaleX, float renderScaleY) Implements com.sun.javafx.tk.TKStage.setBounds. Sets the window bounds to the specified values.
public void	setEnabled(boolean enabled) Implements com.sun.javafx.tk.TKStage.setEnabled. Whether mouse/keyboard events should be sent to this window.
public void	setFullScreen(boolean fullScreen) Implements com.sun.javafx.tk.TKStage.setFullScreen.
public void	setIconified(boolean iconified) Implements com.sun.javafx.tk.TKStage.setIconified.
public void	setIcons(List<E> icons) Implements com.sun.javafx.tk.TKStage.setIcons.
pack-priv final void	setIsPopup()
pack-priv final void	setIsPrimary()
public void	setMaximized(boolean maximized) Implements com.sun.javafx.tk.TKStage.setMaximized.
public void	setMaximumSize(int maxWidth, int maxHeight) Implements com.sun.javafx.tk.TKStage.setMaximumSize.
public void	setMinimumSize(int minWidth, int minHeight) Implements com.sun.javafx.tk.TKStage.setMinimumSize.
public void	setOpacity(float opacity) Implements com.sun.javafx.tk.TKStage.setOpacity.
protected void	setPlatformEnabled(boolean enabled) Overrides com.sun.javafx.tk.quantum.GlassStage.setPlatformEnabled.
pack-priv void	setPlatformWindowClosed()
public void	setPrefHeaderButtonHeight(double height) Overrides com.sun.javafx.tk.quantum.GlassStage.setPrefHeaderButtonHeight. Implements com.sun.javafx.tk.TKStage.setPrefHeaderButtonHeight.
public void	setResizable(boolean resizable) Implements com.sun.javafx.tk.TKStage.setResizable.
public void	setRTL(boolean b) Implements com.sun.javafx.tk.TKStage.setRTL.
public void	setScene(TKScene The peer of the scene to be displayed scene) Overrides com.sun.javafx.tk.quantum.GlassStage.setScene. Implements com.sun.javafx.tk.TKStage.setScene. Set the scene to be displayed in this stage
public void	setTitle(String title) Implements com.sun.javafx.tk.TKStage.setTitle.
public void	setTKStageListener(TKStageListener listener) Overrides com.sun.javafx.tk.quantum.GlassStage.setTKStageListener. Implements com.sun.javafx.tk.TKStage.setTKStageListener. Listener for this stage peer to pass updates and events back to the stage
public void	setVisible(final boolean visible) Overrides com.sun.javafx.tk.quantum.GlassStage.setVisible. Implements com.sun.javafx.tk.TKStage.setVisible. Set if the stage is visible on screen
pack-priv void	setWarning(OverlayWarning newWarning)
public void	toBack() Implements com.sun.javafx.tk.TKStage.toBack.
public void	toFront() Implements com.sun.javafx.tk.TKStage.toFront.
public void	ungrabFocus() Implements com.sun.javafx.tk.TKStage.ungrabFocus. Manually ungrabs focus grabbed on this window previously.

Inherited from com.sun.javafx.tk.quantum.GlassStage:: getScene requestClosingAllWindows setImportant windowsSetEnabled

activeWindows	back to summary
private static List<WindowStage> activeWindows

deadWindow	back to summary
private Window deadWindow

fxStage	back to summary
protected Stage fxStage

isAlwaysOnTop	back to summary
private boolean isAlwaysOnTop

isClosePostponed	back to summary
private boolean isClosePostponed

isInFullScreen	back to summary
private boolean isInFullScreen

isPopupStage	back to summary
private boolean isPopupStage

isPrimaryStage	back to summary
private boolean isPrimaryStage

LOCALE	back to summary
private static final Locale LOCALE

modality	back to summary
private Modality modality

owner	back to summary
private GlassStage owner

platformWindow	back to summary
protected Window platformWindow

platformWindows	back to summary
private static Map<Window, WindowStage> platformWindows

RESOURCES	back to summary
private static final ResourceBundle RESOURCES

rtl	back to summary
private boolean rtl

savedFullScreenExitKey	back to summary
private KeyCombination savedFullScreenExitKey

style	back to summary
private StageStyle style

transparent	back to summary
private boolean transparent

warning	back to summary
private OverlayWarning warning

WindowStage	back to summary
public WindowStage(Window peerWindow, final StageStyle stageStyle, Modality modality, TKStage owner)

Method Detail

addActiveWindow	back to summary
pack-priv static void addActiveWindow(WindowStage window)

applyFullScreen	back to summary
private void applyFullScreen()

close	back to summary
public void close() Overrides com.sun.javafx.tk.quantum.GlassStage.close. Implements com.sun.javafx.tk.TKStage.close. Annotations @Override

back to summary

public void close()

Overrides com.sun.javafx.tk.quantum.GlassStage.close.

Implements com.sun.javafx.tk.TKStage.close.

Annotations

@Override

closePostponed	back to summary
public void closePostponed() Overrides default com.sun.javafx.tk.TKStage.closePostponed. Annotations @Override

closePostponed

back to summary

public void closePostponed()

Overrides default com.sun.javafx.tk.TKStage.closePostponed.

Annotations

@Override

computeAndSetBackground	back to summary
private void computeAndSetBackground(List<Stop> stops)

createTKScene	back to summary
public TKScene createTKScene(boolean depthBuffer, boolean msaa) Implements com.sun.javafx.tk.TKStage.createTKScene. Doc from com.sun.javafx.tk.TKStage.createTKScene. Creates a Scene peer that can be displayed in this Stage peer. Annotations @Override

createTKScene

back to summary

public TKScene createTKScene(boolean depthBuffer, boolean msaa)

Implements com.sun.javafx.tk.TKStage.createTKScene.

Doc from com.sun.javafx.tk.TKStage.createTKScene.

Creates a Scene peer that can be displayed in this Stage peer.

Annotations

@Override

disposeScenePainter	back to summary
private static void disposeScenePainter(ViewScene oldScene)

exitFullScreen	back to summary
pack-priv void exitFullScreen()

findBestImage	back to summary
pack-priv static Image findBestImage(List<E> icons, int width, int height)

findWindowStage	back to summary
pack-priv static WindowStage findWindowStage(Window platformWindow)

fullscreenChanged	back to summary
pack-priv void fullscreenChanged(final boolean fs)

getOutputScaleX	back to summary
public float getOutputScaleX() Implements com.sun.javafx.tk.TKStage.getOutputScaleX. Annotations @Override

getOutputScaleX

back to summary

public float getOutputScaleX()

Implements com.sun.javafx.tk.TKStage.getOutputScaleX.

Annotations

@Override

getOutputScaleY	back to summary
public float getOutputScaleY() Implements com.sun.javafx.tk.TKStage.getOutputScaleY. Annotations @Override

getOutputScaleY

back to summary

public float getOutputScaleY()

Implements com.sun.javafx.tk.TKStage.getOutputScaleY.

Annotations

@Override

getOwner	back to summary
protected GlassStage getOwner()

getPlatformScaleX	back to summary
public float getPlatformScaleX() Implements com.sun.javafx.tk.TKStage.getPlatformScaleX. Annotations @Override

getPlatformScaleX

back to summary

public float getPlatformScaleX()

Implements com.sun.javafx.tk.TKStage.getPlatformScaleX.

Annotations

@Override

getPlatformScaleY	back to summary
public float getPlatformScaleY() Implements com.sun.javafx.tk.TKStage.getPlatformScaleY. Annotations @Override

getPlatformScaleY

back to summary

public float getPlatformScaleY()

Implements com.sun.javafx.tk.TKStage.getPlatformScaleY.

Annotations

@Override

getPlatformWindow	back to summary
public final Window getPlatformWindow()

getRawHandle	back to summary
public long getRawHandle() Implements com.sun.javafx.tk.TKStage.getRawHandle. Doc from com.sun.javafx.tk.TKStage.getRawHandle. Return a handle to the native platform window id. Annotations @Override

getRawHandle

back to summary

public long getRawHandle()

Implements com.sun.javafx.tk.TKStage.getRawHandle.

Doc from com.sun.javafx.tk.TKStage.getRawHandle.

Return a handle to the native platform window id.

Annotations

@Override

getSavedFullScreenExitKey	back to summary
public final KeyCombination getSavedFullScreenExitKey()

getStyle	back to summary
pack-priv StageStyle getStyle()

getViewScene	back to summary
protected ViewScene getViewScene()

grabFocus back to summary

grabFocus	back to summary
public boolean grabFocus() Implements com.sun.javafx.tk.TKStage.grabFocus. Doc from com.sun.javafx.tk.TKStage.grabFocus. Grabs focus on this window. All mouse clicks that occur in this window's client area or client-areas of any of its unfocusable owned windows are delivered as usual. Whenever a click occurs on another app's window (not related via the ownership relation with this one, or a focusable owned window), or on non-client area of any window (titlebar, etc.), or any third-party app's window, or native OS GUI (e.g. a taskbar), the grab is automatically reset, and the window that held the grab receives the FOCUS_UNGRAB event. Note that for this functionality to work correctly, the window must have a focus upon calling this method. All owned popup windows that should be operable during the grabbed focus state (e.g. nested popup menus) must be unfocusable (see `setFocusable`). Clicking a focusable owned window will reset the grab due to a focus transfer. The click that occurs in another window and causes resetting of the grab may or may not be delivered to that other window depending on the native OS behavior. If any of the application's windows already holds the grab, it is reset prior to grabbing the focus for this window. The method may be called multiple times for one window. Subsequent calls do not affect the grab status unless it is reset between the calls, in which case the focus is grabbed again. Note that grabbing the focus on an application window may prevent delivering certain events to other applications until the grab is reset. Therefore, if the application has finished showing popup windows based on a user action (e.g. clicking a menu item), and doesn't require the grab any more, it should call the `ungrabFocus` method. The FOCUS_UNGRAB event signals that the grab has been reset. A user event handler associated with a menu item must be invoked after resetting the grab. Otherwise, if a developer debugs the application and has installed a breakpoint in the event handler, the debugger may become unoperable due to events blocking for other applications on some platforms. Annotations @Override

public boolean grabFocus()

Implements com.sun.javafx.tk.TKStage.grabFocus.

Doc from com.sun.javafx.tk.TKStage.grabFocus.

Grabs focus on this window. All mouse clicks that occur in this window's client area or client-areas of any of its unfocusable owned windows are delivered as usual. Whenever a click occurs on another app's window (not related via the ownership relation with this one, or a focusable owned window), or on non-client area of any window (titlebar, etc.), or any third-party app's window, or native OS GUI (e.g. a taskbar), the grab is automatically reset, and the window that held the grab receives the FOCUS_UNGRAB event. Note that for this functionality to work correctly, the window must have a focus upon calling this method. All owned popup windows that should be operable during the grabbed focus state (e.g. nested popup menus) must be unfocusable (see setFocusable). Clicking a focusable owned window will reset the grab due to a focus transfer. The click that occurs in another window and causes resetting of the grab may or may not be delivered to that other window depending on the native OS behavior. If any of the application's windows already holds the grab, it is reset prior to grabbing the focus for this window. The method may be called multiple times for one window. Subsequent calls do not affect the grab status unless it is reset between the calls, in which case the focus is grabbed again. Note that grabbing the focus on an application window may prevent delivering certain events to other applications until the grab is reset. Therefore, if the application has finished showing popup windows based on a user action (e.g. clicking a menu item), and doesn't require the grab any more, it should call the ungrabFocus method. The FOCUS_UNGRAB event signals that the grab has been reset. A user event handler associated with a menu item must be invoked after resetting the grab. Otherwise, if a developer debugs the application and has installed a breakpoint in the event handler, the debugger may become unoperable due to events blocking for other applications on some platforms.

Annotations

@Override

handleFocusDisabled	back to summary
pack-priv final void handleFocusDisabled()

init	back to summary
public final WindowStage init(GlassSystemMenu sysmenu)

initPlatformWindow	back to summary
private void initPlatformWindow()

isVisible	back to summary
pack-priv boolean isVisible() Overrides com.sun.javafx.tk.quantum.GlassStage.isVisible. Annotations @Override

isVisible

back to summary

pack-priv boolean isVisible()

Overrides com.sun.javafx.tk.quantum.GlassStage.isVisible.

Annotations

@Override

needsUpdateWindow	back to summary
public boolean needsUpdateWindow()

notifyHeaderButtonMetricsChanged	back to summary
private void notifyHeaderButtonMetricsChanged()

postponeClose

back to summary

public void postponeClose()

Overrides default com.sun.javafx.tk.TKStage.postponeClose.

Annotations

@Override

releaseInput

back to summary

public void releaseInput()

Implements com.sun.javafx.tk.TKStage.releaseInput.

Doc from com.sun.javafx.tk.TKStage.releaseInput.

Native keyboard for text input is no longer necessary. Keyboard will be hidden and native text input component too.

Annotations

@Override

removeActiveWindow	back to summary
pack-priv static void removeActiveWindow(WindowStage window)

requestFocus

back to summary

public void requestFocus()

Overrides com.sun.javafx.tk.quantum.GlassStage.requestFocus.

Implements com.sun.javafx.tk.TKStage.requestFocus.

Annotations

@Override

requestFocus

back to summary

public void requestFocus(FocusCause cause)

Overrides com.sun.javafx.tk.quantum.GlassStage.requestFocus.

Implements com.sun.javafx.tk.TKStage.requestFocus.

Annotations

@Override

requestInput

back to summary

public void requestInput(String text, int type, double width, double height, double Mxx, double Mxy, double Mxz, double Mxt, double Myx, double Myy, double Myz, double Myt, double Mzx, double Mzy, double Mzz, double Mzt)

Implements com.sun.javafx.tk.TKStage.requestInput.

Doc from com.sun.javafx.tk.TKStage.requestInput.

Requests text input in form of native keyboard for text component contained by this Window. Native text input component is drawn on the place of JavaFX component to cover it completely and to provide native text editing techniques. Any change of text is immediately reflected in JavaFX text component.

Annotations

@Override

requestToFront	back to summary
protected void requestToFront()

setAlwaysOnTop

back to summary

public void setAlwaysOnTop(boolean alwaysOnTop)

Implements com.sun.javafx.tk.TKStage.setAlwaysOnTop.

Annotations

@Override

setBounds back to summary

public void setBounds(float x, float y, boolean xSet, boolean ySet, float w, float h, float cw, float ch, float xGravity, float yGravity, float renderScaleX, float renderScaleY)

Implements com.sun.javafx.tk.TKStage.setBounds.

Doc from com.sun.javafx.tk.TKStage.setBounds.

Sets the window bounds to the specified values. Gravity values specify how to correct window location if only its size changes (for example when stage decorations are added). User initiated resizing should be ignored and must not influence window location through this mechanism. The corresponding correction formulas are: x -= xGravity * deltaW y -= yGravity * deltaH

Annotations

@Override

setEnabled

back to summary

public void setEnabled(boolean enabled)

Implements com.sun.javafx.tk.TKStage.setEnabled.

Doc from com.sun.javafx.tk.TKStage.setEnabled.

Whether mouse/keyboard events should be sent to this window.

Annotations

@Override

setFullScreen

back to summary

public void setFullScreen(boolean fullScreen)

Implements com.sun.javafx.tk.TKStage.setFullScreen.

Annotations

@Override

setIconified

back to summary

public void setIconified(boolean iconified)

Implements com.sun.javafx.tk.TKStage.setIconified.

Annotations

@Override

setIcons

back to summary

public void setIcons(List<E> icons)

Implements com.sun.javafx.tk.TKStage.setIcons.

Annotations

@Override

setIsPopup	back to summary
pack-priv final void setIsPopup()

setIsPrimary	back to summary
pack-priv final void setIsPrimary()

setMaximized

back to summary

public void setMaximized(boolean maximized)

Implements com.sun.javafx.tk.TKStage.setMaximized.

Annotations

@Override

setMaximumSize

back to summary

public void setMaximumSize(int maxWidth, int maxHeight)

Implements com.sun.javafx.tk.TKStage.setMaximumSize.

Annotations

@Override

setMinimumSize

back to summary

public void setMinimumSize(int minWidth, int minHeight)

Implements com.sun.javafx.tk.TKStage.setMinimumSize.

Annotations

@Override

setOpacity

back to summary

public void setOpacity(float opacity)

Implements com.sun.javafx.tk.TKStage.setOpacity.

Annotations

@Override

setPlatformEnabled

back to summary

protected void setPlatformEnabled(boolean enabled)

Overrides com.sun.javafx.tk.quantum.GlassStage.setPlatformEnabled.

Annotations

@Override

setPlatformWindowClosed	back to summary
pack-priv void setPlatformWindowClosed()

setPrefHeaderButtonHeight

back to summary

public void setPrefHeaderButtonHeight(double height)

Overrides com.sun.javafx.tk.quantum.GlassStage.setPrefHeaderButtonHeight.

Implements com.sun.javafx.tk.TKStage.setPrefHeaderButtonHeight.

Annotations

@Override

setResizable

back to summary

public void setResizable(boolean resizable)

Implements com.sun.javafx.tk.TKStage.setResizable.

Annotations

@Override

setRTL

back to summary

public void setRTL(boolean b)

Implements com.sun.javafx.tk.TKStage.setRTL.

Annotations

@Override

setScene

back to summary

public void setScene(TKScene scene)

Overrides com.sun.javafx.tk.quantum.GlassStage.setScene.

Implements com.sun.javafx.tk.TKStage.setScene.

Set the scene to be displayed in this stage

Parameters

scene:TKScene: The peer of the scene to be displayed

Annotations

@Override

setTitle

back to summary

public void setTitle(String title)

Implements com.sun.javafx.tk.TKStage.setTitle.

Annotations

@Override

setTKStageListener

back to summary

public void setTKStageListener(TKStageListener listener)

Overrides com.sun.javafx.tk.quantum.GlassStage.setTKStageListener.

Implements com.sun.javafx.tk.TKStage.setTKStageListener.

Doc from com.sun.javafx.tk.quantum.GlassStage.setTKStageListener.

Listener for this stage peer to pass updates and events back to the stage

Annotations

@Override

setVisible

back to summary

public void setVisible(final boolean visible)

Overrides com.sun.javafx.tk.quantum.GlassStage.setVisible.

Implements com.sun.javafx.tk.TKStage.setVisible.

Doc from com.sun.javafx.tk.quantum.GlassStage.setVisible.

Set if the stage is visible on screen

Annotations

@Override

setWarning	back to summary
pack-priv void setWarning(OverlayWarning newWarning)

toBack

back to summary

public void toBack()

Implements com.sun.javafx.tk.TKStage.toBack.

Annotations

@Override

toFront

back to summary

public void toFront()

Implements com.sun.javafx.tk.TKStage.toFront.

Annotations

@Override

ungrabFocus

back to summary

public void ungrabFocus()

Implements com.sun.javafx.tk.TKStage.ungrabFocus.

Doc from com.sun.javafx.tk.TKStage.ungrabFocus.

Manually ungrabs focus grabbed on this window previously. This method resets the grab, and forces sending of the FOCUS_UNGRAB event. It should be used when popup windows (such as menus) should be dismissed manually, e.g. when a user clicks a menu item which usually causes the menus to hide.

Annotations

@Override

public Class WindowStage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail