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.

Since:

JavaFX 2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PopupWindow.AnchorLocation Anchor location constants for popup anchor point selection.

Field Summary

Fields inherited from class javafx.stage.Window

impl_peer, peerListener

Constructor Summary

Constructors

Constructor and Description
PopupWindow()

Method Summary

Modifier and Type	Method and Description
ObjectProperty<PopupWindow.AnchorLocation>	anchorLocationProperty()
ReadOnlyDoubleProperty	anchorXProperty()
ReadOnlyDoubleProperty	anchorYProperty()
BooleanProperty	autoFixProperty()
BooleanProperty	autoHideProperty()
BooleanProperty	consumeAutoHidingEventsProperty()
PopupWindow.AnchorLocation	getAnchorLocation()
double	getAnchorX()
double	getAnchorY()
boolean	getConsumeAutoHidingEvents()
protected ObservableList<Node>	getContent() Deprecated. This is an internal API that is not intended for use and will be removed in the next version
EventHandler<Event>	getOnAutoHide()
Node	getOwnerNode()
Window	getOwnerWindow()
void	hide() Hide this Popup and all its children
BooleanProperty	hideOnEscapeProperty()
protected void	impl_visibleChanged(boolean visible) 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 visible) Deprecated. This is an internal API that is not intended for use and will be removed in the next version
boolean	isAutoFix()
boolean	isAutoHide()
boolean	isHideOnEscape()
ObjectProperty<EventHandler<Event>>	onAutoHideProperty()
ReadOnlyObjectProperty<Node>	ownerNodeProperty()
ReadOnlyObjectProperty<Window>	ownerWindowProperty()
void	setAnchorLocation(PopupWindow.AnchorLocation value)
void	setAnchorX(double value)
void	setAnchorY(double value)
void	setAutoFix(boolean value)
void	setAutoHide(boolean value)
void	setConsumeAutoHidingEvents(boolean value)
void	setHideOnEscape(boolean value)
void	setOnAutoHide(EventHandler<Event> value)
protected void	setScene(Scene scene) Note to subclasses: the scene used by PopupWindow is very specifically managed by PopupWindow.
void	show(Node ownerNode, double anchorX, double anchorY) Shows the popup at the specified location on the screen.
void	show(Window owner) Show the popup.
void	show(Window ownerWindow, double anchorX, double anchorY) Shows the popup at the specified location on the screen.

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, impl_getMXWindowType, 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, show, 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

PopupWindow

public PopupWindow()

Method Detail

getContent

@Deprecated
protected ObservableList<Node> getContent()

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Gets the observable, modifiable list of children which are placed in this PopupWindow.

Returns:

the PopupWindow content

getOwnerWindow

public final Window getOwnerWindow()

ownerWindowProperty

public final ReadOnlyObjectProperty<Window> ownerWindowProperty()

getOwnerNode

public final Node getOwnerNode()

ownerNodeProperty

public final ReadOnlyObjectProperty<Node> ownerNodeProperty()

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)

isAutoFix

public final boolean isAutoFix()

autoFixProperty

public final BooleanProperty autoFixProperty()

setAutoHide

public final void setAutoHide(boolean value)

isAutoHide

public final boolean isAutoHide()

autoHideProperty

public final BooleanProperty autoHideProperty()

setOnAutoHide

public final void setOnAutoHide(EventHandler<Event> value)

getOnAutoHide

public final EventHandler<Event> getOnAutoHide()

onAutoHideProperty

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

setHideOnEscape

public final void setHideOnEscape(boolean value)

isHideOnEscape

public final boolean isHideOnEscape()

hideOnEscapeProperty

public final BooleanProperty hideOnEscapeProperty()

setConsumeAutoHidingEvents

public final void setConsumeAutoHidingEvents(boolean value)

getConsumeAutoHidingEvents

public final boolean getConsumeAutoHidingEvents()

consumeAutoHidingEventsProperty

public final BooleanProperty consumeAutoHidingEventsProperty()

show

public void show(Window owner)

Show the popup.

Parameters:

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

Throws:

NullPointerException - if owner is null

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

show

public void show(Node ownerNode,
                 double anchorX,
                 double anchorY)

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 specified anchorX and anchorY 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 autoHideProperty() 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 coordinates

anchorY - the y position of the popup anchor in screen coordinates

Throws:

NullPointerException - if ownerNode is null

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 anchorX,
                 double anchorY)

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 specified anchorX and anchorY coordinates.

Parameters:

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

anchorX - the x position of the popup anchor in screen coordinates

anchorY - the y position of the popup anchor in screen coordinates

Throws:

NullPointerException - if ownerWindow is null

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

impl_visibleChanging

@Deprecated
protected void impl_visibleChanging(boolean visible)

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 visible)

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

setAnchorX

public final void setAnchorX(double value)

getAnchorX

public final double getAnchorX()

anchorXProperty

public final ReadOnlyDoubleProperty anchorXProperty()

setAnchorY

public final void setAnchorY(double value)

getAnchorY

public final double getAnchorY()

anchorYProperty

public final ReadOnlyDoubleProperty anchorYProperty()

setAnchorLocation

public final void setAnchorLocation(PopupWindow.AnchorLocation value)

getAnchorLocation

public final PopupWindow.AnchorLocation getAnchorLocation()

anchorLocationProperty

public final ObjectProperty<PopupWindow.AnchorLocation> anchorLocationProperty()