Packages

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.

Definition Classes: root

package animation

Wraps javafx.animation package.

Definition Classes: scalafx

package application

Wraps javafx.application package.

Definition Classes: scalafx

package beans

Wraps javafx.beans package.

Definition Classes: scalafx

package collections

Wraps javafx.collections package, adding Scala's collections features to original JavaFX collections.

Definition Classes: scalafx

package concurrent

Wraps javafx.concurrent package.

Definition Classes: scalafx

package css

Wraps javafx.css package.

Definition Classes: scalafx
Since: 8.0

package delegate

Contains traits and objects to help to wrap JavaFx classes in their equivalent ScalaFX classes/traits.

Definition Classes: scalafx

package embed

Definition Classes: scalafx

package event

Wraps javafx.event package.

Definition Classes: scalafx

package geometry

Wraps javafx.geometry package.

Definition Classes: scalafx

package print

Wraps javafx.print package.

Definition Classes: scalafx
Since: 8.0

package scene

Wraps javafx.scene package.

Definition Classes: scalafx

package stage

Wraps javafx.stage package.

Definition Classes: scalafx

package util

Wraps javafx.util package.

Definition Classes: scalafx

scalafx

stage

package stage

Wraps javafx.stage package.

Source: package.scala

Linear Supertypes

AnyRef, Any

Content Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

stage
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

class DirectoryChooser extends SFXDelegate[javafx.stage.DirectoryChooser]

class FileChooser extends SFXDelegate[javafx.stage.FileChooser]

Provides support for standard platform file dialogs.

Provides support for standard platform file dialogs. These dialogs have look and feel of the platform UI components which is independent of JavaFX.

Example:

val fileChooser = new FileChooser {
 title = "Open Resource File"
 extensionFilters ++= Seq(
   new ExtensionFilter("Text Files", "*.txt"),
   new ExtensionFilter("Image Files", Seq("*.png", "*.jpg", "*.gif")),
   new ExtensionFilter("Audio Files", Seq("*.wav", "*.mp3", "*.aac")),
   new ExtensionFilter("All Files", "*.*")
 )
}
val selectedFile = fileChooser.showOpenDialog(stage)
if (selectedFile != null) {
 stage.display(selectedFile);
}

sealed abstract class Modality extends SFXEnumDelegate[javafx.stage.Modality]
Wraps javafx.stage.Modality.
class Popup extends PopupWindow with SFXDelegate[javafx.stage.Popup]
abstract class PopupWindow extends Window with SFXDelegate[javafx.stage.PopupWindow]
class Screen extends SFXDelegate[javafx.stage.Screen]
class Stage extends Window with SFXDelegate[javafx.stage.Stage]
The primary stage for your application has to be created by wrapping the JFXApp.STAGE object.
The primary stage for your application has to be created by wrapping the JFXApp.STAGE object.
```
stage = new JFXApp.PrimaryStage {
// your definitions
}
```
Any further stage would be simply instantiated by the no-arg constructor.
trait StageIncludes extends AnyRef
Contains implcit methods to convert from javafx.stage Classes/Traits to their ScalaFX counterparts.
sealed abstract class StageStyle extends SFXEnumDelegate[javafx.stage.StageStyle]
Wraps http://docs.oracle.com/javase/8/javafx/api/javafx/stage/StageStyle.html
class Window extends EventHandlerDelegate with SFXDelegate[javafx.stage.Window] with EventTarget
class WindowEvent extends Event with SFXDelegate[javafx.stage.WindowEvent]

Value Members

object DirectoryChooser
object FileChooser
object Modality extends SFXEnumDelegateCompanion[javafx.stage.Modality, Modality]
Wrapper for javafx.stage.Modality
object Popup
object PopupWindow
object Screen
object Stage
object StageIncludes extends StageIncludes
object StageStyle extends SFXEnumDelegateCompanion[javafx.stage.StageStyle, StageStyle]
object Window
object WindowEvent

Packages

Package Structure

Example Usage

stage

package stage

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Package Structure

Example Usage

stage

package stage

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

stage