ControlsFX 11.2.2 · org.controlsfx.control.PopOver · APIdia, the JavaDoc alternative

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

Modifier and Type	Field and Description
private final SimpleBooleanProperty	animated
private final DoubleProperty	arrowIndent
private final ObjectProperty<PopOver.ArrowLocation>	arrowLocation
private final DoubleProperty	arrowSize
private final BooleanProperty	closeButtonEnabled
private final WeakEventHandler<WindowEvent>	closePopOverOnOwnerWindowClose
private final EventHandler<WindowEvent>	closePopOverOnOwnerWindowCloseLambda
private final ObjectProperty<Node>	contentNode
private final DoubleProperty	cornerRadius
private static final Duration	DEFAULT_FADE_DURATION
private static final String	DEFAULT_STYLE_CLASS
private final BooleanProperty	detachable
private final BooleanProperty	detached
private final ObjectProperty<Duration>	fadeInDuration
private final ObjectProperty<Duration>	fadeOutDuration
private final BooleanProperty	headerAlwaysVisible
private final InvalidationListener	hideListener
private Duration	oneTimeFadeInDuration
private Window	ownerWindow Hides javafx.stage.PopupWindow.ownerWindow.
private final StackPane	root
private double	targetX
private double	targetY
private final StringProperty	title
private final WeakInvalidationListener	weakHideListener
private final WeakChangeListener<Number>	weakXListener
private final WeakChangeListener<Number>	weakYListener
private final ChangeListener<Number>	xListener
private final ChangeListener<Number>	yListener

Access	Constructor and Description
public	PopOver() Creates a pop over with a label as the content node.
public	PopOver(Node The content shown by the pop over content) Creates a pop over with the given node as the content node.

Method Summary

Modifier and Type	Method and Description
private void	adjustWindowLocation()
public final BooleanProperty	Returns: the "animated" property animatedProperty() Stores the "animated" flag.
public final DoubleProperty	Returns: the arrow indent property arrowIndentProperty() Controls the distance between the arrow and the corners of the pop over.
public final ObjectProperty<PopOver.ArrowLocation>	Returns: the arrow location property arrowLocationProperty() Stores the preferred arrow location.
public final DoubleProperty	Returns: the arrow size property arrowSizeProperty() Controls the size of the arrow.
public final BooleanProperty	closeButtonEnabledProperty() Determines whether the header's close button should be available.
private double	computeXOffset()
private double	computeYOffset()
public final ObjectProperty<Node>	Returns: the content node property contentNodeProperty() Returns the content shown by the pop over.
public final DoubleProperty	Returns: the corner radius property (default is 6) cornerRadiusProperty() Returns the corner radius property for the pop over.
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.PopupControl.createDefaultSkin. Create a new instance of the default skin for this control.
public final void	detach() Detaches the pop over from the owning node.
public final BooleanProperty	detachableProperty() Determines if the pop over is detachable at all.
public final BooleanProperty	Returns: the detached property detachedProperty() Determines whether the pop over is detached from the owning node or not.
public final ObjectProperty<Duration>	Returns: the fade-in duration property fadeInDurationProperty() Stores the fade-in duration.
public final ObjectProperty<Duration>	Returns: the fade-out duration property fadeOutDurationProperty() Stores the fade-out duration.
public final double	Returns: the arrow indent value getArrowIndent() Returns the value of the arrow indent property.
public final PopOver.ArrowLocation	Returns: the preferred arrow location getArrowLocation() Returns the value of the arrow location property.
public final double	Returns: the arrow size property value getArrowSize() Returns the value of the arrow size property.
public final Node	Returns: the content node getContentNode() Returns the value of the content property
public final double	Returns: the corner radius getCornerRadius() Returns the value of the corner radius property.
public final Duration	Returns: the fade-in duration getFadeInDuration() Returns the value of the fade-in duration property.
public final Duration	Returns: the fade-out duration getFadeOutDuration() Returns the value of the fade-out duration property.
public final StackPane	Returns: the root pane getRoot() The root pane stores the content node of the popover.
public final String	Returns: the detached title getTitle() Returns the value of the title property.
public final BooleanProperty	headerAlwaysVisibleProperty() Determines whether the `PopOver` header should remain visible, even while attached.
public final void	hide() Overrides javafx.stage.PopupWindow.hide. Hides the pop over by quickly changing its opacity to 0.
public final void	hide(Duration the duration of the fade transition that is being used to change the opacity of the pop over fadeOutDuration) Hides the pop over by quickly changing its opacity to 0.
public final boolean	Returns: true if the PopOver will be shown and hidden with a short fade animation isAnimated() Returns the value of the "animated" property.
public final boolean	Returns: true if the header's close button is enabled isCloseButtonEnabled() Returns the value of the closeButtonEnabled property.
public final boolean	Returns: true if the user is allowed to detach / tear off the pop over isDetachable() Returns the value of the detachable property.
public final boolean	Returns: true if the pop over is currently detached. isDetached() Returns the value of the detached property.
public final boolean	Returns: true if the header is visible even while attached isHeaderAlwaysVisible() Returns the value of the detachable property.
private void	ownerWindowHiding()
public final void	setAnimated(boolean if true the PopOver will be shown and hidden with a short fade animation animated) Sets the value of the "animated" property.
public final void	setArrowIndent(double the arrow indent value size) Sets the value of the arrow indent property.
public final void	setArrowLocation(PopOver.ArrowLocation the requested location location) Sets the value of the arrow location property.
public final void	setArrowSize(double the new value of the arrow size property size) Sets the value of the arrow size property.
public final void	setCloseButtonEnabled(boolean if false, the pop over will not be closeable by the header's close button enabled) Sets the value of the closeButtonEnabled property.
public final void	setContentNode(Node the new content node value content) Sets the value of the content property.
public final void	setCornerRadius(double the corner radius radius) Sets the value of the corner radius property.
public final void	setDetachable(boolean if true then the user can detach / tear off the pop over detachable) Sets the value of the detachable property.
public final void	setDetached(boolean if true the pop over will change its apperance to "detached" mode detached) Sets the value of the detached property.
public final void	setFadeInDuration(Duration the requested fade-in duration duration) Sets the value of the fade-in duration property.
public final void	setFadeOutDuration(Duration the requested fade-out duration duration) Sets the value of the fade-out duration property.
public final void	setHeaderAlwaysVisible(boolean if true, then the header is visible even while attached visible) Sets the value of the headerAlwaysVisible property.
public final void	setTitle(String the title to use when detached title) Sets the value of the title property.
public final void	show(Node the owner of the pop over owner) Shows the pop over in a position relative to the edges of the given owner node.
public final void	show(Node the owner of the pop over owner, double if negative specifies the distance to the owner node or when positive specifies the number of pixels that the arrow will overlap with the owner node (positive values are recommended) offset) Shows the pop over in a position relative to the edges of the given owner node.
public final void	show(Node the owning node owner, double the x coordinate for the pop over arrow tip x, double the y coordinate for the pop over arrow tip y, Duration the time it takes for the pop over to be fully visible. This duration takes precedence over the fade-in property without setting. fadeInDuration) Makes the pop over visible at the give location and associates it with the given owner node.
private void	showFadeInAnimation(Duration fadeInDuration)
public final StringProperty	Returns: the title property titleProperty() Stores the title to display in the PopOver's header.

animated	back to summary
private final SimpleBooleanProperty animated

arrowIndent	back to summary
private final DoubleProperty arrowIndent

arrowLocation	back to summary
private final ObjectProperty<PopOver.ArrowLocation> arrowLocation

arrowSize	back to summary
private final DoubleProperty arrowSize

closeButtonEnabled	back to summary
private final BooleanProperty closeButtonEnabled

closePopOverOnOwnerWindowClose	back to summary
private final WeakEventHandler<WindowEvent> closePopOverOnOwnerWindowClose

closePopOverOnOwnerWindowCloseLambda	back to summary
private final EventHandler<WindowEvent> closePopOverOnOwnerWindowCloseLambda

contentNode	back to summary
private final ObjectProperty<Node> contentNode

cornerRadius	back to summary
private final DoubleProperty cornerRadius

DEFAULT_FADE_DURATION	back to summary
private static final Duration DEFAULT_FADE_DURATION

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS

detachable	back to summary
private final BooleanProperty detachable

detached	back to summary
private final BooleanProperty detached

fadeInDuration	back to summary
private final ObjectProperty<Duration> fadeInDuration

fadeOutDuration	back to summary
private final ObjectProperty<Duration> fadeOutDuration

headerAlwaysVisible	back to summary
private final BooleanProperty headerAlwaysVisible

hideListener	back to summary
private final InvalidationListener hideListener

oneTimeFadeInDuration	back to summary
private Duration oneTimeFadeInDuration

ownerWindow	back to summary
private Window ownerWindow Hides javafx.stage.PopupWindow.ownerWindow.

root	back to summary
private final StackPane root

targetX	back to summary
private double targetX

targetY	back to summary
private double targetY

title	back to summary
private final StringProperty title

weakHideListener	back to summary
private final WeakInvalidationListener weakHideListener

weakXListener	back to summary
private final WeakChangeListener<Number> weakXListener

weakYListener	back to summary
private final WeakChangeListener<Number> weakYListener

xListener	back to summary
private final ChangeListener<Number> xListener

yListener	back to summary
private final ChangeListener<Number> yListener

PopOver	back to summary
public PopOver() Creates a pop over with a label as the content node.

PopOver	back to summary
public PopOver(Node content) Creates a pop over with the given node as the content node. Parameters content:Node The content shown by the pop over

Method Detail

adjustWindowLocation	back to summary
private void adjustWindowLocation()

animatedProperty	back to summary
public final BooleanProperty animatedProperty() Stores the "animated" flag. If true then the PopOver will be shown / hidden with a short fade in / out animation. Returns:BooleanProperty the "animated" property

animatedProperty

back to summary

public final BooleanProperty animatedProperty()

Stores the "animated" flag. If true then the PopOver will be shown / hidden with a short fade in / out animation.

Returns:BooleanProperty: the "animated" property

arrowIndentProperty	back to summary
public final DoubleProperty arrowIndentProperty() Controls the distance between the arrow and the corners of the pop over. The default value is 12. Returns:DoubleProperty the arrow indent property

arrowIndentProperty

back to summary

public final DoubleProperty arrowIndentProperty()

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

Returns:DoubleProperty: the arrow indent property

arrowLocationProperty back to summary

arrowLocationProperty	back to summary
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. Returns:ObjectProperty<PopOver.ArrowLocation> the arrow location property See Also `setAutoFix(boolean)`

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.

Returns:ObjectProperty<PopOver.ArrowLocation>: the arrow location property
See Also: setAutoFix(boolean)

arrowSizeProperty	back to summary
public final DoubleProperty arrowSizeProperty() Controls the size of the arrow. Default value is 12. Returns:DoubleProperty the arrow size property

arrowSizeProperty

back to summary

public final DoubleProperty arrowSizeProperty()

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

Returns:DoubleProperty: the arrow size property

closeButtonEnabledProperty	back to summary
public final BooleanProperty closeButtonEnabledProperty() Determines whether the header's close button should be available.

computeXOffset	back to summary
private double computeXOffset()

computeYOffset	back to summary
private double computeYOffset()

contentNodeProperty	back to summary
public final ObjectProperty<Node> contentNodeProperty() Returns the content shown by the pop over. Returns:ObjectProperty<Node> the content node property

contentNodeProperty

back to summary

public final ObjectProperty<Node> contentNodeProperty()

Returns the content shown by the pop over.

Returns:ObjectProperty<Node>: the content node property

cornerRadiusProperty	back to summary
public final DoubleProperty cornerRadiusProperty() Returns the corner radius property for the pop over. Returns:DoubleProperty the corner radius property (default is 6)

cornerRadiusProperty

back to summary

public final DoubleProperty cornerRadiusProperty()

Returns the corner radius property for the pop over.

Returns:DoubleProperty: the corner radius property (default is 6)

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.PopupControl.createDefaultSkin. Doc from javafx.scene.control.PopupControl.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.PopupControl.createDefaultSkin.

Doc from javafx.scene.control.PopupControl.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Annotations

@Override

detach	back to summary
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	back to summary
public final BooleanProperty detachableProperty() Determines if the pop over is detachable at all.

detachedProperty	back to summary
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. Returns:BooleanProperty the detached property

detachedProperty

back to summary

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.

Returns:BooleanProperty: the detached property

fadeInDurationProperty	back to summary
public final ObjectProperty<Duration> fadeInDurationProperty() Stores the fade-in duration. This should be set before calling PopOver.show(..). Returns:ObjectProperty<Duration> the fade-in duration property

fadeInDurationProperty

back to summary

public final ObjectProperty<Duration> fadeInDurationProperty()

Stores the fade-in duration. This should be set before calling PopOver.show(..).

Returns:ObjectProperty<Duration>: the fade-in duration property

fadeOutDurationProperty	back to summary
public final ObjectProperty<Duration> fadeOutDurationProperty() Stores the fade-out duration. Returns:ObjectProperty<Duration> the fade-out duration property

fadeOutDurationProperty

back to summary

public final ObjectProperty<Duration> fadeOutDurationProperty()

Stores the fade-out duration.

Returns:ObjectProperty<Duration>: the fade-out duration property

getArrowIndent back to summary

public final double getArrowIndent()

Returns the value of the arrow indent property.

Returns:double: the arrow indent value
See Also: arrowIndentProperty()

getArrowLocation back to summary

public final PopOver.ArrowLocation getArrowLocation()

Returns the value of the arrow location property.

Returns:PopOver.ArrowLocation: the preferred arrow location
See Also: arrowLocationProperty()

getArrowSize back to summary

public final double getArrowSize()

Returns the value of the arrow size property.

Returns:double: the arrow size property value
See Also: arrowSizeProperty()

getContentNode back to summary

public final Node getContentNode()

Returns the value of the content property

Returns:Node: the content node
See Also: contentNodeProperty()

getCornerRadius back to summary

public final double getCornerRadius()

Returns the value of the corner radius property.

Returns:double: the corner radius
See Also: cornerRadiusProperty()

getFadeInDuration back to summary

public final Duration getFadeInDuration()

Returns the value of the fade-in duration property.

Returns:Duration: the fade-in duration
See Also: fadeInDurationProperty()

getFadeOutDuration back to summary

public final Duration getFadeOutDuration()

Returns the value of the fade-out duration property.

Returns:Duration: the fade-out duration
See Also: fadeOutDurationProperty()

getRoot

back to summary

public final StackPane getRoot()

The root pane stores the content node of the popover. It is accessible via this method in order to support proper styling.

Example:

PopOver popOver = new PopOver();
popOver.getRoot().getStylesheets().add(...);

Returns:StackPane: the root pane

getTitle back to summary

public final String getTitle()

Returns the value of the title property.

Returns:String: the detached title
See Also: titleProperty()

headerAlwaysVisibleProperty	back to summary
public final BooleanProperty headerAlwaysVisibleProperty() Determines whether the `PopOver` header should remain visible, even while attached.

hide back to summary

public final void hide()

Overrides javafx.stage.PopupWindow.hide.

Hides the pop over by quickly changing its opacity to 0.

Annotations

@Override

See Also

hide(Duration)

hide

back to summary

public final void hide(Duration fadeOutDuration)

Hides the pop over by quickly changing its opacity to 0.

Parameters

fadeOutDuration:Duration: the duration of the fade transition that is being used to change the opacity of the pop over

Since

1.0

isAnimated back to summary

public final boolean isAnimated()

Returns the value of the "animated" property.

Returns:boolean: true if the PopOver will be shown and hidden with a short fade animation
See Also: animatedProperty()

isCloseButtonEnabled back to summary

public final boolean isCloseButtonEnabled()

Returns the value of the closeButtonEnabled property.

Returns:boolean: true if the header's close button is enabled
See Also: closeButtonEnabledProperty()

isDetachable back to summary

public final boolean isDetachable()

Returns the value of the detachable property.

Returns:boolean: true if the user is allowed to detach / tear off the pop over
See Also: detachableProperty()

isDetached back to summary

public final boolean isDetached()

Returns the value of the detached property.

Returns:boolean: true if the pop over is currently detached.
See Also: detachedProperty()

isHeaderAlwaysVisible back to summary

public final boolean isHeaderAlwaysVisible()

Returns the value of the detachable property.

Returns:boolean: true if the header is visible even while attached
See Also: headerAlwaysVisibleProperty()

ownerWindowHiding	back to summary
private void ownerWindowHiding()

setAnimated back to summary

public final void setAnimated(boolean animated)

Sets the value of the "animated" property.

Parameters

animated:boolean: if true the PopOver will be shown and hidden with a short fade animation

See Also

animatedProperty()

setArrowIndent back to summary

public final void setArrowIndent(double size)

Sets the value of the arrow indent property.

Parameters

size:double: the arrow indent value

See Also

arrowIndentProperty()

setArrowLocation back to summary

public final void setArrowLocation(PopOver.ArrowLocation location)

Sets the value of the arrow location property.

Parameters

location:PopOver.ArrowLocation: the requested location

See Also

arrowLocationProperty()

setArrowSize back to summary

public final void setArrowSize(double size)

Sets the value of the arrow size property.

Parameters

size:double: the new value of the arrow size property

See Also

arrowSizeProperty()

setCloseButtonEnabled back to summary

public final void setCloseButtonEnabled(boolean enabled)

Sets the value of the closeButtonEnabled property.

Parameters

enabled:boolean: if false, the pop over will not be closeable by the header's close button

See Also

closeButtonEnabledProperty()

setContentNode back to summary

public final void setContentNode(Node content)

Sets the value of the content property.

Parameters

content:Node: the new content node value

See Also

contentNodeProperty()

setCornerRadius back to summary

public final void setCornerRadius(double radius)

Sets the value of the corner radius property.

Parameters

radius:double: the corner radius

See Also

cornerRadiusProperty()

setDetachable back to summary

public final void setDetachable(boolean detachable)

Sets the value of the detachable property.

Parameters

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

See Also

detachableProperty()

setDetached back to summary

public final void setDetached(boolean detached)

Sets the value of the detached property.

Parameters

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

See Also

detachedProperty()

setFadeInDuration back to summary

public final void setFadeInDuration(Duration duration)

Sets the value of the fade-in duration property. This should be set before calling PopOver.show(..).

Parameters

duration:Duration: the requested fade-in duration

See Also

fadeInDurationProperty()

setFadeOutDuration back to summary

public final void setFadeOutDuration(Duration duration)

Sets the value of the fade-out duration property.

Parameters

duration:Duration: the requested fade-out duration

See Also

fadeOutDurationProperty()

setHeaderAlwaysVisible back to summary

public final void setHeaderAlwaysVisible(boolean visible)

Sets the value of the headerAlwaysVisible property.

Parameters

visible:boolean: if true, then the header is visible even while attached

See Also

headerAlwaysVisibleProperty()

setTitle back to summary

public final void setTitle(String title)

Sets the value of the title property.

Parameters

title:String: the title to use when detached

See Also

titleProperty()

show

back to summary

public final void show(Node owner)

Shows the pop over in a position relative to the edges of the given owner node. The position is dependent on the arrow location. If the arrow is pointing to the right then the pop over will be placed to the left of the given owner. If the arrow points up then the pop over will be placed below the given owner node. The arrow will slightly overlap with the owner node.

Parameters

owner:Node: the owner of the pop over

show

back to summary

public final void show(Node owner, double offset)

Parameters

owner:Node: the owner of the pop over
offset:double: if negative specifies the distance to the owner node or when positive specifies the number of pixels that the arrow will overlap with the owner node (positive values are recommended)

show

back to summary

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:Node: the owning node
x:double: the x coordinate for the pop over arrow tip
y:double: the y coordinate for the pop over arrow tip
fadeInDuration:Duration: the time it takes for the pop over to be fully visible. This duration takes precedence over the fade-in property without setting.

showFadeInAnimation	back to summary
private void showFadeInAnimation(Duration fadeInDuration)

titleProperty

back to summary

public final StringProperty titleProperty()

Stores the title to display in the PopOver's header.

Returns:StringProperty: the title property

Modifier and Type	Field and Description
public static final PopOver.ArrowLocation	BOTTOM_CENTER
public static final PopOver.ArrowLocation	BOTTOM_LEFT
public static final PopOver.ArrowLocation	BOTTOM_RIGHT
public static final PopOver.ArrowLocation	LEFT_BOTTOM
public static final PopOver.ArrowLocation	LEFT_CENTER
public static final PopOver.ArrowLocation	LEFT_TOP
public static final PopOver.ArrowLocation	RIGHT_BOTTOM
public static final PopOver.ArrowLocation	RIGHT_CENTER
public static final PopOver.ArrowLocation	RIGHT_TOP
public static final PopOver.ArrowLocation	TOP_CENTER
public static final PopOver.ArrowLocation	TOP_LEFT
public static final PopOver.ArrowLocation	TOP_RIGHT

Modifier and Type	Method and Description
public static PopOver.ArrowLocation	valueOf(String name)
public static PopOver.ArrowLocation[]	values()

public Class PopOver

Example:

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Example:

public final Enum PopOver.ArrowLocation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail