The JavaFX Stage class is the top level JavaFX container. The primary Stage is constructed by the platform. Additional Stage objects may be constructed by the application.

Stage 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 javafx.application.Application class and the Platform#startup(Runnable) method for more information.

Some Stage 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 platform without a window manager might ignore the iconified property.

Style

A stage has one of the following styles:

StageStyle#DECORATED - a stage with a solid white background and platform decorations.
StageStyle#UNDECORATED - a stage with a solid white background and no decorations.
StageStyle#TRANSPARENT - a stage with a transparent background and no decorations.
StageStyle#UTILITY - a stage with a solid white background and minimal platform decorations.

The style must be initialized before the stage is made visible.

On some platforms decorations might not be available. For example, on some mobile or embedded devices. In these cases a request for a DECORATED or UTILITY window will be accepted, but no decorations will be shown.

Owner

A stage can optionally have an owner Window. When a window is a stage's owner, it is said to be the parent of that stage.

Owned Stages are tied to the parent Window. An owned stage will always be on top of its parent window. When a parent window is closed or iconified, then all owned windows will be affected as well. Owned Stages cannot be independantly iconified.

The owner must be initialized before the stage is made visible.

Modality

A stage has one of the following modalities:

Modality#NONE - a stage that does not block any other window.
Modality#WINDOW_MODAL - a stage that blocks input events from being delivered to all windows from its owner (parent) to its root. Its root is the closest ancestor window without an owner.
Modality#APPLICATION_MODAL - a stage that blocks input events from being delivered to all windows from the same application, except for those from its child hierarchy.

When a window is blocked by a modal stage its Z-order relative to its ancestors is preserved, and it receives no input events and no window activation events, but continues to animate and render normally. Note that showing a modal stage does not necessarily block the caller. The show method returns immediately regardless of the modality of the stage. Use the showAndWait method if you need to block the caller until the modal stage is hidden (closed). The modality must be initialized before the stage is made visible.

Example:


import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.scene.text.Font;
import javafx.scene.text.Text;
import javafx.stage.Stage;

public class HelloWorld extends Application {

    @Override public void start(Stage stage) {
        Text text = new Text(10, 40, "Hello World!");
        text.setFont(new Font(40));
        Scene scene = new Scene(new Group(text));

        stage.setTitle("Welcome to JavaFX!");
        stage.setScene(scene);
        stage.sizeToScene();
        stage.show();
    }

    public static void main(String[] args) {
        Application.launch(args);
    }
}

produces the following on Windows:

A visual rendering
of a JavaFX Stage on Windows

produces the following on Mac OSX:

A visual rendering
of a JavaFX Stage on Mac OSX

produces the following on Linux:

A visual rendering
of a JavaFX Stage on Linux

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	Stage.ResizableProperty

Field Summary

Modifier and Type	Field and Description
private ReadOnlyBooleanWrapper	alwaysOnTop Defines whether this `Stage` is kept on top of other windows.
private ReadOnlyBooleanWrapper	fullScreen Specifies whether this `Stage` should be a full-screen, undecorated window.
private final ObjectProperty<KeyCombination>	fullScreenExitCombination
private final ObjectProperty<String>	fullScreenExitHint Specifies the text to show when a user enters full screen mode, usually used to indicate the way a user should go about exiting out of full screen mode.
private ReadOnlyBooleanWrapper	iconified Defines whether the `Stage` is iconified or not.
private ObservableList<Image>	icons Defines the icon images to be used in the window decorations and when minimized.
private boolean	important
private boolean	inNestedEventLoop
private DoubleProperty	maxHeight Defines the maximum height of this `Stage`.
private ReadOnlyBooleanWrapper	maximized Defines whether the `Stage` is maximized or not.
private DoubleProperty	maxWidth Defines the maximum width of this `Stage`.
private DoubleProperty	minHeight Defines the minimum height of this `Stage`.
private DoubleProperty	minWidth Defines the minimum width of this `Stage`.
private Modality	modality
private Window	owner
private boolean	primary
private BooleanProperty	resizable Defines whether the `Stage` is resizable or not by the user.
private static final StagePeerListener.StageAccessor	STAGE_ACCESSOR
private StageStyle	style
private StringProperty	title Defines the title of the `Stage`.

Inherited from javafx.stage.Window:: hasBeenVisible

Constructor Summary

Access	Constructor and Description
public	Stage() Creates a new instance of decorated `Stage`.
public	Stage(StageStyle The style of the `Stage` style) Creates a new instance of `Stage`.

Method Summary

Modifier and Type	Method and Description
public final ReadOnlyBooleanProperty	alwaysOnTopProperty()
private ReadOnlyBooleanWrapper	alwaysOnTopPropertyImpl()
public void	close() Closes this `Stage`.
private void	doVisibleChanged(boolean value) Hides javafx.stage.Window.doVisibleChanged.
private void	doVisibleChanging(boolean value) Hides javafx.stage.Window.doVisibleChanging.
public final ObjectProperty<String>	fullScreenExitHintProperty()
public final ObjectProperty<KeyCombination>	Returns: the property. fullScreenExitKeyProperty() Get the property for the Full Screen exit key combination.
public final ReadOnlyBooleanProperty	fullScreenProperty()
private ReadOnlyBooleanWrapper	fullScreenPropertyImpl()
public final String	getFullScreenExitHint()
public final KeyCombination	Returns: the current setting (null for system default) getFullScreenExitKeyCombination() Get the current sequence used to exit Full Screen mode.
public final ObservableList<Image>	Returns: An observable list of icons of this window getIcons() Gets the icon images to be used in the window decorations and when minimized.
public final double	getMaxHeight()
public final double	getMaxWidth()
public final double	getMinHeight()
public final double	getMinWidth()
public final Modality	Returns: the modality. getModality() Retrieves the modality attribute for this stage.
public final Window	Returns: the owner Window. getOwner() Retrieves the owner Window for this stage, or null for an unowned stage.
public final StageStyle	Returns: the stage style. getStyle() Retrieves the style attribute for this stage.
public final String	getTitle()
pack-priv Window	getWindowOwner() Overrides javafx.stage.Window.getWindowOwner.
public final ReadOnlyBooleanProperty	iconifiedProperty()
private final ReadOnlyBooleanWrapper	iconifiedPropertyImpl()
public final void	initModality(Modality the modality for this stage. modality) Specifies the modality for this stage.
public final void	initOwner(Window the owner for this stage. owner) Specifies the owner Window for this stage, or null for a top-level, unowned stage.
public final void	initStyle(StageStyle the style for this stage. style) Specifies the style for this stage.
public final boolean	isAlwaysOnTop()
public final boolean	isFullScreen()
public final boolean	isIconified()
private boolean	isImportant()
public final boolean	isMaximized()
pack-priv boolean	isPrimary()
public final boolean	isResizable()
pack-priv boolean	isSizeToSceneAllowed() Overrides javafx.stage.Window.isSizeToSceneAllowed. Determines whether the `sizeToScene()` request is allowed or not.
public final DoubleProperty	maxHeightProperty()
public final ReadOnlyBooleanProperty	maximizedProperty()
private final ReadOnlyBooleanWrapper	maximizedPropertyImpl()
public final DoubleProperty	maxWidthProperty()
public final DoubleProperty	minHeightProperty()
public final DoubleProperty	minWidthProperty()
public final BooleanProperty	resizableProperty()
public final void	setAlwaysOnTop(boolean value)
public final void	setFullScreen(boolean value)
public final void	setFullScreenExitHint(String value)
public final void	setFullScreenExitKeyCombination(KeyCombination the key combination to exit on keyCombination) Specifies the KeyCombination that will allow the user to exit full screen mode.
public final void	setIconified(boolean value)
pack-priv void	setImportant(boolean important)
public final void	setMaxHeight(double value)
public final void	setMaximized(boolean value)
public final void	setMaxWidth(double value)
public final void	setMinHeight(double value)
public final void	setMinWidth(double value)
pack-priv void	setPrimary(boolean primary)
public final void	setResizable(boolean value)
public final void	setScene(Scene the value for the `scene` property value) Overrides javafx.stage.Window.setScene. Specify the scene to be used on this stage.
public final void	setTitle(String value)
public final void	show() Overrides javafx.stage.Window.show. Attempts to show this Window by setting visibility to true
public void	showAndWait() Shows this stage and waits for it to be hidden (closed) before returning to the caller.
public final StringProperty	titleProperty()
public void	toBack() Sends this `Stage` to the back if the stage is visible.
public void	toFront() Brings this `Stage` to the front if the stage is visible.

Inherited from javafx.stage.Window:: addEventFilter addEventHandler applyBounds buildEventDispatchChain centerOnScreen createInternalEventDispatcher decreaseFocusGrabCounter eventDispatcherProperty fireEvent focusedProperty forceIntegerRenderScaleProperty getEventDispatcher getHeight getInternalEventDispatcher getOnCloseRequest getOnHidden getOnHiding getOnShowing getOnShown getOpacity getOutputScaleX getOutputScaleY getPeer getPeerListener getProperties getRenderScaleX getRenderScaleY getScene getUserData getWidth getWindows getX getY hasProperties heightProperty hide increaseFocusGrabCounter isFocused isForceIntegerRenderScale isShowing notifyLocationChanged notifySizeChanged onCloseRequestProperty onHiddenProperty onHidingProperty onShowingProperty onShownProperty opacityProperty outputScaleXProperty outputScaleYProperty removeEventFilter removeEventHandler renderScaleXProperty renderScaleYProperty requestFocus sceneProperty setEventDispatcher setEventHandler setFocused setForceIntegerRenderScale setHeight setOnCloseRequest setOnHidden setOnHiding setOnShowing setOnShown setOpacity setPeer setPeerListener setRenderScaleX setRenderScaleY setUserData setWidth setX setXInternal setY setYInternal showingProperty sizeToScene updateRenderScales widthProperty xProperty yProperty

Field Detail

alwaysOnTop back to summary

alwaysOnTop	back to summary
private ReadOnlyBooleanWrapper alwaysOnTop Defines whether this `Stage` is kept on top of other windows. If some other window is already always-on-top then the relative order between these windows is unspecified (depends on platform). 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. Default Value false Since JavaFX 8u20

private ReadOnlyBooleanWrapper alwaysOnTop

Defines whether this Stage is kept on top of other windows.

If some other window is already always-on-top then the relative order between these windows is unspecified (depends on platform).

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.

Default Value: false
Since: JavaFX 8u20

fullScreen back to summary

fullScreen	back to summary
private ReadOnlyBooleanWrapper fullScreen Specifies whether this `Stage` should be a full-screen, undecorated window. The implementation of full-screen mode is platform and profile-dependent. When set to `true`, the `Stage` will attempt to enter full-screen mode when visible. Set to `false` to return `Stage` to windowed mode. An `IllegalStateException` is thrown if this property is set on a thread other than the JavaFX Application Thread. The full-screen mode will be exited (and the `fullScreen` attribute will be set to `false`) if the full-screen `Stage` loses focus or if another `Stage` enters full-screen mode on the same `Screen`. Note that a `Stage` in full-screen mode can become invisible without losing its full-screen status and will again enter full-screen mode when the `Stage` becomes visible. If the platform supports multiple screens an application can control which `Screen` the Stage will enter full-screen mode on by setting its position to be within the bounds of that `Screen` prior to entering full-screen mode. However once in full-screen mode, `Stage`'s `x`, `y`, `width`, and `height` variables will continue to represent the non-full-screen position and size of the window; the same for `iconified`, `resizable`, `style`, and `opacity`. If changes are made to any of these attributes while in full-screen mode, upon exiting full-screen mode the `Stage` will assume those attributes. In case that more `Stage` modes are set simultaneously their order of importance is `iconified`, fullScreen, `maximized` (from strongest to weakest). 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. The user can unconditionally exit full-screen mode at any time by pressing `ESC`. Default Value false

private ReadOnlyBooleanWrapper fullScreen

Specifies whether this Stage should be a full-screen, undecorated window.

The implementation of full-screen mode is platform and profile-dependent.

When set to true, the Stage will attempt to enter full-screen mode when visible. Set to false to return Stage to windowed mode. An IllegalStateException is thrown if this property is set on a thread other than the JavaFX Application Thread.

The full-screen mode will be exited (and the fullScreen attribute will be set to false) if the full-screen Stage loses focus or if another Stage enters full-screen mode on the same Screen. Note that a Stage in full-screen mode can become invisible without losing its full-screen status and will again enter full-screen mode when the Stage becomes visible.

If the platform supports multiple screens an application can control which Screen the Stage will enter full-screen mode on by setting its position to be within the bounds of that Screen prior to entering full-screen mode.

However once in full-screen mode, Stage's x, y, width, and height variables will continue to represent the non-full-screen position and size of the window; the same for iconified, resizable, style, and opacity. If changes are made to any of these attributes while in full-screen mode, upon exiting full-screen mode the Stage will assume those attributes.

In case that more Stage modes are set simultaneously their order of importance is iconified, fullScreen, maximized (from strongest to weakest).

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.

The user can unconditionally exit full-screen mode at any time by pressing ESC.

Default Value: false

fullScreenExitCombination	back to summary
private final ObjectProperty<KeyCombination> fullScreenExitCombination

fullScreenExitHint	back to summary
private final ObjectProperty<String> fullScreenExitHint Specifies the text to show when a user enters full screen mode, usually used to indicate the way a user should go about exiting out of full screen mode. A value of null will result in the default per-locale message being displayed. If set to the empty string, then no message will be displayed. Since JavaFX 8.0

fullScreenExitHint

back to summary

private final ObjectProperty<String> fullScreenExitHint

Specifies the text to show when a user enters full screen mode, usually used to indicate the way a user should go about exiting out of full screen mode. A value of null will result in the default per-locale message being displayed. If set to the empty string, then no message will be displayed.

Since: JavaFX 8.0

iconified back to summary

iconified	back to summary
private ReadOnlyBooleanWrapper iconified Defines whether the `Stage` is iconified or not. In case that more `Stage` modes are set simultaneously their order of importance is iconified} `fullScreen`, `maximized` (from strongest to weakest). On some mobile and embedded platforms setting this property to true will hide the `Stage` but not show an icon for it. 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. Default Value false

private ReadOnlyBooleanWrapper iconified

Defines whether the Stage is iconified or not.

In case that more Stage modes are set simultaneously their order of importance is iconified} fullScreen, maximized (from strongest to weakest).

On some mobile and embedded platforms setting this property to true will hide the Stage but not show an icon for it.

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.

Default Value: false

icons	back to summary
private ObservableList<Image> icons Defines the icon images to be used in the window decorations and when minimized. The images should be different sizes of the same image and the best size will be chosen, eg. 16x16, 32,32. Default Value empty

icons

back to summary

private ObservableList<Image> icons

Defines the icon images to be used in the window decorations and when minimized. The images should be different sizes of the same image and the best size will be chosen, eg. 16x16, 32,32.

Default Value: empty

important	back to summary
private boolean important

inNestedEventLoop	back to summary
private boolean inNestedEventLoop

maxHeight back to summary

maxHeight	back to summary
private DoubleProperty maxHeight Defines the maximum height of this `Stage`. Default Value Double.MAX_VALUE Since JavaFX 2.1

private DoubleProperty maxHeight

Defines the maximum height of this Stage.

Default Value: Double.MAX_VALUE
Since: JavaFX 2.1

maximized back to summary

maximized	back to summary
private ReadOnlyBooleanWrapper maximized Defines whether the `Stage` is maximized or not. In case that more `Stage` modes are set simultaneously their order of importance is `iconified`, `fullScreen`, maximized (from strongest to weakest). 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. Default Value false Since JavaFX 8.0

private ReadOnlyBooleanWrapper maximized

Defines whether the Stage is maximized or not.

In case that more Stage modes are set simultaneously their order of importance is iconified, fullScreen, maximized (from strongest to weakest).

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.

Default Value: false
Since: JavaFX 8.0

maxWidth back to summary

maxWidth	back to summary
private DoubleProperty maxWidth Defines the maximum width of this `Stage`. Default Value Double.MAX_VALUE Since JavaFX 2.1

private DoubleProperty maxWidth

Defines the maximum width of this Stage.

Default Value: Double.MAX_VALUE
Since: JavaFX 2.1

minHeight back to summary

minHeight	back to summary
private DoubleProperty minHeight Defines the minimum height of this `Stage`. Default Value 0 Since JavaFX 2.1

private DoubleProperty minHeight

Defines the minimum height of this Stage.

Default Value: 0
Since: JavaFX 2.1

minWidth back to summary

minWidth	back to summary
private DoubleProperty minWidth Defines the minimum width of this `Stage`. Default Value 0 Since JavaFX 2.1

private DoubleProperty minWidth

Defines the minimum width of this Stage.

Default Value: 0
Since: JavaFX 2.1

modality	back to summary
private Modality modality

owner	back to summary
private Window owner

primary	back to summary
private boolean primary

resizable back to summary

resizable	back to summary
private BooleanProperty resizable Defines whether the `Stage` is resizable or not by the user. Programmatically you may still change the size of the Stage. This is a hint which allows the implementation to optionally make the Stage resizable by the user. Warning Since 8.0 the property cannot be bound and will throw `RuntimeException` on an attempt to do so. This is because the setting of resizable is asynchronous on some systems or generally might be set by the system / window manager. Bidirectional binds are still allowed, as they don't block setting of the property by the system. Default Value true

private BooleanProperty resizable

Defines whether the Stage is resizable or not by the user. Programmatically you may still change the size of the Stage. This is a hint which allows the implementation to optionally make the Stage resizable by the user.

Warning

Since 8.0 the property cannot be bound and will throw RuntimeException on an attempt to do so. This is because the setting of resizable is asynchronous on some systems or generally might be set by the system / window manager.
Bidirectional binds are still allowed, as they don't block setting of the property by the system.

Default Value: true

STAGE_ACCESSOR	back to summary
private static final StagePeerListener.StageAccessor STAGE_ACCESSOR

style	back to summary
private StageStyle style

title back to summary

title	back to summary
private StringProperty title Defines the title of the `Stage`. Default Value empty string

private StringProperty title

Defines the title of the Stage.

Default Value: empty string

Constructor Detail

Stage back to summary

Stage	back to summary
public Stage() Creates a new instance of decorated `Stage`. Exceptions IllegalStateException: if this constructor is called on a thread other than the JavaFX Application Thread.

public Stage()

Creates a new instance of decorated Stage.

Exceptions

IllegalStateException:: if this constructor is called on a thread other than the JavaFX Application Thread.

Stage back to summary

Stage	back to summary
public Stage(StageStyle style) Creates a new instance of `Stage`. Parameters style:StageStyle The style of the `Stage` Exceptions IllegalStateException: if this constructor is called on a thread other than the JavaFX Application Thread.

public Stage(StageStyle style)

Creates a new instance of Stage.

Parameters

style:StageStyle: The style of the Stage

Exceptions

IllegalStateException:: if this constructor is called on a thread other than the JavaFX Application Thread.

Method Detail

alwaysOnTopProperty	back to summary
public final ReadOnlyBooleanProperty alwaysOnTopProperty()

alwaysOnTopPropertyImpl	back to summary
private ReadOnlyBooleanWrapper alwaysOnTopPropertyImpl()

close	back to summary
public void close() Closes this `Stage`. This call is equivalent to `hide()`.

doVisibleChanged	back to summary
private void doVisibleChanged(boolean value) Hides javafx.stage.Window.doVisibleChanged.

doVisibleChanging	back to summary
private void doVisibleChanging(boolean value) Hides javafx.stage.Window.doVisibleChanging.

fullScreenExitHintProperty	back to summary
public final ObjectProperty<String> fullScreenExitHintProperty()

fullScreenExitKeyProperty	back to summary
public final ObjectProperty<KeyCombination> fullScreenExitKeyProperty() Get the property for the Full Screen exit key combination. Returns:ObjectProperty<KeyCombination> the property. Since JavaFX 8.0

fullScreenExitKeyProperty

back to summary

public final ObjectProperty<KeyCombination> fullScreenExitKeyProperty()

Get the property for the Full Screen exit key combination.

Returns:ObjectProperty<KeyCombination>: the property.
Since: JavaFX 8.0

fullScreenProperty	back to summary
public final ReadOnlyBooleanProperty fullScreenProperty()

fullScreenPropertyImpl	back to summary
private ReadOnlyBooleanWrapper fullScreenPropertyImpl()

getFullScreenExitHint	back to summary
public final String getFullScreenExitHint()

getFullScreenExitKeyCombination	back to summary
public final KeyCombination getFullScreenExitKeyCombination() Get the current sequence used to exit Full Screen mode. Returns:KeyCombination the current setting (null for system default) Since JavaFX 8.0

getFullScreenExitKeyCombination

back to summary

public final KeyCombination getFullScreenExitKeyCombination()

Get the current sequence used to exit Full Screen mode.

Returns:KeyCombination: the current setting (null for system default)
Since: JavaFX 8.0

getIcons	back to summary
public final ObservableList<Image> getIcons() Gets the icon images to be used in the window decorations and when minimized. The images should be different sizes of the same image and the best size will be chosen, eg. 16x16, 32,32. Returns:ObservableList<Image> An observable list of icons of this window

getIcons

back to summary

public final ObservableList<Image> getIcons()

Gets the icon images to be used in the window decorations and when minimized. The images should be different sizes of the same image and the best size will be chosen, eg. 16x16, 32,32.

Returns:ObservableList<Image>: An observable list of icons of this window

getMaxHeight	back to summary
public final double getMaxHeight()

getMaxWidth	back to summary
public final double getMaxWidth()

getMinHeight	back to summary
public final double getMinHeight()

getMinWidth	back to summary
public final double getMinWidth()

getModality	back to summary
public final Modality getModality() Retrieves the modality attribute for this stage. Returns:Modality the modality.

getModality

back to summary

public final Modality getModality()

Retrieves the modality attribute for this stage.

Returns:Modality: the modality.

getOwner	back to summary
public final Window getOwner() Retrieves the owner Window for this stage, or null for an unowned stage. Returns:Window the owner Window.

getOwner

back to summary

public final Window getOwner()

Retrieves the owner Window for this stage, or null for an unowned stage.

Returns:Window: the owner Window.

getStyle	back to summary
public final StageStyle getStyle() Retrieves the style attribute for this stage. Returns:StageStyle the stage style.

getStyle

back to summary

public final StageStyle getStyle()

Retrieves the style attribute for this stage.

Returns:StageStyle: the stage style.

getTitle	back to summary
public final String getTitle()

getWindowOwner	back to summary
pack-priv Window getWindowOwner() Overrides javafx.stage.Window.getWindowOwner. Annotations @Override

getWindowOwner

back to summary

pack-priv Window getWindowOwner()

Overrides javafx.stage.Window.getWindowOwner.

Annotations

@Override

iconifiedProperty	back to summary
public final ReadOnlyBooleanProperty iconifiedProperty()

iconifiedPropertyImpl	back to summary
private final ReadOnlyBooleanWrapper iconifiedPropertyImpl()

initModality	back to summary
public final void initModality(Modality modality) Specifies the modality for this stage. This must be done prior to making the stage visible. The modality is one of: Modality.NONE, Modality.WINDOW_MODAL, or Modality.APPLICATION_MODAL. Parameters modality:Modality the modality for this stage. Exceptions IllegalStateException: if this property is set after the stage has ever been made visible. if this stage is the primary stage. Default Value Modality.NONE

initModality

back to summary

public final void initModality(Modality modality)

Specifies the modality for this stage. This must be done prior to making the stage visible. The modality is one of: Modality.NONE, Modality.WINDOW_MODAL, or Modality.APPLICATION_MODAL.

Parameters

modality:Modality: the modality for this stage.

Exceptions

IllegalStateException:

if this property is set after the stage has ever been made visible.
if this stage is the primary stage.

Default Value

Modality.NONE

initOwner

back to summary

public final void initOwner(Window owner)

Specifies the owner Window for this stage, or null for a top-level, unowned stage. This must be done prior to making the stage visible.

Parameters

owner:Window: the owner for this stage.

Exceptions

IllegalStateException:

if this property is set after the stage has ever been made visible.
if this stage is the primary stage.

Default Value

null

initStyle

back to summary

public final void initStyle(StageStyle style)

Specifies the style for this stage. This must be done prior to making the stage visible. The style is one of: StageStyle.DECORATED, StageStyle.UNDECORATED, StageStyle.TRANSPARENT, or StageStyle.UTILITY.

Parameters

style:StageStyle: the style for this stage.

Exceptions

IllegalStateException:: if this property is set after the stage has ever been made visible.

Default Value

StageStyle.DECORATED

isAlwaysOnTop	back to summary
public final boolean isAlwaysOnTop()

isFullScreen	back to summary
public final boolean isFullScreen()

isIconified	back to summary
public final boolean isIconified()

isImportant	back to summary
private boolean isImportant()

isMaximized	back to summary
public final boolean isMaximized()

isPrimary	back to summary
pack-priv boolean isPrimary()

isResizable	back to summary
public final boolean isResizable()

isSizeToSceneAllowed back to summary

pack-priv boolean isSizeToSceneAllowed()

Overrides javafx.stage.Window.isSizeToSceneAllowed.

Doc from javafx.stage.Window.isSizeToSceneAllowed.

Determines whether the sizeToScene() request is allowed or not.

If this Stage is maximized or in fullScreen, size to scene is not allowed.

Returns:boolean

true if allowed, false otherwise

Annotations

@Override

maxHeightProperty	back to summary
public final DoubleProperty maxHeightProperty()

maximizedProperty	back to summary
public final ReadOnlyBooleanProperty maximizedProperty()

maximizedPropertyImpl	back to summary
private final ReadOnlyBooleanWrapper maximizedPropertyImpl()

maxWidthProperty	back to summary
public final DoubleProperty maxWidthProperty()

minHeightProperty	back to summary
public final DoubleProperty minHeightProperty()

minWidthProperty	back to summary
public final DoubleProperty minWidthProperty()

resizableProperty	back to summary
public final BooleanProperty resizableProperty()

setAlwaysOnTop	back to summary
public final void setAlwaysOnTop(boolean value)

setFullScreen	back to summary
public final void setFullScreen(boolean value)

setFullScreenExitHint	back to summary
public final void setFullScreenExitHint(String value)

setFullScreenExitKeyCombination

back to summary

public final void setFullScreenExitKeyCombination(KeyCombination keyCombination)

Specifies the KeyCombination that will allow the user to exit full screen mode. A value of KeyCombination.NO_MATCH will not match any KeyEvent and will make it so the user is not able to escape from Full Screen mode. A value of null indicates that the default platform specific key combination should be used.

An internal copy of this value is made when entering full-screen mode and will be used to trigger the exit from the mode.

Parameters

keyCombination:KeyCombination: the key combination to exit on

Since

JavaFX 8.0

setIconified	back to summary
public final void setIconified(boolean value)

setImportant	back to summary
pack-priv void setImportant(boolean important)

setMaxHeight	back to summary
public final void setMaxHeight(double value)

setMaximized	back to summary
public final void setMaximized(boolean value)

setMaxWidth	back to summary
public final void setMaxWidth(double value)

setMinHeight	back to summary
public final void setMinHeight(double value)

setMinWidth	back to summary
public final void setMinWidth(double value)

setPrimary	back to summary
pack-priv void setPrimary(boolean primary)

setResizable	back to summary
public final void setResizable(boolean value)

setScene back to summary

public final void setScene(Scene value)

Overrides javafx.stage.Window.setScene.

Specify the scene to be used on this stage.

Parameters

value:Scene

Doc from javafx.stage.Window.setScene.

the value for the scene property

Annotations

@Override

setTitle	back to summary
public final void setTitle(String value)

show

back to summary

public final void show()

Overrides javafx.stage.Window.show.

Doc from javafx.stage.Window.show.

Attempts to show this Window by setting visibility to true

Annotations

@Override

showAndWait back to summary

public void showAndWait()

Shows this stage and waits for it to be hidden (closed) before returning to the caller. This method temporarily blocks processing of the current event, and starts a nested event loop to handle other events. This method must be called on the FX Application thread.

A Stage is hidden (closed) by one of the following means:

the application calls the hide or close method on this stage
this stage has a non-null owner window, and its owner is closed
the user closes the window via the window system (for example, by pressing the close button in the window decoration)

After the Stage is hidden, and the application has returned from the event handler to the event loop, the nested event loop terminates and this method returns to the caller.

For example, consider the following sequence of operations for different event handlers, assumed to execute in the order shown below:

void evtHander1(...) {
    stage1.showAndWait();
    doSomethingAfterStage1Closed(...)
}

void evtHander2(...) {
    stage1.hide();
    doSomethingElseHere(...)
}

evtHandler1 will block at the call to showAndWait. It will resume execution after stage1 is hidden and the current event handler, in this case evtHandler2, returns to the event loop. This means that doSomethingElseHere will execute before doSomethingAfterStage1Closed.

More than one stage may be shown with showAndWait. Each call will start a new nested event loop. The stages may be hidden in any order, but a particular nested event loop (and thus the showAndWait method for the associated stage) will only terminate after all inner event loops have also terminated.

For example, consider the following sequence of operations for different event handlers, assumed to execute in the order shown below:

void evtHander1() {
    stage1.showAndWait();
    doSomethingAfterStage1Closed(...)
}

void evtHander2() {
    stage2.showAndWait();
    doSomethingAfterStage2Closed(...)
}

void evtHander3() {
    stage1.hide();
    doSomethingElseHere(...)
}

void evtHander4() {
    stage2.hide();
    doSomethingElseHereToo(...)
}

evtHandler1 will block at the call to stage1.showAndWait, starting up a nested event loop just like in the previous example. evtHandler2 will then block at the call to stage2.showAndWait, starting up another (inner) nested event loop. The first call to stage1.showAndWait will resume execution after stage1 is hidden, but only after the inner nested event loop started by stage2.showAndWait has terminated. This means that the call to stage1.showAndWait won't return until after evtHandler2 has returned. The order of execution is: stage1.showAndWait, stage2.showAndWait, stage1.hide, doSomethingElseHere, stage2.hide, doSomethingElseHereToo, doSomethingAfterStage2Closed, doSomethingAfterStage1Closed.

This method must not be called on the primary stage or on a stage that is already visible. Additionally, it must either be called from an input event handler or from the run method of a Runnable passed to Platform.runLater. It must not be called during animation or layout processing.

Exceptions

IllegalStateException:

if this method is called on a thread other than the JavaFX Application Thread.
if this method is called during animation or layout processing.
if this method is called on the primary stage.
if this stage is already showing.

Since

JavaFX 2.2

titleProperty	back to summary
public final StringProperty titleProperty()

toBack back to summary

public void toBack()

Sends this Stage to the back if the stage is visible. This action places this Stage at the bottom of the stacking order and shows it behind any other Stage created by this application.

Some platforms do not allow applications to control the stacking order at all, in which case this method does nothing. Other platforms have restrictions on stacking order, so might not place a window below another application's windows nor allow a window that is owned by another window to appear below their owner. Every attempt will be made to move this Stage as low as possible in the stacking order; however, developers should not assume that this method will move this Stage below all other windows in every situation.

toFront back to summary

public void toFront()

Brings this Stage to the front if the stage is visible. This action places this Stage at the top of the stacking order and shows it in front of any other Stage created by this application.

Some platforms do not allow applications to control the stacking order at all, in which case this method does nothing. Other platforms have restrictions on stacking order, so might not place a window above another application's windows nor allow a window that owns other windows to appear on top of those owned windows. Every attempt will be made to move this Stage as high as possible in the stacking order; however, developers should not assume that this method will move this Stage above all other windows in every situation.

javafx.stage back to summary

private Class Stage.ResizableProperty

Class Inheritance

extends SimpleBooleanProperty

java.lang.Object
javafx.beans.binding.BooleanExpression
javafx.beans.property.ReadOnlyBooleanProperty
javafx.beans.property.BooleanProperty
javafx.beans.property.BooleanPropertyBase
javafx.beans.property.SimpleBooleanProperty
javafx.stage.Stage.ResizableProperty

Field Summary

Modifier and Type	Field and Description
private boolean	noInvalidate

Constructor Summary

Access	Constructor and Description
public	ResizableProperty()

Method Summary

Modifier and Type	Method and Description
public void	bind(ObservableValue<? extends Boolean> The observable this `Property` should be bound to. rawObservable) Overrides javafx.beans.property.BooleanPropertyBase.bind. Implements javafx.beans.property.Property.bind. Create a unidirection binding for this `Property`.
protected void	invalidated() Overrides javafx.beans.property.BooleanPropertyBase.invalidated. The method `invalidated()` can be overridden to receive invalidation notifications.
pack-priv void	setNoInvalidate(boolean value)

Inherited from javafx.beans.property.SimpleBooleanProperty:: getBean getName

Field Detail

noInvalidate	back to summary
private boolean noInvalidate

Constructor Detail

ResizableProperty	back to summary
public ResizableProperty()

Method Detail

bind back to summary

public void bind(ObservableValue<? extends Boolean> rawObservable)

Overrides javafx.beans.property.BooleanPropertyBase.bind.

Implements javafx.beans.property.Property.bind.

Doc from javafx.beans.property.BooleanPropertyBase.bind.

Create a unidirection binding for this Property.

Note that JavaFX has all the bind calls implemented through weak listeners. This means the bound property can be garbage collected and stopped from being updated. Note:

Parameters

rawObservable:ObservableValue<? extends Boolean>

Doc from javafx.beans.property.Property.bind.

The observable this Property should be bound to.

Annotations

@Override

invalidated back to summary

protected void invalidated()

Overrides javafx.beans.property.BooleanPropertyBase.invalidated.

Doc from javafx.beans.property.BooleanPropertyBase.invalidated.

The method invalidated() can be overridden to receive invalidation notifications. This is the preferred option in Objects defining the property, because it requires less memory. The default implementation is empty.

Annotations

@Override

setNoInvalidate	back to summary
pack-priv void setNoInvalidate(boolean value)

public Class Stage

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Stage.ResizableProperty

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail