- java.lang.Object
-
- javafx.stage.Window
-
- javafx.stage.Stage
-
- All Implemented Interfaces:
EventTarget
public class Stage extends Window
The JavaFXStage
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
Application
class and thePlatform.startup(Runnable)
method for more information.Many of the
Stage
properties are read only because they can be changed externally by the underlying platform and therefore must not be bindable.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 theshowAndWait()
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:
produces the following on Mac OSX:
produces the following on Linux:
- Since:
- JavaFX 2.0
-
-
Property Summary
Properties Type Property Description ReadOnlyBooleanProperty
alwaysOnTop
Defines whether thisStage
is kept on top of other windows.ObjectProperty<String>
fullScreenExitHint
ObjectProperty<KeyCombination>
fullScreenExitKey
Get the property for the Full Screen exit key combination.ReadOnlyBooleanProperty
fullScreen
Specifies whether thisStage
should be a full-screen, undecorated window.ReadOnlyBooleanProperty
iconified
Defines whether theStage
is iconified or not.DoubleProperty
maxHeight
Defines the maximum height of thisStage
.ReadOnlyBooleanProperty
maximized
Defines whether theStage
is maximized or not.DoubleProperty
maxWidth
Defines the maximum width of thisStage
.DoubleProperty
minHeight
Defines the minimum height of thisStage
.DoubleProperty
minWidth
Defines the minimum width of thisStage
.BooleanProperty
resizable
Defines whether theStage
is resizable or not by the user.StringProperty
title
Defines the title of theStage
.-
Properties inherited from class javafx.stage.Window
eventDispatcher, focused, forceIntegerRenderScale, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, opacity, outputScaleX, outputScaleY, renderScaleX, renderScaleY, scene, showing, width, x, y
-
-
Constructor Summary
Constructors Constructor Description Stage()
Creates a new instance of decoratedStage
.Stage(StageStyle style)
Creates a new instance ofStage
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ReadOnlyBooleanProperty
alwaysOnTopProperty()
Defines whether thisStage
is kept on top of other windows.void
close()
Closes thisStage
.ObjectProperty<String>
fullScreenExitHintProperty()
ObjectProperty<KeyCombination>
fullScreenExitKeyProperty()
Get the property for the Full Screen exit key combination.ReadOnlyBooleanProperty
fullScreenProperty()
Specifies whether thisStage
should be a full-screen, undecorated window.String
getFullScreenExitHint()
Gets the value of the property fullScreenExitHint.KeyCombination
getFullScreenExitKeyCombination()
Get the current sequence used to exit Full Screen mode.ObservableList<Image>
getIcons()
Gets the icon images to be used in the window decorations and when minimized.double
getMaxHeight()
Gets the value of the property maxHeight.double
getMaxWidth()
Gets the value of the property maxWidth.double
getMinHeight()
Gets the value of the property minHeight.double
getMinWidth()
Gets the value of the property minWidth.Modality
getModality()
Retrieves the modality attribute for this stage.Window
getOwner()
Retrieves the owner Window for this stage, or null for an unowned stage.StageStyle
getStyle()
Retrieves the style attribute for this stage.String
getTitle()
Gets the value of the property title.ReadOnlyBooleanProperty
iconifiedProperty()
Defines whether theStage
is iconified or not.void
initModality(Modality modality)
Specifies the modality for this stage.void
initOwner(Window owner)
Specifies the owner Window for this stage, or null for a top-level, unowned stage.void
initStyle(StageStyle style)
Specifies the style for this stage.boolean
isAlwaysOnTop()
Gets the value of the property alwaysOnTop.boolean
isFullScreen()
Gets the value of the property fullScreen.boolean
isIconified()
Gets the value of the property iconified.boolean
isMaximized()
Gets the value of the property maximized.boolean
isResizable()
Gets the value of the property resizable.DoubleProperty
maxHeightProperty()
Defines the maximum height of thisStage
.ReadOnlyBooleanProperty
maximizedProperty()
Defines whether theStage
is maximized or not.DoubleProperty
maxWidthProperty()
Defines the maximum width of thisStage
.DoubleProperty
minHeightProperty()
Defines the minimum height of thisStage
.DoubleProperty
minWidthProperty()
Defines the minimum width of thisStage
.BooleanProperty
resizableProperty()
Defines whether theStage
is resizable or not by the user.void
setAlwaysOnTop(boolean value)
Sets the value of the property alwaysOnTop.void
setFullScreen(boolean value)
Sets the value of the property fullScreen.void
setFullScreenExitHint(String value)
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.void
setFullScreenExitKeyCombination(KeyCombination keyCombination)
Specifies the KeyCombination that will allow the user to exit full screen mode.void
setIconified(boolean value)
Sets the value of the property iconified.void
setMaxHeight(double value)
Sets the value of the property maxHeight.void
setMaximized(boolean value)
Sets the value of the property maximized.void
setMaxWidth(double value)
Sets the value of the property maxWidth.void
setMinHeight(double value)
Sets the value of the property minHeight.void
setMinWidth(double value)
Sets the value of the property minWidth.void
setResizable(boolean value)
Sets the value of the property resizable.void
setScene(Scene value)
Specify the scene to be used on this stage.void
setTitle(String value)
Sets the value of the property title.void
show()
Attempts to show this Window by setting visibility to truevoid
showAndWait()
Shows this stage and waits for it to be hidden (closed) before returning to the caller.StringProperty
titleProperty()
Defines the title of theStage
.void
toBack()
Send theWindow
to the background.void
toFront()
Bring theWindow
to the foreground.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from class javafx.stage.Window
addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, forceIntegerRenderScaleProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getOutputScaleX, getOutputScaleY, getProperties, getRenderScaleX, getRenderScaleY, getScene, getUserData, getWidth, getWindows, getX, getY, hasProperties, heightProperty, hide, isFocused, isForceIntegerRenderScale, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, outputScaleXProperty, outputScaleYProperty, removeEventFilter, removeEventHandler, renderScaleXProperty, renderScaleYProperty, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setForceIntegerRenderScale, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setRenderScaleX, setRenderScaleY, setUserData, setWidth, setX, setY, showingProperty, sizeToScene, widthProperty, xProperty, yProperty
-
-
-
-
Property Detail
-
fullScreen
public final ReadOnlyBooleanProperty fullScreenProperty
Specifies whether thisStage
should be a full-screen, undecorated window.The implementation of full-screen mode is platform and profile-dependent.
When set to
true
, theStage
will attempt to enter full-screen mode when visible. Set tofalse
to returnStage
to windowed mode. AnIllegalStateException
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
If the platform supports multiple screens an application can control whichfullScreen
attribute will be set tofalse
) if the full-screenStage
loses focus or if anotherStage
enters full-screen mode on the sameScreen
. Note that aStage
in full-screen mode can become invisible without losing its full-screen status and will again enter full-screen mode when theStage
becomes visible.Screen
the Stage will enter full-screen mode on by setting its position to be within the bounds of thatScreen
prior to entering full-screen mode.However once in full-screen mode,
Stage
'sx
,y
,width
, andheight
variables will continue to represent the non-full-screen position and size of the window; the same foriconified
,resizable
,style
, andopacity
. If changes are made to any of these attributes while in full-screen mode, upon exiting full-screen mode theStage
will assume those attributes.In case that more
Stage
modes are set simultaneously their order of importance isiconified
, fullScreen,maximized
(from strongest to weakest).The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
The user can unconditionally exit full-screen mode at any time by pressingESC
.If a security manager is present, the application must have the
FXPermission
"unrestrictedFullScreen" in order to enter full-screen mode with no restrictions. Applications without permission will have the following restrictions:- Applications can only enter full-screen mode in response
to user input. More specifically, entering is allowed from mouse
(
Node.mousePressed/mouseReleased/mouseClicked
) or keyboard (Node.keyPressed/keyReleased/keyTyped
) event handlers. It is not allowed to enter full-screen mode in response toESC
key. Attempting to enter full-screen mode from any other context will be ignored.If
Stage
was constructed as full-screen but not visible it will enter full-screen mode upon becoming visible, with the same limitations to when this is allowed to happen as when settingfullScreen
totrue
. - If the application was allowed to enter full-screen mode
it will have limited keyboard input. It will only receive KEY_PRESSED
and KEY_RELEASED events from the following keys:
UP, DOWN, LEFT, RIGHT, SPACE, TAB, PAGE_UP, PAGE_DOWN, HOME, END, ENTER
- Default value:
- false
- See Also:
isFullScreen()
,setFullScreen(boolean)
- Applications can only enter full-screen mode in response
to user input. More specifically, entering is allowed from mouse
(
-
title
public final StringProperty titleProperty
Defines the title of theStage
.- Default value:
- empty string
- See Also:
getTitle()
,setTitle(String)
-
iconified
public final ReadOnlyBooleanProperty iconifiedProperty
Defines whether theStage
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.The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
- See Also:
isIconified()
,setIconified(boolean)
-
maximized
public final ReadOnlyBooleanProperty maximizedProperty
Defines whether theStage
is maximized or not.In case that more
Stage
modes are set simultaneously their order of importance isiconified
,fullScreen
, maximized (from strongest to weakest).The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
- Since:
- JavaFX 8.0
- See Also:
isMaximized()
,setMaximized(boolean)
-
alwaysOnTop
public final ReadOnlyBooleanProperty alwaysOnTopProperty
Defines whether thisStage
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).
If a security manager is present, the application must have the
FXPermission
"setWindowAlwaysOnTop" in order for this property to have any effect. If the application does not have permission, attempting to set this property will be ignored and the property value will be restored tofalse
.The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
- Since:
- JavaFX 8u20
- See Also:
isAlwaysOnTop()
,setAlwaysOnTop(boolean)
-
resizable
public final BooleanProperty resizableProperty
Defines whether theStage
is resizable or not by the user. Programatically 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
- See Also:
isResizable()
,setResizable(boolean)
-
minWidth
public final DoubleProperty minWidthProperty
Defines the minimum width of thisStage
.- Default value:
- 0
- Since:
- JavaFX 2.1
- See Also:
getMinWidth()
,setMinWidth(double)
-
minHeight
public final DoubleProperty minHeightProperty
Defines the minimum height of thisStage
.- Default value:
- 0
- Since:
- JavaFX 2.1
- See Also:
getMinHeight()
,setMinHeight(double)
-
maxWidth
public final DoubleProperty maxWidthProperty
Defines the maximum width of thisStage
.- Default value:
- Double.MAX_VALUE
- Since:
- JavaFX 2.1
- See Also:
getMaxWidth()
,setMaxWidth(double)
-
maxHeight
public final DoubleProperty maxHeightProperty
Defines the maximum height of thisStage
.- Default value:
- Double.MAX_VALUE
- Since:
- JavaFX 2.1
- See Also:
getMaxHeight()
,setMaxHeight(double)
-
fullScreenExitKey
public final ObjectProperty<KeyCombination> fullScreenExitKeyProperty
Get the property for the Full Screen exit key combination.- Since:
- JavaFX 8.0
-
fullScreenExitHint
public final ObjectProperty<String> fullScreenExitHintProperty
-
-
Constructor Detail
-
Stage
public Stage()
Creates a new instance of decoratedStage
.- Throws:
IllegalStateException
- if this constructor is called on a thread other than the JavaFX Application Thread.
-
Stage
public Stage(StageStyle style)
Creates a new instance ofStage
.- Parameters:
style
- The style of theStage
- Throws:
IllegalStateException
- if this constructor is called on a thread other than the JavaFX Application Thread.
-
-
Method Detail
-
setScene
public final void setScene(Scene value)
Specify the scene to be used on this stage.
-
show
public final void show()
Attempts to show this Window by setting visibility to true
-
showAndWait
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
Window.hide()
orclose()
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.- Throws:
IllegalStateException
- if this method is called on a thread other than the JavaFX Application Thread.IllegalStateException
- if this method is called during animation or layout processing.IllegalStateException
- if this method is called on the primary stage.IllegalStateException
- if this stage is already showing.- Since:
- JavaFX 2.2
- the application calls the
-
initStyle
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.- Default value:
- StageStyle.DECORATED
- Parameters:
style
- the style for this stage.- Throws:
IllegalStateException
- if this property is set after the stage has ever been made visible.
-
getStyle
public final StageStyle getStyle()
Retrieves the style attribute for this stage.- Returns:
- the stage style.
-
initModality
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.- Default value:
- Modality.NONE
- Parameters:
modality
- the modality for this stage.- Throws:
IllegalStateException
- if this property is set after the stage has ever been made visible.IllegalStateException
- if this stage is the primary stage.
-
getModality
public final Modality getModality()
Retrieves the modality attribute for this stage.- Returns:
- the modality.
-
initOwner
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.- Default value:
- null
- Parameters:
owner
- the owner for this stage.- Throws:
IllegalStateException
- if this property is set after the stage has ever been made visible.IllegalStateException
- if this stage is the primary stage.
-
getOwner
public final Window getOwner()
Retrieves the owner Window for this stage, or null for an unowned stage.- Returns:
- the owner Window.
-
setFullScreen
public final void setFullScreen(boolean value)
Sets the value of the property fullScreen.- Property description:
- 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
, theStage
will attempt to enter full-screen mode when visible. Set tofalse
to returnStage
to windowed mode. AnIllegalStateException
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
If the platform supports multiple screens an application can control whichfullScreen
attribute will be set tofalse
) if the full-screenStage
loses focus or if anotherStage
enters full-screen mode on the sameScreen
. Note that aStage
in full-screen mode can become invisible without losing its full-screen status and will again enter full-screen mode when theStage
becomes visible.Screen
the Stage will enter full-screen mode on by setting its position to be within the bounds of thatScreen
prior to entering full-screen mode.However once in full-screen mode,
Stage
'sx
,y
,width
, andheight
variables will continue to represent the non-full-screen position and size of the window; the same foriconified
,resizable
,style
, andopacity
. If changes are made to any of these attributes while in full-screen mode, upon exiting full-screen mode theStage
will assume those attributes.In case that more
Stage
modes are set simultaneously their order of importance isiconified
, fullScreen,maximized
(from strongest to weakest).The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
The user can unconditionally exit full-screen mode at any time by pressingESC
.If a security manager is present, the application must have the
FXPermission
"unrestrictedFullScreen" in order to enter full-screen mode with no restrictions. Applications without permission will have the following restrictions:- Applications can only enter full-screen mode in response
to user input. More specifically, entering is allowed from mouse
(
Node.mousePressed/mouseReleased/mouseClicked
) or keyboard (Node.keyPressed/keyReleased/keyTyped
) event handlers. It is not allowed to enter full-screen mode in response toESC
key. Attempting to enter full-screen mode from any other context will be ignored.If
Stage
was constructed as full-screen but not visible it will enter full-screen mode upon becoming visible, with the same limitations to when this is allowed to happen as when settingfullScreen
totrue
. - If the application was allowed to enter full-screen mode
it will have limited keyboard input. It will only receive KEY_PRESSED
and KEY_RELEASED events from the following keys:
UP, DOWN, LEFT, RIGHT, SPACE, TAB, PAGE_UP, PAGE_DOWN, HOME, END, ENTER
- Applications can only enter full-screen mode in response
to user input. More specifically, entering is allowed from mouse
(
- Default value:
- false
-
isFullScreen
public final boolean isFullScreen()
Gets the value of the property fullScreen.- Property description:
- 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
, theStage
will attempt to enter full-screen mode when visible. Set tofalse
to returnStage
to windowed mode. AnIllegalStateException
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
If the platform supports multiple screens an application can control whichfullScreen
attribute will be set tofalse
) if the full-screenStage
loses focus or if anotherStage
enters full-screen mode on the sameScreen
. Note that aStage
in full-screen mode can become invisible without losing its full-screen status and will again enter full-screen mode when theStage
becomes visible.Screen
the Stage will enter full-screen mode on by setting its position to be within the bounds of thatScreen
prior to entering full-screen mode.However once in full-screen mode,
Stage
'sx
,y
,width
, andheight
variables will continue to represent the non-full-screen position and size of the window; the same foriconified
,resizable
,style
, andopacity
. If changes are made to any of these attributes while in full-screen mode, upon exiting full-screen mode theStage
will assume those attributes.In case that more
Stage
modes are set simultaneously their order of importance isiconified
, fullScreen,maximized
(from strongest to weakest).The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
The user can unconditionally exit full-screen mode at any time by pressingESC
.If a security manager is present, the application must have the
FXPermission
"unrestrictedFullScreen" in order to enter full-screen mode with no restrictions. Applications without permission will have the following restrictions:- Applications can only enter full-screen mode in response
to user input. More specifically, entering is allowed from mouse
(
Node.mousePressed/mouseReleased/mouseClicked
) or keyboard (Node.keyPressed/keyReleased/keyTyped
) event handlers. It is not allowed to enter full-screen mode in response toESC
key. Attempting to enter full-screen mode from any other context will be ignored.If
Stage
was constructed as full-screen but not visible it will enter full-screen mode upon becoming visible, with the same limitations to when this is allowed to happen as when settingfullScreen
totrue
. - If the application was allowed to enter full-screen mode
it will have limited keyboard input. It will only receive KEY_PRESSED
and KEY_RELEASED events from the following keys:
UP, DOWN, LEFT, RIGHT, SPACE, TAB, PAGE_UP, PAGE_DOWN, HOME, END, ENTER
- Applications can only enter full-screen mode in response
to user input. More specifically, entering is allowed from mouse
(
- Default value:
- false
-
fullScreenProperty
public final ReadOnlyBooleanProperty fullScreenProperty()
Specifies whether thisStage
should be a full-screen, undecorated window.The implementation of full-screen mode is platform and profile-dependent.
When set to
true
, theStage
will attempt to enter full-screen mode when visible. Set tofalse
to returnStage
to windowed mode. AnIllegalStateException
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
If the platform supports multiple screens an application can control whichfullScreen
attribute will be set tofalse
) if the full-screenStage
loses focus or if anotherStage
enters full-screen mode on the sameScreen
. Note that aStage
in full-screen mode can become invisible without losing its full-screen status and will again enter full-screen mode when theStage
becomes visible.Screen
the Stage will enter full-screen mode on by setting its position to be within the bounds of thatScreen
prior to entering full-screen mode.However once in full-screen mode,
Stage
'sx
,y
,width
, andheight
variables will continue to represent the non-full-screen position and size of the window; the same foriconified
,resizable
,style
, andopacity
. If changes are made to any of these attributes while in full-screen mode, upon exiting full-screen mode theStage
will assume those attributes.In case that more
Stage
modes are set simultaneously their order of importance isiconified
, fullScreen,maximized
(from strongest to weakest).The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
The user can unconditionally exit full-screen mode at any time by pressingESC
.If a security manager is present, the application must have the
FXPermission
"unrestrictedFullScreen" in order to enter full-screen mode with no restrictions. Applications without permission will have the following restrictions:- Applications can only enter full-screen mode in response
to user input. More specifically, entering is allowed from mouse
(
Node.mousePressed/mouseReleased/mouseClicked
) or keyboard (Node.keyPressed/keyReleased/keyTyped
) event handlers. It is not allowed to enter full-screen mode in response toESC
key. Attempting to enter full-screen mode from any other context will be ignored.If
Stage
was constructed as full-screen but not visible it will enter full-screen mode upon becoming visible, with the same limitations to when this is allowed to happen as when settingfullScreen
totrue
. - If the application was allowed to enter full-screen mode
it will have limited keyboard input. It will only receive KEY_PRESSED
and KEY_RELEASED events from the following keys:
UP, DOWN, LEFT, RIGHT, SPACE, TAB, PAGE_UP, PAGE_DOWN, HOME, END, ENTER
- Default value:
- false
- See Also:
isFullScreen()
,setFullScreen(boolean)
- Applications can only enter full-screen mode in response
to user input. More specifically, entering is allowed from mouse
(
-
getIcons
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:
- An observable list of icons of this window
-
setTitle
public final void setTitle(String value)
Sets the value of the property title.- Property description:
- Defines the title of the
Stage
. - Default value:
- empty string
-
getTitle
public final String getTitle()
Gets the value of the property title.- Property description:
- Defines the title of the
Stage
. - Default value:
- empty string
-
titleProperty
public final StringProperty titleProperty()
Defines the title of theStage
.- Default value:
- empty string
- See Also:
getTitle()
,setTitle(String)
-
setIconified
public final void setIconified(boolean value)
Sets the value of the property iconified.- Property description:
- 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.The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
-
isIconified
public final boolean isIconified()
Gets the value of the property iconified.- Property description:
- 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.The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
-
iconifiedProperty
public final ReadOnlyBooleanProperty iconifiedProperty()
Defines whether theStage
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.The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
- See Also:
isIconified()
,setIconified(boolean)
-
setMaximized
public final void setMaximized(boolean value)
Sets the value of the property maximized.- Property description:
- Defines whether the
Stage
is maximized or not.In case that more
Stage
modes are set simultaneously their order of importance isiconified
,fullScreen
, maximized (from strongest to weakest).The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
- Since:
- JavaFX 8.0
-
isMaximized
public final boolean isMaximized()
Gets the value of the property maximized.- Property description:
- Defines whether the
Stage
is maximized or not.In case that more
Stage
modes are set simultaneously their order of importance isiconified
,fullScreen
, maximized (from strongest to weakest).The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
- Since:
- JavaFX 8.0
-
maximizedProperty
public final ReadOnlyBooleanProperty maximizedProperty()
Defines whether theStage
is maximized or not.In case that more
Stage
modes are set simultaneously their order of importance isiconified
,fullScreen
, maximized (from strongest to weakest).The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
- Since:
- JavaFX 8.0
- See Also:
isMaximized()
,setMaximized(boolean)
-
setAlwaysOnTop
public final void setAlwaysOnTop(boolean value)
Sets the value of the property alwaysOnTop.- Property description:
- 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).
If a security manager is present, the application must have the
FXPermission
"setWindowAlwaysOnTop" in order for this property to have any effect. If the application does not have permission, attempting to set this property will be ignored and the property value will be restored tofalse
.The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
- Since:
- JavaFX 8u20
-
isAlwaysOnTop
public final boolean isAlwaysOnTop()
Gets the value of the property alwaysOnTop.- Property description:
- 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).
If a security manager is present, the application must have the
FXPermission
"setWindowAlwaysOnTop" in order for this property to have any effect. If the application does not have permission, attempting to set this property will be ignored and the property value will be restored tofalse
.The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
- Since:
- JavaFX 8u20
-
alwaysOnTopProperty
public final ReadOnlyBooleanProperty alwaysOnTopProperty()
Defines whether thisStage
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).
If a security manager is present, the application must have the
FXPermission
"setWindowAlwaysOnTop" in order for this property to have any effect. If the application does not have permission, attempting to set this property will be ignored and the property value will be restored tofalse
.The property is read only because it can be changed externally by the underlying platform and therefore must not be bindable.
- Default value:
- false
- Since:
- JavaFX 8u20
- See Also:
isAlwaysOnTop()
,setAlwaysOnTop(boolean)
-
setResizable
public final void setResizable(boolean value)
Sets the value of the property resizable.- Property description:
- Defines whether the
Stage
is resizable or not by the user. Programatically 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
-
isResizable
public final boolean isResizable()
Gets the value of the property resizable.- Property description:
- Defines whether the
Stage
is resizable or not by the user. Programatically 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
-
resizableProperty
public final BooleanProperty resizableProperty()
Defines whether theStage
is resizable or not by the user. Programatically 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
- See Also:
isResizable()
,setResizable(boolean)
-
setMinWidth
public final void setMinWidth(double value)
Sets the value of the property minWidth.- Property description:
- Defines the minimum width of this
Stage
. - Default value:
- 0
- Since:
- JavaFX 2.1
-
getMinWidth
public final double getMinWidth()
Gets the value of the property minWidth.- Property description:
- Defines the minimum width of this
Stage
. - Default value:
- 0
- Since:
- JavaFX 2.1
-
minWidthProperty
public final DoubleProperty minWidthProperty()
Defines the minimum width of thisStage
.- Default value:
- 0
- Since:
- JavaFX 2.1
- See Also:
getMinWidth()
,setMinWidth(double)
-
setMinHeight
public final void setMinHeight(double value)
Sets the value of the property minHeight.- Property description:
- Defines the minimum height of this
Stage
. - Default value:
- 0
- Since:
- JavaFX 2.1
-
getMinHeight
public final double getMinHeight()
Gets the value of the property minHeight.- Property description:
- Defines the minimum height of this
Stage
. - Default value:
- 0
- Since:
- JavaFX 2.1
-
minHeightProperty
public final DoubleProperty minHeightProperty()
Defines the minimum height of thisStage
.- Default value:
- 0
- Since:
- JavaFX 2.1
- See Also:
getMinHeight()
,setMinHeight(double)
-
setMaxWidth
public final void setMaxWidth(double value)
Sets the value of the property maxWidth.- Property description:
- Defines the maximum width of this
Stage
. - Default value:
- Double.MAX_VALUE
- Since:
- JavaFX 2.1
-
getMaxWidth
public final double getMaxWidth()
Gets the value of the property maxWidth.- Property description:
- Defines the maximum width of this
Stage
. - Default value:
- Double.MAX_VALUE
- Since:
- JavaFX 2.1
-
maxWidthProperty
public final DoubleProperty maxWidthProperty()
Defines the maximum width of thisStage
.- Default value:
- Double.MAX_VALUE
- Since:
- JavaFX 2.1
- See Also:
getMaxWidth()
,setMaxWidth(double)
-
setMaxHeight
public final void setMaxHeight(double value)
Sets the value of the property maxHeight.- Property description:
- Defines the maximum height of this
Stage
. - Default value:
- Double.MAX_VALUE
- Since:
- JavaFX 2.1
-
getMaxHeight
public final double getMaxHeight()
Gets the value of the property maxHeight.- Property description:
- Defines the maximum height of this
Stage
. - Default value:
- Double.MAX_VALUE
- Since:
- JavaFX 2.1
-
maxHeightProperty
public final DoubleProperty maxHeightProperty()
Defines the maximum height of thisStage
.- Default value:
- Double.MAX_VALUE
- Since:
- JavaFX 2.1
- See Also:
getMaxHeight()
,setMaxHeight(double)
-
toFront
public void toFront()
Bring theWindow
to the foreground. If theWindow
is already in the foreground there is no visible difference.
-
toBack
public void toBack()
Send theWindow
to the background. If theWindow
is already in the background there is no visible difference. This action places thisWindow
at the bottom of the stacking order on platforms that support stacking.
-
close
public void close()
Closes thisStage
. This call is equivalent tohide()
.
-
setFullScreenExitKeyCombination
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. If a security manager is present, the application must have the
FXPermission
"unrestrictedFullScreen" to modify the exit key combination. If the application does not have permission, the value of this property will be ignored, in which case the default key combination will be used.- Parameters:
keyCombination
- the key combination to exit on- Since:
- JavaFX 8.0
-
getFullScreenExitKeyCombination
public final KeyCombination getFullScreenExitKeyCombination()
Get the current sequence used to exit Full Screen mode.- Returns:
- the current setting (null for system default)
- Since:
- JavaFX 8.0
-
fullScreenExitKeyProperty
public final ObjectProperty<KeyCombination> fullScreenExitKeyProperty()
Get the property for the Full Screen exit key combination.- Since:
- JavaFX 8.0
-
setFullScreenExitHint
public final void setFullScreenExitHint(String value)
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.If a security manager is present, the application must have the
FXPermission
"unrestrictedFullScreen" to modify the exit hint. If the application does not have permission, the value of this property will be ignored, in which case the default message will be displayed.- Parameters:
value
- the string to be displayed.- Since:
- JavaFX 8.0
-
getFullScreenExitHint
public final String getFullScreenExitHint()
Gets the value of the property fullScreenExitHint.- Property description:
-
fullScreenExitHintProperty
public final ObjectProperty<String> fullScreenExitHintProperty()
-
-