Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: CssFxConfig

[117:7] extends: object

CssFxConfig wraps CSSFX's scoped configuration object.

Members

  • obj

Methods

  • CssFxConfig (object ConfigObj)

    Creates a config wrapper from the provided Java CSSFXConfig object.

    • @p ConfigObj is an AussomJavaObject wrapping CSSFXConfig.
  • noDefaultConverters ()

    Disables CSSFX's built-in default URI converters for this config.

    • @r this object for chaining
  • addConverter (object ConverterObj)

    Adds a URIToPathConverter object to this config.

    • @p ConverterObj is an AussomJavaObject implementing URIToPathConverter.
    • @r this object for chaining
  • addConverterCallback (callback Convert)

    Adds a URIToPathConverter generated from the provided callback.

    • @p Convert is a callback that takes a URI string and returns a Java Path object or null.
    • @r this object for chaining
  • startMonitor ()

    Starts monitoring and returns a stop handle.

    • @r A CssFxMonitor handle that can be stopped with stop().
  • start ()

    Starts monitoring for this config.

    • @r this object for chaining

class: CssFxMonitor

[179:7] extends: object

CssFxMonitor wraps the Runnable returned by CSSFX start methods. Calling stop() runs that Runnable and tears down the CSSFX monitor.

Members

  • obj

Methods

  • CssFxMonitor (object MonitorObj)

    Creates a monitor wrapper from the provided Runnable object.

    • @p MonitorObj is an AussomJavaObject wrapping a Java Runnable.
  • stop ()

    Stops the CSSFX monitor.

    • @r this object for chaining

class: cssfx

[14:14] static extends: object

CSSFX provides development-time JavaFX stylesheet hot reload support. This wrapper is intentionally AJI-based so Aussom users keep direct access to the full Java CSSFX API when they need functionality beyond the common helpers exposed here.

Members

  • cssfxClass
  • converterClass

Methods

  • startMonitor ()

    Starts CSSFX global monitoring for all JavaFX stages in the app.

    • @r A CssFxMonitor handle that can be stopped with stop().
  • start ()

    Starts CSSFX global monitoring for all JavaFX stages in the app.

    • @r this object for chaining
  • forStage (object StageObj)

    Creates a CSSFX config object scoped to the provided JavaFX Stage.

    • @p StageObj is an AussomJavaObject wrapping a JavaFX Stage/Window.
    • @r A CssFxConfig helper object.
  • forScene (object SceneObj)

    Creates a CSSFX config object scoped to the provided JavaFX Scene.

    • @p SceneObj is an AussomJavaObject wrapping a JavaFX Scene.
    • @r A CssFxConfig helper object.
  • forNode (object NodeObj)

    Creates a CSSFX config object scoped to the provided JavaFX Node.

    • @p NodeObj is an AussomJavaObject wrapping a JavaFX Node.
    • @r A CssFxConfig helper object.
  • addConverter (object ConverterObj)

    Creates a CSSFX config object that starts from the global scope and adds the provided converter.

    • @p ConverterObj is an AussomJavaObject implementing URIToPathConverter.
    • @r A CssFxConfig helper object.
  • addConverterCallback (callback Convert)

    Creates a CSSFX config object that starts from the global scope and adds a converter generated from the provided callback.

    • @p Convert is a callback that takes a URI string and returns a Java Path object or null.
    • @r A CssFxConfig helper object.
  • newPathConverter (callback Convert)

    Creates a URIToPathConverter Java closure from the provided callback. The callback should take one string argument with the stylesheet URI and return a Java Path object or null.

    • @p Convert is a callback with signature (string Uri).
    • @r An AussomJavaObject implementing URIToPathConverter.
  • path (string PathStr)

    Creates a java.nio.file.Path from the provided string path.

    • @p PathStr is a string with the path to convert.
    • @r An AussomJavaObject wrapping the Java Path.
  • pathFromUri (string UriStr)

    Creates a java.nio.file.Path from the provided URI string.

    • @p UriStr is a string with the URI to convert.
    • @r An AussomJavaObject wrapping the Java Path.