Class Popup

java.lang.Object

javafx.stage.Window

javafx.stage.PopupWindow

javafx.stage.Popup

All Implemented Interfaces:

EventTarget

public class Popup
extends PopupWindow

A Popup is a special window-like container for a scene graph. It is typically used for tooltip like notification, drop down boxes, menus, and so forth. The popup has no decorations, and essentially acts as a specialized scene/window which has no decorations, is transparent, and with a null fill.

Since:

JavaFX 2.0

Nested Class Summary

Nested classes/interfaces declared in class PopupWindow

PopupWindow.AnchorLocation

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

Property Summary

Properties declared in class PopupWindow

anchorLocation, anchorX, anchorY, autoFix, autoHide, consumeAutoHidingEvents, hideOnEscape, onAutoHide, ownerNode, ownerWindow

Type	Property	Description
final ObjectProperty<PopupWindow.AnchorLocation>	anchorLocation	Specifies the popup anchor point which is used in popup positioning.
final ReadOnlyDoubleProperty	anchorX	Specifies the x coordinate of the popup anchor point on the screen.
final ReadOnlyDoubleProperty	anchorY	Specifies the y coordinate of the popup anchor point on the screen.
final 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.
final BooleanProperty	autoHide	Specifies whether Popups should auto hide.
final BooleanProperty	consumeAutoHidingEvents	Specifies whether the event, which caused the Popup to hide, should be consumed.
final BooleanProperty	hideOnEscape	Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.
final ObjectProperty<EventHandler<Event>>	onAutoHide	Called after autoHide is run.
final ReadOnlyObjectProperty<Node>	ownerNode	The node which is the owner of this popup.
final ReadOnlyObjectProperty<Window>	ownerWindow	The window which is the parent of this popup.

Properties declared in class Window

eventDispatcher, focused, forceIntegerRenderScale, height, onCloseRequest, onHidden, onHiding, onShowing, onShown, opacity, outputScaleX, outputScaleY, renderScaleX, renderScaleY, scene, showing, width, x, y

Type	Property	Description
final ObjectProperty<EventDispatcher>	eventDispatcher	Specifies the event dispatcher for this node.
final ReadOnlyBooleanProperty	focused	Whether or not this Window has the keyboard or input focus.
final BooleanProperty	forceIntegerRenderScale	Boolean property that controls whether only integer render scales are set by default by the system when there is a change in the associated output scale.
final ReadOnlyDoubleProperty	height	The height of this Window.
final ObjectProperty<EventHandler<WindowEvent>>	onCloseRequest	Called when there is an external request to close this Window.
final ObjectProperty<EventHandler<WindowEvent>>	onHidden	Called just after the Window has been hidden.
final ObjectProperty<EventHandler<WindowEvent>>	onHiding	Called just prior to the Window being hidden.
final ObjectProperty<EventHandler<WindowEvent>>	onShowing	Called just prior to the Window being shown.
final ObjectProperty<EventHandler<WindowEvent>>	onShown	Called just after the Window is shown.
final DoubleProperty	opacity	Defines the opacity of the Window as a value between 0.0 and 1.0.
final ReadOnlyDoubleProperty	outputScaleX	The scale that the Window will apply to horizontal scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.
final ReadOnlyDoubleProperty	outputScaleY	The scale that the Window will apply to vertical scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.
final DoubleProperty	renderScaleX	The horizontal scale that the Window will use when rendering its Scene to the rendering buffer.
final DoubleProperty	renderScaleY	The vertical scale that the Window will use when rendering its Scene to the rendering buffer.
final ReadOnlyObjectProperty<Scene>	scene	The Scene to be rendered on this Window.
final ReadOnlyBooleanProperty	showing	Whether or not this Window is showing (that is, open on the user's system).
final ReadOnlyDoubleProperty	width	The width of this Window.
final ReadOnlyDoubleProperty	x	The horizontal location of this Window on the screen.
final ReadOnlyDoubleProperty	y	The vertical location of this Window on the screen.

Constructor Summary

Constructors

Constructor	Description
Popup()	Creates a Popup.

Method Summary

Modifier and Type	Method	Description
final ObservableList<Node>	getContent()	The ObservableList of Nodes to be rendered on this Popup.

Methods declared in class PopupWindow

anchorLocationProperty, anchorXProperty, anchorYProperty, autoFixProperty, autoHideProperty, consumeAutoHidingEventsProperty, getAnchorLocation, getAnchorX, getAnchorY, getConsumeAutoHidingEvents, getOnAutoHide, getOwnerNode, getOwnerWindow, hide, hideOnEscapeProperty, isAutoFix, isAutoHide, isHideOnEscape, onAutoHideProperty, ownerNodeProperty, ownerWindowProperty, setAnchorLocation, setAnchorX, setAnchorY, setAutoFix, setAutoHide, setConsumeAutoHidingEvents, setHideOnEscape, setOnAutoHide, setScene, show, show, show

Modifier and Type	Method	Description
final ObjectProperty<PopupWindow.AnchorLocation>	anchorLocationProperty()	Specifies the popup anchor point which is used in popup positioning.
final ReadOnlyDoubleProperty	anchorXProperty()	Specifies the x coordinate of the popup anchor point on the screen.
final ReadOnlyDoubleProperty	anchorYProperty()	Specifies the y coordinate of the popup anchor point on the screen.
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.
final BooleanProperty	autoHideProperty()	Specifies whether Popups should auto hide.
final BooleanProperty	consumeAutoHidingEventsProperty()	Specifies whether the event, which caused the Popup to hide, should be consumed.
final PopupWindow.AnchorLocation	getAnchorLocation()	Gets the value of the anchorLocation property.
final double	getAnchorX()	Gets the value of the anchorX property.
final double	getAnchorY()	Gets the value of the anchorY property.
final boolean	getConsumeAutoHidingEvents()	Gets the value of the consumeAutoHidingEvents property.
final EventHandler<Event>	getOnAutoHide()	Gets the value of the onAutoHide property.
final Node	getOwnerNode()	Gets the value of the ownerNode property.
final Window	getOwnerWindow()	Gets the value of the ownerWindow property.
void	hide()	Hide this Popup and all its children
final BooleanProperty	hideOnEscapeProperty()	Specifies whether the PopupWindow should be hidden when an unhandled escape key is pressed while the popup has focus.
final boolean	isAutoFix()	Gets the value of the autoFix property.
final boolean	isAutoHide()	Gets the value of the autoHide property.
final boolean	isHideOnEscape()	Gets the value of the hideOnEscape property.
final ObjectProperty<EventHandler<Event>>	onAutoHideProperty()	Called after autoHide is run.
final ReadOnlyObjectProperty<Node>	ownerNodeProperty()	The node which is the owner of this popup.
final ReadOnlyObjectProperty<Window>	ownerWindowProperty()	The window which is the parent of this popup.
final void	setAnchorLocation(PopupWindow.AnchorLocation value)	Sets the value of the anchorLocation property.
final void	setAnchorX(double value)	Sets the value of the anchorX property.
final void	setAnchorY(double value)	Sets the value of the anchorY property.
final void	setAutoFix(boolean value)	Sets the value of the autoFix property.
final void	setAutoHide(boolean value)	Sets the value of the autoHide property.
final void	setConsumeAutoHidingEvents(boolean value)	Sets the value of the consumeAutoHidingEvents property.
final void	setHideOnEscape(boolean value)	Sets the value of the hideOnEscape property.
final void	setOnAutoHide(EventHandler<Event> value)	Sets the value of the onAutoHide property.
protected final 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 declared in class 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

Modifier and Type	Method	Description
final <T extends Event> void	addEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)	Registers an event filter for this target.
final <T extends Event> void	addEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Registers an event handler for this target.
EventDispatchChain	buildEventDispatchChain(EventDispatchChain tail)	Construct an event dispatch chain for this target.
void	centerOnScreen()	Sets x and y properties on this Window so that it is centered on the current screen.
final ObjectProperty<EventDispatcher>	eventDispatcherProperty()	Specifies the event dispatcher for this node.
final void	fireEvent(Event event)	Fires the specified event.
final ReadOnlyBooleanProperty	focusedProperty()	Whether or not this Window has the keyboard or input focus.
final BooleanProperty	forceIntegerRenderScaleProperty()	Boolean property that controls whether only integer render scales are set by default by the system when there is a change in the associated output scale.
final EventDispatcher	getEventDispatcher()	Gets the value of the eventDispatcher property.
final double	getHeight()	Gets the value of the height property.
final EventHandler<WindowEvent>	getOnCloseRequest()	Gets the value of the onCloseRequest property.
final EventHandler<WindowEvent>	getOnHidden()	Gets the value of the onHidden property.
final EventHandler<WindowEvent>	getOnHiding()	Gets the value of the onHiding property.
final EventHandler<WindowEvent>	getOnShowing()	Gets the value of the onShowing property.
final EventHandler<WindowEvent>	getOnShown()	Gets the value of the onShown property.
final double	getOpacity()	Gets the value of the opacity property.
final double	getOutputScaleX()	Gets the value of the outputScaleX property.
final double	getOutputScaleY()	Gets the value of the outputScaleY property.
final ObservableMap<Object,Object>	getProperties()	Returns an observable map of properties on this node for use primarily by application developers.
final double	getRenderScaleX()	Gets the value of the renderScaleX property.
final double	getRenderScaleY()	Gets the value of the renderScaleY property.
final Scene	getScene()	Gets the value of the scene property.
Object	getUserData()	Returns a previously set Object property, or null if no such property has been set using the Window.setUserData(java.lang.Object) method.
final double	getWidth()	Gets the value of the width property.
static ObservableList<Window>	getWindows()	Returns a list containing a reference to the currently showing JavaFX windows.
final double	getX()	Gets the value of the x property.
final double	getY()	Gets the value of the y property.
boolean	hasProperties()	Tests if Window has properties.
final ReadOnlyDoubleProperty	heightProperty()	The height of this Window.
final boolean	isFocused()	Gets the value of the focused property.
final boolean	isForceIntegerRenderScale()	Gets the value of the forceIntegerRenderScale property.
final boolean	isShowing()	Gets the value of the showing property.
final ObjectProperty<EventHandler<WindowEvent>>	onCloseRequestProperty()	Called when there is an external request to close this Window.
final ObjectProperty<EventHandler<WindowEvent>>	onHiddenProperty()	Called just after the Window has been hidden.
final ObjectProperty<EventHandler<WindowEvent>>	onHidingProperty()	Called just prior to the Window being hidden.
final ObjectProperty<EventHandler<WindowEvent>>	onShowingProperty()	Called just prior to the Window being shown.
final ObjectProperty<EventHandler<WindowEvent>>	onShownProperty()	Called just after the Window is shown.
final DoubleProperty	opacityProperty()	Defines the opacity of the Window as a value between 0.0 and 1.0.
final ReadOnlyDoubleProperty	outputScaleXProperty()	The scale that the Window will apply to horizontal scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.
final ReadOnlyDoubleProperty	outputScaleYProperty()	The scale that the Window will apply to vertical scene coordinates in all stages of rendering and compositing the output to the screen or other destination device.
final <T extends Event> void	removeEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)	Unregisters a previously registered event filter from this target.
final <T extends Event> void	removeEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Unregisters a previously registered event handler from this target.
final DoubleProperty	renderScaleXProperty()	The horizontal scale that the Window will use when rendering its Scene to the rendering buffer.
final DoubleProperty	renderScaleYProperty()	The vertical scale that the Window will use when rendering its Scene to the rendering buffer.
final void	requestFocus()	Requests that this Window get the input focus.
final ReadOnlyObjectProperty<Scene>	sceneProperty()	The Scene to be rendered on this Window.
final void	setEventDispatcher(EventDispatcher value)	Sets the value of the eventDispatcher property.
protected final <T extends Event> void	setEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Sets the handler to use for this event type.
final void	setForceIntegerRenderScale(boolean forced)	Sets the value of the forceIntegerRenderScale property.
final void	setHeight(double value)	Sets the value of the height property.
final void	setOnCloseRequest(EventHandler<WindowEvent> value)	Sets the value of the onCloseRequest property.
final void	setOnHidden(EventHandler<WindowEvent> value)	Sets the value of the onHidden property.
final void	setOnHiding(EventHandler<WindowEvent> value)	Sets the value of the onHiding property.
final void	setOnShowing(EventHandler<WindowEvent> value)	Sets the value of the onShowing property.
final void	setOnShown(EventHandler<WindowEvent> value)	Sets the value of the onShown property.
final void	setOpacity(double value)	Sets the value of the opacity property.
final void	setRenderScaleX(double scale)	Sets the value of the renderScaleX property.
final void	setRenderScaleY(double scale)	Sets the value of the renderScaleY property.
void	setUserData(Object value)	Convenience method for setting a single Object property that can be retrieved at a later date.
final void	setWidth(double value)	Sets the value of the width property.
final void	setX(double value)	Sets the value of the x property.
final void	setY(double value)	Sets the value of the y property.
protected void	show()	Attempts to show this Window by setting visibility to true
final ReadOnlyBooleanProperty	showingProperty()	Whether or not this Window is showing (that is, open on the user's system).
void	sizeToScene()	Set the width and height of this Window to match the size of the content of this Window's Scene.
final ReadOnlyDoubleProperty	widthProperty()	The width of this Window.
final ReadOnlyDoubleProperty	xProperty()	The horizontal location of this Window on the screen.
final ReadOnlyDoubleProperty	yProperty()	The vertical location of this Window on the screen.

Methods declared in class Object

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

Constructor Details

Popup

public Popup()

Creates a Popup.

Method Details

getContent

public final ObservableList<Node> getContent()

The ObservableList of Nodes to be rendered on this Popup. The content forms the complete visual representation of the Popup. Popups have no intrinsic visuals.