Packages

  • package root

    ScalaFX is a UI DSL written within the Scala Language that sits on top of JavaFX 2.x and and JavaFX 8.

    ScalaFX is a UI DSL written within the Scala Language that sits on top of JavaFX 2.x and and JavaFX 8. This means that every ScalaFX application is also a valid Scala application. By extension it supports full interoperability with Java and can run anywhere the Java Virtual Machine (JVM) and JavaFX 2.0 or JavaFX 8 are supported.

    Package Structure

    ScalaFX package structure corresponds to JavaFX package structure, for instance scalafx.animation corresponds to javafx.animation.

    Example Usage

    A basic ScalaFX application is created creating an object that is an instance of JFXApp. Following Java FX theatre metaphor, it contains a stage that contains a scene. A stage roughly corresponds to a window in a typical UI environment. The scene holds UI content presented to the user. In the example below, the content is a pane with a single label component.

    package hello

import scalafx.application.JFXApp
import scalafx.application.JFXApp.PrimaryStage
import scalafx.geometry.Insets
import scalafx.scene.Scene
import scalafx.scene.control.Label
import scalafx.scene.layout.BorderPane

object HelloWorld extends JFXApp {
  stage = new PrimaryStage {
    title = "Hello"
    scene = new Scene {
      root = new BorderPane {
        padding = Insets(25)
        center = new Label("Hello World")
      }
    }
  }
}
    Definition Classes
    root
  • package scalafx

    Base package for ScalaFX classes.

    Base package for ScalaFX classes.

    Definition Classes
    root
  • package concurrent

    Wraps javafx.concurrent package.

    Wraps javafx.concurrent package.

    Definition Classes
    scalafx
  • ConcurrentIncludes
  • ScheduledService
  • Service
  • Task
  • Worker
  • WorkerStateEvent

abstract class ScheduledService[T] extends Service[T] with SFXDelegate[javafx.concurrent.ScheduledService[T]]

Wrapper class for ScheduledService Class.

Source
ScheduledService.scala
Linear Supertypes
Service[T], EventHandlerDelegate2, EventTarget, Worker[T], SFXDelegate[javafx.concurrent.ScheduledService[T]], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScheduledService
  2. Service
  3. EventHandlerDelegate2
  4. EventTarget
  5. Worker
  6. SFXDelegate
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ScheduledService(delegate: javafx.concurrent.ScheduledService[T])

Type Members

  1. trait EventHandled extends AnyRef

    Trait used for handle events manipulation.

    Trait used for handle events manipulation. JavaFX class wrapped must have methods defined in scalafx.event.EventHandlerDelegate2.EventHandled Type:

    def addEventHandler   [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def removeEventHandler[E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def addEventFilter    [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def removeEventFilter [E <: jfxe.Event](eventType: jfxe.EventType[E], eventHandler: jfxe.EventHandler[_ >: E])
def buildEventDispatchChain(chain: jfxe.EventDispatchChain): jfxe.EventDispatchChain
    Definition Classes
    EventHandlerDelegate2
  2. sealed trait FilterMagnet[J <: javafx.event.Event, S <: SFXDelegate[J]] extends AnyRef

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate2
  3. sealed trait HandlerMagnet[J <: javafx.event.Event, S <: SFXDelegate[J]] extends AnyRef

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Trait implementing Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate2

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. def addEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Registers an event filter to this task.

    Registers an event filter to this task. Registered event filters get an event before any associated event handlers.

    E

    Event class

    eventType

    the type of the events to receive by the filter

    eventHandler

    the filter to register that will filter event

    Definition Classes
    EventHandlerDelegate2
  5. def addEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Registers an event handler to this task.

    Registers an event handler to this task. Any event filters are first processed, then the specified onFoo event handlers, and finally any event handlers registered by this method. As with other events in the scene graph, if an event is consumed, it will not continue dispatching.

    E

    Event class

    eventType

    the type of the events to receive by the handler

    eventHandler

    the handler to register that will manipulate event

    Definition Classes
    EventHandlerDelegate2
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def backoffStrategy: ObjectProperty[Callback[javafx.concurrent.ScheduledService[_], Duration]]

    Computes the amount of time to add to the period on each failure.

  8. def backoffStrategy_=(v: Callback[javafx.concurrent.ScheduledService[_], Duration]): Unit
  9. def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

    Construct an event dispatch chain for this target.

    Construct an event dispatch chain for this target.

    Definition Classes
    EventHandlerDelegate2
  10. def cancel: Boolean

    Terminates execution of this Worker.

    Terminates execution of this Worker.

    Definition Classes
    Worker
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  12. def cumulativePeriod: ReadOnlyObjectProperty[Duration]

    The current cumulative period in use between iterations.

  13. def currentFailureCount: ReadOnlyIntegerProperty

    The current number of times the ScheduledService has failed.

  14. def delay: ObjectProperty[Duration]

    The initial delay between when the ScheduledService is first started, and when it will begin operation.

  15. def delay_=(v: Duration): Unit
  16. val delegate: javafx.concurrent.ScheduledService[T]

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    ScheduledService → Service → SFXDelegate
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(ref: Any): Boolean

    Verifies if a object is equals to this delegate.

    Verifies if a object is equals to this delegate.

    ref

    Object to be compared.

    returns

    if the other object is equals to this delegate or not.

    Definition Classes
    SFXDelegate → AnyRef → Any
  19. def eventHandlerDelegate: EventHandled

    Returns a object that implements scalafx.event.EventHandlerDelegate2.EventHandled.

    Returns a object that implements scalafx.event.EventHandlerDelegate2.EventHandled.

    Definition Classes
    Service → EventHandlerDelegate2
  20. def exception: ReadOnlyObjectProperty[Throwable]

    Gets the ReadOnlyObjectProperty representing any exception which occurred.

    Gets the ReadOnlyObjectProperty representing any exception which occurred.

    Definition Classes
    Worker
  21. def executor: ObjectProperty[Executor]

    The executor to use for running this Service.

    The executor to use for running this Service.

    Definition Classes
    Service
  22. def executor_=(v: Executor): Unit
    Definition Classes
    Service
  23. def filterEvent[J <: Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(filter: FilterMagnet[J, S]): Subscription

    Registers an event filter.

    Registers an event filter. Registered event filters get an event before any associated event handlers.

    Example of filtering mouse events

    pane.filterEvent(MouseEvent.Any) {
  me: MouseEvent => {
    me.eventType match {
      case MouseEvent.MousePressed => {
        ...
      }
      case MouseEvent.MouseDragged => {
        ...
      }
      case _ => {
        ...
      }
    }
  }
}

    or

    pane.filterEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
    J

    type JavaFX delegate of the event

    S

    ScalaFX type for J type wrapper.

    eventType

    type of events that will be handled.

    filter

    code handling the event, see examples above.

    Definition Classes
    EventHandlerDelegate2
  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def handleEvent[J <: Event, S <: Event with SFXDelegate[J]](eventType: EventType[J])(handler: HandlerMagnet[J, S]): Subscription

    Registers an event handler.

    Registers an event handler. The handler is called when the node receives an Event of the specified type during the bubbling phase of event delivery.

    Example of handling mouse events

    pane.handleEvent(MouseEvent.Any) {
  me: MouseEvent => {
    me.eventType match {
      case MouseEvent.MousePressed => ...
      case MouseEvent.MouseDragged => ...
      case _                       => {}
    }
  }
}

    or

    pane.handleEvent(MouseEvent.Any) { () => println("Some mouse event handled") }
    J

    type JavaFX delegate of the event

    S

    ScalaFX type for J type wrapper.

    eventType

    type of events that will be handled.

    handler

    code handling the event, see examples above.

    returns

    Returns a subscription that can be used to cancel/remove this event handler

    Definition Classes
    EventHandlerDelegate2
  26. def hashCode(): Int

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def lastValue: ReadOnlyObjectProperty[T]

    The last successfully computed value.

  29. def maximumCumulativePeriod: ObjectProperty[Duration]

    The maximum allowed value for the cumulativePeriod.

  30. def maximumCumulativePeriod_=(v: Duration): Unit
  31. def maximumFailureCount: IntegerProperty

    The maximum number of times the ScheduledService can fail before it simply ends in the FAILED state.

  32. def maximumFailureCount_=(v: Int): Unit
  33. def message: ReadOnlyStringProperty

    Gets the ReadOnlyStringProperty representing the message.

    Gets the ReadOnlyStringProperty representing the message.

    Definition Classes
    Worker
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. def onCancelled: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    The onCancelled event handler is called whenever the Task state transitions to the CANCELLED state.

    The onCancelled event handler is called whenever the Task state transitions to the CANCELLED state.

    Definition Classes
    Service
  38. def onCancelled_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
    Definition Classes
    Service
  39. def onFailed: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    The onFailed event handler is called whenever the Task state transitions to the FAILED state.

    The onFailed event handler is called whenever the Task state transitions to the FAILED state.

    Definition Classes
    Service
  40. def onFailed_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
    Definition Classes
    Service
  41. def onReady: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    The onReady event handler is called whenever the Task state transitions to the READY state.

    The onReady event handler is called whenever the Task state transitions to the READY state.

    Definition Classes
    Service
  42. def onReady_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
    Definition Classes
    Service
  43. def onRunning: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    The onRunning event handler is called whenever the Task state transitions to the RUNNING state.

    The onRunning event handler is called whenever the Task state transitions to the RUNNING state.

    Definition Classes
    Service
  44. def onRunning_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
    Definition Classes
    Service
  45. def onScheduled: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    The onSchedule event handler is called whenever the Task state transitions to the SCHEDULED state.

    The onSchedule event handler is called whenever the Task state transitions to the SCHEDULED state.

    Definition Classes
    Service
  46. def onScheduled_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
    Definition Classes
    Service
  47. def onSucceeded: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

    The onSucceeded event handler is called whenever the Task state transitions to the SUCCEEDED state.

    The onSucceeded event handler is called whenever the Task state transitions to the SUCCEEDED state.

    Definition Classes
    Service
  48. def onSucceeded_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
    Definition Classes
    Service
  49. def period: ObjectProperty[Duration]

    The minimum amount of time to allow between the start of the last run and the start of the next run.

  50. def period_=(v: Duration): Unit
  51. def progress: ReadOnlyDoubleProperty

    Gets the ReadOnlyDoubleProperty representing the progress.

    Gets the ReadOnlyDoubleProperty representing the progress.

    Definition Classes
    Worker
  52. def removeEventFilter[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Unregisters a previously registered event filter from this task.

    Unregisters a previously registered event filter from this task. One filter might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the filter.

    E

    Event class

    eventType

    the event type from which to unregister

    eventHandler

    the filter to unregister

    Definition Classes
    EventHandlerDelegate2
  53. def removeEventHandler[E <: Event](eventType: EventType[E], eventHandler: EventHandler[_ >: E]): Unit

    Unregisters a previously registered event handler from this task.

    Unregisters a previously registered event handler from this task. One handler might have been registered for different event types, so the caller needs to specify the particular event type from which to unregister the handler.

    E

    Event class

    eventType

    the event type from which to unregister

    eventHandler

    the handler to unregister

    Definition Classes
    EventHandlerDelegate2
  54. def reset(): Unit

    Resets the Service.

    Resets the Service.

    Definition Classes
    Service
  55. def restart(): Unit

    Cancels any currently running Task, if any, and restarts this Service.

    Cancels any currently running Task, if any, and restarts this Service.

    Definition Classes
    Service
  56. def restartOnFailure: BooleanProperty

    Indicates whether the ScheduledService should automatically restart in the case of a failure in the Task.

  57. def restartOnFailure_=(v: Boolean): Unit
  58. def running: ReadOnlyBooleanProperty

    Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

    Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

    Definition Classes
    Worker
  59. def start(): Unit

    Starts this Service.

    Starts this Service.

    Definition Classes
    Service
  60. def state: ReadOnlyObjectProperty[State]

    Gets the ReadOnlyObjectProperty representing the current state.

    Gets the ReadOnlyObjectProperty representing the current state.

    Definition Classes
    Worker
  61. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  62. def title: ReadOnlyStringProperty

    Gets the ReadOnlyStringProperty representing the title.

    Gets the ReadOnlyStringProperty representing the title.

    Definition Classes
    Worker
  63. def toString(): String

    returns

    Returns the original delegate's toString() adding a [SFX] prefix.

    Definition Classes
    SFXDelegate → AnyRef → Any
  64. def totalWork: ReadOnlyDoubleProperty

    Gets the ReadOnlyDoubleProperty representing the maximum amount of work that needs to be done.

    Gets the ReadOnlyDoubleProperty representing the maximum amount of work that needs to be done.

    Definition Classes
    Worker
  65. def value: ReadOnlyObjectProperty[T]

    Gets the ReadOnlyObjectProperty representing the value.

    Gets the ReadOnlyObjectProperty representing the value.

    Definition Classes
    Worker
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. def workDone: ReadOnlyDoubleProperty

    Gets the ReadOnlyDoubleProperty representing the current progress.

    Gets the ReadOnlyDoubleProperty representing the current progress.

    Definition Classes
    Worker
  70. object FilterMagnet

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate2
  71. object HandlerMagnet

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Companion object implementing Magnet Pattern Magnet Pattern to avoid compilation error "ambiguous reference to overloaded definition"

    Definition Classes
    EventHandlerDelegate2

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Service[T]

Inherited from EventHandlerDelegate2

Inherited from EventTarget

Inherited from Worker[T]

Inherited from SFXDelegate[javafx.concurrent.ScheduledService[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped