Merge branch 'master' into release

Author: jpsacha

.scalafmt.conf

@@ -1,4 +1,4 @@
-version = 3.8.0
+version = 3.8.3
 
 runner.dialect = scala3
 fileOverride {
@@ -8,6 +8,12 @@ fileOverride {
   "glob:**/src/main/scala-2/**" {
     runner.dialect = scala213source3
   }
+  "glob:**/project/**.scala" {
+    runner.dialect = scala213source3
+  }
+  "glob:**/**.sbt" {
+    runner.dialect = scala213source3
+  }
 }
 
 preset = IntelliJ

ReadMe.md

@@ -24,6 +24,7 @@ Extras do not have direct corresponding concepts in JavaFX.
       * [Example 2](#example-2)
     * [Simpler Use of FXML with MVCfx Pattern](#simpler-use-of-fxml-with-mvcfx-pattern)
     * [ImageDisplay Component](#imagedisplay-component)
+    * [Batch Processing and Progress Dialog](#batch-processing-and-progress-dialog)
   * [Demos](#demos)
     * [StopWatch Application](#stopwatch-application)
     * [ShowMessage Demo](#showmessage-demo)
@@ -328,9 +329,15 @@ The demos module has a complete example of a simple application: [StopWatchApp][
 
 ### ImageDisplay Component
 
-ImageDisplay Component is an image view with ability to zoom in, zoom out, zoom to fit. It can also automatically resize
+ImageDisplay Component is an image view with the ability to zoom in, zoom out, zoom to fit. It can also automatically resize
 to parent size.
 
+### Batch Processing and Progress Dialog
+
+Work in progress
+* Helper UI for running batch processing tasks, see `BatchRunnerProgressDemoApp` for example of use
+* Component for display of progress of batch processing tasks, see `ProgressStatusDemoApp` for example of use
+
 
 Demos
 -----
@@ -364,11 +371,19 @@ and [ShowMessageDemo Scala 3] files for details.
 
 ### ImageDisplay Demo
 
-[ImageDisplayDemoApp][ImageDisplayDemo] a simple example of an application that can display images, with ability to zoom
-in, zoom out, and fit to current window. Illustrates use of the `ImageDisplay` component.
+[ImageDisplayDemoApp][ImageDisplayDemo] a simple example of an application that can display images, 
+with the ability to zoom in, zoom out, and fit to the current window, flip, and rotate the image. 
+Illustrates use of the `ImageDisplay` component.
 
 ![Image Display Demo](notes/assets/ImageDisplayDemo.gif)
 
+### BatchRunnerWithProgress Demo
+
+[BatchRunnerWithProgressDemoApp] demo of `BatchRunnerWithProgress` GUI.
+
+![BatchRunnerWithProgress Demo](notes/assets/BatchRunnerProgressDemoApp.gif) 
+
+
 Status
 ------
 
@@ -406,6 +421,8 @@ BSD-3-Clause ScalaFX license.
 
 [StopWatchDemo Scala 3]: scalafx-extras-demos/src/main/scala-3/org/scalafx/extras/mvcfx/stopwatch
 
+[BatchRunnerWithProgressDemoApp]: scalafx-extras-demos/src/main/scala-3/org/scalafx/extras/batch/BatchRunnerWithProgressDemoApp.scala
+
 [ScalaFX Users Group]: https://groups.google.com/forum/#!forum/scalafx-users
 
 [Discussions]: https://github.com/scalafx/scalafx-extras/discussions

build.sbt

@@ -9,9 +9,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.9.0"
+val projectVersion = "0.9.0.6-SNAPSHOT"
 val versionTagDir  = if (projectVersion.endsWith("SNAPSHOT")) "master" else "v." + projectVersion
-val _scalaVersions = Seq("3.3.3", "2.13.13", "2.12.19")
+val _scalaVersions = Seq("3.3.3", "2.13.14", "2.12.19")
 val _scalaVersion  = _scalaVersions.head
 
 ThisBuild / version            := projectVersion
@@ -22,13 +22,13 @@ ThisBuild / organization       := "org.scalafx"
 publishArtifact := false
 publish / skip  := true
 
-lazy val libEnumeratum     = "com.beachape"               %% "enumeratum"          % "1.7.3"
-lazy val libLogbackClassic = "ch.qos.logback"              % "logback-classic"     % "1.5.3"
+lazy val libEnumeratum     = "com.beachape"               %% "enumeratum"          % "1.7.4"
+lazy val libLogbackClassic = "ch.qos.logback"              % "logback-classic"     % "1.5.6"
 lazy val libParadise       = "org.scalamacros"             % "paradise"            % "2.1.1" cross CrossVersion.full
 lazy val libScalaLogging   = "com.typesafe.scala-logging" %% "scala-logging"       % "3.9.5"
 lazy val libScalaFX        = "org.scalafx"                %% "scalafx"             % "22.0.0-R33"
 lazy val libScalaFXML      = "org.scalafx"                %% "scalafxml-core-sfx8" % "0.5"
-lazy val libScalaTest      = "org.scalatest"              %% "scalatest"           % "3.2.18"
+lazy val libScalaTest      = "org.scalatest"              %% "scalatest"           % "3.2.19"
 lazy val libScalaReflect   = "org.scala-lang"              % "scala-reflect"
 
 def isScala2(scalaVersion: String): Boolean = {

notes/0.10.0.md

@@ -0,0 +1,35 @@
+## ScalaFX-Extras Release v.0.10.0
+
+This release of [ScalaFX-Extras] is a feature release.
+
+### New features
+
+* Add component to display the progress of batch processing tasks [[#33]]
+* Add helper UI for running batch processing tasks [[#34]]
+* ShowMessage: allow for resizing all message dialogs [[#32]]
+* ImageDisplay: add an option to flip image in X or Z axis [[#35]]
+
+### Bug fixes
+
+* ShowMessage dialogs may display cropped messages [[#31]]
+
+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
+
+
+[#31]: https://github.com/scalafx/scalafx-extras/issues/31
+
+[#32]: https://github.com/scalafx/scalafx-extras/issues/32
+
+[#33]: https://github.com/scalafx/scalafx-extras/issues/33
+
+[#34]: https://github.com/scalafx/scalafx-extras/issues/34
+
+[#35]: https://github.com/scalafx/scalafx-extras/issues/35
+
+

notes/assets/BatchRunnerProgressDemoApp.gif

@@ -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.9.9
+sbt.version=1.10.1
 

project/build.properties

@@ -0,0 +1,90 @@
+/*
+ * Copyright (c) 2000-2023 Jarek Sacha. All Rights Reserved.
+ * Author's e-mail: jpsacha at gmail.com
+ */
+
+package org.scalafx.extras.batch
+
+import org.scalafx.extras.BusyWorker
+import org.scalafx.extras.BusyWorker.SimpleTask
+import scalafx.application.JFXApp3
+import scalafx.application.JFXApp3.PrimaryStage
+import scalafx.geometry.Insets
+import scalafx.scene.Scene
+import scalafx.scene.control.{Button, Label}
+import scalafx.scene.layout.VBox
+import scalafx.stage.Window
+
+import scala.util.Random
+
+/**
+ * Example of a task that for batch execution.
+ */
+private class MyTask(val i: Int) extends ItemTask[String] {
+
+  import MyTask.*
+
+  val name = s"Task #$i"
+
+  def run(): String =
+    val t = minTime + new Random().nextInt(maxTime - minTime)
+    Thread.sleep(t)
+    if t % 6 != 0 then
+      s"name t = $t"
+    else
+      throw new Exception(s"Do not like $t")
+}
+
+object MyTask {
+  val minTime = 500
+  val maxTime = 1000
+}
+
+/**
+ * Demo of `BatchRunnerWithProgress` GUI
+ * @author Jarek Sacha
+ */
+object BatchRunnerProgressDemoApp extends JFXApp3:
+
+  private lazy val busyWorker = new BusyWorker(Title, parentWindow)
+  private val Title           = "Batch Processing / Progress Dialog Demo"
+  private val nTasks          = 10
+
+  override def start(): Unit =
+    stage = new PrimaryStage:
+      title = Title
+      scene = new Scene:
+        content = new VBox:
+          padding = Insets(21)
+          spacing = 14
+          children = Seq(
+            new Label(
+              s"""Press "Run x" to initiate processing.
+                 |Wait till processing finished or press "Abort".
+                 |There will be $nTasks processed.
+                 |Tasks will have randomly generated execution time,
+                 |between ${MyTask.minTime} and ${MyTask.maxTime} ms.
+                 |If task's time is divisible by 6, that task will fail.
+                 |""".stripMargin
+            ),
+            new Button("Run as Sequence"):
+              onAction = _ => onStart(false)
+              prefWidth = 120
+            ,
+            new Button("Run in Parallel"):
+              onAction = _ => onStart(true)
+              prefWidth = 120
+          )
+
+  private def onStart(runInParallel: Boolean): Unit = busyWorker.doTask("Start") { () =>
+    type ResultType = String
+    val helper =
+      new BatchRunnerWithProgress[ResultType]("Sample batch processing", Option(stage), runInParallel):
+        def createTasks(): Seq[ItemTask[ResultType]] = (1 to nTasks).map { i => new MyTask(i) }
+
+    helper.run()
+  }
+
+  private def parentWindow: Option[Window] = Option(stage)
+
+end BatchRunnerProgressDemoApp

scalafx-extras-demos/src/main/scala-3/org/scalafx/extras/batch/BatchRunnerWithProgressDemoApp.scala

@@ -0,0 +1,88 @@
+/*
+ * Copyright (c) 2011-2024, 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.batch
+
+import scala.util.{Failure, Success}
+
+import scala.util.{Failure, Success, Try}
+
+/**
+ * Example of using `ParallelBatchRunner` and `ItemTask`.
+ * Results are printed to standard output.
+ *
+ * @author Jarek Sacha
+ */
+object ParallelBatchRunnerDemo {
+  private class DemoTaskItem(n: Int) extends ItemTask[Int] {
+    val name = s"Demo TaskItem $n"
+
+    def run(): Int = {
+      //      println(s"Item ${n} - start")
+      Thread.sleep(300)
+      if n == 7 then
+        //        println(s"Item ${n} - error")
+        throw new IllegalArgumentException(s"Don't give me $n")
+
+      //      println(s"Item ${n} - end")
+      n
+    }
+  }
+
+  def main(args: Array[String]): Unit = {
+    val items: Seq[DemoTaskItem] = Range(0, 10).map { i => new DemoTaskItem(i) }
+
+    val batchHelper = new ParallelBatchRunner(items, progressUpdate, useParallelProcessing = true)
+
+    val results: Seq[(String, Try[Option[Int]])] = batchHelper.execute()
+
+    println()
+    println("Summarize processing")
+    results.foreach {
+      case (name, Success(r)) => println(s"$name: SUCCESS: $r")
+      case (name, Failure(e)) => println(s"$name: ERROR  : ${e.getMessage}")
+    }
+  }
+
+  @FunctionalInterface
+  private def progressUpdate(
+    running: Long,
+    successful: Long,
+    failed: Long,
+    canceled: Long,
+    executed: Long,
+    total: Long,
+    isCanceled: Boolean,
+    perc: Double,
+    message: String
+  ): Unit = {
+    val m =
+      f"R:$running%2d, S:$successful%2d, F:$failed%2d, E:$executed%2d, C:$canceled, T:$total%d, " +
+        f"C:$isCanceled, perc:${perc.toInt}%3d, $message"
+    println(m)
+  }
+}