uk.co.strangeskies.fx

Class FxmlLoadBuilder<C>

java.lang.Object

uk.co.strangeskies.fx.FxmlLoadBuilder<C>

Type Parameters:

C - the controller type

public class FxmlLoadBuilder<C>
extends java.lang.Object

A simple utility class for simplifying FXML resource loading. Common configuration is avoided by providing behavior according to conventions.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FxmlLoadBuilder(javafx.fxml.FXMLLoader loader)

Method Summary

Modifier and Type	Method and Description
static FxmlLoadBuilder<java.lang.Object>	build()
static FxmlLoadBuilder<java.lang.Object>	buildWith(javafx.fxml.FXMLLoader loader)
FxmlLoadBuilder<C>	classLoader(java.lang.ClassLoader classLoader)
<D> FxmlLoadBuilder<D>	controller(java.lang.Class<D> controllerClass) Configure the builder to load into a controller of the given class via FXMLLoader.setControllerFactory(javafx.util.Callback).
<D> FxmlLoadBuilder<D>	controller(java.lang.Class<D> controllerClass, D controller) Configure the builder to load directly into the given controller instance.
<D> FxmlLoadBuilder<D>	controller(D controller) Configure the builder to load directly into the given controller instance.
javafx.util.Pair<C,javafx.scene.Node>	load() Load the TODO
C	loadController() Load the FXML item and return the controller.
<T> T	loadRoot() Load the FXML item and return the root node.
<D extends javafx.scene.Node> FxmlLoadBuilder<D>	object(D object)
FxmlLoadBuilder<C>	resource(java.lang.String resourceName) The FXML resource name, such that the resource be located according to FxUtilities.getResource(Class, String).
FxmlLoadBuilder<C>	resource(java.net.URL resource)
FxmlLoadBuilder<C>	root(javafx.scene.Node root)

Methods inherited from class java.lang.Object

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

Constructor Detail

FxmlLoadBuilder

protected FxmlLoadBuilder(javafx.fxml.FXMLLoader loader)

Parameters:

loader - The FXML loader to use

Method Detail

buildWith

public static FxmlLoadBuilder<java.lang.Object> buildWith(javafx.fxml.FXMLLoader loader)

Parameters:

loader - the FXMLLoader to back the builder

Returns:

an FxmlLoadBuilder over the given backing loader

build

public static FxmlLoadBuilder<java.lang.Object> build()

Returns:

an FxmlLoadBuilder over the default backing loader

controller

public <D> FxmlLoadBuilder<D> controller(D controller)

Configure the builder to load directly into the given controller instance.

Unless an exact resource is given, the resource location will be derived according to FxUtilities.getResource(Class), or FxUtilities.getResource(Class, String) if a resource name is specified.

Type Parameters:

D - the type of the controller object

Parameters:

controller - the controller object to load into

Returns:

the receiving instance

controller

public <D> FxmlLoadBuilder<D> controller(java.lang.Class<D> controllerClass,
                                         D controller)

Configure the builder to load directly into the given controller instance.

Unless an exact resource is given, the resource location will be derived according to FxUtilities.getResource(Class), or FxUtilities.getResource(Class, String) if a resource name is specified.

Type Parameters:

D - the type of the controller object

Parameters:

controllerClass - the controller class to load into

controller - the controller object to load into

Returns:

the receiving instance

controller

public <D> FxmlLoadBuilder<D> controller(java.lang.Class<D> controllerClass)

Configure the builder to load into a controller of the given class via FXMLLoader.setControllerFactory(javafx.util.Callback).

Unless an exact resource is given, the resource location will be derived according to FxUtilities.getResource(Class), or FxUtilities.getResource(Class, String) if a resource name is specified.

Type Parameters:

D - the type of the controller class

Parameters:

controllerClass - the controller class to load into

Returns:

the receiving instance

resource

public FxmlLoadBuilder<C> resource(java.lang.String resourceName)

The FXML resource name, such that the resource be located according to FxUtilities.getResource(Class, String).

Parameters:

resourceName - the name of the FXML resource

Returns:

the receiving instance

resource

public FxmlLoadBuilder<C> resource(java.net.URL resource)

Parameters:

resource - the exact FXML resource

Returns:

the receiving instance

root

public FxmlLoadBuilder<C> root(javafx.scene.Node root)

Parameters:

root - the root node to load the FXML into

Returns:

the receiving instance

classLoader

public FxmlLoadBuilder<C> classLoader(java.lang.ClassLoader classLoader)

Parameters:

classLoader - the new class loader for the FXMLLoader.

Returns:

the receiving instance

object

public <D extends javafx.scene.Node> FxmlLoadBuilder<D> object(D object)

Type Parameters:

D - the type of the controller/root object

Parameters:

object - the root node and the controller to load the FXML into

Returns:

the receiving instance

loadRoot

public <T> T loadRoot()

Load the FXML item and return the root node.

Type Parameters:

T - the expected type of the root node

Returns:

the resulting root node

loadController

public C loadController()

Load the FXML item and return the controller.

Returns:

the resulting controller

load

public javafx.util.Pair<C,javafx.scene.Node> load()

Load the TODO

Returns:

a pair containing the controller object and the root node object