Class Notification

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
atlantafx.base.controls.Notification
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class Notification extends javafx.scene.control.Control
A control that is intended for displaying notifications to users as pop-ups. It is customizable with different colors and icons, can contain a graphic or image, along with the message and additional actions for users to take.

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.ObjectProperty<@Nullable javafx.scene.Node>
    graphic
    Represents an optional graphical component that can be displayed alongside the notification message.
    javafx.beans.property.StringProperty
    message
    Stores a short text message that will be displayed to users when the notification appears.
    javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<? super javafx.event.Event>>
    onClose
    Specifies the close handler used to dismiss this notification.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.collections.ObservableList<javafx.scene.control.Button>>
    primaryActions
    Specifies the primary actions associated with this notification.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.collections.ObservableList<javafx.scene.control.MenuItem>>
    secondaryActions
    Specifies the secondary actions associated with this notification.

    Properties inherited from class javafx.scene.control.Control

    contextMenu, skin, tooltip

    Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

    accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, focusVisible, focusWithin, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragDone, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<? super javafx.event.Event>>
    onClose
     

    Fields inherited from class javafx.scene.layout.Region

    USE_COMPUTED_SIZE, USE_PREF_SIZE

    Fields inherited from class javafx.scene.Node

    BASELINE_OFFSET_SAME_AS_HEIGHT

  • Constructor Summary

    Constructors
    Constructor
    Description
    Notification()
    Creates an empty Notification.
    Notification(@Nullable String message)
    Creates a Notification with initial message text.
    Notification(@Nullable String message, @Nullable javafx.scene.Node graphic)
    Creates a Notification with initial message text and graphic.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
     
    @Nullable javafx.scene.Node
    getGraphic()
    Gets the value of the graphic property.
    @Nullable String
    getMessage()
    Gets the value of the message property.
    @Nullable javafx.event.EventHandler<? super javafx.event.Event>
    getOnClose()
    Gets the value of the onClose property.
    javafx.collections.ObservableList<javafx.scene.control.Button>
    getPrimaryActions()
    Gets the value of the primaryActions property.
    javafx.collections.ObservableList<javafx.scene.control.MenuItem>
    getSecondaryActions()
    Gets the value of the secondaryActions property.
    javafx.beans.property.ObjectProperty<@Nullable javafx.scene.Node>
    graphicProperty()
    Represents an optional graphical component that can be displayed alongside the notification message.
    javafx.beans.property.StringProperty
    messageProperty()
    Stores a short text message that will be displayed to users when the notification appears.
    javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<? super javafx.event.Event>>
    onCloseProperty()
    Specifies the close handler used to dismiss this notification.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.collections.ObservableList<javafx.scene.control.Button>>
    primaryActionsProperty()
    Specifies the primary actions associated with this notification.
    javafx.beans.property.ReadOnlyObjectProperty<javafx.collections.ObservableList<javafx.scene.control.MenuItem>>
    secondaryActionsProperty()
    Specifies the secondary actions associated with this notification.
    void
    setGraphic(@Nullable javafx.scene.Node graphic)
    Sets the value of the graphic property.
    void
    setMessage(@Nullable String message)
    Sets the value of the message property.
    void
    setOnClose(@Nullable javafx.event.EventHandler<? super javafx.event.Event> onClose)
    Sets the value of the onClose property.
    void
    setPrimaryActions(javafx.collections.ObservableList<javafx.scene.control.Button> buttons)
    Sets the value of the primaryActions property.
    void
    setPrimaryActions(javafx.scene.control.Button... buttons)
     
    void
    setSecondaryActions(javafx.collections.ObservableList<javafx.scene.control.MenuItem> items)
    Sets the value of the secondaryActions property.
    void
    setSecondaryActions(javafx.scene.control.MenuItem... items)
     

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getClassCssMetaData, getContextMenu, getControlCssMetaData, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, 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, getUserAgentStylesheet, getWidth, heightProperty, 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, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setNeedsLayout, updateBounds

    Methods inherited from class javafx.scene.Node

    accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, focusVisibleProperty, focusWithinProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragDone, 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, getViewOrder, hasProperties, hoverProperty, idProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isFocusVisible, isFocusWithin, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragDoneProperty, 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, requestFocusTraversal, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, 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, setOnMouseDragDone, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

    • graphic

      public javafx.beans.property.ObjectProperty<@Nullable javafx.scene.Node> graphicProperty
      Represents an optional graphical component that can be displayed alongside the notification message.
      See Also:

    • message

      public javafx.beans.property.StringProperty messageProperty
      Stores a short text message that will be displayed to users when the notification appears. This property doesn't support the formatted text.
      See Also:

    • primaryActions

      public javafx.beans.property.ReadOnlyObjectProperty<javafx.collections.ObservableList<javafx.scene.control.Button>> primaryActionsProperty
      Specifies the primary actions associated with this notification.

      This property is used to store one or more action buttons that will be displayed at the bottom of the notification when it appears. These buttons will be placed inside the ButtonBar and use the alignment that is described in the ButtonBar documentation.

      See Also:

    • secondaryActions

      public javafx.beans.property.ReadOnlyObjectProperty<javafx.collections.ObservableList<javafx.scene.control.MenuItem>> secondaryActionsProperty
      Specifies the secondary actions associated with this notification.

      This property is used to store one or more menu items that will be displayed as a dropdown menu at the top corner of the notification when it appears.

      The dropdown menu button will not appear if the list is empty.

      See Also:

    • onClose

      public javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<? super javafx.event.Event>> onCloseProperty
      Specifies the close handler used to dismiss this notification.

      The close button will not appear if the handler is not set for it.

      See Also:

  • Field Details

    • onClose

      protected final javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<? super javafx.event.Event>> onClose

  • Constructor Details

    • Notification

      public Notification()
      Creates an empty Notification.

    • Notification

      public Notification(@Nullable String message)
      Creates a Notification with initial message text.
      Parameters:
      message - A string for the notification message.

    • Notification

      public Notification(@Nullable String message, @Nullable javafx.scene.Node graphic)
      Creates a Notification with initial message text and graphic.
      Parameters:
      message - A string for the notification message.
      graphic - A graphic or icon.

  • Method Details

    • createDefaultSkin

      protected javafx.scene.control.Skin<?> createDefaultSkin()
      Overrides:
      createDefaultSkin in class javafx.scene.control.Control

    • graphicProperty

      public javafx.beans.property.ObjectProperty<@Nullable javafx.scene.Node> graphicProperty()
      Represents an optional graphical component that can be displayed alongside the notification message.
      Returns:
      the graphic property
      See Also:

    • getGraphic

      public @Nullable javafx.scene.Node getGraphic()
      Gets the value of the graphic property.
      Property description:
      Represents an optional graphical component that can be displayed alongside the notification message.
      Returns:
      the value of the graphic property
      See Also:

    • setGraphic

      public void setGraphic(@Nullable javafx.scene.Node graphic)
      Sets the value of the graphic property.
      Property description:
      Represents an optional graphical component that can be displayed alongside the notification message.
      Parameters:
      graphic - the value for the graphic property
      See Also:

    • messageProperty

      public javafx.beans.property.StringProperty messageProperty()
      Stores a short text message that will be displayed to users when the notification appears. This property doesn't support the formatted text.
      Returns:
      the message property
      See Also:

    • getMessage

      public @Nullable String getMessage()
      Gets the value of the message property.
      Property description:
      Stores a short text message that will be displayed to users when the notification appears. This property doesn't support the formatted text.
      Returns:
      the value of the message property
      See Also:

    • setMessage

      public void setMessage(@Nullable String message)
      Sets the value of the message property.
      Property description:
      Stores a short text message that will be displayed to users when the notification appears. This property doesn't support the formatted text.
      Parameters:
      message - the value for the message property
      See Also:

    • primaryActionsProperty

      public javafx.beans.property.ReadOnlyObjectProperty<javafx.collections.ObservableList<javafx.scene.control.Button>> primaryActionsProperty()
      Specifies the primary actions associated with this notification.

      This property is used to store one or more action buttons that will be displayed at the bottom of the notification when it appears. These buttons will be placed inside the ButtonBar and use the alignment that is described in the ButtonBar documentation.

      Returns:
      the primaryActions property
      See Also:

    • getPrimaryActions

      public javafx.collections.ObservableList<javafx.scene.control.Button> getPrimaryActions()
      Gets the value of the primaryActions property.
      Property description:
      Specifies the primary actions associated with this notification.

      This property is used to store one or more action buttons that will be displayed at the bottom of the notification when it appears. These buttons will be placed inside the ButtonBar and use the alignment that is described in the ButtonBar documentation.

      Returns:
      the value of the primaryActions property
      See Also:

    • setPrimaryActions

      public void setPrimaryActions(javafx.collections.ObservableList<javafx.scene.control.Button> buttons)
      Sets the value of the primaryActions property.
      Property description:
      Specifies the primary actions associated with this notification.

      This property is used to store one or more action buttons that will be displayed at the bottom of the notification when it appears. These buttons will be placed inside the ButtonBar and use the alignment that is described in the ButtonBar documentation.

      Parameters:
      buttons - the value for the primaryActions property
      See Also:

    • setPrimaryActions

      public void setPrimaryActions(javafx.scene.control.Button... buttons)

    • secondaryActionsProperty

      public javafx.beans.property.ReadOnlyObjectProperty<javafx.collections.ObservableList<javafx.scene.control.MenuItem>> secondaryActionsProperty()
      Specifies the secondary actions associated with this notification.

      This property is used to store one or more menu items that will be displayed as a dropdown menu at the top corner of the notification when it appears.

      The dropdown menu button will not appear if the list is empty.

      Returns:
      the secondaryActions property
      See Also:

    • getSecondaryActions

      public javafx.collections.ObservableList<javafx.scene.control.MenuItem> getSecondaryActions()
      Gets the value of the secondaryActions property.
      Property description:
      Specifies the secondary actions associated with this notification.

      This property is used to store one or more menu items that will be displayed as a dropdown menu at the top corner of the notification when it appears.

      The dropdown menu button will not appear if the list is empty.

      Returns:
      the value of the secondaryActions property
      See Also:

    • setSecondaryActions

      public void setSecondaryActions(javafx.collections.ObservableList<javafx.scene.control.MenuItem> items)
      Sets the value of the secondaryActions property.
      Property description:
      Specifies the secondary actions associated with this notification.

      This property is used to store one or more menu items that will be displayed as a dropdown menu at the top corner of the notification when it appears.

      The dropdown menu button will not appear if the list is empty.

      Parameters:
      items - the value for the secondaryActions property
      See Also:

    • setSecondaryActions

      public void setSecondaryActions(javafx.scene.control.MenuItem... items)

    • onCloseProperty

      public javafx.beans.property.ObjectProperty<@Nullable javafx.event.EventHandler<? super javafx.event.Event>> onCloseProperty()
      Specifies the close handler used to dismiss this notification.

      The close button will not appear if the handler is not set for it.

      Returns:
      the onClose property
      See Also:

    • getOnClose

      public @Nullable javafx.event.EventHandler<? super javafx.event.Event> getOnClose()
      Gets the value of the onClose property.
      Property description:
      Specifies the close handler used to dismiss this notification.

      The close button will not appear if the handler is not set for it.

      Returns:
      the value of the onClose property
      See Also:

    • setOnClose

      public void setOnClose(@Nullable javafx.event.EventHandler<? super javafx.event.Event> onClose)
      Sets the value of the onClose property.
      Property description:
      Specifies the close handler used to dismiss this notification.

      The close button will not appear if the handler is not set for it.

      Parameters:
      onClose - the value for the onClose property
      See Also: