org.eclipse.fx.ui.dialogs

Class TitleAreaDialog

java.lang.Object

org.eclipse.fx.ui.dialogs.Dialog

org.eclipse.fx.ui.dialogs.TitleAreaDialog

Direct Known Subclasses:

MessageTitleDialog

public abstract class TitleAreaDialog
extends Dialog

A dialog with a title are to display text and an image. You can use the following css-class selectors:

• titleDialog_TitleArea
• titleDialog_MessageArea
• titleDialog_Title
• titleDialog_Message
• titleDialog_Icon-$iconClass (if you pass a icon-css-class in the constructor)
• titleDialog_ContentArea

Field Summary

Fields inherited from class org.eclipse.fx.ui.dialogs.Dialog

CANCEL_BUTTON, OK_BUTTON

Constructor Summary

Constructors

Constructor and Description
TitleAreaDialog(javafx.stage.Window parent, java.lang.String windowTitle, java.lang.String title, java.lang.String message, java.lang.String iconClass) Create a new dialog
TitleAreaDialog(javafx.stage.Window parent, java.lang.String windowTitle, java.lang.String title, java.lang.String message, java.net.URL imageURI) Create a new dialog

Method Summary

Modifier and Type	Method and Description
protected javafx.scene.Node	createDialogArea()
protected abstract javafx.scene.Node	createDialogContent()
protected javafx.geometry.Insets	getContentInset()
protected java.util.List<java.lang.String>	getStylesheets()
Subscription	showTemporaryErrorMessage(java.lang.String temporaryMessage) Show a temporary error message if another temporary message is already showing then the original one will be removed before
Subscription	showTemporaryInfoMessage(java.lang.String temporaryMessage) Show a temporary info message if another temporary message is already showing then the original one will be removed before
Subscription	showTemporaryMessage(java.lang.String temporaryMessage, java.lang.String... messageStyles) Show a temporary message if another temporary message is already showing then the original one will be removed before
Subscription	showTemporaryWarningMessage(java.lang.String temporaryMessage) Show a temporary warning message if another temporary message is already showing then the original one will be removed before

Methods inherited from class org.eclipse.fx.ui.dialogs.Dialog

buttonPressed, cancelPressed, close, create, createButtonBar, createButtonForBar, createButtonsForBar, createContents, getBounds, getCustomWindowPane, getInitialContentSize, getInitialLocation, getInitialSize, getModality, isCancelDefault, isOkDefault, okPressed, open, pack, preopen, setBounds, setReturnCode

Methods inherited from class java.lang.Object

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

Constructor Detail

TitleAreaDialog

public TitleAreaDialog(javafx.stage.Window parent,
                       java.lang.String windowTitle,
                       java.lang.String title,
                       java.lang.String message,
                       java.net.URL imageURI)

Create a new dialog

Parameters:

parent - the parent

windowTitle - the window title

title - the header title text

message - the header message

imageURI - the uri of the image to display

TitleAreaDialog

public TitleAreaDialog(javafx.stage.Window parent,
                       java.lang.String windowTitle,
                       java.lang.String title,
                       java.lang.String message,
                       java.lang.String iconClass)

Create a new dialog

Parameters:

parent - the parent

windowTitle - the window title

title - the header title text

message - the header message

iconClass - the css class to use for the icon

Method Detail

getStylesheets

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

Overrides:

getStylesheets in class Dialog

Returns:

the stylesheets to use

createDialogArea

protected final javafx.scene.Node createDialogArea()

Specified by:

createDialogArea in class Dialog

Returns:

the dialog area

getContentInset

protected javafx.geometry.Insets getContentInset()

Overrides:

getContentInset in class Dialog

Returns:

insets of the content

createDialogContent

protected abstract javafx.scene.Node createDialogContent()

Returns:

create the content node

showTemporaryMessage

public Subscription showTemporaryMessage(java.lang.String temporaryMessage,
                                         java.lang.String... messageStyles)

Show a temporary message if another temporary message is already showing then the original one will be removed before

Parameters:

temporaryMessage - the message to display

messageStyles - the message styles to apply

Returns:

the subscription to remove the temporary message

Since:

2.4.0

showTemporaryWarningMessage

public Subscription showTemporaryWarningMessage(java.lang.String temporaryMessage)

Show a temporary warning message if another temporary message is already showing then the original one will be removed before

Parameters:

temporaryMessage - the temporary message

Returns:

the subscription to remove the temporary message

Since:

2.4.0

showTemporaryErrorMessage

public Subscription showTemporaryErrorMessage(java.lang.String temporaryMessage)

Show a temporary error message if another temporary message is already showing then the original one will be removed before

Parameters:

temporaryMessage - the temporary message

Returns:

the subscription to remove the temporary message

Since:

2.4.0

showTemporaryInfoMessage

public Subscription showTemporaryInfoMessage(java.lang.String temporaryMessage)

Show a temporary info message if another temporary message is already showing then the original one will be removed before

Parameters:

temporaryMessage - the temporary message

Returns:

the subscription to remove the temporary message

Since:

2.4.0