org.drombler.commons.fx.fxml

Class FXMLLoaders

java.lang.Object

org.drombler.commons.fx.fxml.FXMLLoaders

public class FXMLLoaders
extends Object

Utility methods for FXMLLoader.

Author:

puce

Method Summary

Modifier and Type	Method and Description
static javafx.fxml.FXMLLoader	createFXMLLoader(Class<?> type) Creates a new FXMLLoader.
static Object	load(javafx.fxml.FXMLLoader loader, Class<?> type) Loads the <class name>.fxml file, which is expected to be in the same package as the specified type.
static void	loadRoot(Class<?> type, Object rootController) Loads the <class name>.fxml file, which is expected to be in the same package as the specified type.
static void	loadRoot(Object rootController) Loads the <class name>.fxml file, where <class name> is the type of the specified rootController and the FXML-file is expected to be in the same package.

Methods inherited from class java.lang.Object

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

Method Detail

createFXMLLoader

public static javafx.fxml.FXMLLoader createFXMLLoader(Class<?> type)

Creates a new FXMLLoader.

Sets:

• the ClassLoader to the ClassLoader of the specified type
• the ResourceBundle by looking for a Bundle.properties file in the package of the specified type (or a locale specific derivation) using the default Locale

Parameters:

type - the type specifing the ClassLoader and the package of the Bundle.properties file

Returns:

a FXMLLoader

loadRoot

public static void loadRoot(Object rootController)
                     throws IOException

Loads the <class name>.fxml file, where <class name> is the type of the specified rootController and the FXML-file is expected to be in the same package.

Sets:

• the ClassLoader to the ClassLoader of the type of the rootController
• the ResourceBundle by looking for a Bundle.properties file in the package of the type of the specified rootController (or a locale specific derivation) using the default Locale

The root element of the FXML document is expected to be:

<fx:root type="{super-type}" xmlns:fx="http://javafx.com/fxml">

where "super-type" is the super type of the type of the specified rootController.

Parameters:

rootController - the Object acting as the root and as the controller.

Throws:

IOException

loadRoot

public static void loadRoot(Class<?> type,
                            Object rootController)
                     throws IOException

Loads the <class name>.fxml file, which is expected to be in the same package as the specified type.

Sets:

• the ClassLoader to the ClassLoader of the specified type
• the ResourceBundle by looking for a Bundle.properties file in the package of the specified type (or a locale specific derivation) using the default Locale

The root element of the FXML document is expected to be:

<fx:root type="{super-type}" xmlns:fx="http://javafx.com/fxml">

where "super-type" is the super type of the specified type.

Parameters:

type - the type

rootController - the Object acting as the root and as the controller.

Throws:

IOException

load

public static Object load(javafx.fxml.FXMLLoader loader,
                          Class<?> type)
                   throws IOException

Loads the <class name>.fxml file, which is expected to be in the same package as the specified type.

Parameters:

loader - the FXMLLoader

type - the type

Returns:

the loaded object

Throws:

IOException