モジュール javafx.fxml
パッケージ javafx.fxml

クラスFXMLLoader


  • public class FXMLLoader
extends Object
    XMLドキュメントからオブジェクト階層をロードします。 詳細は、FXMLの概要ドキュメントを参照してください。
    導入されたバージョン:
    JavaFX 2.0

    • フィールドの詳細

      • DEFAULT_CHARSET_NAME

        public static final String DEFAULT_CHARSET_NAME
        文字セットが明示的に指定されていない場合に使用される文字セット
        関連項目:
        定数フィールド値

      • LANGUAGE_PROCESSING_INSTRUCTION

        public static final String LANGUAGE_PROCESSING_INSTRUCTION
        言語処理命令のタグ名
        関連項目:
        定数フィールド値

      • IMPORT_PROCESSING_INSTRUCTION

        public static final String IMPORT_PROCESSING_INSTRUCTION
        インポート処理命令のタグ名
        関連項目:
        定数フィールド値

      • FX_CONTROLLER_ATTRIBUTE

        public static final String FX_CONTROLLER_ATTRIBUTE
        ルートのfx:controller属性の名前
        関連項目:
        定数フィールド値

      • FX_CONSTANT_ATTRIBUTE

        public static final String FX_CONSTANT_ATTRIBUTE
        'fx:constant'のタグ名。
        導入されたバージョン:
        JavaFX 2.2
        関連項目:
        定数フィールド値

      • INCLUDE_RESOURCES_ATTRIBUTE

        public static final String INCLUDE_RESOURCES_ATTRIBUTE
        <fx:include> 'resources'属性。
        関連項目:
        定数フィールド値

      • INCLUDE_CHARSET_ATTRIBUTE

        public static final String INCLUDE_CHARSET_ATTRIBUTE
        <fx:include> 'charset'属性。
        関連項目:
        定数フィールド値

      • REFERENCE_SOURCE_ATTRIBUTE

        public static final String REFERENCE_SOURCE_ATTRIBUTE
        <fx:reference> 'source'属性。
        関連項目:
        定数フィールド値

      • ROOT_TAG

        public static final String ROOT_TAG
        <fx:root>のタグ名。
        導入されたバージョン:
        JavaFX 2.2
        関連項目:
        定数フィールド値

      • ROOT_TYPE_ATTRIBUTE

        public static final String ROOT_TYPE_ATTRIBUTE
        <fx:root> 'type'属性。
        導入されたバージョン:
        JavaFX 2.2
        関連項目:
        定数フィールド値

      • EVENT_HANDLER_PREFIX

        public static final String EVENT_HANDLER_PREFIX
        イベント・ハンドラ属性の接頭辞
        関連項目:
        定数フィールド値

      • EVENT_KEY

        public static final String EVENT_KEY
        イベント・ハンドラ・スクリプト内のイベント・オブジェクトの名前
        関連項目:
        定数フィールド値

      • CHANGE_EVENT_HANDLER_SUFFIX

        public static final String CHANGE_EVENT_HANDLER_SUFFIX
        プロパティ変更/無効化ハンドラの接尾辞
        関連項目:
        定数フィールド値

      • RELATIVE_PATH_PREFIX

        public static final String RELATIVE_PATH_PREFIX
        相対的なロケーションの解決のためのプレフィクス。
        関連項目:
        定数フィールド値

      • BINDING_EXPRESSION_PREFIX

        public static final String BINDING_EXPRESSION_PREFIX
        バインディング式解決の接頭辞
        関連項目:
        定数フィールド値

      • BINDING_EXPRESSION_SUFFIX

        public static final String BINDING_EXPRESSION_SUFFIX
        バインディング式解決の接尾辞
        関連項目:
        定数フィールド値

      • BI_DIRECTIONAL_BINDING_PREFIX

        public static final String BI_DIRECTIONAL_BINDING_PREFIX
        双方向バインディング式解決の接頭辞
        導入されたバージョン:
        JavaFX 2.1
        関連項目:
        定数フィールド値

      • BI_DIRECTIONAL_BINDING_SUFFIX

        public static final String BI_DIRECTIONAL_BINDING_SUFFIX
        双方向バインディング式解決の接尾辞
        導入されたバージョン:
        JavaFX 2.1
        関連項目:
        定数フィールド値

      • ARRAY_COMPONENT_DELIMITER

        public static final String ARRAY_COMPONENT_DELIMITER
        値としての配列のデリミタ
        導入されたバージョン:
        JavaFX 2.1
        関連項目:
        定数フィールド値

      • CONTROLLER_METHOD_PREFIX

        public static final String CONTROLLER_METHOD_PREFIX
        コントローラ・メソッド解決の接頭辞
        関連項目:
        定数フィールド値

      • CONTROLLER_KEYWORD

        public static final String CONTROLLER_KEYWORD
        ネームスペース・マップのコントローラのキー
        導入されたバージョン:
        JavaFX 2.1
        関連項目:
        getNamespace()、定数フィールド値

      • CONTROLLER_SUFFIX

        public static final String CONTROLLER_SUFFIX
        含まれているfxmlファイルのコントローラの接尾辞。 完全なキーはネームスペース・マップに保存されます。
        導入されたバージョン:
        JavaFX 2.2
        関連項目:
        getNamespace()、定数フィールド値

      • INITIALIZE_METHOD_NAME

        public static final String INITIALIZE_METHOD_NAME
        初期化メソッドの名前
        導入されたバージョン:
        JavaFX 2.2
        関連項目:
        定数フィールド値

      • JAVAFX_VERSION

        public static final String JAVAFX_VERSION
        現在のjavafxバージョンを含みます
        導入されたバージョン:
        JavaFX 8.0

      • FX_NAMESPACE_VERSION

        public static final String FX_NAMESPACE_VERSION
        現在のfxネームスペース・バージョンを含みます
        導入されたバージョン:
        JavaFX 8.0
        関連項目:
        定数フィールド値

    • コンストラクタの詳細

      • FXMLLoader

        public FXMLLoader​()
        新しいFXMLLoaderインスタンスを作成します。

      • FXMLLoader

        public FXMLLoader​(URL location)
        新しいFXMLLoaderインスタンスを作成します。
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        導入されたバージョン:
        JavaFX 2.1

      • FXMLLoader

        public FXMLLoader​(URL location,
                  ResourceBundle resources)
        新しいFXMLLoaderインスタンスを作成します。
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        resources - リソース・キー属性値を解決するために使用されるリソース
        導入されたバージョン:
        JavaFX 2.1

      • FXMLLoader

        public FXMLLoader​(URL location,
                  ResourceBundle resources,
                  BuilderFactory builderFactory)
        新しいFXMLLoaderインスタンスを作成します。
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        resources - リソース・キー属性値を解決するために使用されるリソース
        builderFactory - このローダーによって使用されるBuilderファクトリ
        導入されたバージョン:
        JavaFX 2.1

      • FXMLLoader

        public FXMLLoader​(URL location,
                  ResourceBundle resources,
                  BuilderFactory builderFactory,
                  Callback<Class<?>,Object> controllerFactory)
        新しいFXMLLoaderインスタンスを作成します。
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        resources - リソース・キー属性値を解決するために使用されるリソース
        builderFactory - このローダーによって使用されるBuilderファクトリ
        controllerFactory - このローダーによって使用されるコントローラ・ファクトリ
        導入されたバージョン:
        JavaFX 2.1

      • FXMLLoader

        public FXMLLoader​(Charset charset)
        新しいFXMLLoaderインスタンスを作成します。
        パラメータ:
        charset - このローダーによって使用される文字セット

      • FXMLLoader

        public FXMLLoader​(URL location,
                  ResourceBundle resources,
                  BuilderFactory builderFactory,
                  Callback<Class<?>,Object> controllerFactory,
                  Charset charset)
        新しいFXMLLoaderインスタンスを作成します。
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        resources - リソース・キー属性値を解決するために使用されるリソース
        builderFactory - このローダーによって使用されるBuilderファクトリ
        controllerFactory - このローダーによって使用されるコントローラ・ファクトリ
        charset - このローダーによって使用される文字セット
        導入されたバージョン:
        JavaFX 2.1

      • FXMLLoader

        public FXMLLoader​(URL location,
                  ResourceBundle resources,
                  BuilderFactory builderFactory,
                  Callback<Class<?>,Object> controllerFactory,
                  Charset charset,
                  LinkedList<FXMLLoader> loaders)
        新しいFXMLLoaderインスタンスを作成します。
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        resources - リソース・キー属性値を解決するために使用されるリソース
        builderFactory - このローダーによって使用されるBuilderファクトリ
        controllerFactory - このローダーによって使用されるコントローラ・ファクトリ
        charset - このローダーによって使用される文字セット
        loaders - ローダーのリスト
        導入されたバージョン:
        JavaFX 2.1

    • メソッドの詳細

      • getLocation

        public URL getLocation​()
        相対パス属性値の解決に使用される位置を返します。
        戻り値:
        相対パスの属性値を解決するために使用されるロケーション

      • setLocation

        public void setLocation​(URL location)
        相対パス属性値の解決に使用される位置を設定します。
        パラメータ:
        location - ロケーション

      • getResources

        public ResourceBundle getResources​()
        リソース・キー属性値の解決に使用されるリソースを返します。
        戻り値:
        リソース・キー属性値を解決するために使用されるリソース

      • setResources

        public void setResources​(ResourceBundle resources)
        リソース・キー属性値の解決に使用されるリソースを設定します。
        パラメータ:
        resources - リソース

      • getNamespace

        public ObservableMap<String,Object> getNamespace​()
        このローダーで使用されるネームスペースを返します。
        戻り値:
        ネームスペース

      • getRoot

        public <T> T getRoot​()
        オブジェクト階層のルートを返します。
        型パラメータ:
        T - ルート・オブジェクトの型
        戻り値:
        オブジェクト階層のルート

      • setRoot

        public void setRoot​(Object root)
        オブジェクト階層のルートを設定します。 このメソッドに渡される値は、<fx:root>タグの値として使用されます。 <fx:root>を使用する場合、ドキュメントをロードする前にこのメソッドをコールする必要があります。
        パラメータ:
        root - オブジェクト階層のルート
        導入されたバージョン:
        JavaFX 2.2

      • equals

        public boolean equals​(Object obj)
        次のクラスからコピーされた説明: Object
        このオブジェクトと他のオブジェクトが等しいかどうかを示します。

        equalsメソッドは、null以外のオブジェクト参照での同値関係を実装します。

        • 反射性(reflexive): null以外の参照値xについて、x.equals(x)はtrueを返します。
        • 対称性(symmetric): null以外の参照値xおよびyについて、y.equals(x)がtrueを返す場合に限り、x.equals(y)はtrueを返します。
        • 推移性(transitive): null以外の参照値x、y、およびzについて、x.equals(y)がtrueを返し、y.equals(z)がtrueを返す場合、x.equals(z)はtrueを返します。
        • 一貫性(consistent): null以外の参照値xおよびyについて、x.equals(y)の複数の呼出しは、このオブジェクトに対するequalsによる比較で使われた情報が変更されていなければ、一貫してtrueを返すか、一貫してfalseを返します。
        • null以外の参照値xについて、x.equals(null)はfalseを返します。

        Objectクラスのequalsメソッドは、もっとも比較しやすいオブジェクトの同値関係を実装します。つまり、null以外の参照値xとyについて、このメソッドはxとyが同じオブジェクトを参照する(x == yがtrue)場合にだけtrueを返します。

        通常、このメソッドをオーバーライドする場合は、hashCodeメソッドを常にオーバーライドして、等価なオブジェクトは等価なハッシュ・コードを保持する必要があるというhashCodeメソッドの汎用規約に従う必要があることに留意してください。

        オーバーライド:
        equals 、クラス:  Object
        パラメータ:
        obj - 比較対象の参照オブジェクト。
        戻り値:
        このオブジェクトがobj引数と同じである場合はtrue、それ以外の場合はfalse。
        関連項目:
        Object.hashCode()、HashMap

      • getController

        public <T> T getController​()
        ルート・オブジェクトに関連付けられているコントローラを返します。
        型パラメータ:
        T - コントローラの型
        戻り値:
        ルート・オブジェクトに関連付けられたコントローラ

      • setController

        public void setController​(Object controller)
        ルート・オブジェクトに関連付けられているコントローラを設定します。 このメソッドに渡される値は、fx:controller属性の値として使用されます。 fx:controller属性がドキュメントで指定されていない場合、コントローラ・イベント・ハンドラを使用する際に、ドキュメントをロードする前にこのメソッドをコールする必要があります。
        パラメータ:
        controller - ルート・オブジェクトに関連付けるコントローラ
        導入されたバージョン:
        JavaFX 2.2

      • getBuilderFactory

        public BuilderFactory getBuilderFactory​()
        このローダーで使用されるビルダー・ファクトリを返します。
        戻り値:
        ビルダー・ファクトリ

      • setBuilderFactory

        public void setBuilderFactory​(BuilderFactory builderFactory)
        このローダーで使用されるビルダー・ファクトリを設定します。
        パラメータ:
        builderFactory - ビルダー・ファクトリ

      • getControllerFactory

        public Callback<Class<?>,Object> getControllerFactory​()
        このローダーによって使用されるコントローラ・ファクトリを返します。
        戻り値:
        コントローラ・ファクトリ
        導入されたバージョン:
        JavaFX 2.1

      • setControllerFactory

        public void setControllerFactory​(Callback<Class<?>,Object> controllerFactory)
        このローダーによって使用されるコントローラ・ファクトリを設定します。
        パラメータ:
        controllerFactory - コントローラ・ファクトリ
        導入されたバージョン:
        JavaFX 2.1

      • getCharset

        public Charset getCharset​()
        このローダーで使用される文字セットを返します。
        戻り値:
        文字セット

      • setCharset

        public void setCharset​(Charset charset)
        このローダーによって使用される文字セットを設定します。
        パラメータ:
        charset - 文字セット
        導入されたバージョン:
        JavaFX 2.1

      • getClassLoader

        public ClassLoader getClassLoader​()
        このローダーによって使用されるクラス・ローダーを返します。
        戻り値:
        クラス・ローダー
        導入されたバージョン:
        JavaFX 2.1

      • setClassLoader

        public void setClassLoader​(ClassLoader classLoader)
        このローダーによって使用されるクラス・ローダーを設定し、既存のインポートをすべてクリアします。
        パラメータ:
        classLoader - クラス・ローダー
        導入されたバージョン:
        JavaFX 2.1

      • getLoadListener

        public LoadListener getLoadListener​()
        このローダーのロード・リスナーを返します。
        戻り値:
        ロード・リスナー
        導入されたバージョン:
        9

      • setLoadListener

        public final void setLoadListener​(LoadListener loadListener)
        このローダーのロード・リスナーを設定します。
        パラメータ:
        loadListener - ロード・リスナー
        導入されたバージョン:
        9

      • load

        public <T> T load​()
           throws IOException
        FXMLドキュメントからオブジェクト階層をロードします。 ドキュメントのロード元の場所は、setLocation(URL)への事前のコールによって設定されている必要があります。
        型パラメータ:
        T - ルート・オブジェクトの型
        戻り値:
        ロードされたオブジェクト階層
        例外:
        IOException - ロード中にエラーが発生した場合
        導入されたバージョン:
        JavaFX 2.1

      • load

        public <T> T load​(InputStream inputStream)
           throws IOException
        FXMLドキュメントからオブジェクト階層をロードします。
        型パラメータ:
        T - ルート・オブジェクトの型
        パラメータ:
        inputStream - ロードするFXMLデータを含む入力ストリーム
        戻り値:
        ロードされたオブジェクト階層
        例外:
        IOException - ロード中にエラーが発生した場合

      • loadType

        @Deprecated
public static Class<?> loadType​(String packageName,
                                String className)
                         throws ClassNotFoundException
        非推奨。  このメソッドは、現在はgetDefaultClassLoader()に委譲します。
        デフォルトのクラス・ローダーを使用して型をロードします。
        パラメータ:
        packageName - ロードするクラスのパッケージ名
        className - ロードするクラスの名前
        戻り値:
        クラス
        例外:
        ClassNotFoundException - 指定されたクラスが見つからない場合

      • loadType

        @Deprecated
public static Class<?> loadType​(String className)
                         throws ClassNotFoundException
        非推奨。  このメソッドは、現在はgetDefaultClassLoader()に委譲します。
        デフォルトのクラス・ローダーを使用して型をロードします。
        パラメータ:
        className - ロードするクラスの名前
        戻り値:
        クラス
        例外:
        ClassNotFoundException - 指定されたクラスが見つからない場合

      • getDefaultClassLoader

        public static ClassLoader getDefaultClassLoader​()
        デフォルトのクラス・ローダーを返します。
        戻り値:
        デフォルトのクラス・ローダー
        導入されたバージョン:
        JavaFX 2.1

      • setDefaultClassLoader

        public static void setDefaultClassLoader​(ClassLoader defaultClassLoader)
        デフォルトのクラス・ローダーを設定します。
        パラメータ:
        defaultClassLoader - クラスのロード時に使用するデフォルトのクラス・ローダー。
        導入されたバージョン:
        JavaFX 2.1

      • load

        public static <T> T load​(URL location)
                  throws IOException
        FXMLドキュメントからオブジェクト階層をロードします。
        型パラメータ:
        T - ルート・オブジェクトの型
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        戻り値:
        ロードされたオブジェクト階層
        例外:
        IOException - ロード中にエラーが発生した場合

      • load

        public static <T> T load​(URL location,
                         ResourceBundle resources)
                  throws IOException
        FXMLドキュメントからオブジェクト階層をロードします。
        型パラメータ:
        T - ルート・オブジェクトの型
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        resources - リソース・キー属性値を解決するために使用されるリソース
        戻り値:
        ロードされたオブジェクト階層
        例外:
        IOException - ロード中にエラーが発生した場合

      • load

        public static <T> T load​(URL location,
                         ResourceBundle resources,
                         BuilderFactory builderFactory)
                  throws IOException
        FXMLドキュメントからオブジェクト階層をロードします。
        型パラメータ:
        T - ルート・オブジェクトの型
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        resources - リソース・キー属性値を解決するために使用されるリソース
        builderFactory - ドキュメントをロードするために使用されるBuilderファクトリ
        戻り値:
        ロードされたオブジェクト階層
        例外:
        IOException - ロード中にエラーが発生した場合

      • load

        public static <T> T load​(URL location,
                         ResourceBundle resources,
                         BuilderFactory builderFactory,
                         Callback<Class<?>,Object> controllerFactory)
                  throws IOException
        FXMLドキュメントからオブジェクト階層をロードします。
        型パラメータ:
        T - ルート・オブジェクトの型
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        resources - リソース・キー属性値を解決するために使用されるリソース
        builderFactory - ドキュメントのロード時に使用されるBuilderファクトリ
        controllerFactory - ドキュメントをロードするときに使用されるコントローラ・ファクトリ
        戻り値:
        ロードされたオブジェクト階層
        例外:
        IOException - ロード中にエラーが発生した場合
        導入されたバージョン:
        JavaFX 2.1

      • load

        public static <T> T load​(URL location,
                         ResourceBundle resources,
                         BuilderFactory builderFactory,
                         Callback<Class<?>,Object> controllerFactory,
                         Charset charset)
                  throws IOException
        FXMLドキュメントからオブジェクト階層をロードします。
        型パラメータ:
        T - ルート・オブジェクトの型
        パラメータ:
        location - 相対パスの属性値を解決するために使用されるロケーション
        resources - リソース・キー属性値を解決するために使用されるリソース
        builderFactory - ドキュメントのロード時に使用されるBuilderファクトリ
        controllerFactory - ドキュメントをロードするときに使用されるコントローラ・ファクトリ
        charset - ドキュメントのロード時に使用される文字セット
        戻り値:
        ロードされたオブジェクト階層
        例外:
        IOException - ロード中にエラーが発生した場合
        導入されたバージョン:
        JavaFX 2.1