Module org.tentackle.fx

Package org.tentackle.fx

Class DefaultNotificationBuilder

java.lang.Object

org.tentackle.fx.DefaultNotificationBuilder

All Implemented Interfaces:

NotificationBuilder

public class DefaultNotificationBuilder
extends Object
implements NotificationBuilder

Default implementation of a notification builder.

See Also:

• FxFactory.createNotificationBuilder()

Nested Class Summary

Nested classes/interfaces inherited from interface org.tentackle.fx.NotificationBuilder

NotificationBuilder.CloseButtonMode, NotificationBuilder.Type

Constructor Summary

Constructors

Constructor	Description
DefaultNotificationBuilder()

Method Summary

Modifier and Type	Method	Description
javafx.scene.Parent	build()	Creates the notification.
NotificationBuilder	button(String text, javafx.scene.Node graphic, boolean isDefault, Runnable action)	Adds a button.
NotificationBuilder	closeButton(NotificationBuilder.CloseButtonMode closeButtonMode)	Sets the close button mode.
NotificationBuilder	content(javafx.scene.Node content)	Sets a node as an alternative to details.
NotificationBuilder	css(URL css)	Applies a CSS stylesheet. Overrides the default stylesheet org/tentackle/fx/notification.css.
NotificationBuilder	details(String details)	Sets the detail message. A stacktrace, for example.
NotificationBuilder	duration(long duration)	Sets a duration to close the notification automatically. Ignored if there is no hide action.
NotificationBuilder	fadeIn(long fadeIn)	Sets a fadein effect to show the notification smoothly.
NotificationBuilder	fadeOut(long fadeOut)	Sets a fadeout effect to close the notification smoothly. Ignored if there is no hide action.
protected URL	getDefaultCSS()	Gets the default CSS URL.
String	getTitle()	Returns the title of the notification. It depends on the implementation whether the title is already part of the node or of a window title or not visible at all.
NotificationBuilder	graphic(javafx.scene.Node graphic)	Sets the graphic.
NotificationBuilder	hide(Runnable hide)	Sets the hide action when a button is pressed.
NotificationBuilder	text(String text)	Sets the text message.
NotificationBuilder	title(String title)	Sets the title.
NotificationBuilder	type(NotificationBuilder.Type type)	Sets the notification type.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultNotificationBuilder

public DefaultNotificationBuilder()

Method Details

type

public NotificationBuilder type(NotificationBuilder.Type type)

Description copied from interface: NotificationBuilder

Sets the notification type.

Specified by:

type in interface NotificationBuilder

Parameters:

type - the type

Returns:

the builder

graphic

public NotificationBuilder graphic(javafx.scene.Node graphic)

Description copied from interface: NotificationBuilder

Sets the graphic.

Specified by:

graphic in interface NotificationBuilder

Parameters:

graphic - the graphic

Returns:

the builder

title

public NotificationBuilder title(String title)

Description copied from interface: NotificationBuilder

Sets the title.

Specified by:

title in interface NotificationBuilder

Parameters:

title - the title

Returns:

the builder

text

public NotificationBuilder text(String text)

Description copied from interface: NotificationBuilder

Sets the text message.

Specified by:

text in interface NotificationBuilder

Parameters:

text - the message

Returns:

the builder

details

public NotificationBuilder details(String details)

Description copied from interface: NotificationBuilder

Sets the detail message.
A stacktrace, for example.

Notice that details are ignored if NotificationBuilder.content(Node) is set.

Specified by:

details in interface NotificationBuilder

Parameters:

details - the details

Returns:

the builder

content

public NotificationBuilder content(javafx.scene.Node content)

Description copied from interface: NotificationBuilder

Sets a node as an alternative to details.

Specified by:

content in interface NotificationBuilder

Parameters:

content - the content node

Returns:

the builder

duration

public NotificationBuilder duration(long duration)

Description copied from interface: NotificationBuilder

Sets a duration to close the notification automatically.
Ignored if there is no hide action.

Specified by:

duration in interface NotificationBuilder

Parameters:

duration - the time the dialog should be visible [ms]

Returns:

the builder

fadeOut

public NotificationBuilder fadeOut(long fadeOut)

Description copied from interface: NotificationBuilder

Sets a fadeout effect to close the notification smoothly.
Ignored if there is no hide action.

Specified by:

fadeOut in interface NotificationBuilder

Parameters:

fadeOut - the time to fade out [ms]

Returns:

the builder

fadeIn

public NotificationBuilder fadeIn(long fadeIn)

Description copied from interface: NotificationBuilder

Sets a fadein effect to show the notification smoothly.

Specified by:

fadeIn in interface NotificationBuilder

Parameters:

fadeIn - the time to fade in [ms]

Returns:

the builder

button

public NotificationBuilder button(String text,
 javafx.scene.Node graphic,
 boolean isDefault,
 Runnable action)

Description copied from interface: NotificationBuilder

Adds a button.

Specified by:

button in interface NotificationBuilder

Parameters:

text - the button's text

graphic - the button's graphic

isDefault - true if this is the default button

action - the action to perform when clicked

Returns:

the builder

hide

public NotificationBuilder hide(Runnable hide)

Description copied from interface: NotificationBuilder

Sets the hide action when a button is pressed.

Specified by:

hide in interface NotificationBuilder

Parameters:

hide - the action to close or hide the notification

Returns:

the builder

css

public NotificationBuilder css(URL css)

Description copied from interface: NotificationBuilder

Applies a CSS stylesheet.
Overrides the default stylesheet org/tentackle/fx/notification.css.

Specified by:

css in interface NotificationBuilder

Parameters:

css - the stylesheet

Returns:

the builder

closeButton

public NotificationBuilder closeButton(NotificationBuilder.CloseButtonMode closeButtonMode)

Description copied from interface: NotificationBuilder

Sets the close button mode.

Specified by:

closeButton in interface NotificationBuilder

Parameters:

closeButtonMode - the close button mode

Returns:

the builder

build

public javafx.scene.Parent build()

Description copied from interface: NotificationBuilder

Creates the notification.

Specified by:

build in interface NotificationBuilder

Returns:

the notification

getTitle

public String getTitle()

Description copied from interface: NotificationBuilder

Returns the title of the notification.
It depends on the implementation whether the title is already part of the node or of a window title or not visible at all.

Specified by:

getTitle in interface NotificationBuilder

Returns:

the title

getDefaultCSS

protected URL getDefaultCSS()

Gets the default CSS URL.

Returns:

the URL