org.eclipse.fx.osgi.util

Class OSGiFXMLLoader

java.lang.Object

org.eclipse.fx.osgi.util.OSGiFXMLLoader

public class OSGiFXMLLoader
extends java.lang.Object

Helper class which is able to load FXML-Files in OSGi is an easy way

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OSGiFXMLLoader.FXMLData<N,C> Data structured holding data constructed while loading the FXML-Document

Constructor Summary

Constructors

Constructor and Description
OSGiFXMLLoader()

Method Summary

Modifier and Type	Method and Description
static <O> O	load(@NonNull org.osgi.framework.Bundle bundle, @NonNull java.lang.String bundleRelativeFxmlPath, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory) Load a FXML file relative to the bundle
static <O> O	load(@NonNull org.osgi.framework.Bundle bundle, @NonNull java.lang.String bundleRelativeFxmlPath, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory, @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory) Load a FXML file relative to the bundle
static <O> O	load(@NonNull java.lang.Class<?> requester, @NonNull java.lang.String relativeFxmlPath, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory) Load a FXML file relative to the requested
static <O> O	load(@NonNull java.lang.Class<?> requester, @NonNull java.lang.String relativeFxmlPath, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory, @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory) Load a FXML file relative to the requested
static <O> O	load(@NonNull java.lang.ClassLoader classloader, @NonNull java.net.URL url, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory) Load using the given classloader
static <O> O	load(@NonNull java.lang.ClassLoader classloader, @NonNull java.net.URL url, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory, @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory) Load using the given classloader
static <O,C> OSGiFXMLLoader.FXMLData<O,C>	loadWithController(@NonNull org.osgi.framework.Bundle bundle, @NonNull java.lang.String bundleRelativeFxmlPath, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory) Load a FXML file relative to the bundle and provide the constructed scene-node and the controller
static <O,C> OSGiFXMLLoader.FXMLData<O,C>	loadWithController(@NonNull org.osgi.framework.Bundle bundle, @NonNull java.lang.String bundleRelativeFxmlPath, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory, @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory) Load a FXML file relative to the bundle and provide the constructed scene-node and the controller
static <O,C> OSGiFXMLLoader.FXMLData<O,C>	loadWithController(@NonNull java.lang.Class<?> requester, @NonNull java.lang.String relativeFxmlPath, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory) Load a FXML file relative to the requested and provide the constructed scene-node and the controller
static <O,C> OSGiFXMLLoader.FXMLData<O,C>	loadWithController(@NonNull java.lang.Class<?> requester, @NonNull java.lang.String relativeFxmlPath, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory, @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory) Load a FXML file relative to the requested and provide the constructed scene-node and the controller
static <O,C> OSGiFXMLLoader.FXMLData<O,C>	loadWithController(@NonNull java.lang.ClassLoader classloader, @NonNull java.net.URL url, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory) Load using the given classloader and provide the constructed scene-node and the controller
static <O,C> OSGiFXMLLoader.FXMLData<O,C>	loadWithController(@NonNull java.lang.ClassLoader classloader, @NonNull java.net.URL url, @Nullable java.util.ResourceBundle resourceBundle, @Nullable javafx.util.BuilderFactory builderFactory, @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory) Load using the given classloader and provide the constructed scene-node and the controller

Methods inherited from class java.lang.Object

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

Constructor Detail

OSGiFXMLLoader

public OSGiFXMLLoader()

Method Detail

load

public static <O> O load(@NonNull java.lang.Class<?> requester,
                         @NonNull java.lang.String relativeFxmlPath,
                         @Nullable java.util.ResourceBundle resourceBundle,
                         @Nullable javafx.util.BuilderFactory builderFactory)
                  throws java.io.IOException

Load a FXML file relative to the requested

Parameters:

requester - the requester

relativeFxmlPath - the relative FXML-File Path

resourceBundle - the translation to be used

builderFactory - the builder factory to use

Returns:

the created scene graph

Throws:

java.io.IOException

loadWithController

public static <O,C> OSGiFXMLLoader.FXMLData<O,C> loadWithController(@NonNull java.lang.Class<?> requester,
                                                                    @NonNull java.lang.String relativeFxmlPath,
                                                                    @Nullable java.util.ResourceBundle resourceBundle,
                                                                    @Nullable javafx.util.BuilderFactory builderFactory)
                                                             throws java.io.IOException

Load a FXML file relative to the requested and provide the constructed scene-node and the controller

Parameters:

requester - the requester

relativeFxmlPath - the relative FXML-File Path

resourceBundle - the translation to be used

builderFactory - the builder factory to use

Returns:

the created scene graph

Throws:

java.io.IOException

load

public static <O> O load(@NonNull org.osgi.framework.Bundle bundle,
                         @NonNull java.lang.String bundleRelativeFxmlPath,
                         @Nullable java.util.ResourceBundle resourceBundle,
                         @Nullable javafx.util.BuilderFactory builderFactory)
                  throws java.io.IOException

Load a FXML file relative to the bundle

Parameters:

bundle - the bundle

bundleRelativeFxmlPath - the bundle relative path

resourceBundle - the translation to be used

builderFactory - the builder factory to use

Returns:

the created scene graph

Throws:

java.io.IOException

loadWithController

public static <O,C> OSGiFXMLLoader.FXMLData<O,C> loadWithController(@NonNull org.osgi.framework.Bundle bundle,
                                                                    @NonNull java.lang.String bundleRelativeFxmlPath,
                                                                    @Nullable java.util.ResourceBundle resourceBundle,
                                                                    @Nullable javafx.util.BuilderFactory builderFactory)
                                                             throws java.io.IOException

Load a FXML file relative to the bundle and provide the constructed scene-node and the controller

Parameters:

bundle - the bundle

bundleRelativeFxmlPath - the bundle relative path

resourceBundle - the translation to be used

builderFactory - the builder factory to use

Returns:

the created scene graph

Throws:

java.io.IOException

load

public static <O> O load(@NonNull java.lang.ClassLoader classloader,
                         @NonNull java.net.URL url,
                         @Nullable java.util.ResourceBundle resourceBundle,
                         @Nullable javafx.util.BuilderFactory builderFactory)
                  throws java.io.IOException

Load using the given classloader

Parameters:

classloader - the classloader

url - the url of the fxml file

resourceBundle - the translations

builderFactory - the builder factory

Returns:

the created scene graph

Throws:

java.io.IOException

loadWithController

public static <O,C> OSGiFXMLLoader.FXMLData<O,C> loadWithController(@NonNull java.lang.ClassLoader classloader,
                                                                    @NonNull java.net.URL url,
                                                                    @Nullable java.util.ResourceBundle resourceBundle,
                                                                    @Nullable javafx.util.BuilderFactory builderFactory)
                                                             throws java.io.IOException

Load using the given classloader and provide the constructed scene-node and the controller

Parameters:

classloader - the classloader

url - the url of the fxml file

resourceBundle - the translations

builderFactory - the builder factory

Returns:

the created scene graph

Throws:

java.io.IOException

load

public static <O> O load(@NonNull java.lang.Class<?> requester,
                         @NonNull java.lang.String relativeFxmlPath,
                         @Nullable java.util.ResourceBundle resourceBundle,
                         @Nullable javafx.util.BuilderFactory builderFactory,
                         @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory)
                  throws java.io.IOException

Load a FXML file relative to the requested

Parameters:

requester - the requester

relativeFxmlPath - the relative FXML-File Path

resourceBundle - the translation to be used

builderFactory - the builder factory to use

controllerFactory - the controller factory

Returns:

the created scene graph

Throws:

java.io.IOException

loadWithController

public static <O,C> OSGiFXMLLoader.FXMLData<O,C> loadWithController(@NonNull java.lang.Class<?> requester,
                                                                    @NonNull java.lang.String relativeFxmlPath,
                                                                    @Nullable java.util.ResourceBundle resourceBundle,
                                                                    @Nullable javafx.util.BuilderFactory builderFactory,
                                                                    @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory)
                                                             throws java.io.IOException

Load a FXML file relative to the requested and provide the constructed scene-node and the controller

Parameters:

requester - the requester

relativeFxmlPath - the relative FXML-File Path

resourceBundle - the translation to be used

builderFactory - the builder factory to use

controllerFactory - the controller factory

Returns:

the created scene graph

Throws:

java.io.IOException

load

public static <O> O load(@NonNull org.osgi.framework.Bundle bundle,
                         @NonNull java.lang.String bundleRelativeFxmlPath,
                         @Nullable java.util.ResourceBundle resourceBundle,
                         @Nullable javafx.util.BuilderFactory builderFactory,
                         @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory)
                  throws java.io.IOException

Load a FXML file relative to the bundle

Parameters:

bundle - the bundle

bundleRelativeFxmlPath - the bundle relative path

resourceBundle - the translation to be used

builderFactory - the builder factory to use

controllerFactory - the controller factory

Returns:

the created scene graph

Throws:

java.io.IOException

loadWithController

public static <O,C> OSGiFXMLLoader.FXMLData<O,C> loadWithController(@NonNull org.osgi.framework.Bundle bundle,
                                                                    @NonNull java.lang.String bundleRelativeFxmlPath,
                                                                    @Nullable java.util.ResourceBundle resourceBundle,
                                                                    @Nullable javafx.util.BuilderFactory builderFactory,
                                                                    @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory)
                                                             throws java.io.IOException

Load a FXML file relative to the bundle and provide the constructed scene-node and the controller

Parameters:

bundle - the bundle

bundleRelativeFxmlPath - the bundle relative path

resourceBundle - the translation to be used

builderFactory - the builder factory to use

controllerFactory - the controller factory

Returns:

the created scene graph

Throws:

java.io.IOException

load

public static <O> O load(@NonNull java.lang.ClassLoader classloader,
                         @NonNull java.net.URL url,
                         @Nullable java.util.ResourceBundle resourceBundle,
                         @Nullable javafx.util.BuilderFactory builderFactory,
                         @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory)
                  throws java.io.IOException

Load using the given classloader

Parameters:

classloader - the classloader

url - the url of the fxml file

resourceBundle - the translations

builderFactory - the builder factory

controllerFactory - the controller factory

Returns:

the created scene graph

Throws:

java.io.IOException

loadWithController

public static <O,C> OSGiFXMLLoader.FXMLData<O,C> loadWithController(@NonNull java.lang.ClassLoader classloader,
                                                                    @NonNull java.net.URL url,
                                                                    @Nullable java.util.ResourceBundle resourceBundle,
                                                                    @Nullable javafx.util.BuilderFactory builderFactory,
                                                                    @Nullable javafx.util.Callback<java.lang.Class<?>,java.lang.Object> controllerFactory)
                                                             throws java.io.IOException

Load using the given classloader and provide the constructed scene-node and the controller

Parameters:

classloader - the classloader

url - the url of the fxml file

resourceBundle - the translations

builderFactory - the builder factory

controllerFactory - the controller factory

Returns:

the created scene graph

Throws:

java.io.IOException