feat: added choice dialog box API for List and Enum options

Author: AlmasB

fxgl-samples/src/main/java/intermediate/DialogsSample.java

@@ -15,6 +15,7 @@
 import javafx.scene.paint.Color;
 
 import java.util.LinkedHashMap;
+import java.util.List;
 import java.util.Map;
 
 import static com.almasb.fxgl.dsl.FXGL.*;
@@ -26,6 +27,10 @@
  */
 public class DialogsSample extends GameApplication {
 
+    private enum CustomEnum {
+        VALUE1, VALUE2, VALUE3
+    }
+
     @Override
     protected void initSettings(GameSettings settings) { }
 
@@ -42,6 +47,10 @@ protected void initUI() {
         dialogs.put("Choice with 3", () -> getDialogService().showChoiceBox("Choose wisely!", answer -> System.out.println("Chosen: " + answer), "Hello", "World", "FXGL"));
         dialogs.put("Choice with 4", () -> getDialogService().showChoiceBox("Choose wisely!", answer -> System.out.println("Chosen: " + answer), "Hello", "World", "FXGL", "JavaFX"));
 
+        dialogs.put("Choice with List", () -> getDialogService().showChoiceBox("Choose wisely!", List.of("Item1", "Item2"), answer -> System.out.println("Chosen: " + answer)));
+
+        dialogs.put("Choice with Enum", () -> getDialogService().showChoiceBox("Choose wisely!", CustomEnum.class, answer -> System.out.println("Chosen: " + answer)));
+
         dialogs.put("Confirmation", () -> getDialogService().showConfirmationBox("This is a confirmation box. Agree?", answer -> System.out.println("You pressed yes? " + answer)));
 
         dialogs.put("Input", () -> getDialogService().showInputBox("This is an input box. You can type stuff...", answer -> System.out.println("You typed: "+ answer)));

fxgl-scene/src/main/java/com/almasb/fxgl/ui/DialogFactoryService.java

@@ -12,6 +12,7 @@
 import javafx.scene.control.Button;
 import javafx.scene.layout.Pane;
 
+import java.util.List;
 import java.util.function.Consumer;
 import java.util.function.Predicate;
 
@@ -28,6 +29,8 @@ public abstract class DialogFactoryService extends EngineService {
 
     public abstract <T> Pane choiceDialog(String message, Consumer<T> resultCallback, T firstOption, T... options);
 
+    public abstract <T> Pane choiceDialog(String message, List<T> options, Consumer<T> resultCallback);
+
     public abstract Pane inputDialog(String message, Consumer<String> callback);
 
     public abstract Pane inputDialog(String message, Predicate<String> filter, Consumer<String> callback);

fxgl-scene/src/main/java/com/almasb/fxgl/ui/DialogService.java

@@ -11,6 +11,7 @@
 import javafx.scene.Node;
 import javafx.scene.control.Button;
 
+import java.util.List;
 import java.util.function.Consumer;
 import java.util.function.Predicate;
 
@@ -59,6 +60,28 @@ public abstract class DialogService extends EngineService {
      */
     public abstract <T> void showChoiceBox(String message, Consumer<T> resultCallback, T firstOption, T... options);
 
+    /**
+     * Shows a blocking message box with given choices.
+     * The callback is invoked with the user answer as parameter.
+     *
+     * @param message message to show
+     * @param options the list of options
+     * @param resultCallback the function to be called
+     * @param <T> type of options
+     */
+    public abstract <T> void showChoiceBox(String message, List<T> options, Consumer<T> resultCallback);
+
+    /**
+     * Shows a blocking message box with given choices.
+     * The callback is invoked with the user answer as parameter.
+     *
+     * @param message message to show
+     * @param enumClass the Enum class
+     * @param resultCallback the function to be called
+     * @param <T> type of options
+     */
+    public abstract <T extends Enum<T>> void showChoiceBox(String message, Class<T> enumClass, Consumer<T> 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.

fxgl-scene/src/main/kotlin/com/almasb/fxgl/ui/FXGLDialogFactoryServiceProvider.kt

@@ -9,6 +9,7 @@ package com.almasb.fxgl.ui
 import com.almasb.fxgl.core.Inject
 import com.almasb.fxgl.core.util.EmptyRunnable
 import com.almasb.fxgl.localization.LocalizationService
+import com.almasb.fxgl.logging.Logger
 import javafx.beans.binding.StringBinding
 import javafx.beans.property.ReadOnlyDoubleProperty
 import javafx.beans.value.ChangeListener
@@ -95,16 +96,20 @@ class FXGLDialogFactoryServiceProvider : DialogFactoryService() {
     }
 
     override fun <T : Any> choiceDialog(message: String, resultCallback: Consumer<T>, firstOption: T, vararg options: T): Pane {
-        val text = createMessage(message)
-
         val choices = options.toMutableList()
         choices.add(0, firstOption)
 
+        return choiceDialog(message, choices, resultCallback)
+    }
+
+    override fun <T : Any> choiceDialog(message: String, options: List<T>, resultCallback: Consumer<T>): Pane {
+        val text = createMessage(message)
+
         val hbox = HBox()
 
-        if (choices.size > 3) {
+        if (options.size > 3) {
 
-            val choiceBox = uiFactory.newChoiceBox(FXCollections.observableArrayList(choices))
+            val choiceBox = uiFactory.newChoiceBox(FXCollections.observableArrayList(options))
             choiceBox.selectionModel.selectFirst()
 
             val btn = uiFactory.newButton("Select")
@@ -115,8 +120,15 @@ class FXGLDialogFactoryServiceProvider : DialogFactoryService() {
             hbox.children += choiceBox
             hbox.children += btn
 
+        } else if (options.size == 0) {
+            Logger.get<FXGLDialogFactoryServiceProvider>().warning("choiceDialog() called with an empty options list")
+
+            val btn = uiFactory.newButton("No options provided")
+
+            hbox.children += btn
+
         } else {
-            choices.forEach { option ->
+            options.forEach { option ->
                 val btn = uiFactory.newButton(option.toString())
                 btn.setOnAction {
                     resultCallback.accept(option)

fxgl/src/main/kotlin/com/almasb/fxgl/app/services/FXGLDialogService.kt

@@ -142,6 +142,19 @@ class FXGLDialogService : DialogService() {
         show("Choice", dialog)
     }
 
+    override fun <T : Any> showChoiceBox(message: String, options: List<T>, resultCallback: Consumer<T>) {
+        val dialog = dialogFactory.choiceDialog(message, options) { result ->
+            close()
+            resultCallback.accept(result)
+        }
+
+        show("Choice", dialog)
+    }
+
+    override fun <T : Enum<T>> showChoiceBox(message: String, enumClass: Class<T>, resultCallback: Consumer<T>) {
+        showChoiceBox(message, EnumSet.allOf(enumClass).toList(), resultCallback)
+    }
+
     override fun showInputBox(message: String, resultCallback: Consumer<String>) {
         showInputBox(message, Predicate { true }, resultCallback)
     }

fxgl/src/test/kotlin/com/almasb/fxgl/app/MockDialogService.kt

@@ -31,6 +31,12 @@ object MockDialogService : DialogService() {
     override fun <T : Any?> showChoiceBox(message: String?, resultCallback: Consumer<T>?, firstOption: T, vararg options: T) {
     }
 
+    override fun <T : Any?> showChoiceBox(message: String?, options: MutableList<T>?, resultCallback: Consumer<T>?) {
+    }
+
+    override fun <T : Enum<T>?> showChoiceBox(message: String?, enumClass: Class<T>?, resultCallback: Consumer<T>?) {
+    }
+
     override fun showInputBoxWithCancel(message: String?, filter: Predicate<String>?, resultCallback: Consumer<String>?) {
     }