org.controlsfx.control

Class PopOver

java.lang.Object

javafx.stage.Window

javafx.stage.PopupWindow

javafx.scene.control.PopupControl

org.controlsfx.control.PopOver

All Implemented Interfaces:

javafx.css.Styleable, EventTarget, Skinnable

public class PopOver
extends PopupControl

The PopOver control provides detailed information about an owning node in a popup window. The popup window has a very lightweight appearance (no default window decorations) and an arrow pointing at the owner. Due to the nature of popup windows the PopOver will move around with the parent window when the user drags it.

The PopOver can be detached from the owning node by dragging it away from the owner. It stops displaying an arrow and starts displaying a title and a close icon.


The following image shows a popover with an accordion content node. PopOver controls are automatically resizing themselves when the content node changes its size.

Property Summary

Type	Property and Description
DoubleProperty	arrowIndent Controls the distance between the arrow and the corners of the pop over.
ObjectProperty<PopOver.ArrowLocation>	arrowLocation Stores the preferred arrow location.
DoubleProperty	arrowSize Controls the size of the arrow.
ObjectProperty<Node>	contentNode Returns the content shown by the pop over.
DoubleProperty	cornerRadius Returns the corner radius property for the pop over.
BooleanProperty	detachable Determines if the pop over is detachable at all.
BooleanProperty	detached Determines whether the pop over is detached from the owning node or not.
StringProperty	detachedTitle Stores the title to display when the pop over becomes detached.

Properties inherited from class javafx.scene.control.PopupControl

idProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, prefHeightProperty, prefWidthProperty, skinProperty, styleProperty

Properties inherited from class javafx.stage.PopupWindow

anchorLocationProperty, anchorXProperty, anchorYProperty, autoFixProperty, autoHideProperty, consumeAutoHidingEventsProperty, hideOnEscapeProperty, onAutoHideProperty, ownerNodeProperty, ownerWindowProperty

Properties inherited from class javafx.stage.Window

eventDispatcherProperty, focusedProperty, heightProperty, onCloseRequestProperty, onHiddenProperty, onHidingProperty, onShowingProperty, onShownProperty, opacityProperty, sceneProperty, showingProperty, widthProperty, xProperty, yProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PopOver.ArrowLocation All possible arrow locations.

Nested classes/interfaces inherited from class javafx.scene.control.PopupControl

PopupControl.CSSBridge

Nested classes/interfaces inherited from class javafx.stage.PopupWindow

PopupWindow.AnchorLocation

Field Summary

Fields inherited from class javafx.scene.control.PopupControl

bridge, USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.stage.Window

impl_peer, peerListener

Constructor Summary

Constructors

Constructor and Description
PopOver() Creates a pop over with a label as the content node.
PopOver(Node content) Creates a pop over with the given node as the content node.

Method Summary

Modifier and Type	Method and Description
DoubleProperty	arrowIndentProperty() Controls the distance between the arrow and the corners of the pop over.
ObjectProperty<PopOver.ArrowLocation>	arrowLocationProperty() Stores the preferred arrow location.
DoubleProperty	arrowSizeProperty() Controls the size of the arrow.
ObjectProperty<Node>	contentNodeProperty() Returns the content shown by the pop over.
DoubleProperty	cornerRadiusProperty() Returns the corner radius property for the pop over.
protected Skin<?>	createDefaultSkin()
void	detach() Detaches the pop over from the owning node.
BooleanProperty	detachableProperty() Determines if the pop over is detachable at all.
BooleanProperty	detachedProperty() Determines whether the pop over is detached from the owning node or not.
StringProperty	detachedTitleProperty() Stores the title to display when the pop over becomes detached.
double	getArrowIndent() Returns the value of the arrow indent property.
PopOver.ArrowLocation	getArrowLocation() Returns the value of the arrow location property.
double	getArrowSize() Returns the value of the arrow size property.
Node	getContentNode() Returns the value of the content property
double	getCornerRadius() Returns the value of the corner radius property.
String	getDetachedTitle() Returns the value of the detached title property.
boolean	isDetachable() Returns the value of the detachable property.
boolean	isDetached() Returns the value of the detached property.
void	setArrowIndent(double size) Sets the value of the arrow indent property.
void	setArrowLocation(PopOver.ArrowLocation location) Sets the value of the arrow location property.
void	setArrowSize(double size) Sets the value of the arrow size property.
void	setContentNode(Node content) Sets the value of the content property.
void	setCornerRadius(double radius) Sets the value of the corner radius property.
void	setDetachable(boolean detachable) Sets the value of the detachable property.
void	setDetached(boolean detached) Sets the value of the detached property.
void	setDetachedTitle(String title) Sets the value of the detached title property.
void	show(Node owner, double x, double y) Makes the pop over visible at the give location and associates it with the given owner node.
void	show(Node owner, double x, double y, Duration fadeInDuration) Makes the pop over visible at the give location and associates it with the given owner node.

Methods inherited from class javafx.scene.control.PopupControl

getClassCssMetaData, getCssMetaData, getId, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getPseudoClassStates, getSkin, getStyle, getStyleableParent, getStyleClass, getTypeSelector, idProperty, impl_styleableGetNode, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, pseudoClassStateChanged, setId, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setPrefHeight, setPrefSize, setPrefWidth, setSkin, setStyle, skinProperty, styleProperty

Methods inherited from class javafx.stage.PopupWindow

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

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

contentNode

public final ObjectProperty<Node> contentNodeProperty

Returns the content shown by the pop over.

See Also:

getContentNode(), setContentNode(Node)

detachable

public final BooleanProperty detachableProperty

Determines if the pop over is detachable at all.

See Also:

isDetachable(), setDetachable(boolean)

detached

public final BooleanProperty detachedProperty

Determines whether the pop over is detached from the owning node or not. A detached pop over no longer shows an arrow pointing at the owner and features its own title bar.

See Also:

isDetached(), setDetached(boolean)

arrowSize

public final DoubleProperty arrowSizeProperty

Controls the size of the arrow. Default value is 12.

See Also:

getArrowSize(), setArrowSize(double)

arrowIndent

public final DoubleProperty arrowIndentProperty

Controls the distance between the arrow and the corners of the pop over. The default value is 12.

See Also:

getArrowIndent(), setArrowIndent(double)

cornerRadius

public final DoubleProperty cornerRadiusProperty

Returns the corner radius property for the pop over.

See Also:

getCornerRadius(), setCornerRadius(double)

detachedTitle

public final StringProperty detachedTitleProperty

Stores the title to display when the pop over becomes detached.

See Also:

getDetachedTitle(), setDetachedTitle(String)

arrowLocation

public final ObjectProperty<PopOver.ArrowLocation> arrowLocationProperty

Stores the preferred arrow location. This might not be the actual location of the arrow if auto fix is enabled.

See Also:

getArrowLocation(), setArrowLocation(ArrowLocation)

Constructor Detail

PopOver

public PopOver()

Creates a pop over with a label as the content node.

PopOver

public PopOver(Node content)

Creates a pop over with the given node as the content node.

Parameters:

the - content shown by the pop over

Method Detail

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class PopupControl

contentNodeProperty

public final ObjectProperty<Node> contentNodeProperty()

Returns the content shown by the pop over.

See Also:

getContentNode(), setContentNode(Node)

getContentNode

public final Node getContentNode()

Returns the value of the content property

Returns:

the content node

See Also:

#contentProperty()

setContentNode

public final void setContentNode(Node content)

Sets the value of the content property.

Parameters:

content - the new content node value

See Also:

#contentProperty()

show

public final void show(Node owner,
                       double x,
                       double y)

Makes the pop over visible at the give location and associates it with the given owner node. The x and y coordinate will be the target location of the arrow of the pop over and not the location of the window.

Overrides:

show in class PopupWindow

Parameters:

owner - the owning node

x - the x coordinate for the pop over arrow tip

y - the y coordinate for the pop over arrow tip

show

public final void show(Node owner,
                       double x,
                       double y,
                       Duration fadeInDuration)

Makes the pop over visible at the give location and associates it with the given owner node. The x and y coordinate will be the target location of the arrow of the pop over and not the location of the window.

Parameters:

owner - the owning node

x - the x coordinate for the pop over arrow tip

y - the y coordinate for the pop over arrow tip

fadeInDuration - the time it takes for the pop over to be fully visible

detach

public final void detach()

Detaches the pop over from the owning node. The pop over will no longer display an arrow pointing at the owner node.

detachableProperty

public final BooleanProperty detachableProperty()

Determines if the pop over is detachable at all.

See Also:

isDetachable(), setDetachable(boolean)

setDetachable

public final void setDetachable(boolean detachable)

Sets the value of the detachable property.

Parameters:

detachable - if true then the user can detach / tear off the pop over

See Also:

detachableProperty()

isDetachable

public final boolean isDetachable()

Returns the value of the detachable property.

Returns:

true if the user is allowed to detach / tear off the pop over

See Also:

detachableProperty()

detachedProperty

public final BooleanProperty detachedProperty()

Determines whether the pop over is detached from the owning node or not. A detached pop over no longer shows an arrow pointing at the owner and features its own title bar.

See Also:

isDetached(), setDetached(boolean)

setDetached

public final void setDetached(boolean detached)

Sets the value of the detached property.

Parameters:

detached - if true the pop over will change its apperance to "detached" mode

See Also:

detachedProperty();

isDetached

public final boolean isDetached()

Returns the value of the detached property.

Returns:

true if the pop over is currently detached.

See Also:

detachedProperty();

arrowSizeProperty

public final DoubleProperty arrowSizeProperty()

Controls the size of the arrow. Default value is 12.

See Also:

getArrowSize(), setArrowSize(double)

getArrowSize

public final double getArrowSize()

Returns the value of the arrow size property.

Returns:

the arrow size property value

See Also:

arrowSizeProperty()

setArrowSize

public final void setArrowSize(double size)

Sets the value of the arrow size property.

Parameters:

size - the new value of the arrow size property

See Also:

arrowSizeProperty()

arrowIndentProperty

public final DoubleProperty arrowIndentProperty()

Controls the distance between the arrow and the corners of the pop over. The default value is 12.

See Also:

getArrowIndent(), setArrowIndent(double)

getArrowIndent

public final double getArrowIndent()

Returns the value of the arrow indent property.

Returns:

the arrow indent value

See Also:

arrowIndentProperty()

setArrowIndent

public final void setArrowIndent(double size)

Sets the value of the arrow indent property.

Parameters:

size - the arrow indent value

See Also:

arrowIndentProperty()

cornerRadiusProperty

public final DoubleProperty cornerRadiusProperty()

Returns the corner radius property for the pop over.

See Also:

getCornerRadius(), setCornerRadius(double)

getCornerRadius

public final double getCornerRadius()

Returns the value of the corner radius property.

Returns:

the corner radius

See Also:

cornerRadiusProperty()

setCornerRadius

public final void setCornerRadius(double radius)

Sets the value of the corner radius property.

Parameters:

radius - the corner radius

See Also:

cornerRadiusProperty()

detachedTitleProperty

public final StringProperty detachedTitleProperty()

Stores the title to display when the pop over becomes detached.

See Also:

getDetachedTitle(), setDetachedTitle(String)

getDetachedTitle

public final String getDetachedTitle()

Returns the value of the detached title property.

Returns:

the detached title

See Also:

detachedTitleProperty()

setDetachedTitle

public final void setDetachedTitle(String title)

Sets the value of the detached title property.

Parameters:

title - the title to use when detached

See Also:

detachedTitleProperty()

arrowLocationProperty

public final ObjectProperty<PopOver.ArrowLocation> arrowLocationProperty()

Stores the preferred arrow location. This might not be the actual location of the arrow if auto fix is enabled.

See Also:

getArrowLocation(), setArrowLocation(ArrowLocation)

setArrowLocation

public final void setArrowLocation(PopOver.ArrowLocation location)

Sets the value of the arrow location property.

Parameters:

location - the requested location

See Also:

arrowLocationProperty()

getArrowLocation

public final PopOver.ArrowLocation getArrowLocation()

Returns the value of the arrow location property.

Returns:

the preferred arrow location

See Also:

arrowLocationProperty()