java.lang.Object
org.controlsfx.control.Notifications
An API to show popup notification messages to the user in the corner of their
screen, unlike the
NotificationPane
which shows notification messages
within your application itself.
Screenshot
The following screenshot shows a sample notification rising from the
bottom-right corner of my screen:
Code Example:
To create the notification shown in the screenshot, simply do the following:
Notifications.create()
.title("Title Text")
.text("Hello World 0!")
.showWarning();
When there are too many notifications on the screen, one can opt to collapse
the notifications into a single notification using threshold(int, Notifications)
.
Notifications.create()
.title("Title Text")
.text("Hello World 0!")
.threshold(3, Notifications.create().title("Collapsed Notification"))
.showWarning();
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the actions that should be shown in the notification as buttons.static Notifications
create()
Call this to begin the process of building a notification to show.Specifies that the notification should use the built-in dark styling, rather than the default 'modena' notification style (which is a light-gray).Gets the style classes that would be added to theNotificationBar
.graphic
(javafx.scene.Node graphic) Specifies the graphic to show in the notification.hideAfter
(javafx.util.Duration duration) Specifies the duration that the notification should show, after which it will be hidden.Specifies that the close button in the top-right corner of the notification should not be shown.onAction
(javafx.event.EventHandler<javafx.event.ActionEvent> onAction) Specifies what to do when the user clicks on the notification (in addition to the notification hiding, which happens whenever the notification is clicked on).The dialog window owner - which can beScreen
,Window
orNode
.position
(javafx.geometry.Pos position) Specifies the position of the notification on screen, by default it isbottom-right
.void
show()
Instructs the notification to be shown.void
Instructs the notification to be shown, and that it should use the built-in 'confirm' graphic.void
Instructs the notification to be shown, and that it should use the built-in 'error' graphic.void
Instructs the notification to be shown, and that it should use the built-in 'information' graphic.void
Instructs the notification to be shown, and that it should use the built-in 'warning' graphic.styleClass
(String... styleClasses) Specifies the style classes to add to theNotificationBar
.Specifies the text to show in the notification.threshold
(int threshold, Notifications thresholdNotification) Collapses all the current notifications into a single notification when the number of notifications exceed the threshold limit.Specifies the title to show in the notification.
-
Method Details
-
create
Call this to begin the process of building a notification to show. -
text
Specifies the text to show in the notification. -
title
Specifies the title to show in the notification. -
graphic
Specifies the graphic to show in the notification. -
position
Specifies the position of the notification on screen, by default it isbottom-right
. -
owner
The dialog window owner - which can beScreen
,Window
orNode
. If specified, the notifications will be inside the owner, otherwise the notifications will be shown within the whole primary (default) screen. -
hideAfter
Specifies the duration that the notification should show, after which it will be hidden. -
onAction
Specifies what to do when the user clicks on the notification (in addition to the notification hiding, which happens whenever the notification is clicked on). -
darkStyle
Specifies that the notification should use the built-in dark styling, rather than the default 'modena' notification style (which is a light-gray). -
styleClass
Specifies the style classes to add to theNotificationBar
. -
hideCloseButton
Specifies that the close button in the top-right corner of the notification should not be shown. -
action
Specifies the actions that should be shown in the notification as buttons. -
threshold
Collapses all the current notifications into a single notification when the number of notifications exceed the threshold limit. A value of zero will disable the threshold behavior.- Parameters:
threshold
- The number of notifications to show before they can be collapsed into a single notification.thresholdNotification
- Thenotification
to show when threshold is reached.
-
showWarning
public void showWarning()Instructs the notification to be shown, and that it should use the built-in 'warning' graphic. -
showInformation
public void showInformation()Instructs the notification to be shown, and that it should use the built-in 'information' graphic. -
showError
public void showError()Instructs the notification to be shown, and that it should use the built-in 'error' graphic. -
showConfirm
public void showConfirm()Instructs the notification to be shown, and that it should use the built-in 'confirm' graphic. -
show
public void show()Instructs the notification to be shown. -
getStyleClass
Gets the style classes that would be added to theNotificationBar
.
-