org.eclipse.fx.ui.di

Class InjectingFXMLLoader<N>

java.lang.Object

org.eclipse.fx.ui.di.InjectingFXMLLoader<N>

Type Parameters:

N - the root node

All Implemented Interfaces:

FXMLBuilder<N>

public abstract class InjectingFXMLLoader<N>
extends java.lang.Object
implements FXMLBuilder<N>

Allows to use Eclipse DI inside your controller to access services

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.fx.ui.di.FXMLBuilder

FXMLBuilder.Data<N,C>

Constructor Summary

Constructors

Constructor and Description
InjectingFXMLLoader()

Method Summary

Modifier and Type	Method and Description
@NonNull InjectingFXMLLoader<N>	builderFactory(@NonNull javafx.util.BuilderFactory builderFactory) Associate a builder factory with the loader
static <N> InjectingFXMLLoader<N>	create(@NonNull org.eclipse.e4.core.contexts.IEclipseContext context, @NonNull org.osgi.framework.Bundle bundle, @NonNull java.lang.String bundleRelativeFxmlPath) Create a loader which operates relative to the bundle classpath
static <N> @NonNull InjectingFXMLLoader<N>	create(@NonNull org.eclipse.e4.core.contexts.IEclipseContext context, @NonNull org.osgi.framework.Bundle bundle, @NonNull java.lang.String bundleRelativeFxmlPath, boolean useExtendedFXMLLoader) Create a loader which operates relative to the bundle classpath and uses the ExtendedFXMLLoader if requested to do so
static <N> @NonNull InjectingFXMLLoader<N>	create(@NonNull org.eclipse.e4.core.contexts.IEclipseContext context, @NonNull java.lang.Class<?> requester, @NonNull java.lang.String relativeFxmlPath) Create a loader which operates relative to the requestor
static <N> @NonNull InjectingFXMLLoader<N>	create(@NonNull org.eclipse.e4.core.contexts.IEclipseContext context, @NonNull java.lang.Class<?> requester, @NonNull java.lang.String relativeFxmlPath, boolean useExtendedFXMLLoader) Create a loader which operates relative to the requestor and uses the ExtendedFXMLLoader if requested to do so
static <N> @NonNull InjectingFXMLLoader<N>	create(@NonNull org.eclipse.e4.core.contexts.IEclipseContext context, @NonNull java.lang.ClassLoader classloader, @NonNull java.net.URL url) Create a loader which uses the given classloader
@NonNull InjectingFXMLLoader<N>	resourceBundle(@NonNull java.util.ResourceBundle resourceBundle) Associate a resource bundle with the loader

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.fx.ui.di.FXMLBuilder

load, loadWithController

Constructor Detail

InjectingFXMLLoader

public InjectingFXMLLoader()

Method Detail

create

public static <N> @NonNull InjectingFXMLLoader<N> create(@NonNull org.eclipse.e4.core.contexts.IEclipseContext context,
                                                         @NonNull java.lang.Class<?> requester,
                                                         @NonNull java.lang.String relativeFxmlPath)

Create a loader which operates relative to the requestor

Parameters:

context - the di context

requester - the requestor

relativeFxmlPath - the relative path

Returns:

the loader

create

public static <N> @NonNull InjectingFXMLLoader<N> create(@NonNull org.eclipse.e4.core.contexts.IEclipseContext context,
                                                         @NonNull java.lang.Class<?> requester,
                                                         @NonNull java.lang.String relativeFxmlPath,
                                                         boolean useExtendedFXMLLoader)

Create a loader which operates relative to the requestor and uses the ExtendedFXMLLoader if requested to do so

Parameters:

context - the di context

requester - the requestor

relativeFxmlPath - the relative path

useExtendedFXMLLoader - true to use the ExtendedFXMLLoader

Returns:

the loader

create

public static <N> InjectingFXMLLoader<N> create(@NonNull org.eclipse.e4.core.contexts.IEclipseContext context,
                                                @NonNull org.osgi.framework.Bundle bundle,
                                                @NonNull java.lang.String bundleRelativeFxmlPath)

Create a loader which operates relative to the bundle classpath

Parameters:

context - the di context

bundle - the bundle

bundleRelativeFxmlPath - the relative path in the bundle

Returns:

the loader

create

public static <N> @NonNull InjectingFXMLLoader<N> create(@NonNull org.eclipse.e4.core.contexts.IEclipseContext context,
                                                         @NonNull org.osgi.framework.Bundle bundle,
                                                         @NonNull java.lang.String bundleRelativeFxmlPath,
                                                         boolean useExtendedFXMLLoader)

Create a loader which operates relative to the bundle classpath and uses the ExtendedFXMLLoader if requested to do so

Parameters:

context - the di context

bundle - the bundle

bundleRelativeFxmlPath - the relative path in the bundle

useExtendedFXMLLoader - true to use the ExtendedFXMLLoader

Returns:

the loader

create

public static <N> @NonNull InjectingFXMLLoader<N> create(@NonNull org.eclipse.e4.core.contexts.IEclipseContext context,
                                                         @NonNull java.lang.ClassLoader classloader,
                                                         @NonNull java.net.URL url)

Create a loader which uses the given classloader

Parameters:

context - the di context

classloader - the classloader

url - the url to load

Returns:

a loader instance

resourceBundle

public @NonNull InjectingFXMLLoader<N> resourceBundle(@NonNull java.util.ResourceBundle resourceBundle)

Description copied from interface: FXMLBuilder

Associate a resource bundle with the loader

Specified by:

resourceBundle in interface FXMLBuilder<N>

Parameters:

resourceBundle - the resource bundle

Returns:

the builder instance

builderFactory

public @NonNull InjectingFXMLLoader<N> builderFactory(@NonNull javafx.util.BuilderFactory builderFactory)

Description copied from interface: FXMLBuilder

Associate a builder factory with the loader

Specified by:

builderFactory in interface FXMLBuilder<N>

Parameters:

builderFactory - the builder factory

Returns:

the builder instance