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 event

    Wraps javafx.event package.

    Wraps javafx.event package.

    Definition Classes
    scalafx
  • package subscriptions

    Definition Classes
    event
  • ActionEvent
  • Event
  • EventDispatchChain
  • EventDispatcher
  • EventHandler
  • EventHandlerDelegate1
  • EventHandlerDelegate2
  • EventIncludes
  • EventTarget
  • EventType
  • WeakEventHandler

object EventIncludes extends EventIncludes

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventIncludes
  2. EventIncludes
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. implicit def eventClosureWrapperWithParam[J <: javafx.event.Event, S <: SFXDelegate[J], R](handler: (S) => R)(implicit jfx2sfx: (J) => S): EventHandler[J]

    Converts a closure to a JavaFX EventHandler.

    Converts a closure to a JavaFX EventHandler. It is used when the event properties will be used.

    Enables following use:

    button.onAction = (e:ActionEvent) => {
      println("Handling button action: " + e)
      doSomething(e)
    }
    J

    JavaFX Event subclass.

    handler

    Closure that that takes scalafx.event.Event as argument.

    returns

    JavaFX EventHandler which handle method will call handler

    Definition Classes
    EventIncludes
  9. implicit def eventClosureWrapperWithZeroParam[T <: javafx.event.Event, R](handler: () => R): EventHandler[T]

    Converts a closure to a JavaFX EventHandler.

    Converts a closure to a JavaFX EventHandler. It is used when information about event is not be used.

    Enables following use:

     button.onAction = () => {
       println("Handling button action")
       doSomething()
    }
    T

    JavaFX Event subclass.

    handler

    Closure that will not handle event.

    returns

    JavaFX EventHandler which handle method will call handler

    Definition Classes
    EventIncludes
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. implicit def jfxActionEvent2sfx(ae: javafx.event.ActionEvent): ActionEvent

    Converts a javafx.event.ActionEvent instance to its ScalaFX counterpart.

    Converts a javafx.event.ActionEvent instance to its ScalaFX counterpart.

    ae

    JavaFX ActionEvent

    returns

    ScalaFX ActionEvent

    Definition Classes
    EventIncludes
  14. implicit def jfxEvent2sfx(e: javafx.event.Event): Event

    Converts a javafx.event.Event instance to its ScalaFX counterpart.

    Converts a javafx.event.Event instance to its ScalaFX counterpart.

    e

    JavaFX Event

    returns

    ScalaFX Event

    Definition Classes
    EventIncludes
  15. implicit def jfxEventDispatchChain2sfx(e: javafx.event.EventDispatchChain): EventDispatchChain
    Definition Classes
    EventIncludes
  16. implicit def jfxEventDispatcher2sfx(e: javafx.event.EventDispatcher): EventDispatcher
    Definition Classes
    EventIncludes
  17. implicit def jfxEventTarget2sfx(e: javafx.event.EventTarget): EventTarget
    Definition Classes
    EventIncludes
  18. implicit def jfxEventType2sfx[T <: javafx.event.Event](e: javafx.event.EventType[T]): EventType[T]

    Converts a javafx.event.EventType instance to its ScalaFX counterpart.

    Converts a javafx.event.EventType instance to its ScalaFX counterpart.

    T

    Event Type

    e

    JavaFX EventType

    returns

    ScalaFX EventType

    Definition Classes
    EventIncludes
  19. implicit def jfxWeakEventHandler2sfx[T <: javafx.event.Event](weh: javafx.event.WeakEventHandler[T]): WeakEventHandler[T]

    Converts a javafx.event.WeakEventHandler instance to its ScalaFX counterpart.

    Converts a javafx.event.WeakEventHandler instance to its ScalaFX counterpart.

    T

    Event Type

    weh

    JavaFX WeakEventHandler

    returns

    ScalaFX WeakEventHandler

    Definition Classes
    EventIncludes
    Since

    8.0

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  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()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def handle[J <: javafx.event.Event, R](handler: => R): EventHandler[J]

    NOTE: use of handle is deprecated in Scala 2.12 and newer, you can use standard Scala syntax:

    NOTE: use of handle is deprecated in Scala 2.12 and newer, you can use standard Scala syntax:

    button.onAction = _ => {
      println("Handling button action")
      doSomething()
    }

    For Scala 2.11 and older, you can use handle to create a simple event handler when information about event is not be used.

    Enables following use:

    button.onAction = handle {
      println("Handling button action")
      doSomething()
    }
    J

    JavaFX Event subclass.

    handler

    code executed when event is handled.

    returns

    JavaFX EventHandler which will wrap the input code handler.

    Definition Classes
    EventIncludes
    Annotations
    @deprecated
    Deprecated

    (Since version R19) Starting with Scala 2.12 handle{...} can be replaced with idiomatic Scala code _ => {...}

Inherited from EventIncludes

Inherited from AnyRef

Inherited from Any

Ungrouped