org.controlsfx.control

Class NotificationPane

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

org.controlsfx.control.NotificationPane

All Implemented Interfaces:

javafx.css.Styleable, EventTarget, Skinnable

public class NotificationPane
extends Control

The NotificationPane control is a container control that, when prompted by the show() method, will show a non-modal message to the user. The notification appears as a bar that will slide in to their application window, either from the top or the bottom of the NotificationPane (based on showFromTopProperty()) wherever that may be in the scenegraph.

Alternative Styling

As is visible in the screenshots further down this documentation, there are two different styles supported by the NotificationPane control. Firstly, there is the default style based on the JavaFX Modena look. The alternative style is what is currently referred to as the 'dark' look. To enable this functionality, simply do the following:

 
 NotificationPane notificationPane = new NotificationPane();   
 notificationPane.getStyleClass().add(NotificationPane.STYLE_CLASS_DARK);
 

Screenshots

To better explain NotificationPane, here is a table showing both the default and dark look for the NotificationPane on a Windows machine (although that shouldn't impact the visuals a great deal). Also, to show the difference between top and bottom placement, these two modes are also captured in the screenshots below:

Setting	Screenshot
Light theme from top:
Light theme from bottom:
Dark theme from top:
Dark theme from bottom:

Code Examples

NotificationPane is a conceptually very simple control - you simply create your user interface as you normally would, and then wrap it inside the NotificationPane. You can then show a notification bar on top of your content simply by calling show() on the notification bar. Here is an example:

 
 // Create a WebView
 WebView webView = new WebView();
 
 // Wrap it inside a NotificationPane
 NotificationPane notificationPane = new NotificationPane(webView);
 
 // and put the NotificationPane inside a Tab
 Tab tab1 = new Tab("Tab 1");
 tab1.setContent(notificationPane);
 
 // and the Tab inside a TabPane. We just have one tab here, but of course 
 // you can have more!
 TabPane tabPane = new TabPane();
 tabPane.getTabs().addAll(tab1);
 

Now that the notification pane is installed inside the tab, at some point later in you application lifecycle, you can do something like the following to have the notification bar slide into view:

  
 notificationPane.setText("Do you want to save your password?");
 notificationPane.getActions().add(new AbstractAction("Save Password") {
     public void execute(ActionEvent ae) {
         // do save...
           
         // then hide...
         notificationPane.hide();
     }
 }

See Also:

Action, AbstractAction

Property Summary

Type	Property and Description
ObjectProperty<Node>	content The content property represents what is shown in the scene that is not within the notification bar.
ObjectProperty<Node>	graphic The graphic property represents the Node to show within the popup notification bar that appears on top of the content that is within the NotificationPane.
BooleanProperty	showFromTop A property representing whether the notification bar should appear from the top or the bottom of the NotificationPane area.
ReadOnlyBooleanProperty	showing A read-only property that represents whether the notification bar popup should be showing to the user or not.
StringProperty	text The text property represents the text to show within the popup notification bar that appears on top of the content that is within the NotificationPane.

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Field Summary

Fields

Modifier and Type	Field and Description
static String	STYLE_CLASS_DARK

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor and Description
NotificationPane() Creates an instance of NotificationPane with no content, text, graphic properties set, and no actions specified.
NotificationPane(Node content) Creates an instance of NotificationPane with the content property set, but no text or graphic property set, and no actions specified.
NotificationPane(Node content, String text) Creates an instance of NotificationPane with the content and text property set, but no graphic property set, and no actions specified.
NotificationPane(Node content, String text, Node graphic) Creates an instance of NotificationPane with the content, text and graphic properties set, but no actions specified.
NotificationPane(Node content, String text, Node graphic, Action... actions) Creates an instance of NotificationPane with the content, text and graphic property set, and the provided actions copied into the actions list.

Method Summary

Modifier and Type	Method and Description
ObjectProperty<Node>	contentProperty() The content property represents what is shown in the scene that is not within the notification bar.
protected Skin<?>	createDefaultSkin()
ObservableList<Action>	getActions() Observable list of actions used for the actions area of the notification bar.
Node	getContent() Gets the value of the property content.
Node	getGraphic() Gets the value of the property graphic.
String	getText() Gets the value of the property text.
protected String	getUserAgentStylesheet()
ObjectProperty<Node>	graphicProperty() The graphic property represents the Node to show within the popup notification bar that appears on top of the content that is within the NotificationPane.
void	hide() Call this to make the notification bar disappear from the content of this NotificationPane.
boolean	isShowFromTop() Gets the value of the property showFromTop.
boolean	isShowing() Gets the value of the property showing.
void	setContent(Node value) Sets the value of the property content.
void	setGraphic(Node value) Sets the value of the property graphic.
void	setShowFromTop(boolean value) Sets the value of the property showFromTop.
void	setText(String value) Sets the value of the property text.
void	show() Call this to make the notification bar appear on top of the content of this NotificationPane.
BooleanProperty	showFromTopProperty() A property representing whether the notification bar should appear from the top or the bottom of the NotificationPane area.
ReadOnlyBooleanProperty	showingProperty() A read-only property that represents whether the notification bar popup should be showing to the user or not.
StringProperty	textProperty() The text property represents the text to show within the popup notification bar that appears on top of the content that is within the NotificationPane.

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getSkin, getTooltip, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_geomChanged, impl_getAccessible, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

content

public final ObjectProperty<Node> contentProperty

The content property represents what is shown in the scene that is not within the notification bar. In other words, it is what the notification bar should appear on top of. For example, in the scenario where you are using a WebView to show to the user websites, and you want to popup up a notification bar to save a password, the content would be the WebView. Refer to the NotificationPane class documentation for more details.

Returns:

A property representing the content of this NotificationPane.

text

public final StringProperty textProperty

The text property represents the text to show within the popup notification bar that appears on top of the content that is within the NotificationPane.

See Also:

getText(), setText(String)

graphic

public final ObjectProperty<Node> graphicProperty

The graphic property represents the Node to show within the popup notification bar that appears on top of the content that is within the NotificationPane. Despite the term 'graphic', this can be an arbitrarily complex scenegraph in its own right.

See Also:

getGraphic(), setGraphic(Node)

showing

public final ReadOnlyBooleanProperty showingProperty

A read-only property that represents whether the notification bar popup should be showing to the user or not. To toggle visibility, use the show() and hide() methods.

See Also:

isShowing()

showFromTop

public final BooleanProperty showFromTopProperty

A property representing whether the notification bar should appear from the top or the bottom of the NotificationPane area. By default it will appear from the top, but this can be changed by setting this property to false.

See Also:

isShowFromTop(), setShowFromTop(boolean)

Field Detail

STYLE_CLASS_DARK

public static final String STYLE_CLASS_DARK

See Also:

Constant Field Values

Constructor Detail

NotificationPane

public NotificationPane()

Creates an instance of NotificationPane with no content, text, graphic properties set, and no actions specified.

NotificationPane

public NotificationPane(Node content)

Creates an instance of NotificationPane with the content property set, but no text or graphic property set, and no actions specified.

Parameters:

content - The content to show in the NotificationPane behind where the notification bar will appear, that is, the content will notappear in the notification bar.

NotificationPane

public NotificationPane(Node content,
                        String text)

Creates an instance of NotificationPane with the content and text property set, but no graphic property set, and no actions specified.

Parameters:

content - The content to show in the NotificationPane behind where the notification bar will appear, that is, the content will notappear in the notification bar.

text - The text to show in the notification pane.

NotificationPane

public NotificationPane(Node content,
                        String text,
                        Node graphic)

Creates an instance of NotificationPane with the content, text and graphic properties set, but no actions specified.

Parameters:

content - The content to show in the NotificationPane behind where the notification bar will appear, that is, the content will notappear in the notification bar.

text - The text to show in the notification pane.

graphic - The node to show in the notification pane.

NotificationPane

public NotificationPane(Node content,
                        String text,
                        Node graphic,
                        Action... actions)

Creates an instance of NotificationPane with the content, text and graphic property set, and the provided actions copied into the actions list.

Parameters:

content - The content to show in the NotificationPane behind where the notification bar will appear, that is, the content will notappear in the notification bar.

text - The text to show in the notification pane.

graphic - The node to show in the notification pane.

actions - The actions to show in the notification pane.

Method Detail

createDefaultSkin

protected Skin<?> createDefaultSkin()

Overrides:

createDefaultSkin in class Control

getUserAgentStylesheet

protected String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class Control

contentProperty

public final ObjectProperty<Node> contentProperty()

The content property represents what is shown in the scene that is not within the notification bar. In other words, it is what the notification bar should appear on top of. For example, in the scenario where you are using a WebView to show to the user websites, and you want to popup up a notification bar to save a password, the content would be the WebView. Refer to the NotificationPane class documentation for more details.

Returns:

A property representing the content of this NotificationPane.

setContent

public final void setContent(Node value)

Sets the value of the property content.

getContent

public final Node getContent()

Gets the value of the property content.

textProperty

public final StringProperty textProperty()

The text property represents the text to show within the popup notification bar that appears on top of the content that is within the NotificationPane.

See Also:

getText(), setText(String)

setText

public final void setText(String value)

Sets the value of the property text.

getText

public final String getText()

Gets the value of the property text.

graphicProperty

public final ObjectProperty<Node> graphicProperty()

The graphic property represents the Node to show within the popup notification bar that appears on top of the content that is within the NotificationPane. Despite the term 'graphic', this can be an arbitrarily complex scenegraph in its own right.

See Also:

getGraphic(), setGraphic(Node)

setGraphic

public final void setGraphic(Node value)

Sets the value of the property graphic.

getGraphic

public final Node getGraphic()

Gets the value of the property graphic.

showingProperty

public final ReadOnlyBooleanProperty showingProperty()

A read-only property that represents whether the notification bar popup should be showing to the user or not. To toggle visibility, use the show() and hide() methods.

See Also:

isShowing()

isShowing

public final boolean isShowing()

Gets the value of the property showing.

showFromTopProperty

public final BooleanProperty showFromTopProperty()

A property representing whether the notification bar should appear from the top or the bottom of the NotificationPane area. By default it will appear from the top, but this can be changed by setting this property to false.

See Also:

isShowFromTop(), setShowFromTop(boolean)

setShowFromTop

public final void setShowFromTop(boolean value)

Sets the value of the property showFromTop.

isShowFromTop

public final boolean isShowFromTop()

Gets the value of the property showFromTop.

getActions

public final ObservableList<Action> getActions()

Observable list of actions used for the actions area of the notification bar. Modifying the contents of this list will change the actions available to the user.

Returns:

The ObservableList of actions available to the user.

show

public void show()

Call this to make the notification bar appear on top of the content of this NotificationPane. If the notification bar is already showing this will be a no-op.

hide

public void hide()

Call this to make the notification bar disappear from the content of this NotificationPane. If the notification bar is already hidden this will be a no-op.