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 JFXApp3. 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.JFXApp3
import scalafx.geometry.Insets
import scalafx.scene.Scene
import scalafx.scene.control.Label
import scalafx.scene.layout.BorderPane

object HelloWorld extends JFXApp3 {

  override def start(): Unit = {
    stage = new JFXApp3.PrimaryStage {
      title = "Hello"
      scene = new Scene {
        root = new BorderPane {
          padding = Insets(75)
          center = new Label("Hello World")
        }
      }
    }
  }
}
    Definition Classes
    root
  • package scalafx

    Base package for ScalaFX classes.

    Base package for ScalaFX classes.

    Definition Classes
    root
  • package beans

    Wraps javafx.beans package.

    Wraps javafx.beans package.

    Definition Classes
    scalafx
  • package value

    Wraps javafx.beans.value package.

    Wraps javafx.beans.value package.

    Individual JavaFX Observable*Value are implemented as specializations of ObservableValue, generated by implicit conversions.

    Definition Classes
    beans
  • ObservableValue

trait ObservableValue[T, J] extends Observable with SFXDelegate[javafx.beans.value.ObservableValue[J]]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ObservableValue
  2. Observable
  3. SFXDelegate
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def delegate: javafx.beans.value.ObservableValue[J]

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    SFXDelegate
  2. abstract def value: T

    Returns ObservableValue

    Returns ObservableValue

    returns

    ObservableValue

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. def apply(): T

    Returns ObservableValue

    Returns ObservableValue

    returns

    ObservableValue

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. 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
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. def onChange[J1 >: J](op: ⇒ Unit): Subscription

    Adds a function as a ChangeListener.

    Adds a function as a ChangeListener. This function has no arguments because it will not handle values changed.

    op

    A Function with no arguments. It will be called when value changes.

    returns

    A new scalafx.event.subscriptions.Subscription to remove ObservableValue.

  16. def onChange[J1 >: J](op: (ObservableValue[T, J], J1, J1) ⇒ Unit): Subscription

    Adds a function as a ChangeListener.

    Adds a function as a ChangeListener. This function has all arguments from T, T) changed method from ChangeListener.

    J1

    J superclass.

    op

    Function that receives a ObservableValue, the old value and the new value. It will be called when value changes.

    returns

    A new scalafx.event.subscriptions.Subscription to remove ObservableValue.

  17. def onInvalidate(op: ⇒ Unit): Subscription

    Adds a no argument function as a JavaFX InvalidationListener.

    Adds a no argument function as a JavaFX InvalidationListener. This function has no arguments because it will not handle invalidated values.

    op

    A Function with no arguments. It will be called when value was invalidated.

    returns

    A new scalafx.event.subscriptions.Subscription to remove JavaFX InvalidationListener.

    Definition Classes
    Observable
  18. def onInvalidate(op: (Observable) ⇒ Unit): Subscription

    Adds a function as a JavaFX InvalidationListener.

    Adds a function as a JavaFX InvalidationListener. This function has all arguments from invalidated method from InvalidationListener.

    op

    Function that receives a ScalaFX Observable. It will be called when value was invalidated.

    returns

    A new scalafx.event.subscriptions.Subscription to remove JavaFX InvalidationListener.

    Definition Classes
    Observable
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. def when(condition: ObservableValue[Boolean, Boolean]): ObservableValue[J, J]

    Returns an ObservableValue that holds this value and is updated only when condition holds true.

    Returns an ObservableValue that holds this value and is updated only when condition holds true.

    The returned ObservableValue only observes this value when condition holds true. This allows this ObservableValue and the conditional ObservableValue to be garbage collected if neither is otherwise strongly referenced when condition holds false. This is in contrast to the general behavior of bindings, where the binding is only eligible for garbage collection when not observed itself.

    A condition holding null is treated as holding false.

    For example:

    val condition         = BooleanProperty(true)
val longLivedProperty = StringProperty("A")
val whenProperty      = longLivedProperty.when(condition)

// observe whenProperty, which will in turn observe longLivedProperty
whenProperty.onChange((_, old, current) => println(s"whenProperty change : $old -> $current"));

longLivedProperty.value = "B" // "B" is printed

condition.value = false

// After condition becomes false, whenProperty stops observing longLivedProperty; condition
// and whenProperty may now be eligible for GC despite being observed by the ChangeListener
longLivedProperty.value = "C" // nothing is printed
longLivedProperty.value = "D" // nothing is printed

condition.value = true // longLivedProperty is observed again, and "D" is printed
    condition

    a boolean ObservableValue, cannot be null

    returns

    an ObservableValue that holds this value whenever the given condition evaluates to true, otherwise holds the last seen value; never returns null

    Since

    20

Deprecated Value Members

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

Inherited from Observable

Inherited from SFXDelegate[javafx.beans.value.ObservableValue[J]]

Inherited from AnyRef

Inherited from Any

Ungrouped