Merge branch 'master' into release

Author: jpsacha

.scalafmt.conf

@@ -1,4 +1,4 @@
-version = 3.8.3
+version = 3.9.4
 
 runner.dialect = scala3
 fileOverride {

ReadMe.md

@@ -11,28 +11,30 @@ Extras do not have direct corresponding concepts in JavaFX.
 **Contents**
 
 <!-- TOC -->
-  * [Project Structure](#project-structure)
-  * [SBT](#sbt)
-  * [Features](#features)
+
+* [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)
+        * [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)
     * [Batch Processing and Progress Dialog](#batch-processing-and-progress-dialog)
-  * [Demos](#demos)
+* [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)
+* [Status](#status)
+* [Discussion and Support](#discussion-and-support)
+* [License](#license)
+
 <!-- TOC -->
 
 Project Structure
@@ -239,7 +241,7 @@ 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.
+an edited version of the input case class.
 
 Here is an example of usage:
 
@@ -266,10 +268,10 @@ println(s"Result: $result")
 
 ### BusyWorker
 
-BusyWorker helps running a UI task on separate threads (other than the JavaFX Application thread). It will show busy
+BusyWorker helps to run a UI task on separate threads (other than the JavaFX Application thread). It will show busy
 cursor and disable specified nodes while the task is performed. It gives an option to show progress and status messages.
 `BusyWorker` takes care of handling exceptions and displaying error dialogs. It provides for an option to perform custom
-finish actions after task is completed.
+finish actions after the task is completed.
 
 #### Example 1
 
@@ -323,21 +325,24 @@ The full code example can be found in the
 ### Simpler Use of FXML with MVCfx Pattern
 
 Package `org.scalafx.extras.mvcfx` contains classes for creating with UI components based on FXML that use
-Model-View-Controller, here we call it the MVCfx Pattern. See wiki page [MVCfx Pattern] for details.
+Model-View-Controller, here we call it the MVCfx Pattern. See the wiki page [MVCfx Pattern] for details.
 
 The demos module has a complete example of a simple application: [StopWatchApp][StopWatchDemo].
 
 ### ImageDisplay Component
 
-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.
+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 (zoom-to-fit).
+Image cane also rotated and flipped along the X and Y axis.
+
+ImageDisplay provides an option to show overlay on top of the image. Overlays scale and rotate with the image.
 
 ### 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
 
+* Helper UI for running batch processing tasks, see `BatchRunnerProgressDemoApp` for example of use
+* Component for display of the progress of batch processing tasks, see `ProgressStatusDemoApp` for example of use
 
 Demos
 -----
@@ -371,8 +376,8 @@ and [ShowMessageDemo Scala 3] files for details.
 
 ### ImageDisplay Demo
 
-[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. 
+[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)
@@ -381,7 +386,7 @@ Illustrates use of the `ImageDisplay` component.
 
 [BatchRunnerWithProgressDemoApp] demo of `BatchRunnerWithProgress` GUI.
 
-![BatchRunnerWithProgress Demo](notes/assets/BatchRunnerProgressDemoApp.gif) 
+![BatchRunnerWithProgress Demo](notes/assets/BatchRunnerProgressDemoApp.gif)
 
 
 Status

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.10.1"
+val projectVersion = "0.10.1.4-SNAPSHOT"
 val versionTagDir  = if (projectVersion.endsWith("SNAPSHOT")) "master" else "v." + projectVersion
-val _scalaVersions = Seq("3.3.4", "2.13.15", "2.12.20")
+val _scalaVersions = Seq("3.3.5", "2.13.16", "2.12.20")
 val _scalaVersion  = _scalaVersions.head
 
 ThisBuild / version            := projectVersion
@@ -22,8 +22,8 @@ ThisBuild / organization       := "org.scalafx"
 publishArtifact := false
 publish / skip  := true
 
-lazy val libEnumeratum     = "com.beachape"               %% "enumeratum"          % "1.7.5"
-lazy val libLogbackClassic = "ch.qos.logback"              % "logback-classic"     % "1.5.11"
+lazy val libEnumeratum     = "com.beachape"               %% "enumeratum"          % "1.7.6"
+lazy val libLogbackClassic = "ch.qos.logback"              % "logback-classic"     % "1.5.18"
 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"             % "23.0.1-R34"

notes/0.11.0.md

@@ -0,0 +1,30 @@
+## ScalaFX-Extras Release v.0.11.0
+
+This is a feature release of [ScalaFX-Extras].
+
+### New features
+
+* ImageDisplay: add the ability to display simple overlays on top of the images [[#38]]
+
+### API Breaking Changes
+
+* ImageDisplay: `image` assignment is now an `Option`, the JavaFX `null` is not accepted
+  * `imageDisplay.image = image` will need to be changed to `imageDisplay.setImage(image)` or `imageDisplay.image = Option(image)`
+  * `imageDisplay.image = null` will need to be changed to `imageDisplay.image = None`
+
+### Bug fixes
+
+* ImageDisplay: fix some issues with "zoom-to-fit" and "flip" applied at the same time
+
+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
+
+
+[#38]: https://github.com/scalafx/scalafx-extras/issues/31
+
+

project/build.properties

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2011-2024, ScalaFX Project
+# Copyright (c) 2011-2025, 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.10.3
+sbt.version=1.10.11
 

project/sbt-sonatype.sbt

@@ -1,3 +1,3 @@
 // [https://github.com/xerial/sbt-sonatype]
-addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "3.11.1")
-addSbtPlugin("com.github.sbt" % "sbt-pgp"      % "2.2.1")
+addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "3.12.2")
+addSbtPlugin("com.github.sbt" % "sbt-pgp"      % "2.3.1")

scalafx-extras-demos/src/main/scala/org/scalafx/extras/image/ImageDisplayDemoApp.scala

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2011-2024, ScalaFX Project
+ * Copyright (c) 2011-2025, ScalaFX Project
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -32,24 +32,29 @@ import org.scalafx.extras.ShowMessage
 import scalafx.Includes.*
 import scalafx.application.JFXApp3
 import scalafx.application.JFXApp3.PrimaryStage
+import scalafx.beans.property.BooleanProperty
 import scalafx.collections.ObservableBuffer
+import scalafx.geometry.Orientation.Horizontal
 import scalafx.scene.Scene
 import scalafx.scene.control.*
 import scalafx.scene.image.Image
 import scalafx.scene.layout.{BorderPane, FlowPane}
+import scalafx.scene.paint.Color
+import scalafx.scene.shape.Rectangle
 import scalafx.stage.FileChooser
 
 /**
  * Demonstrates use of `ImageDisplay` class.
  */
 object ImageDisplayDemoApp extends JFXApp3 {
 
-  private val rotationItems = ObservableBuffer(0, 90, 180, 270)
+  /** Show example ROI in the center of the Image */
+  private val showROI: BooleanProperty = BooleanProperty(value = false)
+  private val rotationItems            = ObservableBuffer(0, 90, 180, 270)
 
   override def start(): Unit = {
 
     val imageDisplay = new ImageDisplay()
-    //  private var roi: Option[Rectangle] = None
 
     stage = new PrimaryStage {
       scene = new Scene(640, 480) {
@@ -61,6 +66,7 @@ object ImageDisplayDemoApp extends JFXApp3 {
               new Button("Open...") {
                 onAction = () => onFileOpen()
               },
+              Separator(Horizontal),
               new Button("Zoom In") {
                 onAction = () => imageDisplay.zoomIn()
                 disable <== imageDisplay.zoomToFit
@@ -72,6 +78,7 @@ object ImageDisplayDemoApp extends JFXApp3 {
               new ToggleButton("Zoom to fit") {
                 selected <==> imageDisplay.zoomToFit
               },
+              Separator(Horizontal),
               new ToggleButton("Flip X") {
                 selected <==> imageDisplay.flipX
               },
@@ -83,6 +90,10 @@ object ImageDisplayDemoApp extends JFXApp3 {
                   imageDisplay.rotation = newValue
                 }
                 selectionModel().selectFirst()
+              },
+              Separator(Horizontal),
+              new ToggleButton("Show ROI") {
+                selected <==> showROI
               }
             )
           }
@@ -105,6 +116,33 @@ object ImageDisplayDemoApp extends JFXApp3 {
 
     //  setROI()
     // ---------------------------------------------------------------------------
+    showROI.onChange { (_, _, _) =>
+      updateROI()
+    }
+
+    def updateROI(): Unit = {
+      if (showROI())
+        imageDisplay.image() match {
+          case Some(im) =>
+            val w = im.width.value
+            val h = im.height.value
+            val roi = new Rectangle {
+              x = w / 4
+              y = h / 4 + h / 8
+              width = w / 2
+              height = h / 4
+              fill = Color(1, 1, 1, 0.5)
+              stroke = Color.Yellow
+              strokeWidth = 1
+            }
+            imageDisplay.overlays.value = Seq(roi)
+          case None =>
+            imageDisplay.overlays.value = Seq.empty[Rectangle]
+        }
+      else
+        imageDisplay.overlays.value = Seq.empty[Rectangle]
+      //      imageView.scaleY.value = if (newValue) -v else v
+    }
 
     /**
      * Let user select an image file and load it.
@@ -116,7 +154,8 @@ object ImageDisplayDemoApp extends JFXApp3 {
         try {
           val image = new Image("file:" + file.getCanonicalPath)
           if (!image.error()) {
-            imageDisplay.image() = image
+            imageDisplay.setImage(image)
+            updateROI()
           } else {
             image.exception().printStackTrace()
             ShowMessage.exception(
@@ -135,18 +174,8 @@ object ImageDisplayDemoApp extends JFXApp3 {
               t = ex,
               parentWindow = stage
             )
-
         }
       }
     }
-
-    //  private def setROI(): Unit = {
-    //    roi = roi match {
-    //      case Some(r) => None
-    //      case None => Some(Rectangle(278, 205, 37, 10))
-    //    }
-    //
-    //    imageDisplay.roi() = roi
-    //  }
   }
 }