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 text

    Wraps javafx.scene.text package.

    Wraps javafx.scene.text package.

    Definition Classes
    scene
  • Font
  • FontPosture
  • FontSmoothingType
  • FontWeight
  • Text
  • TextAlignment
  • TextBoundsType
  • TextFlow
  • TextIncludes

object Font

Source
Font.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Font
  2. AnyRef
  3. 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. def apply(family: String, weight: javafx.scene.text.FontWeight, posture: javafx.scene.text.FontPosture, size: Double): Font
  5. def apply(family: String, weight: javafx.scene.text.FontWeight, size: Double): Font
  6. def apply(family: String, posture: javafx.scene.text.FontPosture, size: Double): Font
  7. def apply(family: String, size: Double): Font
  8. def apply(family: String): Font
  9. def apply(size: Double): Font
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  12. def default: Font

    Gets the default font which will be from the family "System", and typically the style "Regular", and be of a size consistent with the user's desktop environment, to the extent that can be determined.

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def families: Buffer[String]

    Gets all the font families installed on the user's system, including any application fonts or SDK fonts.

  16. def font(family: String, weight: javafx.scene.text.FontWeight, posture: javafx.scene.text.FontPosture, size: Double): Font

    Searches for an appropriate font based on the font family name and weight and posture style.

  17. def font(family: String, weight: javafx.scene.text.FontWeight, size: Double): Font

    Searches for an appropriate font based on the font family name and weight style.

  18. def font(family: String, posture: javafx.scene.text.FontPosture, size: Double): Font

    Searches for an appropriate font based on the font family name and posture style.

  19. def font(family: String, size: Double): Font

    Searches for an appropriate font based on the font family name and size.

  20. def font(family: String): Font

    Searches for an appropriate font based on the given font family name and default font size.

  21. def font(size: Double): Font

    Searches for an appropriate font based on the default font family name and given font size.

  22. def fontNames(family: String): Buffer[String]

    Gets the names of all fonts in the specified font family that are installed on the users system, including any application fonts and SDK fonts.

  23. def fontNames: Buffer[String]

    Gets the names of all fonts that are installed on the users system, including any application fonts and SDK fonts.

  24. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def loadFont(urlStr: String, size: Double): Font

    Loads a font resource from the specified URL.

  28. def loadFont(in: InputStream, size: Double): Font

    Loads a font resource from the specified input stream.

  29. def loadFonts(in: InputStream, size: Double): Seq[javafx.scene.text.Font]

    Loads font resources from the specified input stream.

    Loads font resources from the specified input stream. If the load is successful such that the stream can be fully read, and it represents a supported font format then an array of Font will be returned.

    The use case for this method is for loading all fonts from a TrueType Collection (TTC).

    If a security manager is present, the application must have the javafx.util.FXPermission "loadFont". If the application does not have permission then this method will return the default system font with the specified font size.

    Any failure such as abbreviated input, or an unsupported font format will result in a null return. It is the application's responsibility to check this before use.

    On a successful (non-null) return the fonts will be registered with the FX graphics system for creation by available constructors and factory methods, and the application should use it in this manner rather than calling this method again, which would repeat the overhead of re-reading and installing the fonts.

    The font size parameter is a convenience so that in typical usage the application can directly use the returned (non-null) fonts rather than needing to re-create via a constructor. Invalid sizes are those <=0 and will result in a default size.

    This method does not close the input stream.

    in

    stream from which to load the fonts.

    size

    of the returned fonts.

    returns

    array of Font, or null if the fonts cannot be created.

    Since

    9

  30. def loadFonts(urlStr: String, size: Double): Seq[javafx.scene.text.Font]

    Loads font resources from the specified URL.

    Loads font resources from the specified URL. If the load is successful such that the location is readable, and it represents a supported font format then an array of Font will be returned.

    The use case for this method is for loading all fonts from a TrueType Collection (TTC).

    If a security manager is present, the application must have both permission to read from the specified URL location and the javafx.util.FXPermission "loadFont". If the application does not have permission to read from the specified URL location, then null is returned. If the application does not have the "loadFont" permission then this method will return an array of one element which is the default system font with the specified font size.

    Any failure such as a malformed URL being unable to locate or read from the resource, or if it doesn't represent a font, will result in a null return. It is the application's responsibility to check this before use.

    On a successful (non-null) return the fonts will be registered with the FX graphics system for creation by available constructors and factory methods, and the application should use it in this manner rather than calling this method again, which would repeat the overhead of downloading and installing the fonts.

    The font size parameter is a convenience so that in typical usage the application can directly use the returned (non-null) font rather than needing to create one via a constructor. Invalid sizes are those <=0 and will result in a default size.

    If the URL represents a local disk file, then no copying is performed and the font file is required to persist for the lifetime of the application. Updating the file in any manner will result in unspecified and likely undesired behaviours.

    urlStr

    from which to load the fonts, specified as a String.

    size

    of the returned fonts.

    returns

    array of Font, or null if the fonts cannot be created.

    Since

    9

  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. implicit def sfxFont2jfx(v: Font): javafx.scene.text.Font
  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. 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

Inherited from AnyRef

Inherited from Any

Ungrouped