Spec-Zone.ru › OpenJavaFX 8
javafx.fxml

Class FXMLLoader

java.lang.Object
  • javafx.fxml.FXMLLoader


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

Since:

JavaFX 2.0

  • Field Summary

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

    Constructors
    Constructor and Description
    FXMLLoader()
    Creates a new FXMLLoader instance.
    FXMLLoader(Charset charset)
    Creates a new FXMLLoader instance.
    FXMLLoader(URL location)
    Creates a new FXMLLoader instance.
    FXMLLoader(URL location, ResourceBundle resources)
    Creates a new FXMLLoader instance.
    FXMLLoader(URL location, ResourceBundle resources, BuilderFactory builderFactory)
    Creates a new FXMLLoader instance.
    FXMLLoader(URL location, ResourceBundle resources, BuilderFactory builderFactory, Callback<Class<?>,Object> controllerFactory)
    Creates a new FXMLLoader instance.
    FXMLLoader(URL location, ResourceBundle resources, BuilderFactory builderFactory, Callback<Class<?>,Object> controllerFactory, Charset charset)
    Creates a new FXMLLoader instance.
    FXMLLoader(URL location, ResourceBundle resources, BuilderFactory builderFactory, Callback<Class<?>,Object> controllerFactory, Charset charset, LinkedList<FXMLLoader> loaders)
    Creates a new FXMLLoader instance.
  • Method Summary

    All MethodsStatic MethodsInstance MethodsConcrete MethodsDeprecated Methods
    Modifier and Type Method and Description
    boolean equals(Object obj)
    BuilderFactory getBuilderFactory()
    Returns the builder factory used by this loader.
    Charset getCharset()
    Returns the character set used by this loader.
    ClassLoader getClassLoader()
    Returns the classloader used by this serializer.
    <T> T getController()
    Returns the controller associated with the root object.
    Callback<Class<?>,Object> getControllerFactory()
    Returns the controller factory used by this serializer.
    static ClassLoader getDefaultClassLoader()
    Returns the default class loader.
    URL getLocation()
    Returns the location used to resolve relative path attribute values.
    ObservableMap<String,Object> getNamespace()
    Returns the namespace used by this loader.
    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(InputStream inputStream)
    Loads an object hierarchy from a FXML document.
    static <T> T load(URL location)
    Loads an object hierarchy from a FXML document.
    static <T> T load(URL location, ResourceBundle resources)
    Loads an object hierarchy from a FXML document.
    static <T> T load(URL location, ResourceBundle resources, BuilderFactory builderFactory)
    Loads an object hierarchy from a FXML document.
    static <T> T load(URL location, ResourceBundle resources, BuilderFactory builderFactory, Callback<Class<?>,Object> controllerFactory)
    Loads an object hierarchy from a FXML document.
    static <T> T load(URL location, ResourceBundle resources, BuilderFactory builderFactory, Callback<Class<?>,Object> controllerFactory, Charset charset)
    Loads an object hierarchy from a FXML document.
    static Class<?> loadType(String className)
    Deprecated.
    This method now delegates to getDefaultClassLoader().
    static Class<?> loadType(String packageName, String className)
    Deprecated.
    This method now delegates to getDefaultClassLoader().
    void setBuilderFactory(BuilderFactory builderFactory)
    Sets the builder factory used by this loader.
    void setCharset(Charset charset)
    Sets the charset used by this loader.
    void setClassLoader(ClassLoader classLoader)
    Sets the classloader used by this serializer and clears any existing imports
    void setController(Object controller)
    Sets the controller associated with the root object.
    void setControllerFactory(Callback<Class<?>,Object> controllerFactory)
    Sets the controller factory used by this serializer.
    static void setDefaultClassLoader(ClassLoader defaultClassLoader)
    Sets the default class loader.
    void setLocation(URL location)
    Sets the location used to resolve relative path attribute values.
    void setResources(ResourceBundle resources)
    Sets the resources used to resolve resource key attribute values.
    void setRoot(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 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 String LANGUAGE_PROCESSING_INSTRUCTION
      The tag name of language processing instruction

      See Also:

      Constant Field Values

    • IMPORT_PROCESSING_INSTRUCTION

      public static final String IMPORT_PROCESSING_INSTRUCTION
      The tag name of import processing instruction

      See Also:

      Constant Field Values

    • FX_NAMESPACE_PREFIX

      public static final String FX_NAMESPACE_PREFIX
      Prefix of 'fx' namespace

      See Also:

      Constant Field Values

    • FX_CONTROLLER_ATTRIBUTE

      public static final String FX_CONTROLLER_ATTRIBUTE
      The name of fx:controller attribute of a root

      See Also:

      Constant Field Values

    • FX_ID_ATTRIBUTE

      public static final String FX_ID_ATTRIBUTE
      The name of fx:id attribute

      See Also:

      Constant Field Values

    • FX_VALUE_ATTRIBUTE

      public static final String FX_VALUE_ATTRIBUTE
      The name of fx:value attribute

      See Also:

      Constant Field Values

    • FX_CONSTANT_ATTRIBUTE

      public static final 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 String FX_FACTORY_ATTRIBUTE
      The name of 'fx:factory' attribute

      See Also:

      Constant Field Values

    • INCLUDE_TAG

      public static final String INCLUDE_TAG
      The tag name of <fx:include>

      See Also:

      Constant Field Values

    • INCLUDE_SOURCE_ATTRIBUTE

      public static final String INCLUDE_SOURCE_ATTRIBUTE
      <fx:include> 'source' attribute

      See Also:

      Constant Field Values

    • INCLUDE_RESOURCES_ATTRIBUTE

      public static final String INCLUDE_RESOURCES_ATTRIBUTE
      <fx:include> 'resources' attribute

      See Also:

      Constant Field Values

    • INCLUDE_CHARSET_ATTRIBUTE

      public static final String INCLUDE_CHARSET_ATTRIBUTE
      <fx:include> 'charset' attribute

      See Also:

      Constant Field Values

    • SCRIPT_TAG

      public static final String SCRIPT_TAG
      The tag name of <fx:script>

      See Also:

      Constant Field Values

    • SCRIPT_SOURCE_ATTRIBUTE

      public static final String SCRIPT_SOURCE_ATTRIBUTE
      <fx:script> 'source' attribute

      See Also:

      Constant Field Values

    • SCRIPT_CHARSET_ATTRIBUTE

      public static final String SCRIPT_CHARSET_ATTRIBUTE
      <fx:script> 'charset' attribute

      See Also:

      Constant Field Values

    • DEFINE_TAG

      public static final String DEFINE_TAG
      The tag name of <fx:define>

      See Also:

      Constant Field Values

    • REFERENCE_TAG

      public static final String REFERENCE_TAG
      The tag name of <fx:reference>

      See Also:

      Constant Field Values

    • REFERENCE_SOURCE_ATTRIBUTE

      public static final String REFERENCE_SOURCE_ATTRIBUTE
      &ltfx:reference&gt 'source' attribute

      See Also:

      Constant Field Values

    • ROOT_TAG

      public static final String ROOT_TAG
      The tag name of <fx:root>

      Since:

      JavaFX 2.2

      See Also:

      Constant Field Values

    • ROOT_TYPE_ATTRIBUTE

      public static final String ROOT_TYPE_ATTRIBUTE
      <fx:root> 'type' attribute

      Since:

      JavaFX 2.2

      See Also:

      Constant Field Values

    • COPY_TAG

      public static final String COPY_TAG
      The tag name of <fx:copy>

      See Also:

      Constant Field Values

    • COPY_SOURCE_ATTRIBUTE

      public static final String COPY_SOURCE_ATTRIBUTE
      <fx:copy> 'source' attribute

      See Also:

      Constant Field Values

    • EVENT_HANDLER_PREFIX

      public static final String EVENT_HANDLER_PREFIX
      The prefix of event handler attributes

      See Also:

      Constant Field Values

    • EVENT_KEY

      public static final 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 String CHANGE_EVENT_HANDLER_SUFFIX
      Suffix for property change/invalidation handlers

      See Also:

      Constant Field Values

    • NULL_KEYWORD

      public static final String NULL_KEYWORD
      Value that represents 'null'

      See Also:

      Constant Field Values

    • ESCAPE_PREFIX

      public static final 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 String RELATIVE_PATH_PREFIX
      Prefix for relative location resultion

      See Also:

      Constant Field Values

    • RESOURCE_KEY_PREFIX

      public static final String RESOURCE_KEY_PREFIX
      Prefix for resource resolution

      See Also:

      Constant Field Values

    • EXPRESSION_PREFIX

      public static final String EXPRESSION_PREFIX
      Prefix for (variable) expression resolution

      See Also:

      Constant Field Values

    • BINDING_EXPRESSION_PREFIX

      public static final String BINDING_EXPRESSION_PREFIX
      Prefix for binding expression resolution

      See Also:

      Constant Field Values

    • BINDING_EXPRESSION_SUFFIX

      public static final String BINDING_EXPRESSION_SUFFIX
      Suffix for binding expression resolution

      See Also:

      Constant Field Values

    • BI_DIRECTIONAL_BINDING_PREFIX

      public static final 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 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 String ARRAY_COMPONENT_DELIMITER
      Delimiter for arrays as values

      Since:

      JavaFX 2.1

      See Also:

      Constant Field Values

    • LOCATION_KEY

      public static final 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 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 String CONTROLLER_METHOD_PREFIX
      Prefix for controller method resolution

      See Also:

      Constant Field Values

    • CONTROLLER_KEYWORD

      public static final 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 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 String INITIALIZE_METHOD_NAME
      The name of initialize method

      Since:

      JavaFX 2.2

      See Also:

      Constant Field Values

    • JAVAFX_VERSION

      public static final String JAVAFX_VERSION
      Contains the current javafx version

      Since:

      JavaFX 8.0

    • FX_NAMESPACE_VERSION

      public static final 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(URL location)
      Creates a new FXMLLoader instance.

      Parameters:

      location -

      Since:

      JavaFX 2.1

    • FXMLLoader

      public FXMLLoader(URL location,
                        ResourceBundle resources)
      Creates a new FXMLLoader instance.

      Parameters:

      location -

      Since:

      JavaFX 2.1

    • FXMLLoader

      public FXMLLoader(URL location,
                        ResourceBundle resources,
                        BuilderFactory builderFactory)
      Creates a new FXMLLoader instance.

      Parameters:

      location -

      Since:

      JavaFX 2.1

    • FXMLLoader

      public FXMLLoader(URL location,
                        ResourceBundle resources,
                        BuilderFactory builderFactory,
                        Callback<Class<?>,Object> controllerFactory)
      Creates a new FXMLLoader instance.

      Parameters:

      location -

      Since:

      JavaFX 2.1

    • FXMLLoader

      public FXMLLoader(Charset charset)
      Creates a new FXMLLoader instance.

      Parameters:

      charset -

    • FXMLLoader

      public FXMLLoader(URL location,
                        ResourceBundle resources,
                        BuilderFactory builderFactory,
                        Callback<Class<?>,Object> controllerFactory,
                        Charset charset)
      Creates a new FXMLLoader instance.

      Parameters:

      location -

      Since:

      JavaFX 2.1

    • FXMLLoader

      public FXMLLoader(URL location,
                        ResourceBundle resources,
                        BuilderFactory builderFactory,
                        Callback<Class<?>,Object> controllerFactory,
                        Charset charset,
                        LinkedList<FXMLLoader> loaders)
      Creates a new FXMLLoader instance.

      Parameters:

      location -

      Since:

      JavaFX 2.1

  • Method Detail

    • getLocation

      public URL getLocation()
      Returns the location used to resolve relative path attribute values.
    • setLocation

      public void setLocation(URL location)
      Sets the location used to resolve relative path attribute values.

      Parameters:

      location -

    • getResources

      public ResourceBundle getResources()
      Returns the resources used to resolve resource key attribute values.
    • setResources

      public void setResources(ResourceBundle resources)
      Sets the resources used to resolve resource key attribute values.

      Parameters:

      resources -

    • getNamespace

      public ObservableMap<String,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(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(Object obj)

      Overrides:

      equals in class Object

    • getController

      public <T> T getController()
      Returns the controller associated with the root object.
    • setController

      public void setController(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<Class<?>,Object> getControllerFactory()
      Returns the controller factory used by this serializer.

      Since:

      JavaFX 2.1

    • setControllerFactory

      public void setControllerFactory(Callback<Class<?>,Object> controllerFactory)
      Sets the controller factory used by this serializer.

      Parameters:

      controllerFactory -

      Since:

      JavaFX 2.1

    • getCharset

      public Charset getCharset()
      Returns the character set used by this loader.
    • setCharset

      public void setCharset(Charset charset)
      Sets the charset used by this loader.

      Parameters:

      charset -

      Since:

      JavaFX 2.1

    • getClassLoader

      public ClassLoader getClassLoader()
      Returns the classloader used by this serializer.

      Since:

      JavaFX 2.1

    • setClassLoader

      public void setClassLoader(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 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).

      When the "template" flag is set to false (the default), this method will clear the imports before loading the document's content. When "template" is true, the imports will not be cleared, and the root value will be set to null before the content is loaded. This helps improve performance on subsequent loads by eliminating the overhead of loading the classes referred to by the document.

      Returns:

      The loaded object hierarchy.

      Throws:

      IOException

      Since:

      JavaFX 2.1

    • load

      public <T> T load(InputStream inputStream)
                 throws 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:

      IOException

    • loadType

      public static Class<?> loadType(String packageName,
                                      String className)
                               throws ClassNotFoundException
      Deprecated. This method now delegates to getDefaultClassLoader().
      Loads a type using the default class loader.

      Parameters:

      packageName -

      Throws:

      ClassNotFoundException

    • loadType

      public static Class<?> loadType(String className)
                               throws ClassNotFoundException
      Deprecated. This method now delegates to getDefaultClassLoader().
      Loads a type using the default class loader.

      Parameters:

      className -

      Throws:

      ClassNotFoundException

    • getDefaultClassLoader

      public static ClassLoader getDefaultClassLoader()
      Returns the default class loader.

      Since:

      JavaFX 2.1

    • setDefaultClassLoader

      public static void setDefaultClassLoader(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(URL location)
                        throws IOException
      Loads an object hierarchy from a FXML document.

      Parameters:

      location -

      Throws:

      IOException

    • load

      public static <T> T load(URL location,
                               ResourceBundle resources)
                        throws IOException
      Loads an object hierarchy from a FXML document.

      Parameters:

      location -

      Throws:

      IOException

    • load

      public static <T> T load(URL location,
                               ResourceBundle resources,
                               BuilderFactory builderFactory)
                        throws IOException
      Loads an object hierarchy from a FXML document.

      Parameters:

      location -

      Throws:

      IOException

    • load

      public static <T> T load(URL location,
                               ResourceBundle resources,
                               BuilderFactory builderFactory,
                               Callback<Class<?>,Object> controllerFactory)
                        throws IOException
      Loads an object hierarchy from a FXML document.

      Parameters:

      location -

      Throws:

      IOException

      Since:

      JavaFX 2.1

    • load

      public static <T> T load(URL location,
                               ResourceBundle resources,
                               BuilderFactory builderFactory,
                               Callback<Class<?>,Object> controllerFactory,
                               Charset charset)
                        throws IOException
      Loads an object hierarchy from a FXML document.

      Parameters:

      location -

      Throws:

      IOException

      Since:

      JavaFX 2.1

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API