Module fr.brouillard.oss.cssfx

Package fr.brouillard.oss.cssfx

Class CSSFX

java.lang.Object

fr.brouillard.oss.cssfx.CSSFX

public class CSSFX
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CSSFX.CSSFXConfig	Stores information before finally building/starting the CSS monitoring.

Constructor Summary

Constructors

Constructor	Description
CSSFX()

Method Summary

Modifier and Type	Method	Description
static CSSFX.CSSFXConfig	addConverter(URIToPathConverter converter)	Register a new converter that will be used to map CSS resources to local file.
static CSSFX.CSSFXConfig	onlyFor(javafx.scene.Node n)	Restrict the source file detection for graphical sub-tree of the given Node
static CSSFX.CSSFXConfig	onlyFor(javafx.scene.Scene s)	Restrict the source file detection for graphical sub-tree of the given Scene
static CSSFX.CSSFXConfig	onlyFor(javafx.stage.Window window)	Restrict the source file detection for graphical sub-tree of the given Stage
static Runnable	start()	Directly start monitoring the CSS of the application using defaults: standard source file detectors: Maven, Gradle, execution from built JAR (details in URIToPathConverters.DEFAULT_CONVERTERS) detection activated on all stages of the application, including the ones that will appear later on
static Runnable	start(javafx.scene.Node node)	Directly start monitoring CSS for the given node.
static Runnable	start(javafx.scene.Scene scene)	Directly start monitoring CSS for the given Scene.
static Runnable	start(javafx.stage.Window window)	Directly start monitoring CSS for the given Window.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CSSFX

public CSSFX()

Method Detail

start

public static Runnable start()

Directly start monitoring the CSS of the application using defaults:

• standard source file detectors: Maven, Gradle, execution from built JAR (details in URIToPathConverters.DEFAULT_CONVERTERS)
• detection activated on all stages of the application, including the ones that will appear later on

Returns:

a Runnable object to stop CSSFX monitoring

start

public static Runnable start(javafx.stage.Window window)

Directly start monitoring CSS for the given Window.

• standard source file detectors: Maven, Gradle, execution from built JAR (details in URIToPathConverters.DEFAULT_CONVERTERS)
• detection activated on the given Window only (and its children)

Parameters:

window - the window that will be monitored

Returns:

a Runnable object to stop CSSFX monitoring

start

public static Runnable start(javafx.scene.Scene scene)

Directly start monitoring CSS for the given Scene.

• standard source file detectors: Maven, Gradle, execution from built JAR (details in URIToPathConverters.DEFAULT_CONVERTERS)
• detection activated on the scene only (and its children)

Parameters:

scene - the scene that will be monitored

Returns:

a Runnable object to stop CSSFX monitoring

start

public static Runnable start(javafx.scene.Node node)

Directly start monitoring CSS for the given node.

• standard source file detectors: Maven, Gradle, execution from built JAR (details in URIToPathConverters.DEFAULT_CONVERTERS)
• detection activated on the node only (and its children)

Parameters:

node - the node that will be monitored

Returns:

a Runnable object to stop CSSFX monitoring

onlyFor

public static CSSFX.CSSFXConfig onlyFor(javafx.stage.Window window)

Restrict the source file detection for graphical sub-tree of the given Stage

Parameters:

window - the window to restrict the detection on, if null then no restriction will apply

Returns:

a CSSFX.CSSFXConfig object as a builder to allow further configuration

onlyFor

public static CSSFX.CSSFXConfig onlyFor(javafx.scene.Scene s)

Restrict the source file detection for graphical sub-tree of the given Scene

Parameters:

s - the scene to restrict the detection on, if null then no restriction will apply

Returns:

a CSSFX.CSSFXConfig object as a builder to allow further configuration

onlyFor

public static CSSFX.CSSFXConfig onlyFor(javafx.scene.Node n)

Restrict the source file detection for graphical sub-tree of the given Node

Parameters:

n - the node to restrict the detection on, if null then no restriction will apply

Returns:

a CSSFX.CSSFXConfig object as a builder to allow further configuration

addConverter

public static CSSFX.CSSFXConfig addConverter(URIToPathConverter converter)

Register a new converter that will be used to map CSS resources to local file.

Parameters:

converter - an additional converter to use, ignored if null

Returns:

a CSSFX.CSSFXConfig object as a builder to allow further configuration