- All Implemented Interfaces:
EventTarget
- Direct Known Subclasses:
Popup
,PopupControl
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.
- Since:
- JavaFX 2.0
-
Property Summary
TypePropertyDescriptionSpecifies the popup anchor point which is used in popup positioning.final ReadOnlyDoubleProperty
Specifies the x coordinate of the popup anchor point on the screen.final ReadOnlyDoubleProperty
Specifies the y coordinate of the popup anchor point on the screen.final BooleanProperty
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.final BooleanProperty
Specifies whether Popups should auto hide.final BooleanProperty
Specifies whether the event, which caused the Popup to hide, should be consumed.final BooleanProperty
Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.final ObjectProperty<EventHandler<Event>>
Called after autoHide is run.final ReadOnlyObjectProperty<Node>
The node which is the owner of this popup.final ReadOnlyObjectProperty<Window>
The window which is the parent of this popup.Properties declared in class javafx.stage.Window
eventDispatcher, focused, forceIntegerRenderScale, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, opacity, outputScaleX, outputScaleY, renderScaleX, renderScaleY, scene, showing, width, x, y
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Anchor location constants for popup anchor point selection. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the popup anchor point which is used in popup positioning.final ReadOnlyDoubleProperty
Specifies the x coordinate of the popup anchor point on the screen.final ReadOnlyDoubleProperty
Specifies the y coordinate of the popup anchor point on the screen.final BooleanProperty
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.final BooleanProperty
Specifies whether Popups should auto hide.final BooleanProperty
Specifies whether the event, which caused the Popup to hide, should be consumed.Gets the value of the property anchorLocation.final double
Gets the value of the property anchorX.final double
Gets the value of the property anchorY.final boolean
Gets the value of the property consumeAutoHidingEvents.final EventHandler<Event>
Gets the value of the property onAutoHide.final Node
Gets the value of the property ownerNode.final Window
Gets the value of the property ownerWindow.void
hide()
Hide this Popup and all its childrenfinal BooleanProperty
Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.final boolean
Gets the value of the property autoFix.final boolean
Gets the value of the property autoHide.final boolean
Gets the value of the property hideOnEscape.final ObjectProperty<EventHandler<Event>>
Called after autoHide is run.final ReadOnlyObjectProperty<Node>
The node which is the owner of this popup.final ReadOnlyObjectProperty<Window>
The window which is the parent of this popup.final void
Sets the value of the property anchorLocation.final void
setAnchorX
(double value) Sets the value of the property anchorX.final void
setAnchorY
(double value) Sets the value of the property anchorY.final void
setAutoFix
(boolean value) Sets the value of the property autoFix.final void
setAutoHide
(boolean value) Sets the value of the property autoHide.final void
setConsumeAutoHidingEvents
(boolean value) Sets the value of the property consumeAutoHidingEvents.final void
setHideOnEscape
(boolean value) Sets the value of the property hideOnEscape.final void
setOnAutoHide
(EventHandler<Event> value) Sets the value of the property onAutoHide.protected final void
Note to subclasses: the scene used by PopupWindow is very specifically managed by PopupWindow.void
Shows the popup at the specified location on the screen.void
Show the popup.void
Shows the popup at the specified location on the screen.Methods declared in 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, 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, show, showingProperty, sizeToScene, widthProperty, xProperty, yProperty
-
Property Details
-
ownerWindow
The window which is the parent of this popup. All popups must have an owner window.- See Also:
-
ownerNode
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:
-
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.- Default value:
- true
- See Also:
-
autoHide
Specifies whether Popups should auto hide. If a popup loses focus and autoHide is true, then the popup will be hidden automatically.The only exception is when owner Node is specified using
show(javafx.scene.Node, double, double)
. Focusing owner Node will not hide the PopupWindow.- Default value:
- false
- See Also:
-
onAutoHide
Called after autoHide is run.- See Also:
-
hideOnEscape
Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.- Default value:
- true
- See Also:
-
consumeAutoHidingEvents
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
- Since:
- JavaFX 2.2
- See Also:
-
anchorX
Specifies the x coordinate of the popup anchor point on the screen. If theanchorLocation
is set toWINDOW_TOP_LEFT
orWINDOW_BOTTOM_LEFT
thex
andanchorX
values will be identical.- Since:
- JavaFX 8.0
- See Also:
-
anchorY
Specifies the y coordinate of the popup anchor point on the screen. If theanchorLocation
is set toWINDOW_TOP_LEFT
orWINDOW_TOP_RIGHT
they
andanchorY
values will be identical.- Since:
- JavaFX 8.0
- See Also:
-
anchorLocation
Specifies the popup anchor point which is used in popup positioning. The point can be set to a corner of the popup window or a corner of its content. In this context the content corners are derived from the popup root node's layout bounds.In general changing of the anchor location won't change the current window position. Instead of that, the
anchorX
andanchorY
values are recalculated to correspond to the new anchor point.- Since:
- JavaFX 8.0
- See Also:
-
-
Constructor Details
-
PopupWindow
public PopupWindow()Constructor for subclasses to call.
-
-
Method Details
-
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
The window which is the parent of this popup. All popups must have an owner window.- See Also:
-
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
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:
-
setScene
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. -
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
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:
-
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.
The only exception is when owner Node is specified using
show(javafx.scene.Node, double, double)
. Focusing owner Node will not hide the PopupWindow. - 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.
The only exception is when owner Node is specified using
show(javafx.scene.Node, double, double)
. Focusing owner Node will not hide the PopupWindow. - Default value:
- false
-
autoHideProperty
Specifies whether Popups should auto hide. If a popup loses focus and autoHide is true, then the popup will be hidden automatically.The only exception is when owner Node is specified using
show(javafx.scene.Node, double, double)
. Focusing owner Node will not hide the PopupWindow.- Default value:
- false
- See Also:
-
setOnAutoHide
Sets the value of the property onAutoHide.- Property description:
- Called after autoHide is run.
-
getOnAutoHide
Gets the value of the property onAutoHide.- Property description:
- Called after autoHide is run.
-
onAutoHideProperty
Called after autoHide is run.- See Also:
-
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
Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.- Default value:
- true
- See Also:
-
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
- Since:
- JavaFX 2.2
-
getConsumeAutoHidingEvents
public final boolean getConsumeAutoHidingEvents()Gets 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
- Since:
- JavaFX 2.2
-
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
- Since:
- JavaFX 2.2
- See Also:
-
show
Show the popup.- Parameters:
owner
- The owner of the popup. This must not be null.- Throws:
NullPointerException
- if owner is nullIllegalArgumentException
- if the specified owner window would create cycle in the window hierarchy
-
show
Shows the popup at the specified location on the screen. The popup window is positioned in such way that its anchor point (anchorLocation
) is displayed at the specifiedanchorX
andanchorY
coordinates.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.Note that when
autoHide
is set to true, mouse press on the owner Node will not hide the PopupWindow.- Parameters:
ownerNode
- The owner Node of the popup. It must not be null and must be associated with a Window.anchorX
- the x position of the popup anchor in screen coordinatesanchorY
- the y position of the popup anchor in screen coordinates- Throws:
NullPointerException
- if ownerNode is nullIllegalArgumentException
- if the specified owner node is not associated with a Window or when the window would create cycle in the window hierarchy
-
show
Shows the popup at the specified location on the screen. The popup window is positioned in such way that its anchor point (anchorLocation
) is displayed at the specifiedanchorX
andanchorY
coordinates.- Parameters:
ownerWindow
- The owner of the popup. This must not be null.anchorX
- the x position of the popup anchor in screen coordinatesanchorY
- the y position of the popup anchor in screen coordinates- Throws:
NullPointerException
- if ownerWindow is nullIllegalArgumentException
- if the specified owner window would create cycle in the window hierarchy
-
hide
public void hide()Hide this Popup and all its children -
setAnchorX
public final void setAnchorX(double value) Sets the value of the property anchorX.- Property description:
- Specifies the x coordinate of the popup anchor point on the screen. If
the
anchorLocation
is set toWINDOW_TOP_LEFT
orWINDOW_BOTTOM_LEFT
thex
andanchorX
values will be identical. - Since:
- JavaFX 8.0
-
getAnchorX
public final double getAnchorX()Gets the value of the property anchorX.- Property description:
- Specifies the x coordinate of the popup anchor point on the screen. If
the
anchorLocation
is set toWINDOW_TOP_LEFT
orWINDOW_BOTTOM_LEFT
thex
andanchorX
values will be identical. - Since:
- JavaFX 8.0
-
anchorXProperty
Specifies the x coordinate of the popup anchor point on the screen. If theanchorLocation
is set toWINDOW_TOP_LEFT
orWINDOW_BOTTOM_LEFT
thex
andanchorX
values will be identical.- Since:
- JavaFX 8.0
- See Also:
-
setAnchorY
public final void setAnchorY(double value) Sets the value of the property anchorY.- Property description:
- Specifies the y coordinate of the popup anchor point on the screen. If
the
anchorLocation
is set toWINDOW_TOP_LEFT
orWINDOW_TOP_RIGHT
they
andanchorY
values will be identical. - Since:
- JavaFX 8.0
-
getAnchorY
public final double getAnchorY()Gets the value of the property anchorY.- Property description:
- Specifies the y coordinate of the popup anchor point on the screen. If
the
anchorLocation
is set toWINDOW_TOP_LEFT
orWINDOW_TOP_RIGHT
they
andanchorY
values will be identical. - Since:
- JavaFX 8.0
-
anchorYProperty
Specifies the y coordinate of the popup anchor point on the screen. If theanchorLocation
is set toWINDOW_TOP_LEFT
orWINDOW_TOP_RIGHT
they
andanchorY
values will be identical.- Since:
- JavaFX 8.0
- See Also:
-
setAnchorLocation
Sets the value of the property anchorLocation.- Property description:
- Specifies the popup anchor point which is used in popup positioning. The
point can be set to a corner of the popup window or a corner of its
content. In this context the content corners are derived from the popup
root node's layout bounds.
In general changing of the anchor location won't change the current window position. Instead of that, the
anchorX
andanchorY
values are recalculated to correspond to the new anchor point. - Since:
- JavaFX 8.0
-
getAnchorLocation
Gets the value of the property anchorLocation.- Property description:
- Specifies the popup anchor point which is used in popup positioning. The
point can be set to a corner of the popup window or a corner of its
content. In this context the content corners are derived from the popup
root node's layout bounds.
In general changing of the anchor location won't change the current window position. Instead of that, the
anchorX
andanchorY
values are recalculated to correspond to the new anchor point. - Since:
- JavaFX 8.0
-
anchorLocationProperty
Specifies the popup anchor point which is used in popup positioning. The point can be set to a corner of the popup window or a corner of its content. In this context the content corners are derived from the popup root node's layout bounds.In general changing of the anchor location won't change the current window position. Instead of that, the
anchorX
andanchorY
values are recalculated to correspond to the new anchor point.- Since:
- JavaFX 8.0
- See Also:
-