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 scene

    Wraps javafx.scene package.

    Wraps javafx.scene package.

    Definition Classes
    scalafx
  • package image

    Wraps javafx.scene.image package.

    Wraps javafx.scene.image package.

    Definition Classes
    scene
  • Image
  • ImageIncludes
  • ImageView
  • PixelFormat
  • PixelReader
  • PixelWriter
  • WritableImage
  • WritablePixelFormat

class Image extends SFXDelegate[javafx.scene.image.Image]

Source
Image.scala
Linear Supertypes
SFXDelegate[javafx.scene.image.Image], AnyRef, Any
Known Subclasses
WritableImage
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Image
  2. SFXDelegate
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Image(that: AnyRef, imagePath: String)

  2. new Image(url: String, requestedWidth: Double, requestedHeight: Double, preserveRatio: Boolean, smooth: Boolean, backgroundLoading: Boolean)

    Construct a new Image with the specified parameters.

  3. new Image(url: String, requestedWidth: Double, requestedHeight: Double, preserveRatio: Boolean, smooth: Boolean)

    Construct a new Image with the specified parameters.

  4. new Image(url: String, backgroundLoading: Boolean)

    Construct a new Image with the specified parameters.

  5. new Image(url: String)

    Construct an Image which pixels are loaded from the specified url.

  6. new Image(inputStream: InputStream, requestedWidth: Double, requestedHeight: Double, preserveRatio: Boolean, smooth: Boolean)

    Construct a new Image with the specified parameters.

  7. new Image(inputStream: InputStream)

    Construct an Image which pixels are loaded from the specified input stream.

  8. new Image(delegate: javafx.scene.image.Image)

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 backgroundLoading: Boolean

    Indicates whether the image is being loaded in the background.

  6. def cancel(): Unit

    Cancels the background loading of this image.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. val delegate: javafx.scene.image.Image

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    Image → SFXDelegate
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. 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
  11. def error: ReadOnlyBooleanProperty

    Indicates whether an error was detected while loading an image.

  12. def exception: ReadOnlyObjectProperty[Exception]

    The exception which caused image loading to fail.

  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hashCode(): Int

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  15. def height: ReadOnlyDoubleProperty

    The image height or 0 if the image loading fails.

  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def pixelReader: Option[PixelReader]

    This method returns a Option of scalafx.scene.image.PixelReader that provides access to read the pixels of the image, if the image is readable.

  21. def preserveRatio: Boolean

    Indicates whether to preserve the aspect ratio of the original image when scaling to fit the image within the bounding box provided by width and height.

  22. def progress: ReadOnlyDoubleProperty

    The approximate percentage of image's loading that has been completed.

  23. def smooth: Boolean

    Indicates whether to use a better quality filtering algorithm or a faster one when scaling this image to fit within the bounding box provided by width and height.

  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. def width: ReadOnlyDoubleProperty

    The image width or 0 if the image loading fails.

Deprecated Value Members

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

Inherited from SFXDelegate[javafx.scene.image.Image]

Inherited from AnyRef

Inherited from Any

Ungrouped