From ee989b8997d5ab9ebd6a7e64f527d511e6331b2d Mon Sep 17 00:00:00 2001
From: Marvin Elsen <git@marvinelsen.com>
Date: Thu, 3 Oct 2024 21:33:07 +0200
Subject: [PATCH] Split preferences dialog into Dialog and Controller

---
 .../willow/ui/controllers/MenuController.kt   |  10 +-
 .../dialogs/PreferencesDialogController.kt    | 108 ++++++++++++++
 .../willow/ui/dialogs/PreferencesDialog.kt    | 135 ++++--------------
 .../resources/fxml/dialogs/preferences.fxml   |   5 +-
 4 files changed, 142 insertions(+), 116 deletions(-)
 create mode 100644 src/main/kotlin/com/marvinelsen/willow/ui/controllers/dialogs/PreferencesDialogController.kt

diff --git a/src/main/kotlin/com/marvinelsen/willow/ui/controllers/MenuController.kt b/src/main/kotlin/com/marvinelsen/willow/ui/controllers/MenuController.kt
index 10851e3..9157b11 100644
--- a/src/main/kotlin/com/marvinelsen/willow/ui/controllers/MenuController.kt
+++ b/src/main/kotlin/com/marvinelsen/willow/ui/controllers/MenuController.kt
@@ -8,9 +8,13 @@ import javafx.beans.binding.Bindings
 import javafx.fxml.FXML
 import javafx.scene.control.MenuBar
 import javafx.scene.control.MenuItem
+import java.util.ResourceBundle
 
 @Suppress("UnusedPrivateMember")
 class MenuController(private val model: Model, private val config: Config) {
+    @FXML
+    private lateinit var resources: ResourceBundle
+
     @FXML
     private lateinit var menuBar: MenuBar
 
@@ -28,10 +32,10 @@ class MenuController(private val model: Model, private val config: Config) {
 
     @FXML
     private fun onMenuItemPreferencesAction() {
-        PreferencesDialog(menuBar.scene.window, config).showAndWait().ifPresent { result ->
+        PreferencesDialog(menuBar.scene.window, config, resources).showAndWait().ifPresent { result ->
             when (result) {
-                PreferencesDialog.Result.CHANGES -> config.save()
-                PreferencesDialog.Result.NO_CHANGES -> config.load()
+                PreferencesDialog.Result.SAVE_CHANGES -> config.save()
+                PreferencesDialog.Result.DO_NOT_SAVE_CHANGES -> config.load()
             }
         }
     }
diff --git a/src/main/kotlin/com/marvinelsen/willow/ui/controllers/dialogs/PreferencesDialogController.kt b/src/main/kotlin/com/marvinelsen/willow/ui/controllers/dialogs/PreferencesDialogController.kt
new file mode 100644
index 0000000..08f70df
--- /dev/null
+++ b/src/main/kotlin/com/marvinelsen/willow/ui/controllers/dialogs/PreferencesDialogController.kt
@@ -0,0 +1,108 @@
+package com.marvinelsen.willow.ui.controllers.dialogs
+
+import com.marvinelsen.willow.config.Config
+import com.marvinelsen.willow.config.Pronunciation
+import com.marvinelsen.willow.config.Script
+import com.marvinelsen.willow.config.Theme
+import com.marvinelsen.willow.ui.formatters.FontSizeTextFormatter
+import javafx.fxml.FXML
+import javafx.scene.control.CheckBox
+import javafx.scene.control.ComboBox
+import javafx.scene.control.Spinner
+import java.util.Locale
+
+@Suppress("UnusedPrivateMember")
+class PreferencesDialogController(private val config: Config) {
+    @FXML
+    private lateinit var comboBoxLocale: ComboBox<Locale>
+
+    @FXML
+    private lateinit var comboBoxTheme: ComboBox<Theme>
+
+    @FXML
+    private lateinit var comboBoxScript: ComboBox<Script>
+
+    @FXML
+    private lateinit var comboBoxPronunciationSearchResults: ComboBox<Pronunciation>
+
+    @FXML
+    private lateinit var comboBoxPronunciationDetails: ComboBox<Pronunciation>
+
+    @FXML
+    private lateinit var checkBoxShowPronunciationSearchResults: CheckBox
+
+    @FXML
+    private lateinit var checkBoxShowDefinitionSearchResults: CheckBox
+
+    @FXML
+    private lateinit var spinnerHeadwordFontSizeDetails: Spinner<Int>
+
+    @FXML
+    private lateinit var spinnerPronunciationFontSizeDetails: Spinner<Int>
+
+    @FXML
+    private lateinit var spinnerHeadwordFontSizeSearchResults: Spinner<Int>
+
+    @FXML
+    private lateinit var spinnerPronunciationFontSizeSearchResults: Spinner<Int>
+
+    @FXML
+    private lateinit var spinnerDefinitionFontSizeSearchResults: Spinner<Int>
+
+    private val entryHeadwordFontSizeObjectProperty = config.details.headwordFontSize.asObject()
+    private val entryPronunciationFontSizeObjectProperty = config.details.pronunciationFontSize.asObject()
+
+    private val searchResultHeadwordFontSizeObjectProperty = config.searchResults.headwordFontSize.asObject()
+    private val searchResultPronunciationFontSizeObjectProperty = config.searchResults.pronunciationFontSize.asObject()
+    private val searchResultDefinitionFontSizeObjectProperty = config.searchResults.definitionFontSize.asObject()
+
+    @FXML
+    private fun initialize() {
+        comboBoxLocale.items.addAll(
+            setOf(
+                Locale.ENGLISH,
+                Locale.GERMAN,
+                Locale.CHINA,
+                Locale.TAIWAN
+            )
+        )
+
+        comboBoxTheme.valueProperty().bindBidirectional(config.theme)
+        comboBoxScript.valueProperty().bindBidirectional(config.script)
+        comboBoxLocale.valueProperty().bindBidirectional(config.locale)
+        comboBoxPronunciationSearchResults.valueProperty().bindBidirectional(config.searchResults.pronunciation)
+        comboBoxPronunciationDetails.valueProperty().bindBidirectional(config.details.pronunciation)
+
+        checkBoxShowDefinitionSearchResults
+            .selectedProperty()
+            .bindBidirectional(config.searchResults.shouldShowDefinition)
+        checkBoxShowPronunciationSearchResults
+            .selectedProperty()
+            .bindBidirectional(config.searchResults.shouldShowPronunciation)
+
+        with(spinnerHeadwordFontSizeDetails) {
+            editor.textFormatter = FontSizeTextFormatter()
+            valueFactory.valueProperty().bindBidirectional(entryHeadwordFontSizeObjectProperty)
+        }
+
+        with(spinnerPronunciationFontSizeDetails) {
+            editor.textFormatter = FontSizeTextFormatter()
+            valueFactory.valueProperty().bindBidirectional(entryPronunciationFontSizeObjectProperty)
+        }
+
+        with(spinnerHeadwordFontSizeSearchResults) {
+            editor.textFormatter = FontSizeTextFormatter()
+            valueFactory.valueProperty().bindBidirectional(searchResultHeadwordFontSizeObjectProperty)
+        }
+
+        with(spinnerPronunciationFontSizeSearchResults) {
+            editor.textFormatter = FontSizeTextFormatter()
+            valueFactory.valueProperty().bindBidirectional(searchResultPronunciationFontSizeObjectProperty)
+        }
+
+        with(spinnerDefinitionFontSizeSearchResults) {
+            editor.textFormatter = FontSizeTextFormatter()
+            valueFactory.valueProperty().bindBidirectional(searchResultDefinitionFontSizeObjectProperty)
+        }
+    }
+}
diff --git a/src/main/kotlin/com/marvinelsen/willow/ui/dialogs/PreferencesDialog.kt b/src/main/kotlin/com/marvinelsen/willow/ui/dialogs/PreferencesDialog.kt
index 770f0ae..3cf1860 100644
--- a/src/main/kotlin/com/marvinelsen/willow/ui/dialogs/PreferencesDialog.kt
+++ b/src/main/kotlin/com/marvinelsen/willow/ui/dialogs/PreferencesDialog.kt
@@ -1,82 +1,42 @@
 package com.marvinelsen.willow.ui.dialogs
 
-import com.marvinelsen.willow.WillowApplication
 import com.marvinelsen.willow.config.Config
-import com.marvinelsen.willow.config.Pronunciation
-import com.marvinelsen.willow.config.Script
-import com.marvinelsen.willow.config.Theme
-import com.marvinelsen.willow.ui.formatters.FontSizeTextFormatter
-import javafx.fxml.FXML
+import com.marvinelsen.willow.ui.controllers.dialogs.PreferencesDialogController
 import javafx.fxml.FXMLLoader
 import javafx.scene.control.ButtonType
-import javafx.scene.control.CheckBox
-import javafx.scene.control.ComboBox
 import javafx.scene.control.Dialog
 import javafx.scene.control.DialogPane
-import javafx.scene.control.Spinner
 import javafx.stage.Modality
 import javafx.stage.Stage
 import javafx.stage.Window
 import javafx.util.Callback
-import java.util.Locale
+import java.util.ResourceBundle
 
-class PreferencesDialog(owner: Window?, config: Config) : Dialog<PreferencesDialog.Result>() {
+class PreferencesDialog(
+    owner: Window?,
+    config: Config,
+    resources: ResourceBundle,
+) : Dialog<PreferencesDialog.Result>() {
     companion object {
-        private const val DIALOG_MIN_HEIGHT = 400.0
-        private const val DIALOG_MIN_WIDTH = 400.0
+        private const val MIN_HEIGHT = 400.0
+        private const val MIN_WIDTH = 400.0
     }
 
     enum class Result {
-        CHANGES, NO_CHANGES
+        SAVE_CHANGES, DO_NOT_SAVE_CHANGES
     }
 
-    @FXML
-    private lateinit var comboBoxLocale: ComboBox<Locale>
-
-    @FXML
-    private lateinit var comboBoxTheme: ComboBox<Theme>
-
-    @FXML
-    private lateinit var comboBoxScript: ComboBox<Script>
-
-    @FXML
-    private lateinit var comboBoxPronunciationSearchResults: ComboBox<Pronunciation>
-
-    @FXML
-    private lateinit var comboBoxPronunciationDetails: ComboBox<Pronunciation>
-
-    @FXML
-    private lateinit var checkBoxShowPronunciationSearchResults: CheckBox
-
-    @FXML
-    private lateinit var checkBoxShowDefinitionSearchResults: CheckBox
-
-    @FXML
-    private lateinit var spinnerHeadwordFontSizeDetails: Spinner<Int>
-
-    @FXML
-    private lateinit var spinnerPronunciationFontSizeDetails: Spinner<Int>
-
-    @FXML
-    private lateinit var spinnerHeadwordFontSizeSearchResults: Spinner<Int>
-
-    @FXML
-    private lateinit var spinnerPronunciationFontSizeSearchResults: Spinner<Int>
-
-    @FXML
-    private lateinit var spinnerDefinitionFontSizeSearchResults: Spinner<Int>
-
-    private val entryHeadwordFontSizeObjectProperty = config.details.headwordFontSize.asObject()
-    private val entryPronunciationFontSizeObjectProperty = config.details.pronunciationFontSize.asObject()
-
-    private val searchResultHeadwordFontSizeObjectProperty = config.searchResults.headwordFontSize.asObject()
-    private val searchResultPronunciationFontSizeObjectProperty = config.searchResults.pronunciationFontSize.asObject()
-    private val searchResultDefinitionFontSizeObjectProperty = config.searchResults.definitionFontSize.asObject()
-
     init {
-        val loader = FXMLLoader(WillowApplication::class.java.getResource("/fxml/dialogs/preferences.fxml"))
-        loader.setController(this)
-        val root: DialogPane = loader.load()
+        val fxmlLoader = FXMLLoader()
+        fxmlLoader.resources = resources
+        fxmlLoader.controllerFactory = Callback { type ->
+            when (type) {
+                PreferencesDialogController::class.java -> PreferencesDialogController(config)
+                else -> error("Trying to instantiate unknown controller type $type")
+            }
+        }
+
+        val root = fxmlLoader.load(javaClass.getResourceAsStream("/fxml/dialogs/preferences.fxml")) as DialogPane
 
         dialogPane = root
         title = "Settings"
@@ -86,55 +46,8 @@ class PreferencesDialog(owner: Window?, config: Config) : Dialog<PreferencesDial
         initModality(Modality.APPLICATION_MODAL)
 
         (dialogPane.scene.window as Stage).apply {
-            minWidth = DIALOG_MIN_WIDTH
-            minHeight = DIALOG_MIN_HEIGHT
-        }
-
-        comboBoxLocale.items.addAll(
-            setOf(
-                Locale.ENGLISH,
-                Locale.GERMAN,
-                Locale.CHINA,
-                Locale.TAIWAN
-            )
-        )
-
-        comboBoxTheme.valueProperty().bindBidirectional(config.theme)
-        comboBoxScript.valueProperty().bindBidirectional(config.script)
-        comboBoxLocale.valueProperty().bindBidirectional(config.locale)
-        comboBoxPronunciationSearchResults.valueProperty().bindBidirectional(config.searchResults.pronunciation)
-        comboBoxPronunciationDetails.valueProperty().bindBidirectional(config.details.pronunciation)
-
-        checkBoxShowDefinitionSearchResults
-            .selectedProperty()
-            .bindBidirectional(config.searchResults.shouldShowDefinition)
-        checkBoxShowPronunciationSearchResults
-            .selectedProperty()
-            .bindBidirectional(config.searchResults.shouldShowPronunciation)
-
-        with(spinnerHeadwordFontSizeDetails) {
-            editor.textFormatter = FontSizeTextFormatter()
-            valueFactory.valueProperty().bindBidirectional(entryHeadwordFontSizeObjectProperty)
-        }
-
-        with(spinnerPronunciationFontSizeDetails) {
-            editor.textFormatter = FontSizeTextFormatter()
-            valueFactory.valueProperty().bindBidirectional(entryPronunciationFontSizeObjectProperty)
-        }
-
-        with(spinnerHeadwordFontSizeSearchResults) {
-            editor.textFormatter = FontSizeTextFormatter()
-            valueFactory.valueProperty().bindBidirectional(searchResultHeadwordFontSizeObjectProperty)
-        }
-
-        with(spinnerPronunciationFontSizeSearchResults) {
-            editor.textFormatter = FontSizeTextFormatter()
-            valueFactory.valueProperty().bindBidirectional(searchResultPronunciationFontSizeObjectProperty)
-        }
-
-        with(spinnerDefinitionFontSizeSearchResults) {
-            editor.textFormatter = FontSizeTextFormatter()
-            valueFactory.valueProperty().bindBidirectional(searchResultDefinitionFontSizeObjectProperty)
+            minWidth = MIN_WIDTH
+            minHeight = MIN_HEIGHT
         }
 
         resultConverter = Callback(::convertToResult)
@@ -142,7 +55,7 @@ class PreferencesDialog(owner: Window?, config: Config) : Dialog<PreferencesDial
 
     private fun convertToResult(buttonType: ButtonType) =
         when (buttonType) {
-            ButtonType.APPLY -> Result.CHANGES
-            else -> Result.NO_CHANGES
+            ButtonType.APPLY -> Result.SAVE_CHANGES
+            else -> Result.DO_NOT_SAVE_CHANGES
         }
 }
diff --git a/src/main/resources/fxml/dialogs/preferences.fxml b/src/main/resources/fxml/dialogs/preferences.fxml
index cc3b12f..2d81950 100644
--- a/src/main/resources/fxml/dialogs/preferences.fxml
+++ b/src/main/resources/fxml/dialogs/preferences.fxml
@@ -7,7 +7,8 @@
 <?import javafx.scene.control.*?>
 <?import javafx.scene.layout.*?>
 <DialogPane styleClass="preferences-dialog" xmlns="http://javafx.com/javafx/23" xmlns:fx="http://javafx.com/fxml/1"
-            stylesheets="/css/preferences.css">
+            stylesheets="/css/preferences.css"
+            fx:controller="com.marvinelsen.willow.ui.controllers.dialogs.PreferencesDialogController">
     <fx:define>
         <FXCollections fx:factory="observableArrayList" fx:id="phoneticAlphabets">
             <Pronunciation fx:value="PINYIN_WITH_TONE_MARKS"/>
@@ -169,6 +170,6 @@
             </Tab>
         </TabPane>
     </content>
-    <ButtonType fx:id="buttonTypeApply" fx:constant="APPLY"/>
+    <ButtonType fx:constant="APPLY"/>
     <ButtonType fx:constant="CANCEL"/>
 </DialogPane>