javafx.fxml

Class FXMLLoader

java.lang.Object

javafx.fxml.FXMLLoader

public class FXMLLoader
extends java.lang.Object

Loads an object hierarchy from an XML document.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARRAY_COMPONENT_DELIMITER
static java.lang.String	BI_DIRECTIONAL_BINDING_PREFIX
static java.lang.String	BI_DIRECTIONAL_BINDING_SUFFIX
static java.lang.String	BINDING_EXPRESSION_PREFIX
static java.lang.String	BINDING_EXPRESSION_SUFFIX
static java.lang.String	CHANGE_EVENT_HANDLER_SUFFIX
static java.lang.String	CONTROLLER_KEYWORD
static java.lang.String	CONTROLLER_METHOD_PREFIX
static java.lang.String	CONTROLLER_SUFFIX
static java.lang.String	COPY_SOURCE_ATTRIBUTE
static java.lang.String	COPY_TAG
static java.lang.String	DEFAULT_CHARSET_NAME
static java.lang.String	DEFINE_TAG
static java.lang.String	ESCAPE_PREFIX
static java.lang.String	EVENT_HANDLER_PREFIX
static java.lang.String	EVENT_KEY
static java.lang.String	EXPRESSION_PREFIX
static java.lang.String	FX_CONSTANT_ATTRIBUTE
static java.lang.String	FX_CONTROLLER_ATTRIBUTE
static java.lang.String	FX_FACTORY_ATTRIBUTE
static java.lang.String	FX_ID_ATTRIBUTE
static java.lang.String	FX_NAMESPACE_PREFIX
static java.lang.String	FX_VALUE_ATTRIBUTE
static java.lang.String	IMPORT_PROCESSING_INSTRUCTION
static java.lang.String	INCLUDE_CHARSET_ATTRIBUTE
static java.lang.String	INCLUDE_RESOURCES_ATTRIBUTE
static java.lang.String	INCLUDE_SOURCE_ATTRIBUTE
static java.lang.String	INCLUDE_TAG
static java.lang.String	INITIALIZE_METHOD_NAME
static java.lang.String	LANGUAGE_PROCESSING_INSTRUCTION
static java.lang.String	LOCATION_KEY
static java.lang.String	NULL_KEYWORD
static java.lang.String	REFERENCE_SOURCE_ATTRIBUTE
static java.lang.String	REFERENCE_TAG
static java.lang.String	RELATIVE_PATH_PREFIX
static java.lang.String	RESOURCE_KEY_PREFIX
static java.lang.String	RESOURCES_KEY
static java.lang.String	ROOT_TAG
static java.lang.String	ROOT_TYPE_ATTRIBUTE
static java.lang.String	SCRIPT_CHARSET_ATTRIBUTE
static java.lang.String	SCRIPT_SOURCE_ATTRIBUTE
static java.lang.String	SCRIPT_TAG

Constructor Summary

Constructors

Constructor and Description
FXMLLoader() Creates a new FXMLLoader instance.
FXMLLoader(java.nio.charset.Charset charset) Creates a new FXMLLoader instance.
FXMLLoader(java.net.URL location) Creates a new FXMLLoader instance.
FXMLLoader(java.net.URL location, java.util.ResourceBundle resources) Creates a new FXMLLoader instance.
FXMLLoader(java.net.URL location, java.util.ResourceBundle resources, BuilderFactory builderFactory) Creates a new FXMLLoader instance.
FXMLLoader(java.net.URL location, java.util.ResourceBundle resources, BuilderFactory builderFactory, Callback<java.lang.Class<?>,java.lang.Object> controllerFactory) Creates a new FXMLLoader instance.
FXMLLoader(java.net.URL location, java.util.ResourceBundle resources, BuilderFactory builderFactory, Callback<java.lang.Class<?>,java.lang.Object> controllerFactory, java.nio.charset.Charset charset) Creates a new FXMLLoader instance.
FXMLLoader(java.net.URL location, java.util.ResourceBundle resources, BuilderFactory builderFactory, Callback<java.lang.Class<?>,java.lang.Object> controllerFactory, java.nio.charset.Charset charset, java.util.LinkedList<FXMLLoader> loaders) Creates a new FXMLLoader instance.

Method Summary

Methods

Modifier and Type	Method and Description
BuilderFactory	getBuilderFactory() Returns the builder factory used by this loader.
java.nio.charset.Charset	getCharset() Returns the character set used by this loader.
java.lang.ClassLoader	getClassLoader() Returns the classloader used by this serializer.
<T> T	getController() Sets the controller associated with the root object.
Callback<java.lang.Class<?>,java.lang.Object>	getControllerFactory() Returns the controller factory used by this serializer.
static java.lang.ClassLoader	getDefaultClassLoader() Returns the default class loader.
java.net.URL	getLocation() Returns the location used to resolve relative path attribute values.
ObservableMap<java.lang.String,java.lang.Object>	getNamespace() Returns the namespace used by this loader.
java.util.ResourceBundle	getResources() Returns the resources used to resolve resource key attribute values.
<T> T	getRoot() Returns the root of the object hierarchy.
java.lang.Object	load() Loads an object hierarchy from a FXML document.
java.lang.Object	load(java.io.InputStream inputStream) Loads an object hierarchy from a FXML document.
static <T> T	load(java.net.URL location) Loads an object hierarchy from a FXML document.
static <T> T	load(java.net.URL location, java.util.ResourceBundle resources) Loads an object hierarchy from a FXML document.
static <T> T	load(java.net.URL location, java.util.ResourceBundle resources, BuilderFactory builderFactory) Loads an object hierarchy from a FXML document.
static <T> T	load(java.net.URL location, java.util.ResourceBundle resources, BuilderFactory builderFactory, Callback<java.lang.Class<?>,java.lang.Object> controllerFactory) Loads an object hierarchy from a FXML document.
static <T> T	load(java.net.URL location, java.util.ResourceBundle resources, BuilderFactory builderFactory, Callback<java.lang.Class<?>,java.lang.Object> controllerFactory, java.nio.charset.Charset charset) Loads an object hierarchy from a FXML document.
static java.lang.Class<?>	loadType(java.lang.String className) Deprecated. This method now delegates to getDefaultClassLoader().
static java.lang.Class<?>	loadType(java.lang.String packageName, java.lang.String className) Deprecated. This method now delegates to getDefaultClassLoader().
void	setBuilderFactory(BuilderFactory builderFactory) Sets the builder factory used by this loader.
void	setCharset(java.nio.charset.Charset charset) Sets the charset used by this loader.
void	setClassLoader(java.lang.ClassLoader classLoader) Sets the classloader used by this serializer.
void	setController(java.lang.Object controller) Sets the controller associated with the root object.
void	setControllerFactory(Callback<java.lang.Class<?>,java.lang.Object> controllerFactory) Sets the controller factory used by this serializer.
static void	setDefaultClassLoader(java.lang.ClassLoader defaultClassLoader) Sets the default class loader.
void	setLocation(java.net.URL location) Sets the location used to resolve relative path attribute values.
void	setResources(java.util.ResourceBundle resources) Sets the resources used to resolve resource key attribute values.
void	setRoot(java.lang.Object root) Sets the root of the object hierarchy.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET_NAME

public static final java.lang.String DEFAULT_CHARSET_NAME

See Also:

Constant Field Values

LANGUAGE_PROCESSING_INSTRUCTION

public static final java.lang.String LANGUAGE_PROCESSING_INSTRUCTION

See Also:

Constant Field Values

IMPORT_PROCESSING_INSTRUCTION

public static final java.lang.String IMPORT_PROCESSING_INSTRUCTION

See Also:

Constant Field Values

FX_NAMESPACE_PREFIX

public static final java.lang.String FX_NAMESPACE_PREFIX

See Also:

Constant Field Values

FX_CONTROLLER_ATTRIBUTE

public static final java.lang.String FX_CONTROLLER_ATTRIBUTE

See Also:

Constant Field Values

FX_ID_ATTRIBUTE

public static final java.lang.String FX_ID_ATTRIBUTE

See Also:

Constant Field Values

FX_VALUE_ATTRIBUTE

public static final java.lang.String FX_VALUE_ATTRIBUTE

See Also:

Constant Field Values

FX_CONSTANT_ATTRIBUTE

public static final java.lang.String FX_CONSTANT_ATTRIBUTE

See Also:

Constant Field Values

FX_FACTORY_ATTRIBUTE

public static final java.lang.String FX_FACTORY_ATTRIBUTE

See Also:

Constant Field Values

INCLUDE_TAG

public static final java.lang.String INCLUDE_TAG

See Also:

Constant Field Values

INCLUDE_SOURCE_ATTRIBUTE

public static final java.lang.String INCLUDE_SOURCE_ATTRIBUTE

See Also:

Constant Field Values

INCLUDE_RESOURCES_ATTRIBUTE

public static final java.lang.String INCLUDE_RESOURCES_ATTRIBUTE

See Also:

Constant Field Values

INCLUDE_CHARSET_ATTRIBUTE

public static final java.lang.String INCLUDE_CHARSET_ATTRIBUTE

See Also:

Constant Field Values

SCRIPT_TAG

public static final java.lang.String SCRIPT_TAG

See Also:

Constant Field Values

SCRIPT_SOURCE_ATTRIBUTE

public static final java.lang.String SCRIPT_SOURCE_ATTRIBUTE

See Also:

Constant Field Values

SCRIPT_CHARSET_ATTRIBUTE

public static final java.lang.String SCRIPT_CHARSET_ATTRIBUTE

See Also:

Constant Field Values

DEFINE_TAG

public static final java.lang.String DEFINE_TAG

See Also:

Constant Field Values

REFERENCE_TAG

public static final java.lang.String REFERENCE_TAG

See Also:

Constant Field Values

REFERENCE_SOURCE_ATTRIBUTE

public static final java.lang.String REFERENCE_SOURCE_ATTRIBUTE

See Also:

Constant Field Values

ROOT_TAG

public static final java.lang.String ROOT_TAG

See Also:

Constant Field Values

ROOT_TYPE_ATTRIBUTE

public static final java.lang.String ROOT_TYPE_ATTRIBUTE

See Also:

Constant Field Values

COPY_TAG

public static final java.lang.String COPY_TAG

See Also:

Constant Field Values

COPY_SOURCE_ATTRIBUTE

public static final java.lang.String COPY_SOURCE_ATTRIBUTE

See Also:

Constant Field Values

EVENT_HANDLER_PREFIX

public static final java.lang.String EVENT_HANDLER_PREFIX

See Also:

Constant Field Values

EVENT_KEY

public static final java.lang.String EVENT_KEY

See Also:

Constant Field Values

CHANGE_EVENT_HANDLER_SUFFIX

public static final java.lang.String CHANGE_EVENT_HANDLER_SUFFIX

See Also:

Constant Field Values

NULL_KEYWORD

public static final java.lang.String NULL_KEYWORD

See Also:

Constant Field Values

ESCAPE_PREFIX

public static final java.lang.String ESCAPE_PREFIX

See Also:

Constant Field Values

RELATIVE_PATH_PREFIX

public static final java.lang.String RELATIVE_PATH_PREFIX

See Also:

Constant Field Values

RESOURCE_KEY_PREFIX

public static final java.lang.String RESOURCE_KEY_PREFIX

See Also:

Constant Field Values

EXPRESSION_PREFIX

public static final java.lang.String EXPRESSION_PREFIX

See Also:

Constant Field Values

BINDING_EXPRESSION_PREFIX

public static final java.lang.String BINDING_EXPRESSION_PREFIX

See Also:

Constant Field Values

BINDING_EXPRESSION_SUFFIX

public static final java.lang.String BINDING_EXPRESSION_SUFFIX

See Also:

Constant Field Values

BI_DIRECTIONAL_BINDING_PREFIX

public static final java.lang.String BI_DIRECTIONAL_BINDING_PREFIX

See Also:

Constant Field Values

BI_DIRECTIONAL_BINDING_SUFFIX

public static final java.lang.String BI_DIRECTIONAL_BINDING_SUFFIX

See Also:

Constant Field Values

ARRAY_COMPONENT_DELIMITER

public static final java.lang.String ARRAY_COMPONENT_DELIMITER

See Also:

Constant Field Values

LOCATION_KEY

public static final java.lang.String LOCATION_KEY

See Also:

Constant Field Values

RESOURCES_KEY

public static final java.lang.String RESOURCES_KEY

See Also:

Constant Field Values

CONTROLLER_METHOD_PREFIX

public static final java.lang.String CONTROLLER_METHOD_PREFIX

See Also:

Constant Field Values

CONTROLLER_KEYWORD

public static final java.lang.String CONTROLLER_KEYWORD

See Also:

Constant Field Values

CONTROLLER_SUFFIX

public static final java.lang.String CONTROLLER_SUFFIX

See Also:

Constant Field Values

INITIALIZE_METHOD_NAME

public static final java.lang.String INITIALIZE_METHOD_NAME

See Also:

Constant Field Values

Constructor Detail

FXMLLoader

public FXMLLoader()

Creates a new FXMLLoader instance.

FXMLLoader

public FXMLLoader(java.net.URL location)

Creates a new FXMLLoader instance.

Parameters:

location -

FXMLLoader

public FXMLLoader(java.net.URL location,
          java.util.ResourceBundle resources)

Creates a new FXMLLoader instance.

Parameters:

location -

resources -

FXMLLoader

public FXMLLoader(java.net.URL location,
          java.util.ResourceBundle resources,
          BuilderFactory builderFactory)

Creates a new FXMLLoader instance.

Parameters:

location -

resources -

builderFactory -

FXMLLoader

public FXMLLoader(java.net.URL location,
          java.util.ResourceBundle resources,
          BuilderFactory builderFactory,
          Callback<java.lang.Class<?>,java.lang.Object> controllerFactory)

Creates a new FXMLLoader instance.

Parameters:

location -

resources -

builderFactory -

controllerFactory -

FXMLLoader

public FXMLLoader(java.nio.charset.Charset charset)

Creates a new FXMLLoader instance.

Parameters:

charset -

FXMLLoader

public FXMLLoader(java.net.URL location,
          java.util.ResourceBundle resources,
          BuilderFactory builderFactory,
          Callback<java.lang.Class<?>,java.lang.Object> controllerFactory,
          java.nio.charset.Charset charset)

Creates a new FXMLLoader instance.

Parameters:

location -

resources -

builderFactory -

controllerFactory -

charset -

FXMLLoader

public FXMLLoader(java.net.URL location,
          java.util.ResourceBundle resources,
          BuilderFactory builderFactory,
          Callback<java.lang.Class<?>,java.lang.Object> controllerFactory,
          java.nio.charset.Charset charset,
          java.util.LinkedList<FXMLLoader> loaders)

Creates a new FXMLLoader instance.

Parameters:

location -

resources -

builderFactory -

controllerFactory -

charset -

loaders -

Method Detail

getNamespace

public ObservableMap<java.lang.String,java.lang.Object> getNamespace()

Returns the namespace used by this loader.

getRoot

public <T> T getRoot()

Returns the root of the object hierarchy.

setRoot

public void setRoot(java.lang.Object root)

Sets the root of the object hierarchy. The value passed to this method is used as the value of the <fx:root%gt; tag. This method must be called prior to loading the document when using <fx:root%gt;.

Parameters:

root - The root of the object hierarchy.

getController

public <T> T getController()

Sets the controller associated with the root object. The value passed to this method is used as the value of the fx:controller attribute. This method must be called prior to loading the document when using controller event handlers when an fx:controller attribute is not specified in the document.

Returns:

controller The controller associated with the root object.

setController

public void setController(java.lang.Object controller)

Sets the controller associated with the root object.

Parameters:

controller - Sets the controller associated with the root object.

Since:

2.2

getLocation

public java.net.URL getLocation()

Returns the location used to resolve relative path attribute values.

setLocation

public void setLocation(java.net.URL location)

Sets the location used to resolve relative path attribute values.

Parameters:

location -

getResources

public java.util.ResourceBundle getResources()

Returns the resources used to resolve resource key attribute values.

setResources

public void setResources(java.util.ResourceBundle resources)

Sets the resources used to resolve resource key attribute values.

Parameters:

resources -

getBuilderFactory

public BuilderFactory getBuilderFactory()

Returns the builder factory used by this loader.

setBuilderFactory

public void setBuilderFactory(BuilderFactory builderFactory)

Sets the builder factory used by this loader.

Parameters:

builderFactory -

getControllerFactory

public Callback<java.lang.Class<?>,java.lang.Object> getControllerFactory()

Returns the controller factory used by this serializer.

setControllerFactory

public void setControllerFactory(Callback<java.lang.Class<?>,java.lang.Object> controllerFactory)

Sets the controller factory used by this serializer.

Parameters:

controllerFactory -

getCharset

public java.nio.charset.Charset getCharset()

Returns the character set used by this loader.

setCharset

public void setCharset(java.nio.charset.Charset charset)

Sets the charset used by this loader.

Parameters:

charset -

getClassLoader

public java.lang.ClassLoader getClassLoader()

Returns the classloader used by this serializer.

setClassLoader

public void setClassLoader(java.lang.ClassLoader classLoader)

Sets the classloader used by this serializer.

Parameters:

classLoader -

load

public java.lang.Object load()
                      throws java.io.IOException

Loads an object hierarchy from a FXML document. The location from which the document will be loaded must have been set by a prior call to setLocation(URL).

Returns:

The loaded object hierarchy.

Throws:

java.io.IOException

load

public java.lang.Object load(java.io.InputStream inputStream)
                      throws java.io.IOException

Loads an object hierarchy from a FXML document.

Parameters:

inputStream - An input stream containing the FXML data to load.

Returns:

The loaded object hierarchy.

Throws:

java.io.IOException

loadType

public static java.lang.Class<?> loadType(java.lang.String packageName,
                          java.lang.String className)
                                   throws java.lang.ClassNotFoundException

Deprecated. This method now delegates to getDefaultClassLoader().

Loads a type using the default class loader.

Parameters:

packageName -

className -

Throws:

java.lang.ClassNotFoundException

loadType

public static java.lang.Class<?> loadType(java.lang.String className)
                                   throws java.lang.ClassNotFoundException

Deprecated. This method now delegates to getDefaultClassLoader().

Loads a type using the default class loader.

Parameters:

className -

Throws:

java.lang.ClassNotFoundException

getDefaultClassLoader

public static java.lang.ClassLoader getDefaultClassLoader()

Returns the default class loader.

setDefaultClassLoader

public static void setDefaultClassLoader(java.lang.ClassLoader defaultClassLoader)

Sets the default class loader.

Parameters:

defaultClassLoader - The default class loader to use when loading classes.

load

public static <T> T load(java.net.URL location)
              throws java.io.IOException

Loads an object hierarchy from a FXML document.

Parameters:

location -

Throws:

java.io.IOException

load

public static <T> T load(java.net.URL location,
         java.util.ResourceBundle resources)
              throws java.io.IOException

Loads an object hierarchy from a FXML document.

Parameters:

location -

resources -

Throws:

java.io.IOException

load

public static <T> T load(java.net.URL location,
         java.util.ResourceBundle resources,
         BuilderFactory builderFactory)
              throws java.io.IOException

Loads an object hierarchy from a FXML document.

Parameters:

location -

resources -

builderFactory -

Throws:

java.io.IOException

load

public static <T> T load(java.net.URL location,
         java.util.ResourceBundle resources,
         BuilderFactory builderFactory,
         Callback<java.lang.Class<?>,java.lang.Object> controllerFactory)
              throws java.io.IOException

Loads an object hierarchy from a FXML document.

Parameters:

location -

resources -

builderFactory -

controllerFactory -

Throws:

java.io.IOException

load

public static <T> T load(java.net.URL location,
         java.util.ResourceBundle resources,
         BuilderFactory builderFactory,
         Callback<java.lang.Class<?>,java.lang.Object> controllerFactory,
         java.nio.charset.Charset charset)
              throws java.io.IOException

Loads an object hierarchy from a FXML document.

Parameters:

location -

resources -

builderFactory -

controllerFactory -

charset -

Throws:

java.io.IOException