com.almasb.fxgl.service

Interface Display

All Superinterfaces:

UserProfileSavable

public interface Display
extends UserProfileSavable

Display service. Provides access to dialogs and display settings.

Author:

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

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyObjectProperty<FXGLScene>	currentScene

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ReadOnlyObjectProperty<FXGLScene>	currentSceneProperty()
javafx.geometry.Rectangle2D	getBounds() Returns available (visual) bounds of the physical display.
default FXGLScene	getCurrentScene()
double	getScaleRatio()
List<SceneDimension>	getSceneDimensions()
void	registerScene(FXGLScene scene) Register an FXGL scene to be managed by display settings.
boolean	saveScreenshot() Saves a screenshot of the current scene into a ".png" file.
void	setScene(FXGLScene scene) Set current FXGL scene.
void	setSceneDimension(SceneDimension dimension) Set new scene dimension.
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.
<T> void	showDialog(javafx.scene.control.Dialog<T> dialog, Consumer<T> resultCallback) Shows given dialog and blocks execution of the game until the dialog is dismissed.
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.
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.
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.

Methods inherited from interface com.almasb.fxgl.service.listener.UserProfileSavable

load, save

Property Detail

currentScene

javafx.beans.property.ReadOnlyObjectProperty<FXGLScene> currentSceneProperty

See Also:

getCurrentScene()

Method Detail

registerScene

void registerScene(FXGLScene scene)

Register an FXGL scene to be managed by display settings.

Parameters:

scene - the scene

setScene

void setScene(FXGLScene scene)

Set current FXGL scene. The scene will be immediately displayed.

Parameters:

scene - the scene

currentSceneProperty

javafx.beans.property.ReadOnlyObjectProperty<FXGLScene> currentSceneProperty()

See Also:

getCurrentScene()

getCurrentScene

default FXGLScene getCurrentScene()

Returns:

current FXGL scene

getBounds

javafx.geometry.Rectangle2D getBounds()

Returns available (visual) bounds of the physical display. If the game is running fullscreen then this returns maximum bounds of the physical display.

Returns:

display bounds

saveScreenshot

boolean saveScreenshot()

Saves a screenshot of the current scene into a ".png" file.

Returns:

true if the screenshot was saved successfully, false otherwise

getSceneDimensions

List<SceneDimension> getSceneDimensions()

Returns:

a list of supported scene dimensions with 360, 480, 720 and 1080 heights

setSceneDimension

void setSceneDimension(SceneDimension dimension)

Set new scene dimension. This will change the video output resolution and adapt all subsystems.

Parameters:

dimension - scene dimension

getScaleRatio

double getScaleRatio()

Returns:

scale ratio of the current size vs target size

showDialog

<T> void showDialog(javafx.scene.control.Dialog<T> dialog,
                    Consumer<T> resultCallback)

Shows given dialog and blocks execution of the game until the dialog is dismissed. The provided callback will be called with the dialog result as parameter when the dialog closes.

Parameters:

dialog - JavaFX dialog

resultCallback - the function to be called

showMessageBox

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

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