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 Service[T] extends Worker[T] with EventTarget with EventHandlerDelegate with SFXDelegate[javafx.concurrent.Service[T]]

Wrapper trait for Service Class.

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

Instance Constructors

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

Type Members

  1. type EventHandled = AnyRef { ... /* 5 definitions in type refinement */ }

    Definition Classes
    EventHandlerDelegate
  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
    EventHandlerDelegate
  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
    EventHandlerDelegate

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
    EventHandlerDelegate
  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
    EventHandlerDelegate
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def buildEventDispatchChain(chain: EventDispatchChain): EventDispatchChain

    Construct an event dispatch chain for this target.

    Construct an event dispatch chain for this target.

    Definition Classes
    EventHandlerDelegate
  8. def cancel: Boolean

    Terminates execution of this Worker.

    Terminates execution of this Worker.

    Definition Classes
    Worker
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. val delegate: javafx.concurrent.Service[T]

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    Service → SFXDelegate
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. 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
  13. def eventHandlerDelegate: EventHandled

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

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

    Definition Classes
    Service → EventHandlerDelegate
  14. def exception: ReadOnlyObjectProperty[Throwable]

    Gets the ReadOnlyObjectProperty representing any exception which occurred.

    Gets the ReadOnlyObjectProperty representing any exception which occurred.

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

    The executor to use for running this Service.

  16. def executor_=(v: Executor): Unit
  17. 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
    EventHandlerDelegate
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. 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
    EventHandlerDelegate
  20. def hashCode(): Int

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def message: ReadOnlyStringProperty

    Gets the ReadOnlyStringProperty representing the message.

    Gets the ReadOnlyStringProperty representing the message.

    Definition Classes
    Worker
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def onCancelled: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

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

  27. def onCancelled_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
  28. def onFailed: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

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

  29. def onFailed_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
  30. def onReady: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

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

  31. def onReady_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
  32. def onRunning: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

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

  33. def onRunning_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
  34. def onScheduled: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

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

  35. def onScheduled_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
  36. def onSucceeded: ObjectProperty[EventHandler[javafx.concurrent.WorkerStateEvent]]

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

  37. def onSucceeded_=(v: EventHandler[javafx.concurrent.WorkerStateEvent]): Unit
  38. def progress: ReadOnlyDoubleProperty

    Gets the ReadOnlyDoubleProperty representing the progress.

    Gets the ReadOnlyDoubleProperty representing the progress.

    Definition Classes
    Worker
  39. 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
    EventHandlerDelegate
  40. 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
    EventHandlerDelegate
  41. def reset(): Unit

    Resets the Service.

  42. def restart(): Unit

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

  43. def running: ReadOnlyBooleanProperty

    Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

    Gets the ReadOnlyBooleanProperty representing whether the Worker is running.

    Definition Classes
    Worker
  44. def start(): Unit

    Starts this Service.

  45. def state: ReadOnlyObjectProperty[State]

    Gets the ReadOnlyObjectProperty representing the current state.

    Gets the ReadOnlyObjectProperty representing the current state.

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

    Gets the ReadOnlyStringProperty representing the title.

    Gets the ReadOnlyStringProperty representing the title.

    Definition Classes
    Worker
  48. def toString(): String

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  49. 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
  50. def value: ReadOnlyObjectProperty[T]

    Gets the ReadOnlyObjectProperty representing the value.

    Gets the ReadOnlyObjectProperty representing the value.

    Definition Classes
    Worker
  51. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  53. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. def workDone: ReadOnlyDoubleProperty

    Gets the ReadOnlyDoubleProperty representing the current progress.

    Gets the ReadOnlyDoubleProperty representing the current progress.

    Definition Classes
    Worker
  55. 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
    EventHandlerDelegate
  56. 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
    EventHandlerDelegate

Deprecated Value Members

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

Inherited from EventHandlerDelegate

Inherited from EventTarget

Inherited from Worker[T]

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

Inherited from AnyRef

Inherited from Any

Ungrouped