Sapphire

A JavaFX Application Framework for Scala User.

Version

Actual Version is 0.9.1.

Scala Version is 2.11.1.

Licence

Apache 2 License.

Technology Stack

Java / JDK 1.8

Sapphire runs agains the latest JDK 8 version.

JavaFX

Java UI Application Framework as replacement for Swing.

Sapphire depends on JavaFX 8, which is included in JDK 8.

http://www.oracle.com/technetwork/java/javafx/overview/index.html

ScalaFX

A DSL for JavaFX written in Scala.

https://code.google.com/p/scalafx/

FXML support by scalafxml.

[https://github.com/vigoo/scalafxml/] (https://github.com/vigoo/scalafxml)

(Optional - you have to import additional libs)

Dependency Injection

Sapphire use Apache Deltaspike as CDI Abstraction Layer.

http://deltaspike.apache.org

The default implementation depends on Apache OpenWebBeans.

http://openwebbeans.apache.org

Expression Language

Expressions are resolved by JUEL.

http://juel.sourceforge.net

Features

Application Environment powered by CDI

Application Controller
UI Controller loading
Parameter Provider
Configuration Provider
FXML Loading

Bean Enhancement

Every Java / Scala Bean can be used for FXBean
FXBean has additional support for java/scala Maps
FXBean resolves Expressions on bean
FXBean creates Properties needed for Binding on demand
FXBean has change management by default

Scala JavaFX Bean Binding

Bindings by form id
Binding with converter
Adapter Pattern (FXBean Adapter)

ViewController

Controller Lifecycle
Node Locator
Controller CDI Additions

FXML Support

Simple load from controller
Value Factory for using expressions inside fxml
Support for scalafxml with @sfxml annotations

TODO

Documentation !
g8 template
automatic binding for more node types (currently: Label, TextField, TextArea, CheckBox)

maven

Sapphire use a github repository for maven.

https://github.com/sfxcode/mvn-repo

sbt build snippet

crossScalaVersions := Seq("2.11.0")

// optional - needed for macro support with scalafxml
// addCompilerPlugin("org.scalamacros" % "paradise" % "2.0.0" cross CrossVersion.full)

resolvers ++= Seq(
  "sfxcode-releases" at "https://raw.github.com/sfxcode/mvn-repo/master/releases",
  "sfxcode-snapshots" at "https://raw.github.com/sfxcode/mvn-repo/master/snapshots"
)

libraryDependencies +=   "com.sfxcode.sapphire" %% "sapphire-core" % "0.9.1"

// optional - controls framework

// libraryDependencies +=   "com.sfxcode.sapphire" %% "sapphire-control" % "0.9.1"

// optional - recompiled macros for 2.11

// libraryDependencies += "org.scalafx" % "scalafxml-core_2.10" % "0.1" intransitive()

// libraryDependencies += "com.sfxcode.scalafxml" %% "scalafxml-core-macros" % "0.3.0" intransitive()

Demos

Demos can be found under sapphire-demo on github.

swhgoon / sapphire-core