org.eclipse.fx.ui.dialogs

Class Dialog

java.lang.Object

org.eclipse.fx.ui.dialogs.Dialog

Direct Known Subclasses:

FontDialog, MessageDialog, PromptInputDialog, TitleAreaDialog

public abstract class Dialog
extends java.lang.Object

Base class for dialogs

Field Summary

Fields

Modifier and Type	Field and Description
static int	CANCEL_BUTTON Cancel button ID
static int	OK_BUTTON Ok button ID

Constructor Summary

Constructors

Constructor and Description
Dialog(@Nullable javafx.stage.Window parent, @NonNull java.lang.String title) Create a new dialog instance

Method Summary

Modifier and Type	Method and Description
protected void	buttonPressed(int type) Method called when button is pressed
protected void	cancelPressed() Method called when the cancle button is invoked
protected void	close() Close the dialog
protected javafx.stage.Stage	create() Create the dialogs stage
protected javafx.scene.Node	createButtonBar()
protected javafx.scene.control.Button	createButtonForBar(int type, java.lang.String label, boolean defaultOkButton, boolean defaultCancel) Create a button for the button bar
protected java.util.List<javafx.scene.control.Button>	createButtonsForBar() Create the buttons for the bar
protected javafx.scene.Parent	createContents() Create the dialog content Subclasses should normally override createDialogArea()
protected abstract javafx.scene.Node	createDialogArea()
@NonNull javafx.scene.shape.Rectangle	getBounds() The bounds of the dialog Has to be called after open().
protected javafx.geometry.Insets	getContentInset()
protected javafx.geometry.Point2D	getInitialContentSize(javafx.scene.Parent rootContainer) Get the initial size of the content
protected javafx.geometry.Point2D	getInitialLocation(javafx.scene.Parent rootContainer) Get initial location of the dialog
protected javafx.geometry.Point2D	getInitialSize(javafx.scene.Parent rootContainer) Get the initial size of the dialog
protected javafx.stage.Modality	getModality()
protected java.util.List<java.lang.String>	getStylesheets()
protected boolean	isCancelDefault(int buttonId) Check if the button ID is the default cancle button
protected boolean	isOkDefault(int buttonId) Check if the button ID is the default ok button
protected void	okPressed() Method called when the ok button is invoked
int	open() Open the dialog
void	pack() Pack the dialog to the content size
protected void	preopen(javafx.stage.Stage s) Called before dialog is opened
void	setBounds(int x, int y, int width, int height) Set the bounds of the dialog Has to be called after open().
protected void	setReturnCode(int returnCode) Setting the return code

Methods inherited from class java.lang.Object

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

Field Detail

OK_BUTTON

public static final int OK_BUTTON

Ok button ID

See Also:

Constant Field Values

CANCEL_BUTTON

public static final int CANCEL_BUTTON

Cancel button ID

See Also:

Constant Field Values

Constructor Detail

Dialog

public Dialog(@Nullable javafx.stage.Window parent,
              @NonNull java.lang.String title)

Create a new dialog instance

Parameters:

parent - the owner, might be null

title - the title shown in the window trim

Method Detail

createContents

protected javafx.scene.Parent createContents()

Create the dialog content

Subclasses should normally override createDialogArea()

Returns:

the content

getContentInset

protected javafx.geometry.Insets getContentInset()

Returns:

insets of the content

createDialogArea

protected abstract javafx.scene.Node createDialogArea()

Returns:

the dialog area

createButtonBar

protected javafx.scene.Node createButtonBar()

Returns:

the button bar

createButtonsForBar

protected java.util.List<javafx.scene.control.Button> createButtonsForBar()

Create the buttons for the bar

Returns:

list of buttons to create

isOkDefault

protected boolean isOkDefault(int buttonId)

Check if the button ID is the default ok button

Parameters:

buttonId - the button id

Returns:

true if the button is the default ok button

See Also:

Button.defaultButtonProperty()

isCancelDefault

protected boolean isCancelDefault(int buttonId)

Check if the button ID is the default cancle button

Parameters:

buttonId - the button id

Returns:

true if the button is the default cancel button

createButtonForBar

protected javafx.scene.control.Button createButtonForBar(int type,
                                                         java.lang.String label,
                                                         boolean defaultOkButton,
                                                         boolean defaultCancel)

Create a button for the button bar

Parameters:

type - the button id

label - the label

defaultOkButton - true if it is the default button Button.defaultButtonProperty()

defaultCancel - true if it is the cancel button Button.cancelButtonProperty()

Returns:

the button

buttonPressed

protected void buttonPressed(int type)

Method called when button is pressed

Parameters:

type - the button id

okPressed

protected void okPressed()

Method called when the ok button is invoked

cancelPressed

protected void cancelPressed()

Method called when the cancle button is invoked

setReturnCode

protected void setReturnCode(int returnCode)

Setting the return code

Parameters:

returnCode - the new return code

close

protected void close()

Close the dialog

getStylesheets

protected java.util.List<java.lang.String> getStylesheets()

Returns:

the stylesheets to use

create

protected javafx.stage.Stage create()

Create the dialogs stage

Returns:

the stage

getInitialContentSize

protected javafx.geometry.Point2D getInitialContentSize(javafx.scene.Parent rootContainer)

Get the initial size of the content

Parameters:

rootContainer - the root container

Returns:

null if default is used

getInitialSize

protected javafx.geometry.Point2D getInitialSize(javafx.scene.Parent rootContainer)

Get the initial size of the dialog

Parameters:

rootContainer - the root container

Returns:

null if the default is used

getInitialLocation

protected javafx.geometry.Point2D getInitialLocation(javafx.scene.Parent rootContainer)

Get initial location of the dialog

Parameters:

rootContainer - the root container

Returns:

null if the default is used

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)

Set the bounds of the dialog

Has to be called after open(). For initial size and location use getInitialSize(Parent) getInitialLocation(Parent)

Parameters:

x - the x position

y - thy y position

width - the width

height - the height

getBounds

public @NonNull javafx.scene.shape.Rectangle getBounds()

The bounds of the dialog

Has to be called after open().

Returns:

the current bounds of the dialog window

pack

public void pack()

Pack the dialog to the content size

getModality

protected javafx.stage.Modality getModality()

Returns:

the modality (default Modality.WINDOW_MODAL)

open

public int open()

Open the dialog

Returns:

the return value

preopen

protected void preopen(javafx.stage.Stage s)

Called before dialog is opened

Parameters:

s - the stage