Packages

  • package root

    Helper methods and classes to simplify ScalaFX use.

    Helper methods and classes to simplify ScalaFX use.

    Package org.scalafx.extras contains basic helper methods for running tasks on threads and showing messages.

    Package org.scalafx.extras.image contains image display component with scrolling and zooming.

    Package org.scalafx.extras.mvcfx contains classes for creating with UI components based on FXML.

    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package scalafx
    Definition Classes
    org
  • package extras

    Helper methods for working with ScalaFX.

    Helper methods for working with ScalaFX.

    Definition Classes
    scalafx
  • package generic_pane
    Definition Classes
    extras
  • package image
    Definition Classes
    extras
  • package mvcfx

    Package mvcfx helps in implementation of Model-View-Controller-like patters, we call it MVCfx.

    Package mvcfx helps in implementation of Model-View-Controller-like patters, we call it MVCfx. The pattern is build around use of views defined in FXML (the view), with binding to ScalaFX using ScalaFXML library.

    There are two cooperating classes ControllerFX for binding FXML to Scala code and ModelFX that contains logic for the component. An additional helper MVCfx class is provided to instantiate the ControllerFX and the corresponding ModelFX.

    The structure of the UI component is defined in a standard JavaFX FXML file. The Scala side of the FXML is in a class ControllerFX. Part of the ControllerFX is automatically generated by ScalaFXML macro, the rest can be customized as needed, including binding of the UI to appropriate parts of the component logic represented by the ModelFX. Use of the MVCfx is optional and primarily intended to simplify instantiation of the ControllerFX and the ModelFX.

    Below is an example using the classes in mvcfx. The code implements a simple Stop Watch. The complete code is in demos part of the ScalaFX Extras project.

    Note the recommended naming convention used: * StopWatch extends MVCfx * StopWatchModel extends ModelFX * StopWatchController extends ControllerFX * StopWatch.fxml the FXVM declaration of the view

    First we have the FXML definitions representing the structure of the user interface (org/scalafx/extras/mvcfx/stopwatch/StopWatch.fxml)

    <?import javafx.geometry.Insets?>
    <?import javafx.scene.control.*?>
    <?import javafx.scene.layout.BorderPane?>
    <?import javafx.scene.layout.HBox?>
    <?import javafx.scene.text.*?>
    <BorderPane xmlns="http://javafx.com/javafx/8.0.65" xmlns:fx="http://javafx.com/fxml/1"
                fx:controller="org.scalafx.extras.mvcfx.stopwatch.StopWatchController">
        <bottom>
            <ButtonBar BorderPane.alignment="CENTER">
                <buttons>
                    <Button fx:id="startButton" mnemonicParsing="false" text="Start"/>
                    <Button fx:id="stopButton" mnemonicParsing="false" text="Stop"/>
                    <Button fx:id="resetButton" mnemonicParsing="false" text="Reset"/>
                </buttons>
            </ButtonBar>
        </bottom>
        <center>
            <HBox>
                <children>
                    <Label fx:id="minutesLabel" alignment="CENTER" contentDisplay="CENTER" text="99" textAlignment="CENTER"
                           BorderPane.alignment="CENTER">
                    </Label>
                    <Label text=":">
                    </Label>
                    <Label fx:id="secondsLabel" alignment="CENTER" contentDisplay="CENTER" text="99" textAlignment="CENTER">
                    </Label>
                    <Label text=".">
                    </Label>
                    <Label fx:id="fractionLabel" alignment="CENTER" contentDisplay="CENTER" text="99"
                           textAlignment="CENTER">
                    </Label>
                </children>
            </HBox>
        </center>
    </BorderPane>

    The ControllerFX creates connection of the FXML to Scala code and underlying ModelFX for the application logic. Note the @sfxml annotation and the constructor arguments corresponding to controls defined in FXML, like minutesLabel. The last argument to the constructor is the ModelFX. (org.scalafx.extras.mvcfx.stopwatch.StopWatchController)

    package org.scalafx.extras.mvcfx.stopwatch
    
    import org.scalafx.extras.mvcfx.ControllerFX
    
    import scalafx.Includes._
    import scalafx.scene.control.{Button, Label}
    import scalafxml.core.macros.sfxml
    
    @sfxml
    class StopWatchController(minutesLabel: Label,
                              secondsLabel: Label,
                              fractionLabel: Label,
                              startButton: Button,
                              stopButton: Button,
                              resetButton: Button,
                              model: StopWatchModel) extends ControllerFX {
    
      minutesLabel.text.value = format2d(model.minutes.longValue)
      model.minutes.onChange { (_, _, newValue) =>
        minutesLabel.text.value = format2d(newValue.longValue)
      }
      secondsLabel.text.value = format2d(model.seconds.longValue())
      model.seconds.onChange { (_, _, newValue) =>
        secondsLabel.text.value = format2d(newValue.longValue())
      }
      fractionLabel.text.value = format2d(model.secondFraction.longValue() / 10)
      model.secondFraction.onChange { (_, _, newValue) =>
        fractionLabel.text.value = format2d(newValue.longValue() / 10)
      }
    
      startButton.disable <== model.running
      stopButton.disable <== !model.running
      resetButton.disable <== model.running
    
      startButton.onAction = handle {
        model.onStart()
      }
      stopButton.onAction = handle {
        model.onStop()
      }
      resetButton.onAction = handle {
        model.onReset()
      }
    
      private def format2d(t: Number) = f"${t.longValue()}%02d"
    }

    The ModelFX implements the logic for the operation of the Stop Watch. Notice that there are no direct references to UI controls. The connection to the UI is through the properties (like minutes). The ModelFX is not aware how the ControllerFX is implemented. (org.scalafx.extras.mvcfx.stopwatch.StopWatchModel)

    package org.scalafx.extras.mvcfx.stopwatch
    
    import javafx.{concurrent => jfxc}
    
    import org.scalafx.extras._
    import org.scalafx.extras.mvcfx.ModelFX
    
    import scalafx.Includes._
    import scalafx.beans.property.{LongProperty, ReadOnlyBooleanProperty, ReadOnlyBooleanWrapper}
    
    class StopWatchModel extends ModelFX {
    
      private val _running = ReadOnlyBooleanWrapper(false)
    
      val running: ReadOnlyBooleanProperty = _running.readOnlyProperty
    
      private val counterService = new CounterService()
      counterService.period = 10.ms
    
      val minutes = new LongProperty()
      val seconds = new LongProperty()
      val secondFraction = new LongProperty()
    
      counterService.elapsedTime.onChange { (_, _, newValue) =>
        val t = newValue.longValue()
        secondFraction.value = t % 1000
        seconds.value = (t / 1000) % 60
        minutes.value = t / 1000 / 60
      }
    
      def onStart(): Unit = {
        counterService.doResume()
        _running.value = true
      }
    
      def onStop(): Unit = {
        counterService.doPause()
        _running.value = false
      }
    
      def onReset(): Unit = counterService.doReset()
    
      private class CounterService extends jfxc.ScheduledService[Long] {
    
        private var timeAccumulator: Long = 0
        private var restartTime: Long = 0
    
        val elapsedTime = new LongProperty()
    
        override def createTask(): jfxc.Task[Long] = {
          new jfxc.Task[Long]() {
            override protected def call(): Long = {
              val ct = System.currentTimeMillis()
              val et = timeAccumulator + (ct - restartTime)
              onFX {elapsedTime.value = et}
              et
            }
          }
        }
    
        def doPause(): Unit = {
          val ct = System.currentTimeMillis()
          timeAccumulator += (ct - restartTime)
          onFX {elapsedTime.value = timeAccumulator}
          this.cancel()
        }
    
        def doResume(): Unit = {
          restartTime = System.currentTimeMillis()
          this.restart()
        }
    
        def doReset(): Unit = {
          timeAccumulator = 0
          onFX {elapsedTime.value = 0}
        }
      }
    }

    The MVCfx implementation is very simple, it only needs instance of the model and information about location of the FXML resource. (org.scalafx.extras.mvcfx.stopwatch.StopWatch)

    package org.scalafx.extras.mvcfx.stopwatch
    
    import org.scalafx.extras.mvcfx.MVCfx
    
    class StopWatch(val model: StopWatchModel = new StopWatchModel())
      extends MVCfx("/org/scalafx/extras/mvcfx/stopwatch/StopWatchView.fxml")

    The MVCfx can be easily used in an Application class to create UI. (org.scalafx.extras.mvcfx.stopwatch.StopWatchApp)

    package org.scalafx.extras.mvcfx.stopwatch
    
    import scala.language.implicitConversions
    import scalafx.application.JFXApp3
    import scalafx.application.JFXApp3.PrimaryStage
    import scalafx.scene.Scene
    import scalafx.scene.layout.BorderPane
    
    object StopWatchApp extends JFXApp3 {
      override def start(): Unit = {
        stage = new PrimaryStage {
          scene = new Scene {
            title = "StopWatch"
            root = new BorderPane {
              center = new StopWatch().view
            }
          }
        }
      }
    }
    Definition Classes
    extras
  • package pong
    Definition Classes
    extras
  • BusyWorker
  • ShowMessage
  • ShowMessageLogger

trait ShowMessage extends AnyRef

Mixin that adds ability to easily show message dialogs. A messageLogger can be provided, so when the error or warning dialogs are shown, they are also logged.

A ShowMessage mixin will typically be used with the ModelFX.

Source
ShowMessage.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShowMessage
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def parentWindow: Option[Window]

    Parent window for a dialog.

    Parent window for a dialog. Dialogs are shown modal, the window will be blocked while dialog is displayed.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def messageLogger: Option[ShowMessageLogger]

    Logger to use for error and warning dialogs.

    Logger to use for error and warning dialogs.

    Attributes
    protected
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def showConfirmation(title: String, header: String, content: String = ""): Boolean

    Show a confirmation dialog with "OK" and "Cancel" buttons.

    Show a confirmation dialog with "OK" and "Cancel" buttons.

    title

    dialog title.

    header

    header text.

    content

    content text.

    returns

    true when user selected 'OK' and false when user selected Cancel or dismissed the dialog.

  17. def showConfirmationYesNoCancel(title: String, header: String, content: String = ""): Option[Boolean]

    Show a confirmation dialog with "OK", "No", and "Cancel" buttons.

    Show a confirmation dialog with "OK", "No", and "Cancel" buttons.

    title

    dialog title.

    header

    header text.

    content

    content text.

    returns

    Some(true) when user selected 'OK', Some(false) when user selected No, and None user selected Cancel or dismissed the dialog.

  18. def showError(title: String, header: String, content: String = ""): Unit

    Show error dialog

    Show error dialog

    title

    dialog title

    header

    header text.

    content

    main content text.

  19. def showException(title: String, message: String, t: Throwable): Unit

    Displays error dialog with expandable exception information.

    Displays error dialog with expandable exception information.

    title

    Dialog title

    message

    Message (excluding t.getMessage(), it is automatically displayed)

    t

    exception to be displayed in the dialog

  20. def showInformation(title: String, header: String, content: String, resizable: Boolean = false): Unit

    Show information dialog

    Show information dialog

    title

    dialog title

    header

    header text.

    content

    main content text.

  21. def showWarning(title: String, header: String, content: String): Unit

    Show warning dialog

    Show warning dialog

    title

    dialog title

    header

    header text.

    content

    main content text.

  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped