FXMLLoader (JavaFX 8)

JavaFX on JDK 8 has a shorter support timeline than JDK 8. Update releases of JDK 8 after March 2028 will not include JavaFX. Visit www.oracle.com/javase/javafx for details.

java.lang.Object
- javafx.fxml.FXMLLoader

```
public class FXMLLoader
extends java.lang.Object
```
Loads an object hierarchy from an XML document.

Since:

JavaFX 2.0

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ARRAY_COMPONENT_DELIMITER` Delimiter for arrays as values
`static java.lang.String`	`BI_DIRECTIONAL_BINDING_PREFIX` Prefix for bidirectional-binding expression resolution
`static java.lang.String`	`BI_DIRECTIONAL_BINDING_SUFFIX` Suffix for bidirectional-binding expression resolution
`static java.lang.String`	`BINDING_EXPRESSION_PREFIX` Prefix for binding expression resolution
`static java.lang.String`	`BINDING_EXPRESSION_SUFFIX` Suffix for binding expression resolution
`static java.lang.String`	`CHANGE_EVENT_HANDLER_SUFFIX` Suffix for property change/invalidation handlers
`static java.lang.String`	`CONTROLLER_KEYWORD` A key for controller in namespace map
`static java.lang.String`	`CONTROLLER_METHOD_PREFIX` Prefix for controller method resolution
`static java.lang.String`	`CONTROLLER_SUFFIX` A suffix for controllers of included fxml files.
`static java.lang.String`	`COPY_SOURCE_ATTRIBUTE` <fx:copy> 'source' attribute
`static java.lang.String`	`COPY_TAG` The tag name of <fx:copy>
`static java.lang.String`	`DEFAULT_CHARSET_NAME` The character set used when character set is not explicitly specified
`static java.lang.String`	`DEFINE_TAG` The tag name of <fx:define>
`static java.lang.String`	`ESCAPE_PREFIX` Escape prefix for escaping special characters inside attribute values.
`static java.lang.String`	`EVENT_HANDLER_PREFIX` The prefix of event handler attributes
`static java.lang.String`	`EVENT_KEY` The name of the Event object in event handler scripts
`static java.lang.String`	`EXPRESSION_PREFIX` Prefix for (variable) expression resolution
`static java.lang.String`	`FX_CONSTANT_ATTRIBUTE` The tag name of 'fx:constant'
`static java.lang.String`	`FX_CONTROLLER_ATTRIBUTE` The name of fx:controller attribute of a root
`static java.lang.String`	`FX_FACTORY_ATTRIBUTE` The name of 'fx:factory' attribute
`static java.lang.String`	`FX_ID_ATTRIBUTE` The name of fx:id attribute
`static java.lang.String`	`FX_NAMESPACE_PREFIX` Prefix of 'fx' namespace
`static java.lang.String`	`FX_NAMESPACE_VERSION` Contains the current fx namepsace version
`static java.lang.String`	`FX_VALUE_ATTRIBUTE` The name of fx:value attribute
`static java.lang.String`	`IMPORT_PROCESSING_INSTRUCTION` The tag name of import processing instruction
`static java.lang.String`	`INCLUDE_CHARSET_ATTRIBUTE` <fx:include> 'charset' attribute
`static java.lang.String`	`INCLUDE_RESOURCES_ATTRIBUTE` <fx:include> 'resources' attribute
`static java.lang.String`	`INCLUDE_SOURCE_ATTRIBUTE` <fx:include> 'source' attribute
`static java.lang.String`	`INCLUDE_TAG` The tag name of <fx:include>
`static java.lang.String`	`INITIALIZE_METHOD_NAME` The name of initialize method
`static java.lang.String`	`JAVAFX_VERSION` Contains the current javafx version
`static java.lang.String`	`LANGUAGE_PROCESSING_INSTRUCTION` The tag name of language processing instruction
`static java.lang.String`	`LOCATION_KEY` A key for location URL in namespace map
`static java.lang.String`	`NULL_KEYWORD` Value that represents 'null'
`static java.lang.String`	`REFERENCE_SOURCE_ATTRIBUTE` <fx:reference> 'source' attribute
`static java.lang.String`	`REFERENCE_TAG` The tag name of <fx:reference>
`static java.lang.String`	`RELATIVE_PATH_PREFIX` Prefix for relative location resultion
`static java.lang.String`	`RESOURCE_KEY_PREFIX` Prefix for resource resolution
`static java.lang.String`	`RESOURCES_KEY` A key for ResourceBundle in namespace map
`static java.lang.String`	`ROOT_TAG` The tag name of <fx:root>
`static java.lang.String`	`ROOT_TYPE_ATTRIBUTE` <fx:root> 'type' attribute
`static java.lang.String`	`SCRIPT_CHARSET_ATTRIBUTE` <fx:script> 'charset' attribute
`static java.lang.String`	`SCRIPT_SOURCE_ATTRIBUTE` <fx:script> 'source' attribute
`static java.lang.String`	`SCRIPT_TAG` The tag name of <fx:script>

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

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`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()` Returns 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.
`<T> T`	`load()` Loads an object hierarchy from a FXML document.
`<T> T`	`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 and clears any existing imports
`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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_CHARSET_NAME
```
public static final java.lang.String DEFAULT_CHARSET_NAME
```
    The character set used when character set is not explicitly specified
    
    See Also:
    
    Constant Field Values
  - LANGUAGE_PROCESSING_INSTRUCTION
```
public static final java.lang.String LANGUAGE_PROCESSING_INSTRUCTION
```
    The tag name of language processing instruction
    
    See Also:
    
    Constant Field Values
  - IMPORT_PROCESSING_INSTRUCTION
```
public static final java.lang.String IMPORT_PROCESSING_INSTRUCTION
```
    The tag name of import processing instruction
    
    See Also:
    
    Constant Field Values
  - FX_NAMESPACE_PREFIX
```
public static final java.lang.String FX_NAMESPACE_PREFIX
```
    Prefix of 'fx' namespace
    
    See Also:
    
    Constant Field Values
  - FX_CONTROLLER_ATTRIBUTE
```
public static final java.lang.String FX_CONTROLLER_ATTRIBUTE
```
    The name of fx:controller attribute of a root
    
    See Also:
    
    Constant Field Values
  - FX_ID_ATTRIBUTE
```
public static final java.lang.String FX_ID_ATTRIBUTE
```
    The name of fx:id attribute
    
    See Also:
    
    Constant Field Values
  - FX_VALUE_ATTRIBUTE
```
public static final java.lang.String FX_VALUE_ATTRIBUTE
```
    The name of fx:value attribute
    
    See Also:
    
    Constant Field Values
  - FX_CONSTANT_ATTRIBUTE
```
public static final java.lang.String FX_CONSTANT_ATTRIBUTE
```
    The tag name of 'fx:constant'
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    Constant Field Values
  - FX_FACTORY_ATTRIBUTE
```
public static final java.lang.String FX_FACTORY_ATTRIBUTE
```
    The name of 'fx:factory' attribute
    
    See Also:
    
    Constant Field Values
  - INCLUDE_TAG
```
public static final java.lang.String INCLUDE_TAG
```
    The tag name of <fx:include>
    
    See Also:
    
    Constant Field Values
  - INCLUDE_SOURCE_ATTRIBUTE
```
public static final java.lang.String INCLUDE_SOURCE_ATTRIBUTE
```
    <fx:include> 'source' attribute
    
    See Also:
    
    Constant Field Values
  - INCLUDE_RESOURCES_ATTRIBUTE
```
public static final java.lang.String INCLUDE_RESOURCES_ATTRIBUTE
```
    <fx:include> 'resources' attribute
    
    See Also:
    
    Constant Field Values
  - INCLUDE_CHARSET_ATTRIBUTE
```
public static final java.lang.String INCLUDE_CHARSET_ATTRIBUTE
```
    <fx:include> 'charset' attribute
    
    See Also:
    
    Constant Field Values
  - SCRIPT_TAG
```
public static final java.lang.String SCRIPT_TAG
```
    The tag name of <fx:script>
    
    See Also:
    
    Constant Field Values
  - SCRIPT_SOURCE_ATTRIBUTE
```
public static final java.lang.String SCRIPT_SOURCE_ATTRIBUTE
```
    <fx:script> 'source' attribute
    
    See Also:
    
    Constant Field Values
  - SCRIPT_CHARSET_ATTRIBUTE
```
public static final java.lang.String SCRIPT_CHARSET_ATTRIBUTE
```
    <fx:script> 'charset' attribute
    
    See Also:
    
    Constant Field Values
  - DEFINE_TAG
```
public static final java.lang.String DEFINE_TAG
```
    The tag name of <fx:define>
    
    See Also:
    
    Constant Field Values
  - REFERENCE_TAG
```
public static final java.lang.String REFERENCE_TAG
```
    The tag name of <fx:reference>
    
    See Also:
    
    Constant Field Values
  - REFERENCE_SOURCE_ATTRIBUTE
```
public static final java.lang.String REFERENCE_SOURCE_ATTRIBUTE
```
    <fx:reference> 'source' attribute
    
    See Also:
    
    Constant Field Values
  - ROOT_TAG
```
public static final java.lang.String ROOT_TAG
```
    The tag name of <fx:root>
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    Constant Field Values
  - ROOT_TYPE_ATTRIBUTE
```
public static final java.lang.String ROOT_TYPE_ATTRIBUTE
```
    <fx:root> 'type' attribute
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    Constant Field Values
  - COPY_TAG
```
public static final java.lang.String COPY_TAG
```
    The tag name of <fx:copy>
    
    See Also:
    
    Constant Field Values
  - COPY_SOURCE_ATTRIBUTE
```
public static final java.lang.String COPY_SOURCE_ATTRIBUTE
```
    <fx:copy> 'source' attribute
    
    See Also:
    
    Constant Field Values
  - EVENT_HANDLER_PREFIX
```
public static final java.lang.String EVENT_HANDLER_PREFIX
```
    The prefix of event handler attributes
    
    See Also:
    
    Constant Field Values
  - EVENT_KEY
```
public static final java.lang.String EVENT_KEY
```
    The name of the Event object in event handler scripts
    
    See Also:
    
    Constant Field Values
  - CHANGE_EVENT_HANDLER_SUFFIX
```
public static final java.lang.String CHANGE_EVENT_HANDLER_SUFFIX
```
    Suffix for property change/invalidation handlers
    
    See Also:
    
    Constant Field Values
  - NULL_KEYWORD
```
public static final java.lang.String NULL_KEYWORD
```
    Value that represents 'null'
    
    See Also:
    
    Constant Field Values
  - ESCAPE_PREFIX
```
public static final java.lang.String ESCAPE_PREFIX
```
    Escape prefix for escaping special characters inside attribute values. Serves as an escape for ESCAPE_PREFIX, RELATIVE_PATH_PREFIX, #RESOURCE_KEY_PREFIX, {@link #EXPRESSION_PREFIX}, {@link #BI_DIRECTIONAL_BINDING_PREFIX}
    
    Since:
    
    JavaFX 2.1
    
    See Also:
    
    Constant Field Values
  - RELATIVE_PATH_PREFIX
```
public static final java.lang.String RELATIVE_PATH_PREFIX
```
    Prefix for relative location resultion
    
    See Also:
    
    Constant Field Values
  - RESOURCE_KEY_PREFIX
```
public static final java.lang.String RESOURCE_KEY_PREFIX
```
    Prefix for resource resolution
    
    See Also:
    
    Constant Field Values
  - EXPRESSION_PREFIX
```
public static final java.lang.String EXPRESSION_PREFIX
```
    Prefix for (variable) expression resolution
    
    See Also:
    
    Constant Field Values
  - BINDING_EXPRESSION_PREFIX
```
public static final java.lang.String BINDING_EXPRESSION_PREFIX
```
    Prefix for binding expression resolution
    
    See Also:
    
    Constant Field Values
  - BINDING_EXPRESSION_SUFFIX
```
public static final java.lang.String BINDING_EXPRESSION_SUFFIX
```
    Suffix for binding expression resolution
    
    See Also:
    
    Constant Field Values
  - BI_DIRECTIONAL_BINDING_PREFIX
```
public static final java.lang.String BI_DIRECTIONAL_BINDING_PREFIX
```
    Prefix for bidirectional-binding expression resolution
    
    Since:
    
    JavaFX 2.1
    
    See Also:
    
    Constant Field Values
  - BI_DIRECTIONAL_BINDING_SUFFIX
```
public static final java.lang.String BI_DIRECTIONAL_BINDING_SUFFIX
```
    Suffix for bidirectional-binding expression resolution
    
    Since:
    
    JavaFX 2.1
    
    See Also:
    
    Constant Field Values
  - ARRAY_COMPONENT_DELIMITER
```
public static final java.lang.String ARRAY_COMPONENT_DELIMITER
```
    Delimiter for arrays as values
    
    Since:
    
    JavaFX 2.1
    
    See Also:
    
    Constant Field Values
  - LOCATION_KEY
```
public static final java.lang.String LOCATION_KEY
```
    A key for location URL in namespace map
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    getNamespace(), Constant Field Values
  - RESOURCES_KEY
```
public static final java.lang.String RESOURCES_KEY
```
    A key for ResourceBundle in namespace map
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    getNamespace(), Constant Field Values
  - CONTROLLER_METHOD_PREFIX
```
public static final java.lang.String CONTROLLER_METHOD_PREFIX
```
    Prefix for controller method resolution
    
    See Also:
    
    Constant Field Values
  - CONTROLLER_KEYWORD
```
public static final java.lang.String CONTROLLER_KEYWORD
```
    A key for controller in namespace map
    
    Since:
    
    JavaFX 2.1
    
    See Also:
    
    getNamespace(), Constant Field Values
  - CONTROLLER_SUFFIX
```
public static final java.lang.String CONTROLLER_SUFFIX
```
    A suffix for controllers of included fxml files. The full key is stored in namespace map.
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    getNamespace(), Constant Field Values
  - INITIALIZE_METHOD_NAME
```
public static final java.lang.String INITIALIZE_METHOD_NAME
```
    The name of initialize method
    
    Since:
    
    JavaFX 2.2
    
    See Also:
    
    Constant Field Values
  - JAVAFX_VERSION
```
public static final java.lang.String JAVAFX_VERSION
```
    Contains the current javafx version
    
    Since:
    
    JavaFX 8.0
  - FX_NAMESPACE_VERSION
```
public static final java.lang.String FX_NAMESPACE_VERSION
```
    Contains the current fx namepsace version
    
    Since:
    
    JavaFX 8.0
    
    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 -
    
    Since:
    
    JavaFX 2.1
  - FXMLLoader
```
public FXMLLoader(java.net.URL location,
                  java.util.ResourceBundle resources)
```
    Creates a new FXMLLoader instance.
    
    Parameters:
    
    location -
    
    resources -
    
    Since:
    
    JavaFX 2.1
  - FXMLLoader
```
public FXMLLoader(java.net.URL location,
                  java.util.ResourceBundle resources,
                  BuilderFactory builderFactory)
```
    Creates a new FXMLLoader instance.
    
    Parameters:
    
    location -
    
    resources -
    
    builderFactory -
    
    Since:
    
    JavaFX 2.1
  - 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 -
    
    Since:
    
    JavaFX 2.1
  - 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 -
    
    Since:
    
    JavaFX 2.1
  - 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 -
    
    Since:
    
    JavaFX 2.1
- Method Detail
  - 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 -
  - 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> tag. This method must be called prior to loading the document when using <fx:root>.
    
    Parameters:
    
    root - The root of the object hierarchy.
    
    Since:
    
    JavaFX 2.2
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - getController
```
public <T> T getController()
```
    Returns the controller associated with the root object.
  - setController
```
public void setController(java.lang.Object controller)
```
    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.
    
    Parameters:
    
    controller - The controller to associate with the root object.
    
    Since:
    
    JavaFX 2.2
  - 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.
    
    Since:
    
    JavaFX 2.1
  - setControllerFactory
```
public void setControllerFactory(Callback<java.lang.Class<?>,java.lang.Object> controllerFactory)
```
    Sets the controller factory used by this serializer.
    
    Parameters:
    
    controllerFactory -
    
    Since:
    
    JavaFX 2.1
  - 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 -
    
    Since:
    
    JavaFX 2.1
  - getClassLoader
```
public java.lang.ClassLoader getClassLoader()
```
    Returns the classloader used by this serializer.
    
    Since:
    
    JavaFX 2.1
  - setClassLoader
```
public void setClassLoader(java.lang.ClassLoader classLoader)
```
    Sets the classloader used by this serializer and clears any existing imports
    
    Parameters:
    
    classLoader -
    
    Since:
    
    JavaFX 2.1
  - load
```
public <T> T 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
    
    Since:
    
    JavaFX 2.1
  - load
```
public <T> T 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.
    
    Since:
    
    JavaFX 2.1
  - 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.
    
    Since:
    
    JavaFX 2.1
  - 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
    
    Since:
    
    JavaFX 2.1
  - 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
    
    Since:
    
    JavaFX 2.1

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2008, 2026, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Class FXMLLoader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CHARSET_NAME

LANGUAGE_PROCESSING_INSTRUCTION

IMPORT_PROCESSING_INSTRUCTION

FX_NAMESPACE_PREFIX

FX_CONTROLLER_ATTRIBUTE

FX_ID_ATTRIBUTE

FX_VALUE_ATTRIBUTE

FX_CONSTANT_ATTRIBUTE

FX_FACTORY_ATTRIBUTE

INCLUDE_TAG

INCLUDE_SOURCE_ATTRIBUTE

INCLUDE_RESOURCES_ATTRIBUTE

INCLUDE_CHARSET_ATTRIBUTE

SCRIPT_TAG

SCRIPT_SOURCE_ATTRIBUTE

SCRIPT_CHARSET_ATTRIBUTE

DEFINE_TAG

REFERENCE_TAG

REFERENCE_SOURCE_ATTRIBUTE

ROOT_TAG

ROOT_TYPE_ATTRIBUTE

COPY_TAG

COPY_SOURCE_ATTRIBUTE

EVENT_HANDLER_PREFIX

EVENT_KEY

CHANGE_EVENT_HANDLER_SUFFIX

NULL_KEYWORD

ESCAPE_PREFIX

RELATIVE_PATH_PREFIX

RESOURCE_KEY_PREFIX

EXPRESSION_PREFIX

BINDING_EXPRESSION_PREFIX

BINDING_EXPRESSION_SUFFIX

BI_DIRECTIONAL_BINDING_PREFIX

BI_DIRECTIONAL_BINDING_SUFFIX

ARRAY_COMPONENT_DELIMITER

LOCATION_KEY

RESOURCES_KEY

CONTROLLER_METHOD_PREFIX

CONTROLLER_KEYWORD

CONTROLLER_SUFFIX

INITIALIZE_METHOD_NAME

JAVAFX_VERSION

FX_NAMESPACE_VERSION

Constructor Detail

FXMLLoader

FXMLLoader

FXMLLoader

FXMLLoader

FXMLLoader

FXMLLoader

FXMLLoader

FXMLLoader

Method Detail

getLocation

setLocation

getResources

setResources

getNamespace

getRoot

setRoot

equals

getController

setController

getBuilderFactory

setBuilderFactory

getControllerFactory

setControllerFactory

getCharset

setCharset

getClassLoader

setClassLoader

load

load