FXDialog class. The available dialogs in this class
are useful for displaying small information graphic dialogs
rather than complex windows. For more complex dialogs it is
advised to rather create a new sub class of FXDialog.
| Modifier and Type | Field and Description |
|---|---|
| public static final int | |
| private static final Logger | |
| private final Window | |
| private static final Duration |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| private <T> ChoiceDialog | createChoiceDialog(String title, String content, String okButtonLabel, T defaultChoice, Collection<T> choices)
|
| private FXDialog | |
| private FXDialog | |
| private <V> org. | |
| private DirectoryChooser | |
| private FileChooser | |
| public void | notify(String
the message to show. message)Implements org. Notify the user in a non-blocking way (i.e., in form of toast in a snackbar). |
| public static String | |
| public <V> Optional | showBackgroundProgressDialogAndWait(String
title of the dialog title, String message to show below the list of background tasks content, StateManager The stateManager)StateManager which contains the background tasksImplements org. Constructs and shows a dialog showing the progress of running background tasks. |
| public <T> Optional | showChoiceDialogAndWait(String title, String content, String okButtonLabel, T defaultChoice, Collection<T> choices)
Implements org. This will create and display new |
| public boolean | showConfirmationDialogAndWait(String title, String content)
Implements org. This will create and display a new confirmation dialog. |
| public boolean | showConfirmationDialogAndWait(String title, String content, String okButtonLabel)
Implements org. Create and display a new confirmation dialog. |
| public boolean | showConfirmationDialogAndWait(String title, String content, String okButtonLabel, String cancelButtonLabel)
Implements org. Create and display a new confirmation dialog. |
| public boolean | showConfirmationDialogWithOptOutAndWait(String title, String content, String optOutMessage, Consumer<Boolean> optOutAction)
Implements org. Create and display a new confirmation dialog. |
| public boolean | showConfirmationDialogWithOptOutAndWait(String title, String content, String okButtonLabel, String cancelButtonLabel, String optOutMessage, Consumer<Boolean> optOutAction)
Implements org. Create and display a new confirmation dialog. |
| public Optional | showCustomButtonDialogAndWait(Alert.
Implements org. This will create and display a new dialog of the specified
|
| public void | showCustomDialog(BaseDialog<?>
dialog to show aboutDialogView)Implements org. Shows a custom dialog without returning any results. |
| public Optional | showCustomDialogAndWait(String title, DialogPane contentPane, ButtonType... buttonTypes)
Implements org. This will create and display a new dialog showing a custom |
| public <R> Optional | showCustomDialogAndWait(Dialog<R>
dialog to show dialog)Implements org. Shows a custom dialog and returns the result. |
| public Optional | showDirectorySelectionDialog(DirectoryDialogConfiguration directoryDialogConfiguration)
Implements org. Shows a new directory selection dialog. |
| public <T> Optional | showEditableChoiceDialogAndWait(String title, String content, String okButtonLabel, T defaultChoice, Collection<T> choices, StringConverter<T> converter)
Implements org.
|
| public void | showErrorDialogAndWait(String title, String content)
Implements org. This will create and display a new error dialog. |
| public void | showErrorDialogAndWait(String
the error message message, Throwable the exception causing the error exception)Implements org. Create and display error dialog displaying the given exception. |
| public void | showErrorDialogAndWait(String title, String content, Throwable
the exception causing the error exception)Implements org. Create and display error dialog displaying the given exception. |
| public void | showErrorDialogAndWait(String
the error message message)Implements org. Create and display error dialog displaying the given message. |
| public Optional | showFileOpenDialog(FileDialogConfiguration fileDialogConfiguration)
Implements org. Shows a new file open dialog. |
| public List | showFileOpenDialogAndGetMultipleFiles(FileDialogConfiguration fileDialogConfiguration)
Implements org. Shows a new file open dialog. |
| public Optional | showFileOpenFromArchiveDialog(Path archivePath)
Implements org. Shows a new dialog that list all files contained in the given archive and which lets the user select one of these files. |
| public Optional | showFileSaveDialog(FileDialogConfiguration fileDialogConfiguration)
Implements org. Shows a new file save dialog. |
| public void | showInformationDialogAndWait(String title, String content)
Implements org. This will create and display a new information dialog. |
| public Optional | showInputDialogAndWait(String title, String content)
Implements org. This will create and display new |
| public Optional | showInputDialogWithDefaultAndWait(String title, String content, String defaultValue)
Implements org. This will create and display new |
| public Optional | showPasswordDialogAndWait(String title, String header, String content)
Implements org. This will create and display new |
| public boolean | showPrintDialog(PrinterJob
the print job to customize job)Implements org. Displays a Print Dialog. |
| public <V> void | showProgressDialog(String
title of the dialog title, String message to show above the progress bar content, Task<V> The task)Task which executes the work and for which to show the dialogImplements org. Constructs and shows a cancelable |
| public <V> void | showProgressDialogAndWait(String
title of the dialog title, String message to show above the progress bar content, Task<V> The task)Task which executes the work and for which to show the dialogImplements org. Constructs and shows a cancelable |
| public void | showWarningDialogAndWait(String title, String content)
Implements org. This will create and display a new information dialog. |
| DIALOG_SIZE_LIMIT | back to summary |
|---|---|
| public static final int DIALOG_SIZE_LIMIT | |
| LOGGER | back to summary |
|---|---|
| private static final Logger LOGGER | |
| mainWindow | back to summary |
|---|---|
| private final Window mainWindow | |
| TOAST_MESSAGE_DISPLAY_TIME | back to summary |
|---|---|
| private static final Duration TOAST_MESSAGE_DISPLAY_TIME | |
| JabRefDialogService | back to summary |
|---|---|
| public JabRefDialogService(Window mainWindow) | |
| createChoiceDialog | back to summary |
|---|---|
| private <T> ChoiceDialog | |
| createDialog | back to summary |
|---|---|
| private FXDialog createDialog(Alert. | |
| createDialogWithOptOut | back to summary |
|---|---|
| private FXDialog createDialogWithOptOut(Alert. | |
| createProgressDialog | back to summary |
|---|---|
| private <V> org. | |
| getConfiguredDirectoryChooser | back to summary |
|---|---|
| private DirectoryChooser getConfiguredDirectoryChooser(DirectoryDialogConfiguration directoryDialogConfiguration) | |
| getConfiguredFileChooser | back to summary |
|---|---|
| private FileChooser getConfiguredFileChooser(FileDialogConfiguration fileDialogConfiguration) | |
| notify | back to summary |
|---|---|
| public void notify(String message) Implements org. Doc from org. Notify the user in a non-blocking way (i.e., in form of toast in a snackbar). | |
| shortenDialogMessage | back to summary |
|---|---|
| public static String shortenDialogMessage(String dialogMessage) | |
| showBackgroundProgressDialogAndWait | back to summary |
|---|---|
| public <V> Optional Implements org. Doc from org. Constructs and shows a dialog showing the progress of running background tasks. Clicking cancel will cancel the underlying service and close the dialog. The dialog will exit as soon as none of the background tasks are running
| |
| showChoiceDialogAndWait | back to summary |
|---|---|
| public <T> Optional Implements org. Doc from org. This will create and display new
| |
| showConfirmationDialogAndWait | back to summary |
|---|---|
| public boolean showConfirmationDialogAndWait(String title, String content) Implements org. Doc from org. This will create and display a new confirmation dialog.
It will include a blue question icon on the left and
a OK and Cancel button. To create a confirmation dialog with custom
buttons see also
| |
| showConfirmationDialogAndWait | back to summary |
|---|---|
| public boolean showConfirmationDialogAndWait(String title, String content, String okButtonLabel) Implements org. Doc from org. Create and display a new confirmation dialog.
It will include a blue question icon on the left and
a OK (with given label) and Cancel button. To create a confirmation dialog with custom
buttons see also
| |
| showConfirmationDialogAndWait | back to summary |
|---|---|
| public boolean showConfirmationDialogAndWait(String title, String content, String okButtonLabel, String cancelButtonLabel) Implements org. Doc from org. Create and display a new confirmation dialog.
It will include a blue question icon on the left and
a OK (with given label) and Cancel (also with given label) button. To create a confirmation dialog with custom
buttons see also
| |
| showConfirmationDialogWithOptOutAndWait | back to summary |
|---|---|
| public boolean showConfirmationDialogWithOptOutAndWait(String title, String content, String optOutMessage, Consumer<Boolean> optOutAction) Implements org. Doc from org. Create and display a new confirmation dialog.
It will include a blue question icon on the left and
a YES (with given label) and Cancel (also with given label) button. To create a confirmation dialog with custom
buttons see also
| |
| showConfirmationDialogWithOptOutAndWait | back to summary |
|---|---|
| public boolean showConfirmationDialogWithOptOutAndWait(String title, String content, String okButtonLabel, String cancelButtonLabel, String optOutMessage, Consumer<Boolean> optOutAction) Implements org. Doc from org. Create and display a new confirmation dialog.
It will include a blue question icon on the left and
a YES (with given label) and Cancel (also with given label) button. To create a confirmation dialog with custom
buttons see also
| |
| showCustomButtonDialogAndWait | back to summary |
|---|---|
| public Optional Implements org. Doc from org. This will create and display a new dialog of the specified
| |
| showCustomDialog | back to summary |
|---|---|
| public void showCustomDialog(BaseDialog<?> aboutDialogView) Implements org. Doc from org. Shows a custom dialog without returning any results.
| |
| showCustomDialogAndWait | back to summary |
|---|---|
| public Optional Implements org. Doc from org. This will create and display a new dialog showing a custom
| |
| showCustomDialogAndWait | back to summary |
|---|---|
| public <R> Optional Implements org. Doc from org. Shows a custom dialog and returns the result. | |
| showDirectorySelectionDialog | back to summary |
|---|---|
| public Optional Implements org. Doc from org. Shows a new directory selection dialog. The method doesn't return until the
displayed open dialog is dismissed. The return value specifies
the file chosen by the user or an empty | |
| showEditableChoiceDialogAndWait | back to summary |
|---|---|
| public <T> Optional Implements org.
| |
| showErrorDialogAndWait | back to summary |
|---|---|
| public void showErrorDialogAndWait(String title, String content) Implements org. Doc from org. This will create and display a new error dialog.
It will include a red error icon on the left and
a single OK Button. To create a error dialog with custom
buttons see also
| |
| showErrorDialogAndWait | back to summary |
|---|---|
| public void showErrorDialogAndWait(String message, Throwable exception) Implements org. Doc from org. Create and display error dialog displaying the given exception. | |
| showErrorDialogAndWait | back to summary |
|---|---|
| public void showErrorDialogAndWait(String title, String content, Throwable exception) Implements org. Doc from org. Create and display error dialog displaying the given exception. | |
| showErrorDialogAndWait | back to summary |
|---|---|
| public void showErrorDialogAndWait(String message) Implements org. Doc from org. Create and display error dialog displaying the given message. | |
| showFileOpenDialog | back to summary |
|---|---|
| public Optional Implements org. Doc from org. Shows a new file open dialog. The method doesn't return until the
displayed open dialog is dismissed. The return value specifies
the file chosen by the user or an empty | |
| showFileOpenDialogAndGetMultipleFiles | back to summary |
|---|---|
| public List Implements org. Doc from org. Shows a new file open dialog. The method doesn't return until the
displayed open dialog is dismissed. The return value specifies
the files chosen by the user or an empty | |
| showFileOpenFromArchiveDialog | back to summary |
|---|---|
| public Optional Implements org. Doc from org. Shows a new dialog that list all files contained in the given archive and which lets the user select one of these
files. The method doesn't return until the displayed open dialog is dismissed. The return value specifies the
file chosen by the user or an empty | |
| showFileSaveDialog | back to summary |
|---|---|
| public Optional Implements org. Doc from org. Shows a new file save dialog. The method doesn't return until the
displayed file save dialog is dismissed. The return value specifies the
file chosen by the user or an empty | |
| showInformationDialogAndWait | back to summary |
|---|---|
| public void showInformationDialogAndWait(String title, String content) Implements org. Doc from org. This will create and display a new information dialog.
It will include a blue information icon on the left and
a single OK Button. To create an information dialog with custom
buttons see also
| |
| showInputDialogAndWait | back to summary |
|---|---|
| public Optional Implements org. Doc from org. This will create and display new
| |
| showInputDialogWithDefaultAndWait | back to summary |
|---|---|
| public Optional Implements org. Doc from org. This will create and display new
| |
| showPasswordDialogAndWait | back to summary |
|---|---|
| public Optional Implements org. Doc from org. This will create and display new | |
| showPrintDialog | back to summary |
|---|---|
| public boolean showPrintDialog(PrinterJob job) Implements org. Doc from org. Displays a Print Dialog. Allow the user to update job state such as printer and settings. These changes will be available in the appropriate properties after the print dialog has returned. The print dialog is also used to confirm the user wants to proceed with printing.
| |
| showProgressDialog | back to summary |
|---|---|
| public <V> void showProgressDialog(String title, String content, Task<V> task) Implements org. Doc from org. Constructs and shows a cancelable | |
| showProgressDialogAndWait | back to summary |
|---|---|
| public <V> void showProgressDialogAndWait(String title, String content, Task<V> task) Implements org. Doc from org. Constructs and shows a cancelable | |
| showWarningDialogAndWait | back to summary |
|---|---|
| public void showWarningDialogAndWait(String title, String content) Implements org. Doc from org. This will create and display a new information dialog.
It will include a yellow warning icon on the left and
a single OK Button. To create a warning dialog with custom
buttons see also
| |