Module MaterialFX

Package io.github.palexdev.materialfx.dialogs

Class MFXStageDialogBuilder

java.lang.Object

io.github.palexdev.materialfx.dialogs.MFXStageDialogBuilder

public class MFXStageDialogBuilder
extends Object

Builder class for MFXStageDialogs with fluent api.

Constructor Summary

Constructors

Constructor	Description
MFXStageDialogBuilder()
MFXStageDialogBuilder(MFXStageDialog stageDialog)

Method Summary

Modifier and Type	Method	Description
<T extends Event> MFXStageDialogBuilder	addEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)	Delegate for Window.addEventFilter(EventType, EventHandler).
<T extends Event> MFXStageDialogBuilder	addEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Delegate for Window.addEventHandler(EventType, EventHandler).
static MFXStageDialogBuilder	build()	Uses the no-arg constructor, starts from a new MFXStageDialog.
static MFXStageDialogBuilder	build(MFXStageDialog stageDialog)	Uses the MFXStageDialogBuilder(MFXStageDialog) constructor, starts from the given dialog.
MFXStageDialog	get()
MFXStageDialogBuilder	initModality(Modality modality)	Sets the dialog's modality.
MFXStageDialogBuilder	initOwner(Window owner)	Sets the dialog's owner window.
<T extends Event> MFXStageDialogBuilder	removeEventFilter(EventType<T> eventType, EventHandler<? super T> eventFilter)	Delegate for Window.removeEventFilter(EventType, EventHandler).
<T extends Event> MFXStageDialogBuilder	removeEventHandler(EventType<T> eventType, EventHandler<? super T> eventHandler)	Delegate for Window.removeEventHandler(EventType, EventHandler).
MFXStageDialogBuilder	setAlwaysOnTop(boolean alwaysOnTop)	Sets whether the dialog should stay always on top.
MFXStageDialogBuilder	setCenterInOwnerNode(boolean centerInOwnerNode)	Sets whether the dialog should be centered on the owner node when shown.
MFXStageDialogBuilder	setContent(AbstractMFXDialog content)	Sets the dialog's content.
MFXStageDialogBuilder	setDraggable(boolean draggable)	Sets whether the dialog is draggable.
MFXStageDialogBuilder	setOnCloseRequest(EventHandler<WindowEvent> handler)	Sets tha action to perform on a close request.
MFXStageDialogBuilder	setOnHidden(EventHandler<WindowEvent> handler)	Sets tha action to perform on hidden.
MFXStageDialogBuilder	setOnHiding(EventHandler<WindowEvent> handler)	Sets tha action to perform on hiding.
MFXStageDialogBuilder	setOnShowing(EventHandler<WindowEvent> handler)	Sets tha action to perform on showing.
MFXStageDialogBuilder	setOnShown(EventHandler<WindowEvent> handler)	Sets tha action to perform on shown.
MFXStageDialogBuilder	setOverlayClose(boolean overlayClose)	Sets whether to close the dialog when pressing on its owner node.
MFXStageDialogBuilder	setOwnerNode(Pane ownerNode)	Sets the dialog's owner node.
MFXStageDialogBuilder	setScrimOwner(boolean scrimOwner)	Sets whether to scrim the dialog's owner node on showing.
MFXStageDialogBuilder	setScrimPriority(ScrimPriority scrimPriority)	Sets the enum constant used to specify how to apply the scrim effect.
MFXStageDialogBuilder	setScrimStrength(double scrimStrength)	Sets the scrim effect strength(opacity).
MFXStageDialogBuilder	setTitle(String title)	Sets the dialog's title.

Methods inherited from class java.lang.Object

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

Constructor Details

MFXStageDialogBuilder

public MFXStageDialogBuilder()

MFXStageDialogBuilder

public MFXStageDialogBuilder(MFXStageDialog stageDialog)

Method Details

build

public static MFXStageDialogBuilder build()

Uses the no-arg constructor, starts from a new MFXStageDialog.

build

public static MFXStageDialogBuilder build(MFXStageDialog stageDialog)

Uses the MFXStageDialogBuilder(MFXStageDialog) constructor, starts from the given dialog.

setContent

public MFXStageDialogBuilder setContent(AbstractMFXDialog content)

Sets the dialog's content.

setOwnerNode

public MFXStageDialogBuilder setOwnerNode(Pane ownerNode)

Sets the dialog's owner node.

setCenterInOwnerNode

public MFXStageDialogBuilder setCenterInOwnerNode(boolean centerInOwnerNode)

Sets whether the dialog should be centered on the owner node when shown.

setScrimOwner

public MFXStageDialogBuilder setScrimOwner(boolean scrimOwner)

Sets whether to scrim the dialog's owner node on showing.

setScrimStrength

public MFXStageDialogBuilder setScrimStrength(double scrimStrength)

Sets the scrim effect strength(opacity).

setScrimPriority

public MFXStageDialogBuilder setScrimPriority(ScrimPriority scrimPriority)

Sets the enum constant used to specify how to apply the scrim effect. You can have two owners, one is the stage owner(Window) and the other is the dialog owner(Pane). Sometimes it's better to apply the scrim to the window (for example the owner node would not allow to apply the scrim effect, for example AnchorPanes, VBoxes, HBoxes...), but you still want to center the dialog in the owner node. Setting this to ScrimPriority.WINDOW will tell the dialog to apply the effect to owner window, setting this to ScrimPriority.NODE will tell the dialog to apply the effect to owner node.

setDraggable

public MFXStageDialogBuilder setDraggable(boolean draggable)

Sets whether the dialog is draggable.

setOverlayClose

public MFXStageDialogBuilder setOverlayClose(boolean overlayClose)

Sets whether to close the dialog when pressing on its owner node.

initModality

public MFXStageDialogBuilder initModality(Modality modality)

Sets the dialog's modality.

initOwner

public MFXStageDialogBuilder initOwner(Window owner)

Sets the dialog's owner window.

setTitle

public MFXStageDialogBuilder setTitle(String title)

Sets the dialog's title.

setAlwaysOnTop

public MFXStageDialogBuilder setAlwaysOnTop(boolean alwaysOnTop)

Sets whether the dialog should stay always on top.

setOnCloseRequest

public MFXStageDialogBuilder setOnCloseRequest(EventHandler<WindowEvent> handler)

Sets tha action to perform on a close request.

setOnShowing

public MFXStageDialogBuilder setOnShowing(EventHandler<WindowEvent> handler)

Sets tha action to perform on showing.

setOnShown

public MFXStageDialogBuilder setOnShown(EventHandler<WindowEvent> handler)

Sets tha action to perform on shown.

setOnHiding

public MFXStageDialogBuilder setOnHiding(EventHandler<WindowEvent> handler)

Sets tha action to perform on hiding.

setOnHidden

public MFXStageDialogBuilder setOnHidden(EventHandler<WindowEvent> handler)

Sets tha action to perform on hidden.

addEventHandler

public <T extends Event> MFXStageDialogBuilder addEventHandler(EventType<T> eventType,
 EventHandler<? super T> eventHandler)

Delegate for Window.addEventHandler(EventType, EventHandler).

removeEventHandler

public <T extends Event> MFXStageDialogBuilder removeEventHandler(EventType<T> eventType,
 EventHandler<? super T> eventHandler)

Delegate for Window.removeEventHandler(EventType, EventHandler).

addEventFilter

public <T extends Event> MFXStageDialogBuilder addEventFilter(EventType<T> eventType,
 EventHandler<? super T> eventFilter)

Delegate for Window.addEventFilter(EventType, EventHandler).

removeEventFilter

public <T extends Event> MFXStageDialogBuilder removeEventFilter(EventType<T> eventType,
 EventHandler<? super T> eventFilter)

Delegate for Window.removeEventFilter(EventType, EventHandler).

get

public MFXStageDialog get()

Returns:

the built stage dialog