Added application 5 - custom dialogs

Author: SergeMerzliakov

README.md

@@ -15,6 +15,7 @@ The list of demo apps includes:
   * **Application 2** -  Drag and Drop
   * **Application 3** -  Nested Controllers, Event Based using Google EventBus
   * **Application 4** -  TableView Cell Value Factories vs Cell Factories
+  * **Application 5** -  Custom Dialogs, an alternative to JavaFX official approach
 
 
 My blog on JavaFx with Kotlin at [https://thickclient.blog/](https://thickclient.blog/)
@@ -125,3 +126,11 @@ Start the application with:
 
     gradlew runApp4
 
+#### Application 5 - Custom Dialogs
+
+* Simple, alternative custom dialog framework (2 classes!!) for creating custom dialogs 
+* FXML based UI
+
+Start the application with:
+
+    gradlew runApp5

build.gradle

@@ -12,10 +12,11 @@ def JFX_INSTALL = '/Library/Java/javafx/13.0'
 // END YOUR SETUP
 
 group 'org.epistatic'
-version '1.1.0'
+version '2.2.0'
 
 repositories {
     mavenCentral()
+    jcenter()
     flatDir {
         dirs "${JFX_INSTALL}/lib"
     }
@@ -98,6 +99,19 @@ task runApp4(type: JavaExec) {
     }
 }
 
+task runApp5(type: JavaExec) {
+    group = "Application"
+    description = "Runs Application 5 - Custom Dialog Demo"
+    classpath sourceSets.main.runtimeClasspath
+    main = 'org.epistatic.app5.Main'
+    doFirst {
+        jvmArgs = [
+                '--module-path', "${JFX_INSTALL}/lib",
+                '--add-modules', 'javafx.fxml,javafx.controls'
+        ]
+    }
+}
+
 task collateInstall(type:Copy){
     delete "installBuild"
     mkdir "installBuild/lib"

src/main/kotlin/org/epistatic/app4/controller/ApplicationController.kt

@@ -1,20 +1,3 @@
-package org.epistatic.app4.controller
-
-import javafx.beans.property.ReadOnlyObjectWrapper
-import javafx.collections.FXCollections
-import javafx.collections.ObservableList
-import javafx.fxml.FXML
-import javafx.scene.control.Button
-import javafx.scene.control.TableCell
-import javafx.scene.control.TableColumn
-import javafx.scene.control.TableView
-import javafx.scene.control.cell.PropertyValueFactory
-import javafx.stage.Stage
-import org.epistatic.app4.model.DateItem
-import java.time.OffsetDateTime
-import java.time.ZoneOffset
-
-
 /**
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -34,8 +17,25 @@ import java.time.ZoneOffset
  * under the License.
  **/
 
+package org.epistatic.app4.controller
+
+import javafx.beans.property.ReadOnlyObjectWrapper
+import javafx.collections.FXCollections
+import javafx.collections.ObservableList
+import javafx.fxml.FXML
+import javafx.scene.control.Button
+import javafx.scene.control.TableCell
+import javafx.scene.control.TableColumn
+import javafx.scene.control.TableView
+import javafx.scene.control.cell.PropertyValueFactory
+import javafx.stage.Stage
+import org.epistatic.app4.model.DateItem
+import java.time.OffsetDateTime
+import java.time.ZoneOffset
+
+
 /**
- * Controller for app5/app4.fxml
+ * Controller for app4/app4.fxml
  */
 class ApplicationController {
 

src/main/kotlin/org/epistatic/app5/Main.kt

@@ -0,0 +1,54 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ **/
+
+package org.epistatic.app5
+
+import javafx.application.Application
+import javafx.fxml.FXMLLoader
+import javafx.scene.Scene
+import javafx.scene.layout.GridPane
+import javafx.scene.layout.Pane
+import javafx.stage.Stage
+
+/**
+ * An Application with multiple controllers and nested FXML
+ *
+ *   1) Assigning controllers to FXML at runtime
+ *   2) Multiple controllers communicating via Events (via Google EventBus)
+ *   3) Dragging Items from the Desktop
+ *   4) Controllers can leverage dependency injection, improving testing options
+ */
+class Main : Application() {
+
+   @Throws(Exception::class)
+   override fun start(primaryStage: Stage) {
+      val loader = FXMLLoader(javaClass.getResource("/app5/app5.fxml"))
+      val root = loader.load<Pane>()
+      primaryStage.title = "Custom Dialog Demo"
+      primaryStage.scene = Scene(root, 400.0, 150.0)
+      primaryStage.show()
+   }
+
+   companion object {
+      @JvmStatic
+      fun main(args: Array<String>) {
+         launch(Main::class.java, *args)
+      }
+   }
+}

src/main/kotlin/org/epistatic/app5/controller/ApplicationController.kt

@@ -0,0 +1,54 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ **/
+
+package org.epistatic.app5.controller
+
+import javafx.fxml.FXML
+import javafx.scene.control.Button
+import javafx.scene.control.Label
+import javafx.stage.Stage
+
+/**
+ * Controller for app5 - Custom Dialog Demo
+ */
+class ApplicationController {
+
+   @FXML lateinit var exitButton: Button
+   @FXML lateinit var nameLabel: Label
+
+   @FXML
+   fun initialize() {
+   }
+
+   @FXML
+   fun rename() {
+      val stage = exitButton.scene.window as Stage
+      val dialog = SingleValueDialog(stage,"New Name", "Change Name", nameLabel.text)
+      val result = dialog.showAndWait()
+      if (result.ok){
+         nameLabel.text = result.data
+      }
+   }
+
+   @FXML
+   fun closeApplication() {
+      val stage = exitButton.scene.window as Stage
+      stage.close()
+   }
+}

src/main/kotlin/org/epistatic/app5/controller/CustomDialog.kt

@@ -0,0 +1,53 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ **/
+
+package org.epistatic.app5.controller
+
+import javafx.stage.Modality
+import javafx.stage.Stage
+
+/**
+ * Superclass of all non-trivial custom dialogs which are essentially modal windows
+ * Not for standard message or warning dialogs - use JavaFX dialogs for those
+ */
+abstract class CustomDialog<T>(ownerStage: Stage, title: String) {
+
+   private var result: T? = null
+
+   var stage: Stage = Stage()
+
+   init {
+      stage.title = title
+      stage.initOwner(ownerStage)
+   }
+
+   /**
+    * override this to return result from dialog's controller
+    */
+   abstract fun result(): DialogResult<T>
+
+   /**
+    * Show dialog modally and then return the result
+    */
+   fun showAndWait(): DialogResult<T> {
+      stage.initModality(Modality.APPLICATION_MODAL)
+      stage.showAndWait()
+      return result()
+   }
+}

src/main/kotlin/org/epistatic/app5/controller/DialogResult.kt

@@ -0,0 +1,22 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+**/
+
+package org.epistatic.app5.controller
+
+class DialogResult<T>(val ok: Boolean, val data: T)

src/main/kotlin/org/epistatic/app5/controller/SingleValueDialog.kt

@@ -0,0 +1,49 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+**/
+
+package org.epistatic.app5.controller
+
+import javafx.fxml.FXMLLoader
+import javafx.scene.Scene
+import javafx.scene.layout.VBox
+import javafx.stage.Stage
+
+/**
+ * Simple dialog for entering a single string value. Title, label and default parameters
+ * are all constructor arguments
+ */
+class SingleValueDialog(ownerStage: Stage, label: String, title: String, defaultValue: String?) : CustomDialog<String>(ownerStage, title) {
+
+   var controller: SingleValueDialogController
+
+   init {
+      val loader = FXMLLoader(javaClass.getResource("/app5/singleValueDialog.fxml"))
+      controller = SingleValueDialogController(label, defaultValue)
+      loader.setController(controller)
+      val root = loader.load<VBox>()
+      stage.scene = Scene(root)
+   }
+
+   override fun result(): DialogResult<String> {
+      val v = controller.getValue()
+      if (v != null)
+         return DialogResult(true, v)
+      return DialogResult(false, "")
+   }
+}