com.cathive.fx.guice

Class GuiceFXMLLoader

java.lang.Object

com.cathive.fx.guice.GuiceFXMLLoader

public class GuiceFXMLLoader
extends Object

If you want to `guicify` your JavaFX experience you can use an instance of this class instead of the FXMLLoader that ships with JavaFX.

The easiest way to use this class is by just injecting it into your JavaFX application in the right places.

Author:

Benjamin P. Jung

See Also:

FXMLLoader

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GuiceFXMLLoader.Result A simple wrapper around the result of a FXML loading operation.

Constructor Summary

Constructors

Constructor and Description
GuiceFXMLLoader(com.google.inject.Injector injector, FXMLLoadingScope fxmlLoadingScope) This constructor is usually never called directly.

Method Summary

Modifier and Type	Method and Description
GuiceFXMLLoader.Result	load(URL url) Loads an object hierarchy from a FXML document.
GuiceFXMLLoader.Result	load(URL url, ResourceBundle resources) Loads an object hierarchy from a FXML document.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuiceFXMLLoader

@Inject
public GuiceFXMLLoader(com.google.inject.Injector injector,
                                FXMLLoadingScope fxmlLoadingScope)

This constructor is usually never called directly.

Instead use an existing Injector instance to fetch an instance of this class.

Parameters:

injector - Usually injected via Guice.

fxmlLoadingScope - Usually injected via Guice.

Throws:

IllegalArgumentException - if you try to pass a null value as injector instance.

IllegalStateException - if the injector has no binding for the FXMLController loading scope.

Method Detail

load

public GuiceFXMLLoader.Result load(URL url,
                                   ResourceBundle resources)
                            throws IOException

Loads an object hierarchy from a FXML document.

A simple wrapper around the load method of JavaFX' FXMLLoader class that adds a tiny notch of Guice-related magic.

Parameters:

url - URL of the FXML resource to be loaded.

resources - Resources to be used to localize strings.

Returns:

The loaded object hierarchy encapsulated in a special result object.

Throws:

IOException

See Also:

FXMLLoader.load(URL, ResourceBundle)

load

public GuiceFXMLLoader.Result load(URL url)
                            throws IOException

Loads an object hierarchy from a FXML document.

A simple wrapper around the load method of JavaFX' FXMLLoader class that adds a tiny notch of Guice-related magic.

Parameters:

url - URL of the FXML resource to be loaded.

Returns:

The loaded object hierarchy encapsulated in a special result object.

Throws:

IOException

See Also:

FXMLLoader.load(URL)