Module org.tquadrat.foundation.fx

Package org.tquadrat.foundation.fx.util

Class AlertBuilder

java.lang.Object

org.tquadrat.foundation.fx.util.AlertBuilder

@ClassVersion(sourceVersion="$Id: AlertBuilder.java 1110 2024-03-04 15:26:06Z tquadrat $")
@API(status=STABLE,
     since="0.4.1")
public class AlertBuilder
extends Object

This class provides a fluent API to build an Alert.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: AlertBuilder.java 1110 2024-03-04 15:26:06Z tquadrat $

Since:

0.4.1

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.fx.util.AlertBuilder"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private final Alert	m_Alert	The alert instance to build.
private boolean	m_IsBuilt	Flag that prevents the re-use of the builder.

Constructor Summary

Constructors

Constructor	Description
AlertBuilder(Alert.AlertType type)	Creates a new instance of AlertBuilder.
AlertBuilder(Alert.AlertType type, Window owner)	Creates a new instance of AlertBuilder.

Method Summary

Modifier and Type	Method	Description
final <E extends Event> AlertBuilder	addEventFilter(EventType<E> eventType, EventHandler<? super E> eventFilter)	Registers an event filter for the new alert.
final <E extends Event> AlertBuilder	addEventHandler(EventType<E> eventType, EventHandler<? super E> eventHandler)	Registers an even filter for the new alert.
final Alert	build()	Returns the alert instance.
private final void	checkIsBuilt()	Throws an IllegalStateException when m_IsBuilt is true.
final boolean	execute()	Builds the alert, calls showAndWait() on it and returns the result.
final AlertBuilder	setContentText(String s)	Sets the content text for the new alert.
final AlertBuilder	setDialogPane(DialogPane dialogPane)	Sets the DialogPane for the new alert.
final AlertBuilder	setDimensions(double width, double height)	Sets the window dimensions for the new alert.
final AlertBuilder	setGraphic(Node node)	Sets the graphics for the new alert.
final AlertBuilder	setHeaderText(String s)	Sets the header text for the new alert.
final AlertBuilder	setHeight(double height)	Sets the window height for the new alert.
final AlertBuilder	setModality(Modality modality)	Sets the Modality for the new alert.
final AlertBuilder	setOnCloseRequest(EventHandler<DialogEvent> eventHandler)	Sets the 'OnCloseRequest' event handler for the new alert.
final AlertBuilder	setOnHidden(EventHandler<DialogEvent> eventHandler)	Sets the 'OnHidden' event handler for the new alert.
final AlertBuilder	setOnHiding(EventHandler<DialogEvent> eventHandler)	Sets the 'OnHiding' event handler for the new alert.
final AlertBuilder	setOnShowing(EventHandler<DialogEvent> eventHandler)	Sets the 'OnShowing' event handler for the new alert.
final AlertBuilder	setOnShown(EventHandler<DialogEvent> eventHandler)	Sets the 'OnShown' event handler for the new alert.
final AlertBuilder	setOwner(Window owner)	Sets the parent window for the new alert.
final AlertBuilder	setPos(double x, double y)	Sets the position for the new alert.
final AlertBuilder	setResizable(boolean flag)	Sets the flag that indicates whether the window for the new alert can be resized.
final AlertBuilder	setResultConverter(Callback<ButtonType,ButtonType> callback)	Sets the result converter for the new alert.
final AlertBuilder	setStyle(StageStyle style)	Sets the style for the new alert.
final AlertBuilder	setTitle(String s)	Sets the window title for the new alert.
final AlertBuilder	setWidth(double width)	Sets the window width for the new alert.
final AlertBuilder	setX(double x)	Sets the x position for the new alert.
final AlertBuilder	setY(double y)	Sets the y position for the new alert.

Methods inherited from class java.lang.Object

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

Field Details

m_Alert

private final Alert m_Alert

The alert instance to build.

m_IsBuilt

private boolean m_IsBuilt

Flag that prevents the re-use of the builder.

Constructor Details

AlertBuilder

public AlertBuilder(Alert.AlertType type)

Creates a new instance of AlertBuilder.

Parameters:

type - The type of the new alert.

AlertBuilder

public AlertBuilder(Alert.AlertType type,
 Window owner)

Creates a new instance of AlertBuilder.

Parameters:

type - The type of the new alert.

owner - The parent window for the alert.

Method Details

addEventFilter

public final <E extends Event> AlertBuilder addEventFilter(EventType<E> eventType,
 EventHandler<? super E> eventFilter)
                                                    throws IllegalStateException

Registers an event filter for the new alert.

Type Parameters:

E - The event class of the filer.

Parameters:

eventType - The type of the events received by the filter.

eventFilter - The event filter.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.addEventFilter(EventType,EventHandler)

addEventHandler

public final <E extends Event> AlertBuilder addEventHandler(EventType<E> eventType,
 EventHandler<? super E> eventHandler)
                                                     throws IllegalStateException

Registers an even filter for the new alert.

Type Parameters:

E - The event class of the filter.

Parameters:

eventType - The type of the events received by the filter.

eventHandler - The event handler.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.addEventHandler(EventType,EventHandler)

build

public final Alert build()
                  throws IllegalStateException

Returns the alert instance.

Returns:

The alert.

Throws:

IllegalStateException - The method build() was already called previously on this builder instance.

checkIsBuilt

private final void checkIsBuilt()
                         throws IllegalStateException

Throws an IllegalStateException when m_IsBuilt is true.

Throws:

IllegalStateException - m_IsBuilt is true.

execute

@API(status=STABLE,
     since="0.4.1")
public final boolean execute()
                      throws IllegalStateException

Builds the alert, calls showAndWait() on it and returns the result.

Returns:

true if the alert was terminated with the Ok button, false in any other case.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

Since:

0.4.2

setContentText

public final AlertBuilder setContentText(String s)
                                  throws IllegalStateException

Sets the content text for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

s - The content text; can be null.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setContentText(String)

setDialogPane

public final AlertBuilder setDialogPane(DialogPane dialogPane)
                                 throws IllegalStateException

Sets the DialogPane for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

dialogPane - The dialog pane; can be null.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setDialogPane(DialogPane)

setDimensions

public final AlertBuilder setDimensions(double width,
 double height)
                                 throws IllegalStateException

Sets the window dimensions for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the values set by the previous one.

Parameters:

width - The window width.

height - The window height.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setHeight(double)
• Dialog.setWidth(double)

setGraphic

public final AlertBuilder setGraphic(Node node)
                              throws IllegalStateException

Sets the graphics for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

node - The graphics; can be null.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setGraphic(Node)

setHeaderText

public final AlertBuilder setHeaderText(String s)
                                 throws IllegalStateException

Sets the header text for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

s - The text for the header; can be null.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setHeaderText(String)

setHeight

public final AlertBuilder setHeight(double height)
                             throws IllegalStateException

Sets the window height for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

height - The window height.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setHeight(double)

setModality

public final AlertBuilder setModality(Modality modality)
                               throws IllegalStateException

Sets the Modality for the new alert.

Parameters:

modality - The modality.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.initModality(Modality)

setOnCloseRequest

public final AlertBuilder setOnCloseRequest(EventHandler<DialogEvent> eventHandler)
                                     throws IllegalStateException

Sets the 'OnCloseRequest' event handler for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

eventHandler - The event handler

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setOnCloseRequest(EventHandler)

setOnHidden

public final AlertBuilder setOnHidden(EventHandler<DialogEvent> eventHandler)
                               throws IllegalStateException

Sets the 'OnHidden' event handler for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

eventHandler - The event handler

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setOnHidden(EventHandler)

setOnHiding

public final AlertBuilder setOnHiding(EventHandler<DialogEvent> eventHandler)
                               throws IllegalStateException

Sets the 'OnHiding' event handler for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

eventHandler - The event handler

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setOnHiding(EventHandler)

setOnShowing

public final AlertBuilder setOnShowing(EventHandler<DialogEvent> eventHandler)
                                throws IllegalStateException

Sets the 'OnShowing' event handler for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

eventHandler - The event handler

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setOnShowing(EventHandler)

setOnShown

public final AlertBuilder setOnShown(EventHandler<DialogEvent> eventHandler)
                              throws IllegalStateException

Sets the 'OnShown' event handler for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

eventHandler - The event handler

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setOnShown(EventHandler)

setOwner

@API(status=STABLE,
     since="0.4.1")
public final AlertBuilder setOwner(Window owner)
                            throws IllegalStateException

Sets the parent window for the new alert.

Parameters:

owner - The parent window.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

Since:

0.4.2

See Also:

• Dialog.initOwner(Window)

setPos

public final AlertBuilder setPos(double x,
 double y)
                          throws IllegalStateException

Sets the position for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the values set by the previous one.

Parameters:

x - The x position for the alert window.

y - The y position for the alert window.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setX(double)
• Dialog.setY(double)

setResizable

public final AlertBuilder setResizable(boolean flag)
                                throws IllegalStateException

Sets the flag that indicates whether the window for the new alert can be resized.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

flag - true for a resizeable window, _false for a window with fixed sizes.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setResizable(boolean)

setResultConverter

public final AlertBuilder setResultConverter(Callback<ButtonType,ButtonType> callback)
                                      throws IllegalStateException

Sets the result converter for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Setting a result converter may have an impact on the behaviour of execute().

Parameters:

callback - The result converter; can be null.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setResultConverter(Callback)

setStyle

public final AlertBuilder setStyle(StageStyle style)
                            throws IllegalStateException

Sets the style for the new alert.

Parameters:

style - The style.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.initStyle(StageStyle)

setTitle

public final AlertBuilder setTitle(String s)
                            throws IllegalStateException

Sets the window title for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

s - The window title; can be null.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setTitle(String)

setWidth

public final AlertBuilder setWidth(double width)
                            throws IllegalStateException

Sets the window width for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

width - The window width.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setWidth(double)

setX

public final AlertBuilder setX(double x)
                        throws IllegalStateException

Sets the x position for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

x - The x position.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setX(double)

setY

public final AlertBuilder setY(double y)
                        throws IllegalStateException

Sets the y position for the new alert.

This operation can be called repeatedly; each consecutive call will overwrite the value set by the previous one.

Parameters:

y - The y position.

Returns:

The builder reference.

Throws:

IllegalStateException - The method build() was already called on this builder instance.

See Also:

• Dialog.setX(double)