com.almasb.fxgl.service

Interface Display

public interface Display

Display service. Provides access to dialogs.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Method Summary

Modifier and Type	Method and Description
void	showBox(String message, javafx.scene.Node content, javafx.scene.control.Button... buttons) Shows a blocking (stops game execution, method returns normally) generic dialog.
void	showConfirmationBox(String message, Consumer<Boolean> resultCallback) Shows a blocking message box with YES and NO buttons.
void	showErrorBox(String errorMessage, Runnable callback) Shows a blocking (stops game execution, method returns normally) dialog with the error.
void	showErrorBox(Throwable error) Shows a blocking (stops game execution, method returns normally) dialog with the error.
default void	showInputBox(String message, Consumer<String> resultCallback) Shows a blocking (stops game execution, method returns normally) message box with OK button and input field.
void	showInputBox(String message, Predicate<String> filter, Consumer<String> resultCallback) Shows a blocking (stops game execution, method returns normally) message box with OK button and input field.
void	showInputBoxWithCancel(String message, Predicate<String> filter, Consumer<String> resultCallback) Shows a blocking (stops game execution, method returns normally) message box with OK and CANCEL buttons and input field.
default void	showMessageBox(String message) Shows a blocking (stops game execution, method returns normally) message box with OK button.
void	showMessageBox(String message, Runnable callback) Shows a blocking (stops game execution, method returns normally) message box with OK button.
UIDialogHandler	showProgressBox(String message) Shows a blocking (stops game execution, method returns normally) progress dialog.

Method Detail

showMessageBox

default void showMessageBox(String message)

Shows a blocking (stops game execution, method returns normally) message box with OK button. On button press, the message box will be dismissed.

Parameters:

message - the message to show

showMessageBox

void showMessageBox(String message,
                    Runnable callback)

Shows a blocking (stops game execution, method returns normally) message box with OK button. On button press, the message box will be dismissed and the callback function called.

Parameters:

message - the message to show

callback - the function to be called when dialog is dismissed

showConfirmationBox

void showConfirmationBox(String message,
                         Consumer<Boolean> resultCallback)

Shows a blocking message box with YES and NO buttons. The callback is invoked with the user answer as parameter.

Parameters:

message - message to show

resultCallback - the function to be called

showInputBox

default void showInputBox(String message,
                          Consumer<String> resultCallback)

Shows a blocking (stops game execution, method returns normally) message box with OK button and input field. The callback is invoked with the field text as parameter.

Parameters:

message - message to show

resultCallback - the function to be called

showInputBox

void showInputBox(String message,
                  Predicate<String> filter,
                  Consumer<String> resultCallback)

Shows a blocking (stops game execution, method returns normally) message box with OK button and input field. The callback is invoked with the field text as parameter.

Parameters:

message - message to show

filter - filter to validate input

resultCallback - the function to be called

showInputBoxWithCancel

void showInputBoxWithCancel(String message,
                            Predicate<String> filter,
                            Consumer<String> resultCallback)

Shows a blocking (stops game execution, method returns normally) message box with OK and CANCEL buttons and input field. The callback is invoked with the field text as parameter, or with empty string if dialog was cancelled.

Parameters:

message - message to show

filter - the filter to validate input

resultCallback - result function to call back or empty string if use cancelled the dialog

showErrorBox

void showErrorBox(Throwable error)

Shows a blocking (stops game execution, method returns normally) dialog with the error.

Parameters:

error - the error to show

showErrorBox

void showErrorBox(String errorMessage,
                  Runnable callback)

Shows a blocking (stops game execution, method returns normally) dialog with the error.

Parameters:

errorMessage - error message to show

callback - the function to be called when dialog is dismissed

showBox

void showBox(String message,
             javafx.scene.Node content,
             javafx.scene.control.Button... buttons)

Shows a blocking (stops game execution, method returns normally) generic dialog.

Parameters:

message - the message

content - the content

buttons - buttons present

showProgressBox

UIDialogHandler showProgressBox(String message)

Shows a blocking (stops game execution, method returns normally) progress dialog. Can only be dismissed via the returned handler.

Parameters:

message - message to show

Returns:

dialog handler