javafx.stage

Class PopupWindow

java.lang.Object

javafx.stage.Window

javafx.stage.PopupWindow

All Implemented Interfaces:

EventTarget

Direct Known Subclasses:

Popup, PopupControl

public abstract class PopupWindow
extends Window

PopupWindow is the parent for a variety of different types of popup based windows including Popup and Tooltip and ContextMenu.

A PopupWindow is a secondary window which has no window decorations or title bar. It doesn't show up in the OS as a top-level window. It is typically used for tool tip like notification, drop down boxes, menus, and so forth.

The PopupWindow cannot be shown without an owner. PopupWindows require that an owner window exist in order to be shown. However, it is possible to create a PopupWindow ahead of time and simply set the owner (or change the owner) before first being made visible. Attempting to change the owner while the PopupWindow is visible will result in an IllegalStateException.

The PopupWindow encapsulates much of the behavior and functionality common to popups, such as the ability to close when the "esc" key is pressed, or the ability to hide all child popup windows whenever this window is hidden. These abilities can be enabled or disabled via properties.

Property Summary

Properties

Type	Property and Description
BooleanProperty	autoFix This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.
BooleanProperty	autoHide Specifies whether Popups should auto hide.
BooleanProperty	consumeAutoHidingEvents Specifies whether the event, which caused the Popup to hide, should be consumed.
BooleanProperty	hideOnEscape Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.
ObjectProperty<EventHandler<Event>>	onAutoHide Called after autoHide is run.
ReadOnlyObjectProperty<Node>	ownerNode The node which is the owner of this popup.
ReadOnlyObjectProperty<Window>	ownerWindow The window which is the parent of this popup.

Properties inherited from class javafx.stage.Window

eventDispatcher, focused, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, opacity, scene, showing, width, x, y

Constructor Summary

Constructors

Constructor and Description
PopupWindow()

Method Summary

Methods

Modifier and Type	Method and Description
BooleanProperty	autoFixProperty() This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.
BooleanProperty	autoHideProperty() Specifies whether Popups should auto hide.
BooleanProperty	consumeAutoHidingEventsProperty() Specifies whether the event, which caused the Popup to hide, should be consumed.
boolean	getConsumeAutoHidingEvents()
EventHandler<Event>	getOnAutoHide() Gets the value of the property onAutoHide.
Node	getOwnerNode() Gets the value of the property ownerNode.
Window	getOwnerWindow() Gets the value of the property ownerWindow.
void	hide() Hide this Popup and all its children
BooleanProperty	hideOnEscapeProperty() Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.
boolean	isAutoFix() Gets the value of the property autoFix.
boolean	isAutoHide() Gets the value of the property autoHide.
boolean	isHideOnEscape() Gets the value of the property hideOnEscape.
ObjectProperty<EventHandler<Event>>	onAutoHideProperty() Called after autoHide is run.
ReadOnlyObjectProperty<Node>	ownerNodeProperty() The node which is the owner of this popup.
ReadOnlyObjectProperty<Window>	ownerWindowProperty() The window which is the parent of this popup.
void	setAutoFix(boolean value) Sets the value of the property autoFix.
void	setAutoHide(boolean value) Sets the value of the property autoHide.
void	setConsumeAutoHidingEvents(boolean value) Sets the value of the property consumeAutoHidingEvents.
void	setHideOnEscape(boolean value) Sets the value of the property hideOnEscape.
void	setOnAutoHide(EventHandler<Event> value) Sets the value of the property onAutoHide.
protected void	setScene(Scene scene) Note to subclasses: the scene used by PopupWindow is very specifically managed by PopupWindow.
void	show(Node ownerNode, double screenX, double screenY) Shows the popup at the specified x,y location relative to the screen.
void	show(Window owner) Show the popup.
void	show(Window ownerWindow, double screenX, double screenY) Show the Popup at the specified x,y location relative to the screen

Methods inherited from class javafx.stage.Window

addEventFilter, addEventHandler, buildEventDispatchChain, centerOnScreen, eventDispatcherProperty, fireEvent, focusedProperty, getEventDispatcher, getHeight, getOnCloseRequest, getOnHidden, getOnHiding, getOnShowing, getOnShown, getOpacity, getScene, getWidth, getX, getY, heightProperty, isFocused, isShowing, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, removeEventFilter, removeEventHandler, requestFocus, sceneProperty, setEventDispatcher, setEventHandler, setHeight, setOnCloseRequest, setOnHidden, setOnHiding, setOnShowing, setOnShown, setOpacity, setWidth, setX, setY, show, showingProperty, sizeToScene, widthProperty, xProperty, yProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

ownerWindow

public final ReadOnlyObjectProperty<Window> ownerWindowProperty

The window which is the parent of this popup. All popups must have an owner window.

See Also:

getOwnerWindow()

ownerNode

public final ReadOnlyObjectProperty<Node> ownerNodeProperty

The node which is the owner of this popup. All popups must have an owner window but are not required to be associated with an owner node. If an autohide Popup has an owner node, mouse press inside the owner node doesn't cause the Popup to hide.

See Also:

getOwnerNode()

autoFix

public final BooleanProperty autoFixProperty

This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.

Default value:

true

See Also:

isAutoFix(), setAutoFix(boolean)

autoHide

public final BooleanProperty autoHideProperty

Specifies whether Popups should auto hide. If a popup loses focus and autoHide is true, then the popup will be hidden automatically.

Default value:

false

See Also:

isAutoHide(), setAutoHide(boolean)

onAutoHide

public final ObjectProperty<EventHandler<Event>> onAutoHideProperty

Called after autoHide is run.

See Also:

getOnAutoHide(), setOnAutoHide(EventHandler)

hideOnEscape

public final BooleanProperty hideOnEscapeProperty

Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.

Default value:

true

See Also:

isHideOnEscape(), setHideOnEscape(boolean)

consumeAutoHidingEvents

public final BooleanProperty consumeAutoHidingEventsProperty

Specifies whether the event, which caused the Popup to hide, should be consumed. Having the event consumed prevents it from triggering some additional UI response in the Popup's owner window.

Default value:

true

See Also:

setConsumeAutoHidingEvents(boolean)

Constructor Detail

PopupWindow

public PopupWindow()

Method Detail

getOwnerWindow

public final Window getOwnerWindow()

Gets the value of the property ownerWindow.

Property description:

The window which is the parent of this popup. All popups must have an owner window.

ownerWindowProperty

public final ReadOnlyObjectProperty<Window> ownerWindowProperty()

The window which is the parent of this popup. All popups must have an owner window.

See Also:

getOwnerWindow()

getOwnerNode

public final Node getOwnerNode()

Gets the value of the property ownerNode.

Property description:

The node which is the owner of this popup. All popups must have an owner window but are not required to be associated with an owner node. If an autohide Popup has an owner node, mouse press inside the owner node doesn't cause the Popup to hide.

ownerNodeProperty

public final ReadOnlyObjectProperty<Node> ownerNodeProperty()

The node which is the owner of this popup. All popups must have an owner window but are not required to be associated with an owner node. If an autohide Popup has an owner node, mouse press inside the owner node doesn't cause the Popup to hide.

See Also:

getOwnerNode()

setScene

protected final void setScene(Scene scene)

Note to subclasses: the scene used by PopupWindow is very specifically managed by PopupWindow. This method is overridden to throw UnsupportedOperationException. You cannot specify your own scene.

Overrides:

setScene in class Window

Parameters:

scene -

setAutoFix

public final void setAutoFix(boolean value)

Sets the value of the property autoFix.

Property description:

This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.

Default value:

true

isAutoFix

public final boolean isAutoFix()

Gets the value of the property autoFix.

Property description:

This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.

Default value:

true

autoFixProperty

public final BooleanProperty autoFixProperty()

This convenience variable indicates whether, when the popup is shown, it should automatically correct its position such that it doesn't end up positioned off the screen.

Default value:

true

See Also:

isAutoFix(), setAutoFix(boolean)

setAutoHide

public final void setAutoHide(boolean value)

Sets the value of the property autoHide.

Property description:

Specifies whether Popups should auto hide. If a popup loses focus and autoHide is true, then the popup will be hidden automatically.

Default value:

false

isAutoHide

public final boolean isAutoHide()

Gets the value of the property autoHide.

Property description:

Specifies whether Popups should auto hide. If a popup loses focus and autoHide is true, then the popup will be hidden automatically.

Default value:

false

autoHideProperty

public final BooleanProperty autoHideProperty()

Specifies whether Popups should auto hide. If a popup loses focus and autoHide is true, then the popup will be hidden automatically.

Default value:

false

See Also:

isAutoHide(), setAutoHide(boolean)

setOnAutoHide

public final void setOnAutoHide(EventHandler<Event> value)

Sets the value of the property onAutoHide.

Property description:

Called after autoHide is run.

getOnAutoHide

public final EventHandler<Event> getOnAutoHide()

Gets the value of the property onAutoHide.

Property description:

Called after autoHide is run.

onAutoHideProperty

public final ObjectProperty<EventHandler<Event>> onAutoHideProperty()

Called after autoHide is run.

See Also:

getOnAutoHide(), setOnAutoHide(EventHandler)

setHideOnEscape

public final void setHideOnEscape(boolean value)

Sets the value of the property hideOnEscape.

Property description:

Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.

Default value:

true

isHideOnEscape

public final boolean isHideOnEscape()

Gets the value of the property hideOnEscape.

Property description:

Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.

Default value:

true

hideOnEscapeProperty

public final BooleanProperty hideOnEscapeProperty()

Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.

Default value:

true

See Also:

isHideOnEscape(), setHideOnEscape(boolean)

setConsumeAutoHidingEvents

public final void setConsumeAutoHidingEvents(boolean value)

Sets the value of the property consumeAutoHidingEvents.

Property description:

Specifies whether the event, which caused the Popup to hide, should be consumed. Having the event consumed prevents it from triggering some additional UI response in the Popup's owner window.

Default value:

true

getConsumeAutoHidingEvents

public final boolean getConsumeAutoHidingEvents()

consumeAutoHidingEventsProperty

public final BooleanProperty consumeAutoHidingEventsProperty()

Specifies whether the event, which caused the Popup to hide, should be consumed. Having the event consumed prevents it from triggering some additional UI response in the Popup's owner window.

Default value:

true

See Also:

setConsumeAutoHidingEvents(boolean)

show

public void show(Window owner)

Show the popup.

Parameters:

owner - The owner of the popup. This must not be null.

Throws:

java.lang.NullPointerException - if owner is null

java.lang.IllegalArgumentException - if the specified owner window would create cycle in the window hierarchy

show

public void show(Node ownerNode,
        double screenX,
        double screenY)

Shows the popup at the specified x,y location relative to the screen. The popup is associated with the specified owner node. The Window which contains the owner node at the time of the call becomes an owner window of the displayed popup.

Parameters:

ownerNode - The owner Node of the popup. It must not be null and must be associated with a Window.

screenX - the x location in screen coordinates at which to show this PopupWindow.

screenY - the y location in screen coordiates at which to show this PopupWindow.

Throws:

java.lang.NullPointerException - if ownerNode is null

java.lang.IllegalArgumentException - if the specified owner node is not associated with a Window or when the window would create cycle in the window hierarchy

show

public void show(Window ownerWindow,
        double screenX,
        double screenY)

Show the Popup at the specified x,y location relative to the screen

Parameters:

ownerWindow - The owner of the popup. This must not be null.

screenX - the x location in screen coordinates at which to show this PopupWindow.

screenY - the y location in screen coordiates at which to show this PopupWindow.

Throws:

java.lang.NullPointerException - if ownerWindow is null

java.lang.IllegalArgumentException - if the specified owner window would create cycle in the window hierarchy

hide

public void hide()

Hide this Popup and all its children

Overrides:

hide in class Window