org.drombler.commons.fx.fxml

Class FXMLLoaders

java.lang.Object

org.drombler.commons.fx.fxml.FXMLLoaders

public final class FXMLLoaders
extends Object

Utility methods for FXMLLoader.

Author:

puce

Method Summary

Modifier and Type	Method and Description
static FXMLLoader	createFXMLLoader(ClassLoader classLoader) Creates a new FXMLLoader.
static <T> T	load(Class<?> type) Loads the <class name>.fxml file, which is expected to be in the same package as the specified type.
static <T> T	load(Class<?> type, ResourceBundle resourceBundle) Loads the <class name>.fxml file, which is expected to be in the same package as the specified type.
static <T> T	load(FXMLLoader loader, Class<?> type) Loads the <class name>.fxml file, which is expected to be in the same package as the specified type.
static <T> T	load(FXMLLoader loader, Class<?> type, ResourceBundle resourceBundle) Loads the <class name>.fxml file, which is expected to be in the same package as the specified type.
static void	loadRoot(FXMLLoader loader, 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.
static void	loadRoot(FXMLLoader loader, Object rootController, ResourceBundle resourceBundle) 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.
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.
static void	loadRoot(Object rootController, ResourceBundle resourceBundle) 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.
static void	resetFXMLLoader(FXMLLoader loader) Resets the following properties of the specified FXMLLoader to null: root controller controllerFactory resources location TODO: needed?

Methods inherited from class java.lang.Object

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

Method Detail

createFXMLLoader

public static FXMLLoader createFXMLLoader(ClassLoader classLoader)

Creates a new FXMLLoader.

Sets:

• the ClassLoader

Parameters:

classLoader - the ClassLoader

Returns:

a FXMLLoader

resetFXMLLoader

public static void resetFXMLLoader(FXMLLoader loader)

Resets the following properties of the specified FXMLLoader to null:

• root
• controller
• controllerFactory
• resources
• location

TODO: needed?

Parameters:

loader - a FXMLLoader

See Also:

loadRoot(javafx.fxml.FXMLLoader, java.lang.Object), loadRoot(javafx.fxml.FXMLLoader, java.lang.Object, java.util.ResourceBundle), load(javafx.fxml.FXMLLoader, java.lang.Class, java.util.ResourceBundle)

loadRoot

public 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.

Sets:

• the ClassLoader to the ClassLoader of the specified type
• the root
• the controller
• the ResourceBundle by looking for a <name>.properties file, where <name> is equal to the name of the type of the rootController (or a locale specific derivation using the default Locale)
• the location to the FXML file

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.

loadRoot

public static void loadRoot(FXMLLoader loader,
                            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.

Sets:

• the root
• the controller
• the ResourceBundle by looking for a <name>.properties file, where <name> is equal to the name of the specified type (or a locale specific derivation using the default Locale)
• the location to the FXML file

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.

TODO: needed?

Parameters:

loader - the FXMLLoader

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

See Also:

resetFXMLLoader(javafx.fxml.FXMLLoader)

loadRoot

public static void loadRoot(Object rootController,
                            ResourceBundle resourceBundle)

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 specified type
• the root
• the controller
• the ResourceBundle to the specified resourceBundle
• the location to the FXML file

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.

resourceBundle - the ResourceBundle the FXMLLoader should use.

loadRoot

public static void loadRoot(FXMLLoader loader,
                            Object rootController,
                            ResourceBundle resourceBundle)

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 root
• the controller
• the ResourceBundle to the specified resourceBundle
• the location to the FXML file

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:

loader - the FXMLLoader

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

resourceBundle - the ResourceBundle the FXMLLoader should use.

See Also:

resetFXMLLoader(javafx.fxml.FXMLLoader)

load

public static <T> T load(Class<?> type)

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 <name>.properties file, where <name> is equal to the name of the specified type (or a locale specific derivation using the default Locale)
• the location to the FXML file

Type Parameters:

T - the type of the root element

Parameters:

type - the type

Returns:

the loaded object

See Also:

resetFXMLLoader(javafx.fxml.FXMLLoader)

load

public static <T> T load(FXMLLoader loader,
                         Class<?> type)

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

Sets:

• the ResourceBundle by looking for a <name>.properties file, where <name> is equal to the name of the specified type (or a locale specific derivation using the default Locale)
• the location to the FXML file

Type Parameters:

T - the type of the root element

Parameters:

loader - the FXMLLoader

type - the type

Returns:

the loaded object

See Also:

resetFXMLLoader(javafx.fxml.FXMLLoader)

load

public static <T> T load(Class<?> type,
                         ResourceBundle resourceBundle)

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 to the specified resourceBundle
• the location to the FXML file

Type Parameters:

T - the type of the root element

Parameters:

type - the type

resourceBundle - the ResourceBundle the FXMLLoader should use.

Returns:

the loaded object

See Also:

resetFXMLLoader(javafx.fxml.FXMLLoader)

load

public static <T> T load(FXMLLoader loader,
                         Class<?> type,
                         ResourceBundle resourceBundle)

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

Sets:

• the ResourceBundle to the specified resourceBundle
• the location to the FXML file

Type Parameters:

T - the type of the root element

Parameters:

loader - the FXMLLoader

type - the type

resourceBundle - the ResourceBundle the FXMLLoader should use.

Returns:

the loaded object

See Also:

resetFXMLLoader(javafx.fxml.FXMLLoader)