Merge branch 'master' into release

Author: jpsacha

.scalafmt.conf

@@ -1,4 +1,4 @@
-version = 3.5.8
+version = 3.7.3
 
 runner.dialect = scala3
 fileOverride {

ReadMe.md

@@ -2,37 +2,36 @@ ScalaFX Extras
 ==============
 
 [![Scala CI](https://github.com/scalafx/scalafx-extras/actions/workflows/scala.yml/badge.svg)](https://github.com/scalafx/scalafx-extras/actions/workflows/scala.yml)
-[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.scalafx/scalafx-extras_2.13/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.scalafx/scalafx-extras_2.13)
-[![Scaladoc](https://javadoc.io/badge2/org.scalafx/scalafx-extras_2.13/scaladoc.svg)](https://javadoc.io/doc/org.scalafx/scalafx-extras_2.13)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.scalafx/scalafx-extras_3/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.scalafx/scalafx-extras_3)
+[![Scaladoc](https://javadoc.io/badge2/org.scalafx/scalafx-extras_3/scaladoc.svg)](https://javadoc.io/doc/org.scalafx/scalafx-extras_3)
 
 ScalaFX Extras are additions to ScalaFX that simplify creation of User interfaces. In contrast to ScalaFX core, the
 Extras do not have direct corresponding concepts in JavaFX.
 
 **Contents**
 
 <!-- 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)
+  * [Project Structure](#project-structure)
+  * [SBT](#sbt)
+  * [Features](#features)
+    * [Helper Methods](#helper-methods)
+    * [Simpler Display of Standard Dialogs](#simpler-display-of-standard-dialogs)
+    * [Easy Custom Panes](#easy-custom-panes)
+    * [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)
-
+    * [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
@@ -80,9 +79,9 @@ Example execution some code on a separate thread and waiting for the result of c
 
 ```scala
 val x = offFXAndWait {
-   val a = 3
-   val b = 7
-   a * b
+  val a = 3
+  val b = 7
+  a * b
 }
 
 ```
@@ -95,10 +94,10 @@ Standard dialogs can be quickly displayed using functions provided my `ShowMessa
 import org.scalafx.extras.ShowMessage
 
 ShowMessage.information(
-   "Dialog Title",
-   "This is the information 'header'",
-   "This is the information detailed 'content'.",
-   parentWindow
+  "Dialog Title",
+  "This is the information 'header'",
+  "This is the information detailed 'content'.",
+  parentWindow
 )
 ```
 
@@ -120,20 +119,80 @@ exceptions dialogs are displayed.
 ```scala
 class MyUIModel extends Model with ShowMessage {
 
-   def onSomeUserAction(): Unit = {
-      // ...
-      showInformation("Dialog Title",
-         "This is the information 'header'",
-         "This is the information detailed 'content'.")
-      // ...
-   }
+  def onSomeUserAction(): Unit = {
+    // ...
+    showInformation("Dialog Title",
+      "This is the information 'header'",
+      "This is the information detailed 'content'.")
+    // ...
+  }
 
-   // ...
+  // ...
 }
 ```  
 
 The demos module has a complete example of a simple application in `ShowMessageDemoApp`.
 
+### Easy Custom Panes
+
+`GenericPane` is a helper class that simplifies creation of panes. Particularly suited for creation of input controls.
+
+Typically there are 4 steps to using a `GenericPane`:
+
+1. Creation, where elements of the pane are appended vertically using `add*(...)` methods, for instance,
+   `addStringField(label, defaultText)`
+
+2. Adding the pane to the UI
+
+3. User interaction, after the pane is displayed
+
+4. Optionally, reading of input. Pane's editable content can be read using `next*()` methods. Content is read in the
+   order it is added. The whole pane content can be read multiple tiles. Remember to call `resetReadout()` to ensure
+   that reading is restarted from the beginning of the pane.
+
+A complete example in Scala 3. Shows a pane with 2 directory selection fields and a button "Print Fields". When the
+button is pressed values
+of the directory fields are printed
+
+[//]: # (@formatter:off)
+```scala
+import scalafx.application.JFXApp3
+import scalafx.application.JFXApp3.PrimaryStage
+import scalafx.geometry.Insets
+import scalafx.scene.Scene
+import scalafx.scene.control.Button
+import scalafx.scene.layout.VBox
+import scalafx.scene.paint.*
+import scalafx.scene.paint.Color.*
+import scalafx.scene.text.Text
+
+object GenericPaneDemo extends JFXApp3:
+
+  override def start(): Unit =
+
+    val gp = new GenericPane():
+      addDirectoryField("Input", "images")
+      addDirectoryField("Output", "output")
+
+    stage = new PrimaryStage:
+      title = "GenericPane Demo"
+      scene = new Scene:
+        content = new VBox:
+          padding = Insets(7, 7, 7, 7)
+          spacing = 7
+          children = Seq(
+            gp.pane,
+            new Button("Print Fields"):
+              onAction = (_) =>
+                gp.resetReadout()
+                println(s"Input dir : ${gp.nextString()}")
+                println(s"Output dir: ${gp.nextString()}")
+          )
+```
+[//]: # (@formatter:off)
+
+![GenericPane Demo](notes/assets/GenericPane.png)
+
 ### Easy Custom Dialogs
 
 Custom dialogs can be quickly created using `GenericDialogFX` class. This class is particularly suited for creation of
@@ -152,27 +211,27 @@ Here is en example:
 ```scala
 // Create a dialog
 val dialog =
-   new GenericDialogFX(
-      title = "GenericDialogFX Demo",
-      header = "Fancy description can go here."
-   ) {
-      // Add fields
-      addCheckbox("Check me out!", defaultValue = false)
-      addCheckbox("Check me too!", defaultValue = true)
-   }
+  new GenericDialogFX(
+    title = "GenericDialogFX Demo",
+    header = "Fancy description can go here."
+  ) {
+    // Add fields
+    addCheckbox("Check me out!", defaultValue = false)
+    addCheckbox("Check me too!", defaultValue = true)
+  }
 
 // Show dialog to the user
 dialog.showDialog()
 
 // Read input provided by the user
 if (dialog.wasOKed) {
-   val select1 = dialog.nextBoolean()
-   val select2 = dialog.nextBoolean()
+  val select1 = dialog.nextBoolean()
+  val select2 = dialog.nextBoolean()
 
-   println(s"Selection 1: $select1")
-   println(s"Selection 2: $select2")
+  println(s"Selection 1: $select1")
+  println(s"Selection 2: $select2")
 } else {
-   println("Dialog was cancelled.")
+  println("Dialog was cancelled.")
 }
 ```
 
@@ -198,10 +257,10 @@ case class FilterOptions(kernelSize: Int = 7,
 val filterOptions = FilterOptions()
 
 val result: Option[FilterOptions] =
-   new AutoDialog(filterOptions)
-           .showDialog(
-              "AutoDialog Demo",
-              "Fields are auto generated from `FilterOptions` object")
+  new AutoDialog(filterOptions)
+    .showDialog(
+      "AutoDialog Demo",
+      "Fields are auto generated from `FilterOptions` object")
 
 println(s"Result: $result")
 ```

build.sbt

@@ -10,9 +10,9 @@ 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.7.0"
+val projectVersion = "0.7.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 _scalaVersions = Seq("3.2.2", "2.13.10", "2.12.17")
 val _scalaVersion  = _scalaVersions.head
 
 ThisBuild / version             := projectVersion
@@ -77,8 +77,8 @@ lazy val scalaFXExtrasDemos = (project in file("scalafx-extras-demos")).settings
   ),
   publishArtifact := false,
   libraryDependencies ++= Seq(
-    "com.typesafe.scala-logging" %% "scala-logging"   % "3.9.4",
-    "ch.qos.logback"              % "logback-classic" % "1.2.11"
+    "com.typesafe.scala-logging" %% "scala-logging"   % "3.9.5",
+    "ch.qos.logback"              % "logback-classic" % "1.4.7" % Runtime
   )
 ).dependsOn(scalaFXExtras % "compile;test->test")
 
@@ -148,13 +148,13 @@ lazy val scalaFXExtrasSettings = Seq(
       Seq.empty[sbt.ModuleID]
   ),
   libraryDependencies ++= Seq(
-    "org.scalafx"   %% "scalafx"   % "18.0.2-R29",
-    "org.scalatest" %% "scalatest" % "3.2.11" % "test"
+    "org.scalafx"   %% "scalafx"   % "20.0.0-R31",
+    "org.scalatest" %% "scalatest" % "3.2.15" % "test"
   ),
   libraryDependencies ++= (
     if (isScala2(scalaVersion.value))
       Seq(
-        "com.beachape"  %% "enumeratum"          % "1.7.0",
+        "com.beachape"  %% "enumeratum"          % "1.7.2",
         "org.scala-lang" % "scala-reflect"       % scalaVersion.value,
         "org.scalafx"   %% "scalafxml-core-sfx8" % "0.5"
       )
@@ -204,7 +204,7 @@ lazy val manifestSetting = packageOptions += {
   )
 }
 
-import xerial.sbt.Sonatype._
+import xerial.sbt.Sonatype.*
 
 // Metadata needed by Maven Central
 // See also http://maven.apache.org/pom.html#Developers

notes/0.8.0.md

@@ -0,0 +1,84 @@
+## ScalaFX-Extras Release v.0.8.0
+
+This release of [ScalaFX-Extras] add ability to conveniently add fields and read data from a pane using `GenericPane`. Add a couple bug fixes 
+
+### New features
+
+In addition to `GenericDialogFX` there is a `GenericPane` that can be used to build a `Pane` that can be used with more
+granularity in designing UIs. It can be used as a part of other, more complex, control. Example:
+
+[//]: # (@formatter:off)
+```scala
+import scalafx.application.JFXApp3
+import scalafx.application.JFXApp3.PrimaryStage
+import scalafx.geometry.Insets
+import scalafx.scene.Scene
+import scalafx.scene.control.Button
+import scalafx.scene.layout.VBox
+import scalafx.scene.paint.*
+import scalafx.scene.paint.Color.*
+import scalafx.scene.text.Text
+
+object GenericPaneDemo extends JFXApp3:
+
+  override def start(): Unit =
+
+    val gp = new GenericPane():
+      addDirectoryField("Input", "images")
+      addDirectoryField("Output", "output")
+
+    stage = new PrimaryStage:
+      title = "GenericPane Demo"
+      scene = new Scene:
+        content = new VBox:
+          padding = Insets(7, 7, 7, 7)
+          spacing = 7
+          children = Seq(
+            gp.pane,
+            new Button("Print Fields"):
+              onAction = (_) =>
+                gp.resetReadout()
+                println(s"Input dir : ${gp.nextString()}")
+                println(s"Output dir: ${gp.nextString()}")
+          )
+```
+[//]: # (@formatter:on)
+
+The `scalafx-extras-demos` subproject has an example.
+
+#### Additional features:
+
+* The preferred width (expressed in text columns) of the text field in `FileSelectionField` can now be controlled. This
+  adds similar options to
+    * `GenericPaneBase.addDirectoryField`
+    * `GenericPaneBase.addFileField`
+
+### Breaking Changes
+
+* Package name `org.scalafx.extras.generic_dialog` was changed to `org.scalafx.extras.generic_pane`
+* The constructor of `GenericDialogFX` parameter's name `parentWindow` was changes to `ownerWindow` to avoid conflict
+  with similarly named parameter in `GenericPaneBase`
+
+### All changes:
+
+* Add: Generic Pane [[#22]]
+* Fix: `GenericPaneBase.addDirectoryField` - is ignoring argument columns [[#23]]
+* Fix: `GenericPaneBase.addFileField` is missing argument columns [[#24]]
+* Fix: `IllegalAccessError` in `AutoDialog` (0.7.0) [[#25]]
+
+To post questions please use [Project Discussions][Discussions] or [ScalaFX Users Group][scalafx-users]
+
+[ScalaFX-Extras]: https://github.com/scalafx/scalafx-extras
+
+[Discussions]: https://github.com/scalafx/scalafx-extras/discussions
+
+[scalafx-users]: https://groups.google.com/forum/#!forum/scalafx-users
+
+[#22]: https://github.com/scalafx/scalafx-extras/issues/22
+
+[#23]: https://github.com/scalafx/scalafx-extras/issues/23
+
+[#24]: https://github.com/scalafx/scalafx-extras/issues/24
+
+[#25]: https://github.com/scalafx/scalafx-extras/issues/25
+

notes/assets/GenericPane.png

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2011-2022, ScalaFX Project
+# Copyright (c) 2011-2023, ScalaFX Project
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -24,5 +24,5 @@
 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
-sbt.version=1.7.1
+sbt.version=1.8.2