Merge branch 'master' into release

Author: jpsacha

ReadMe.md

@@ -10,23 +10,30 @@ Extras do not have direct corresponding concepts in JavaFX.
 
 **Contents**
 
-0. [Project Structure](#project-structure)
-0. [SBT](#sbt)
-0. [Features](#features)
-   1. [Helper Methods](#helper-methods)
-   1. [Simpler Display of Standard Dialogs](#simpler-display-of-standard-dialogs)
-   1. [Easy Custom Dialogs](#easy-custom-dialogs)
-   1. [BusyWorker](#busyworker)
-   1. [Simpler Use of FXML with MVCfx Pattern](#simpler-use-of-fxml-with-mvcfx-pattern)
-   1. [Image Display Component](#imagedisplay-component)
-0. [Demos](#demos)
-   1. [StopWatch Application](#stopwatch-application)
-   1. [ShowMessage Demo](#showmessage-demo)
-   1. [BusyWorker Demo](#busyworker-demo)
-   1. [ImageDisplay Demo](#imagedisplay-demo)
-0. [Status](#status)
-0. [Discussion and Support](#discussion-and-support)
-0. [License](#license)
+<!-- TOC -->
+
+* [Project Structure](#project-structure)
+* [SBT](#sbt)
+* [Features](#features)
+   * [Helper Methods](#helper-methods)
+   * [Simpler Display of Standard Dialogs](#simpler-display-of-standard-dialogs)
+   * [Easy Custom Dialogs](#easy-custom-dialogs)
+   * [Edit a Case Class object with AutoDialog](#edit-a-case-class-object-with-autodialog)
+   * [BusyWorker](#busyworker)
+      * [Example 1](#example-1)
+      * [Example 2](#example-2)
+   * [Simpler Use of FXML with MVCfx Pattern](#simpler-use-of-fxml-with-mvcfx-pattern)
+   * [ImageDisplay Component](#imagedisplay-component)
+* [Demos](#demos)
+   * [StopWatch Application](#stopwatch-application)
+   * [ShowMessage Demo](#showmessage-demo)
+   * [BusyWorker Demo](#busyworker-demo)
+   * [ImageDisplay Demo](#imagedisplay-demo)
+* [Status](#status)
+* [Discussion and Support](#discussion-and-support)
+* [License](#license)
+
+<!-- TOC -->
 
 Project Structure
 -----------------
@@ -173,6 +180,34 @@ if (dialog.wasOKed) {
 
 A more elaborate example is in the `GenericDialogFXDemo`.
 
+### Edit a Case Class object with AutoDialog
+
+`AutoDialog` can be used too quickly open auto generated dialog from case class. After closing, the dialog will return
+edited version of the input case class.
+
+Here is an example of usage:
+
+```scala
+import org.scalafx.extras.auto_dialog.AutoDialog
+
+case class FilterOptions(kernelSize: Int = 7,
+                         start: Double = 3.14,
+                         tag: String = "alpha",
+                         debugMode: Boolean = false)
+
+val filterOptions = FilterOptions()
+
+val result: Option[FilterOptions] =
+   new AutoDialog(filterOptions)
+           .showDialog(
+              "AutoDialog Demo",
+              "Fields are auto generated from `FilterOptions` object")
+
+println(s"Result: $result")
+```
+
+![GenericDialogFX Demo](notes/assets/AutoDialog.png)
+
 ### BusyWorker
 
 BusyWorker helps running a UI task on separate threads (other than the JavaFX Application thread). It will show busy
@@ -193,7 +228,7 @@ new BusyWorker("Simple Task", parentWindow).doTask { () =>
 }
 ```
 
-#### Examnple 2
+#### Example 2
 
 Here is a little more elaborated example. It updates a progress message and progress indicator.
 

build.sbt

@@ -10,11 +10,10 @@ import scala.xml.{Node => XmlNode, NodeSeq => XmlNodeSeq, _}
 // JAR_BUILT_BY      - Name to be added to Jar metadata field "Built-By" (defaults to System.getProperty("user.name")
 //
 
-val projectVersion = "0.6.0"
+val projectVersion = "0.6.0.1-SNAPSHOT"
 val versionTagDir  = if (projectVersion.endsWith("SNAPSHOT")) "master" else "v." + projectVersion
 val _scalaVersions = Seq("3.0.2", "2.13.8", "2.12.16")
 val _scalaVersion  = _scalaVersions.head
-val _javaFXVersion = "18.0.1"
 
 ThisBuild / version             := projectVersion
 ThisBuild / crossScalaVersions  := _scalaVersions
@@ -24,10 +23,6 @@ ThisBuild / organization        := "org.scalafx"
 publishArtifact     := false
 publish / skip      := true
 
-lazy val JavaFXModuleLibs: Seq[ModuleID] =
-  Seq("base", "controls", "fxml", "graphics", "media", "swing", "web")
-    .map(m => "org.openjfx" % s"javafx-$m" % _javaFXVersion)
-
 def isScala2(scalaVersion: String): Boolean = {
   CrossVersion.partialVersion(scalaVersion) match {
     case Some((2, _)) => true
@@ -80,7 +75,6 @@ lazy val scalaFXExtrasDemos = (project in file("scalafx-extras-demos")).settings
     "-Xmx512M",
     "-Djavafx.verbose"
   ),
-  libraryDependencies ++= JavaFXModuleLibs,
   publishArtifact := false,
   libraryDependencies ++= Seq(
     "com.typesafe.scala-logging" %% "scala-logging"   % "3.9.4",
@@ -131,7 +125,7 @@ lazy val scalaFXExtrasSettings = Seq(
   Compile / doc / scalacOptions ++= (
     if(isScala2(scalaVersion.value))
       Seq(
-        s"-doc-external-doc:${scalaInstance.value.libraryJars.head}#http://www.scala-lang.org/api/${scalaVersion.value}/",
+        s"-doc-external-doc:${scalaInstance.value.libraryJars.head}#https://www.scala-lang.org/api/${scalaVersion.value}/",
         "-doc-source-url", "https://github.com/SscalaFX-Extras/scalafx-extras/blob/" + versionTagDir + "/scalafx/€{FILE_PATH}.scala"
       ) ++ (
         Option(System.getenv("GRAPHVIZ_DOT_PATH")) match {
@@ -154,9 +148,9 @@ lazy val scalaFXExtrasSettings = Seq(
       Seq.empty[sbt.ModuleID]
   ),
   libraryDependencies ++= Seq(
-    "org.scalafx"   %% "scalafx"   % "18.0.1-R27",
+    "org.scalafx"   %% "scalafx"   % "18.0.2-R29",
     "org.scalatest" %% "scalatest" % "3.2.11" % "test"
-  ) ++ JavaFXModuleLibs,
+  ),
   libraryDependencies ++= (
     if (isScala2(scalaVersion.value))
       Seq(
@@ -215,7 +209,7 @@ import xerial.sbt.Sonatype._
 // Metadata needed by Maven Central
 // See also http://maven.apache.org/pom.html#Developers
 lazy val mavenCentralSettings = Seq(
-  homepage               := Some(new URL("http://www.scalafx.org/")),
+  homepage               := Some(new URL("https://www.scalafx.org/")),
   startYear              := Some(2016),
   licenses               := Seq(("BSD", new URL("https://github.com/scalafx/scalafx-extras/blob/master/LICENSE.txt"))),
   sonatypeProfileName    := "org.scalafx",

notes/0.7.0.md

@@ -0,0 +1,40 @@
+### ScalaFX-Extras Release v.0.7.0
+
+This release provides a convenient way to generate dialogs from case classes (scala 3).
+`AutoDialog` is used too quickly open auto generated dialog from case class.
+After closing, the dialog will return edited version of the input case class:
+
+```scala
+import org.scalafx.extras.auto_dialog.AutoDialog
+
+case class FilterOptions(kernelSize: Int = 7,
+                         start: Double = 3.14,
+                         tag: String = "alpha",
+                         debugMode: Boolean = false)
+
+val result: Option[FilterOptions] =
+  new AutoDialog(FilterOptions())
+    .showDialog(
+      "AutoDialog Demo",
+      "Fields are auto generated from `FilterOptions` object")
+
+println(s"Result: $result")
+```
+
+The `scalafx-extras-demos` subproject has an example.
+
+Enhancements:
+
+* \[Scala 3\] auto generate input dialogs from simple case classes [[#18]]
+* Update to ScalaFX 18.0.2-R29 [[#20]]
+
+To post questions please use [Project Discussions][Discussions] or [ScalaFX Users Group][scalafx-users]
+
+[Discussions]: https://github.com/scalafx/scalafx-extras/discussions
+
+[scalafx-users]: https://groups.google.com/forum/#!forum/scalafx-users
+
+[#18]: https://github.com/scalafx/scalafx-extras/issues/18
+
+[#20]: https://github.com/scalafx/scalafx-extras/issues/20
+

notes/assets/AutoDialog.png

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2011-2022, ScalaFX Project
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the ScalaFX Project nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE SCALAFX PROJECT OR ITS CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.scalafx.extras.auto_dialog
+
+import org.scalafx.extras.initFX
+
+object AutoDialogDemo:
+
+  case class FilterOptions(kernelSize: Int = 7,
+                           start: Double = 3.14,
+                           tag: String = "alpha",
+                           debugMode: Boolean = false)
+
+  def main(args: Array[String]): Unit =
+
+    initFX()
+
+    val filterOptions = FilterOptions()
+
+    val result: Option[FilterOptions] =
+      new AutoDialog(filterOptions)
+        .showDialog(
+          "AutoDialog Demo",
+          "Fields are auto generated from `FilterOptions` object")
+
+    println(s"Result: $result")
+
+    System.exit(0)
+
+

scalafx-extras-demos/src/main/scala-3/org/scalafx/extras/auto_dialog/AutoDialogDemo.scala

@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2011-2022, ScalaFX Project
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of the ScalaFX Project nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE SCALAFX PROJECT OR ITS CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package org.scalafx.extras.auto_dialog
+
+import org.scalafx.extras.auto_dialog.{DialogDecoder, DialogEncoder}
+import org.scalafx.extras.generic_dialog.GenericDialogFX
+import scalafx.stage.Window
+
+
+/** Automatically created a dialog from a case class.
+  * Names of the members of the input `data` will be used as labels for fields corresponding to their values.
+  * Initially case with members of `Boolean`, `Int`, `Double`, and `String` are supported.
+  *
+  * Use methods [[#showDialog]] to display the dialog and retrieve edited content.
+  *
+  * {{{
+  *   case class FilterOptions(kernelSize: Int = 7,
+  *                            start: Double = 3.14,
+  *                            tag: String = "alpha",
+  *                            debugMode: Boolean = false)
+  *
+  *   val result: Option[FilterOptions] =
+  *     new AutoDialog(FilterOptions())
+  *       .showDialog(
+  *         "Filter Options",
+  *         "Fields below were auto generated from `FilterOptions` object")
+  *
+  *   println(s"Result: result")
+  * }}}
+  *
+  * @param data data that will define the dialog and its initial values
+  */
+class AutoDialog[A >: Null : DialogEncoder : DialogDecoder](data: A):
+
+  /**
+    * Display the dialog and block till the dialog is closed.
+    *
+    * @param title        dialog title
+    * @param header       dialog header
+    * @param parentWindow optional parent window that will be blocked when dialog is displayed
+    * @return when dialog was confirmed with OK it will return content of the fields of the dialog.
+    *         If dialog was cancelled it will return `None`
+    */
+  def showDialog(title: String,
+                 header: String = "",
+                 parentWindow: Option[Window] = None): Option[A] =
+    val gd = new GenericDialogFX(title, header = header, parentWindow = parentWindow)
+
+    // Add fields to the dialog
+    summon[DialogEncoder[A]].addEditor(gd, "", data)
+
+    gd.showDialog()
+
+    if gd.wasOKed then
+      val r = summon[DialogDecoder[A]].decode(gd)
+      Option(r)
+    else
+      None
+
+end AutoDialog