Stage (openjfx 8.0.202 API)

java.lang.Object
- javafx.stage.Window
- - javafx.stage.Stage

All Implemented Interfaces:

EventTarget
```
public class Stage
extends Window
```
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.

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 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:

produces the following on Mac OSX:

produces the following on Linux:
Since:

JavaFX 2.0

Field Summary
- Fields inherited from class javafx.stage.Window
  impl_peer, peerListener

Constructor Summary

Constructors
Constructor and Description

Stage()
Creates a new instance of decorated Stage.

Stage(StageStyle style)
Creates a new instance of Stage.

Constructors
Constructor and Description
`Stage()` Creates a new instance of decorated `Stage`.
`Stage(StageStyle style)` Creates a new instance of `Stage`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ReadOnlyBooleanProperty`	`alwaysOnTopProperty()`
`void`	`close()` Closes this `Stage`.
`ObjectProperty<String>`	`fullScreenExitHintProperty()`
`ObjectProperty<KeyCombination>`	`fullScreenExitKeyProperty()` Get the property for the Full Screen exit key combination.
`ReadOnlyBooleanProperty`	`fullScreenProperty()`
`String`	`getFullScreenExitHint()`
`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()`
`double`	`getMaxWidth()`
`double`	`getMinHeight()`
`double`	`getMinWidth()`
`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()`
`ReadOnlyBooleanProperty`	`iconifiedProperty()`
`String`	`impl_getMXWindowType()` Deprecated. This is an internal API that is not intended for use and will be removed in the next version
`void`	`impl_setImportant(boolean important)` Deprecated. This is an internal API that is not intended for use and will be removed in the next version
`void`	`impl_setPrimary(boolean primary)` Deprecated. This is an internal API that is not intended for use and will be removed in the next version
`protected void`	`impl_visibleChanged(boolean value)` Deprecated. This is an internal API that is not intended for use and will be removed in the next version
`protected void`	`impl_visibleChanging(boolean value)` Deprecated. This is an internal API that is not intended for use and will be removed in the next version
`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()`
`boolean`	`isFullScreen()`
`boolean`	`isIconified()`
`boolean`	`isMaximized()`
`boolean`	`isResizable()`
`DoubleProperty`	`maxHeightProperty()`
`ReadOnlyBooleanProperty`	`maximizedProperty()`
`DoubleProperty`	`maxWidthProperty()`
`DoubleProperty`	`minHeightProperty()`
`DoubleProperty`	`minWidthProperty()`
`BooleanProperty`	`resizableProperty()`
`void`	`setAlwaysOnTop(boolean value)`
`void`	`setFullScreen(boolean value)`
`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)`
`void`	`setMaxHeight(double value)`
`void`	`setMaximized(boolean value)`
`void`	`setMaxWidth(double value)`
`void`	`setMinHeight(double value)`
`void`	`setMinWidth(double value)`
`void`	`setResizable(boolean value)`
`void`	`setScene(Scene value)` Specify the scene to be used on this stage.
`void`	`setTitle(String value)`
`void`	`show()` Attempts to show this Window by setting visibility to true
`void`	`showAndWait()` Shows this stage and waits for it to be hidden (closed) before returning to the caller.
`StringProperty`	`titleProperty()`
`void`	`toBack()` Send the `Window` to the background.
`void`	`toFront()` Bring the `Window` to the foreground.

Methods inherited from class javafx.stage.Window
addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getProperties, getScene, getUserData, getWidth, getX, getY, hasProperties, heightProperty, hide, impl_getPeer, impl_getWindows, isFocused, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, removeEventFilter, removeEventHandler, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setFocused, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setUserData, setWidth, setX, setY, showingProperty, sizeToScene, widthProperty, xProperty, yProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Stage
```
public Stage()
```
    Creates a new instance of decorated Stage.
    
    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 of Stage.
    
    Parameters:
    
    style - The style of the Stage
    
    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.
    
    Overrides:
    
    setScene in class Window
  - show
```
public final void show()
```
    Description copied from class: Window
    
    Attempts to show this Window by setting visibility to true
    
    Overrides:
    
    show in class Window
  - impl_setPrimary
```
@Deprecated
public void impl_setPrimary(boolean primary)
```
    Deprecated. This is an internal API that is not intended for use and will be removed in the next version
    
    sets this stage to be the primary stage. When run as an applet, this stage will appear in the broswer
  - impl_getMXWindowType
```
@Deprecated
public String impl_getMXWindowType()
```
    Deprecated. This is an internal API that is not intended for use and will be removed in the next version
    
    Overrides:
    
    impl_getMXWindowType in class Window
  - impl_setImportant
```
@Deprecated
public void impl_setImportant(boolean important)
```
    Deprecated. This is an internal API that is not intended for use and will be removed in the next version
    
    Sets a flag indicating whether this stage is an "important" window for the purpose of determining whether the application is idle and should exit. The application is considered finished when the last important window is closed.
  - 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() 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:
    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
  - 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.
    
    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.
    
    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.
    
    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)
```
  - isFullScreen
```
public final boolean isFullScreen()
```
  - fullScreenProperty
```
public final ReadOnlyBooleanProperty fullScreenProperty()
```
  - 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)
```
  - getTitle
```
public final String getTitle()
```
  - titleProperty
```
public final StringProperty titleProperty()
```
  - setIconified
```
public final void setIconified(boolean value)
```
  - isIconified
```
public final boolean isIconified()
```
  - iconifiedProperty
```
public final ReadOnlyBooleanProperty iconifiedProperty()
```
  - setMaximized
```
public final void setMaximized(boolean value)
```
  - isMaximized
```
public final boolean isMaximized()
```
  - maximizedProperty
```
public final ReadOnlyBooleanProperty maximizedProperty()
```
  - setAlwaysOnTop
```
public final void setAlwaysOnTop(boolean value)
```
  - isAlwaysOnTop
```
public final boolean isAlwaysOnTop()
```
  - alwaysOnTopProperty
```
public final ReadOnlyBooleanProperty alwaysOnTopProperty()
```
  - setResizable
```
public final void setResizable(boolean value)
```
  - isResizable
```
public final boolean isResizable()
```
  - resizableProperty
```
public final BooleanProperty resizableProperty()
```
  - setMinWidth
```
public final void setMinWidth(double value)
```
  - getMinWidth
```
public final double getMinWidth()
```
  - minWidthProperty
```
public final DoubleProperty minWidthProperty()
```
  - setMinHeight
```
public final void setMinHeight(double value)
```
  - getMinHeight
```
public final double getMinHeight()
```
  - minHeightProperty
```
public final DoubleProperty minHeightProperty()
```
  - setMaxWidth
```
public final void setMaxWidth(double value)
```
  - getMaxWidth
```
public final double getMaxWidth()
```
  - maxWidthProperty
```
public final DoubleProperty maxWidthProperty()
```
  - setMaxHeight
```
public final void setMaxHeight(double value)
```
  - getMaxHeight
```
public final double getMaxHeight()
```
  - maxHeightProperty
```
public final DoubleProperty maxHeightProperty()
```
  - impl_visibleChanging
```
@Deprecated
protected void impl_visibleChanging(boolean value)
```
    Deprecated. This is an internal API that is not intended for use and will be removed in the next version
    
    Description copied from class: Window
    
    This can be replaced by listening for the onShowing/onHiding events
    
    Overrides:
    
    impl_visibleChanging in class Window
  - impl_visibleChanged
```
@Deprecated
protected void impl_visibleChanged(boolean value)
```
    Deprecated. This is an internal API that is not intended for use and will be removed in the next version
    
    Description copied from class: Window
    
    This can be replaced by listening for the onShown/onHidden events
    
    Overrides:
    
    impl_visibleChanged in class Window
  - toFront
```
public void toFront()
```
    Bring the Window to the foreground. If the Window is already in the foreground there is no visible difference.
  - toBack
```
public void toBack()
```
    Send the Window to the background. If the Window is already in the background there is no visible difference. This action places this Window at the bottom of the stacking order on platforms that support stacking.
  - close
```
public void close()
```
    Closes this Stage. This call is equivalent to hide().
  - 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 FullScreen mode and will be used to trigger the exit from the mode. If an application does not have the proper permissions, this setting will be ignored.
    
    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.
    
    Returns:
    
    the property.
    
    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 an application does not have the proper permissions, this setting will be ignored.
    
    Parameters:
    
    value - the string to be displayed.
    
    Since:
    
    JavaFX 8.0
  - getFullScreenExitHint
```
public final String getFullScreenExitHint()
```
  - fullScreenExitHintProperty
```
public final ObjectProperty<String> fullScreenExitHintProperty()
```

Class Stage

Field Summary

Fields inherited from class javafx.stage.Window

Constructor Summary

Method Summary

Methods inherited from class javafx.stage.Window

Methods inherited from class java.lang.Object

Constructor Detail

Stage

Stage

Method Detail

setScene

show

impl_setPrimary

impl_getMXWindowType

impl_setImportant

showAndWait

initStyle

getStyle

initModality

getModality

initOwner

getOwner

setFullScreen

isFullScreen

fullScreenProperty

getIcons

setTitle

getTitle

titleProperty

setIconified

isIconified

iconifiedProperty

setMaximized

isMaximized

maximizedProperty

setAlwaysOnTop

isAlwaysOnTop

alwaysOnTopProperty

setResizable

isResizable

resizableProperty

setMinWidth

getMinWidth

minWidthProperty

setMinHeight

getMinHeight

minHeightProperty

setMaxWidth

getMaxWidth

maxWidthProperty

setMaxHeight

getMaxHeight

maxHeightProperty

impl_visibleChanging

impl_visibleChanged

toFront

toBack

close

setFullScreenExitKeyCombination

getFullScreenExitKeyCombination

fullScreenExitKeyProperty

setFullScreenExitHint

getFullScreenExitHint

fullScreenExitHintProperty