de.saxsys.mvvmfx

Class MvvmFX

java.lang.Object

de.saxsys.mvvmfx.MvvmFX

public class MvvmFX
extends Object

This class is a facade that is used by the user to access classes and services from the framework.

Constructor Summary

Constructors

Constructor and Description
MvvmFX()

Method Summary

Modifier and Type	Method and Description
static void	addGlobalBuilderFactory(javafx.util.BuilderFactory factory) Add a BuilderFactory to be used by mvvmFX.
static NotificationCenter	getNotificationCenter()
static void	setCustomDependencyInjector(javafx.util.Callback<Class<?>,Object> injector) This method is used to integrate the mvvmFX framework into your dependency injection environment.
static void	setGlobalResourceBundle(ResourceBundle resourceBundle) This method is used to set a global ResourceBundle for the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

MvvmFX

public MvvmFX()

Method Detail

getNotificationCenter

public static NotificationCenter getNotificationCenter()

Returns:

an instance of the NotificationCenter.

setCustomDependencyInjector

public static void setCustomDependencyInjector(javafx.util.Callback<Class<?>,Object> injector)

This method is used to integrate the mvvmFX framework into your dependency injection environment. This way you can tell the framework how it can get instances of classes f.e. services or business facades.
The callback has to return an instance for a given class type. This is the same way as it is done with the FXMLLoader.setControllerFactory(javafx.util.Callback) that is normally used with JavaFX's fxml.

Parameters:

injector - a callback that returns instances for given class types.

setGlobalResourceBundle

public static void setGlobalResourceBundle(ResourceBundle resourceBundle)

This method is used to set a global ResourceBundle for the application. This resource bundle is automatically loaded for all views. If there is an resourceBundle provided while loading the view (via FluentViewLoader.FxmlViewStep.resourceBundle(ResourceBundle) or FluentViewLoader.JavaViewStep.resourceBundle(ResourceBundle)) both resourceBundles will be merged.

The global resourceBundle set by this method will have a lower priority then the ones provided while loading. If there are keys available in both resourceBundles, the values of the global resourceBundle will be overwritten.

Parameters:

resourceBundle - the resourceBundle

addGlobalBuilderFactory

public static void addGlobalBuilderFactory(javafx.util.BuilderFactory factory)

Add a BuilderFactory to be used by mvvmFX.
A BuilderFactory is used to enable custom controls that need special initialization to be used with FXML. MvvmFX can manage multiple builder factories. If you add multiple factories that can provide builders for the same type, the last added builder factory will be used. This way it's possible to "overwrite" a more abstract builder factory with a more specific factory.
MvvmFX also takes care for handling the default JavaFXBuilderFactory. If no custom builder factory is able to provide a builder for a given type the default JavaFX builder factory will be used as last resort. This way you don't have to take care for standard JavaFX types in your builder factory.
While most of the time using a global builder factory is the best approach, for some special use cases it's needed to define a special builder factory that is only used for a single loading procedure. For such use cases one can use the FluentViewLoader with the parameter FluentViewLoader.FxmlViewStep.builderFactory(BuilderFactory) instead. In this case the provided builder factory is again combined with the global factories (if defined). Builder factories provided via FluentViewLoader have a higher priority then global builder factories.

Parameters:

factory - the builder factory