Module MaterialFX

Package io.github.palexdev.materialfx.notifications

Class MFXNotificationSystem

java.lang.Object

io.github.palexdev.materialfx.notifications.base.AbstractMFXNotificationSystem

io.github.palexdev.materialfx.notifications.MFXNotificationSystem

All Implemented Interfaces:

INotificationSystem

public class MFXNotificationSystem
extends AbstractMFXNotificationSystem

Simple implementation of an AbstractMFXNotificationSystem which makes use of a CircularQueue to keep a history of the shown notifications (by default max size is 100), and a list to keep a reference to queued notifications that can't be shown at the moment of publish(INotification) and that will be sent to scheduleReopen(INotification) instead.

Field Summary

Fields inherited from class io.github.palexdev.materialfx.notifications.base.AbstractMFXNotificationSystem

animated, closeAfter, closeAfterTransition, closeAutomatically, closing, dummyStage, onClose, owner, popup, position, screen, showing, spacing

Method Summary

Modifier and Type	Method	Description
protected void	close()	Sets the closing property to true and hides the notification.
protected TransitionPositionBean	computePosition()	Computes the position of the popup as a TransitionPositionBean to be used in animations too.
INotificationSystem	dispose()	Closes and disposes the notification system if not needed anymore.
CircularQueue<INotification>	history()	Returns the list of shown notifications.
protected void	init()	Initializes the popup's position for the specified NotificationPos.
MFXNotificationSystem	initOwner(Window owner)	A notification system should be initialized to honor the behavior of a owner Window.
static MFXNotificationSystem	instance()
MFXNotificationSystem	publish(INotification notification)	If the notification system is showing/closing, exits and scheduleReopen(INotification) is called.
protected void	scheduleReopen(INotification notification)	Adds the notification to the queued notifications list, then adds a one-time listener to the closing property so that when it becomes false a notification is removed from the queue and then sent to publish(INotification) again.
MFXNotificationSystem	setHistoryLimit(int size)	Delegate to CircularQueue.setSize(int).
protected void	show()	Sets the showing property to true, computes the popup position as a TransitionPositionBean, then positions the popup (animated or not).

Methods inherited from class io.github.palexdev.materialfx.notifications.base.AbstractMFXNotificationSystem

delaySetPosition, getCloseAfter, getPosition, getScreen, getSpacing, isAnimated, isCloseAutomatically, isClosing, isShowing, setAnimated, setCloseAfter, setCloseAutomatically, setPosition, setScreen, setSpacing

Methods inherited from class java.lang.Object

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

Method Details

instance

public static MFXNotificationSystem instance()

initOwner

public MFXNotificationSystem initOwner(Window owner)

A notification system should be initialized to honor the behavior of a owner Window. (for example if the owner closes that the notification system closes too)

This method must be called before the notification system can be used.

Also calls dispose() before initializing.

init

protected void init()

Initializes the popup's position for the specified NotificationPos.

Overrides:

init in class AbstractMFXNotificationSystem

publish

public MFXNotificationSystem publish(INotification notification)

If the notification system is showing/closing, exits and scheduleReopen(INotification) is called.

Adds the notification to the notifications queue then if the notification system is set to close automatically starts the close PauseTransition.

Shows the popup (the content is still hidden tough so it's not really open), then forces the notification container to compute its bounds (should not be necessary though), shown the content and calls show().

Throws:

IllegalStateException - if the notification system has not been initialized

show

protected void show()

Sets the showing property to true, computes the popup position as a TransitionPositionBean, then positions the popup (animated or not).

Specified by:

show in class AbstractMFXNotificationSystem

close

protected void close()

Sets the closing property to true and hides the notification. At the end always hides the popup, and resets the showing/closing properties.

Specified by:

close in class AbstractMFXNotificationSystem

scheduleReopen

protected void scheduleReopen(INotification notification)

Adds the notification to the queued notifications list, then adds a one-time listener to the closing property so that when it becomes false a notification is removed from the queue and then sent to publish(INotification) again.

Specified by:

scheduleReopen in class AbstractMFXNotificationSystem

computePosition

protected TransitionPositionBean computePosition()

Computes the position of the popup as a TransitionPositionBean to be used in animations too.

Specified by:

computePosition in class AbstractMFXNotificationSystem

dispose

public INotificationSystem dispose()

Description copied from interface: INotificationSystem

Closes and disposes the notification system if not needed anymore.

history

public CircularQueue<INotification> history()

Returns the list of shown notifications.

setHistoryLimit

public MFXNotificationSystem setHistoryLimit(int size)

Delegate to CircularQueue.setSize(int).