public class Notifications
extends java.lang.Object
NotificationPane which shows notification messages
within your application itself.
The following screenshot shows a sample notification rising from the
bottom-right corner of my screen:
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();
| Modifier and Type | Method and Description |
|---|---|
Notifications |
action(Action... actions)
Specify 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.
|
Notifications |
darkStyle()
Specify that the notification should use the built-in dark styling,
rather than the default 'modena' notification style (which is a
light-gray).
|
Notifications |
graphic(javafx.scene.Node graphic)
Specify the graphic to show in the notification.
|
Notifications |
hideAfter(javafx.util.Duration duration)
Specify the duration that the notification should show, after which it
will be hidden.
|
Notifications |
hideCloseButton()
Specify that the close button in the top-right corner of the notification
should not be shown.
|
Notifications |
onAction(javafx.event.EventHandler<javafx.event.ActionEvent> onAction)
Specify what to do when the user clicks on the notification (in addition
to the notification hiding, which happens whenever the notification is
clicked on).
|
Notifications |
owner(java.lang.Object owner)
The dialog window owner - which can be
Screen, Window
or Node. |
Notifications |
position(javafx.geometry.Pos position)
Specify the position of the notification on screen, by default it is
bottom-right. |
void |
show()
Instructs the notification to be shown.
|
void |
showConfirm()
Instructs the notification to be shown, and that it should use the
built-in 'confirm' graphic.
|
void |
showError()
Instructs the notification to be shown, and that it should use the
built-in 'error' graphic.
|
void |
showInformation()
Instructs the notification to be shown, and that it should use the
built-in 'information' graphic.
|
void |
showWarning()
Instructs the notification to be shown, and that it should use the
built-in 'warning' graphic.
|
Notifications |
text(java.lang.String text)
Specify the text to show in the notification.
|
Notifications |
threshold(int threshold,
Notifications thresholdNotification)
Collapses all the current notifications into a single notification when the
number of notifications exceed the threshold limit.
|
Notifications |
title(java.lang.String title)
Specify the title to show in the notification.
|
public static Notifications create()
public Notifications text(java.lang.String text)
public Notifications title(java.lang.String title)
public Notifications graphic(javafx.scene.Node graphic)
public Notifications position(javafx.geometry.Pos position)
bottom-right.public Notifications owner(java.lang.Object owner)
Screen, Window
or Node. If specified, the notifications will be inside
the owner, otherwise the notifications will be shown within the whole
primary (default) screen.public Notifications hideAfter(javafx.util.Duration duration)
public Notifications onAction(javafx.event.EventHandler<javafx.event.ActionEvent> onAction)
public Notifications darkStyle()
public Notifications hideCloseButton()
public Notifications action(Action... actions)
public Notifications threshold(int threshold, Notifications thresholdNotification)
threshold - The number of notifications to show before they can be collapsed
into a single notification.thresholdNotification - The notification to show when
threshold is reached.public void showWarning()
public void showInformation()
public void showError()
public void showConfirm()
public void show()