Module MaterialFX

Package io.github.palexdev.materialfx.controls

Class MFXSimpleNotification

java.lang.Object

io.github.palexdev.materialfx.controls.MFXSimpleNotification

All Implemented Interfaces:

INotification

public class MFXSimpleNotification
extends Object
implements INotification

Simple implementation of INotification.

By default the INotification.getTimeToStringConverter() function is set to use StringUtils.timeToHumanReadable(long). By default the INotification.setOnUpdateElapsed(BiConsumer) function is set to do nothing.

Offers a Builder to build a notification with fluent design.

Property Summary

Properties

Type	Property	Description
ObjectProperty<NotificationState>	notificationState	Specifies the notification's read state.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MFXSimpleNotification.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MFXSimpleNotification()
	MFXSimpleNotification(Region content)

Method Summary

Modifier and Type	Method	Description
Region	getContent()
long	getElapsedTime()
NotificationState	getState()
long	getTime()
Function<Long,String>	getTimeToStringConverter()
ObjectProperty<NotificationState>	notificationStateProperty()	Specifies the notification's read state.
protected void	setContent(Region content)
void	setNotificationState(NotificationState state)	Sets the value of the property notificationState.
void	setOnUpdateElapsed(BiConsumer<Long,String> elapsedConsumer)	This action is automatically called by INotification.updateElapsed(), use this to inform "someone" that the elapsed time should be updated.
void	setTimeToStringConverter(Function<Long,String> converter)	Sets the function used to convert a time in seconds to String.
void	updateElapsed()	Should be called by a periodic task to inform "someone" that the elapsed time should be updated

Methods inherited from class java.lang.Object

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

Property Details

notificationState

public ObjectProperty<NotificationState> notificationStateProperty

Specified by:

notificationStateProperty in interface INotification

See Also:

• setNotificationState(NotificationState)

Constructor Details

MFXSimpleNotification

protected MFXSimpleNotification()

MFXSimpleNotification

public MFXSimpleNotification(Region content)

Method Details

getContent

public Region getContent()

Specified by:

getContent in interface INotification

Returns:

the notification's content

setContent

protected void setContent(Region content)

getState

public NotificationState getState()

Specified by:

getState in interface INotification

notificationStateProperty

public ObjectProperty<NotificationState> notificationStateProperty()

Description copied from interface: INotification

Specifies the notification's read state.

Specified by:

notificationStateProperty in interface INotification

See Also:

• setNotificationState(NotificationState)

setNotificationState

public void setNotificationState(NotificationState state)

Sets the value of the property notificationState.

Specified by:

setNotificationState in interface INotification

Property description:

getTime

public long getTime()

Specified by:

getTime in interface INotification

Returns:

the created time as a long value, the number of seconds from the Java epoch

getElapsedTime

public long getElapsedTime()

Specified by:

getElapsedTime in interface INotification

Returns:

the difference between the current number of seconds from the Java epoch and the created time

getTimeToStringConverter

public Function<Long,String> getTimeToStringConverter()

Specified by:

getTimeToStringConverter in interface INotification

Returns:

the function used to convert a time in seconds to String

setTimeToStringConverter

public void setTimeToStringConverter(Function<Long,String> converter)

Description copied from interface: INotification

Sets the function used to convert a time in seconds to String.

Specified by:

setTimeToStringConverter in interface INotification

updateElapsed

public void updateElapsed()

Description copied from interface: INotification

Should be called by a periodic task to inform "someone" that the elapsed time should be updated

Specified by:

updateElapsed in interface INotification

setOnUpdateElapsed

public void setOnUpdateElapsed(BiConsumer<Long,String> elapsedConsumer)

Description copied from interface: INotification

This action is automatically called by INotification.updateElapsed(), use this to inform "someone" that the elapsed time should be updated. The action is a BiConsumer and the inputs are the elapsed seconds as a long value and the elapsed seconds converted to a String by using the INotification.getTimeToStringConverter().

Specified by:

setOnUpdateElapsed in interface INotification