de.saxsys.mvvmfx

Class FluentViewLoader.FxmlViewStep<ViewType extends FxmlView<? extends ViewModelType>,ViewModelType extends ViewModel>

java.lang.Object

de.saxsys.mvvmfx.FluentViewLoader.FxmlViewStep<ViewType,ViewModelType>

Type Parameters:

ViewType - the generic type of the View that should be loaded. This type has to implement FxmlView.

ViewModelType - the generic type of the ViewModel. This type has to implement ViewModel.

Enclosing class:

FluentViewLoader

public static class FluentViewLoader.FxmlViewStep<ViewType extends FxmlView<? extends ViewModelType>,ViewModelType extends ViewModel>
extends Object

This class is the builder step to load a fxml based view. It is accessed from the FluentViewLoader with the method FluentViewLoader.fxmlView(Class).

Method Summary

Modifier and Type	Method and Description
FluentViewLoader.FxmlViewStep<ViewType,ViewModelType>	builderFactory(javafx.util.BuilderFactory builderFactory) This param is used to add a BuilderFactory that is used when loading the view.
FluentViewLoader.FxmlViewStep<ViewType,ViewModelType>	codeBehind(ViewType codeBehind) This param is used to define an existing instance of the codeBehind class that is used instead of creating a new one while loading.
FluentViewLoader.FxmlViewStep<ViewType,ViewModelType>	context(Context context)
ViewTuple<ViewType,ViewModelType>	load() The final step of the Fluent API.
FluentViewLoader.FxmlViewStep<ViewType,ViewModelType>	providedScopes(Collection<Scope> providedScopes)
FluentViewLoader.FxmlViewStep<ViewType,ViewModelType>	providedScopes(Scope... providedScopes)
FluentViewLoader.FxmlViewStep<ViewType,ViewModelType>	resourceBundle(ResourceBundle resourceBundle) Provide a ResourceBundle that is used while loading this view.
FluentViewLoader.FxmlViewStep<ViewType,ViewModelType>	root(Object root) This param is used to define a JavaFX node that is used as the root element when loading the fxml file.
FluentViewLoader.FxmlViewStep<ViewType,ViewModelType>	viewModel(ViewModelType viewModel) This param is used to define an existing viewModel instance to be used when loading the view.

Methods inherited from class java.lang.Object

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

Method Detail

context

public FluentViewLoader.FxmlViewStep<ViewType,ViewModelType> context(Context context)

providedScopes

public FluentViewLoader.FxmlViewStep<ViewType,ViewModelType> providedScopes(Scope... providedScopes)

providedScopes

public FluentViewLoader.FxmlViewStep<ViewType,ViewModelType> providedScopes(Collection<Scope> providedScopes)

resourceBundle

public FluentViewLoader.FxmlViewStep<ViewType,ViewModelType> resourceBundle(ResourceBundle resourceBundle)

Provide a ResourceBundle that is used while loading this view. Note: It is possible to provide a global application-wide resourceBundle via MvvmFX.setGlobalResourceBundle(ResourceBundle) method.

If there is a global resourceBundle set it will be merged with the resourceBundle provided by this builder method. The resourceBundle provided by this method will have a higher priority then the global one which means that if there are duplicate keys, the values of the global resourceBundle will be overwritten and the values of this resourceBundle will be used.

It is possible to add multiple resourceBundles by invoking this builder method multiple times. In this case the last provided resourceBundle will have the highest priority when it comes to overwriting values with the same keys.

Parameters:

resourceBundle - the resource bundle that is used while loading the view.

Returns:

this instance of the builder step.

root

public FluentViewLoader.FxmlViewStep<ViewType,ViewModelType> root(Object root)

This param is used to define a JavaFX node that is used as the root element when loading the fxml file.
This can be useful when creating custom controls with the fx:root element.

Parameters:

root - the root element that is used to load the fxml file.

Returns:

this instance of the builder step.

codeBehind

public FluentViewLoader.FxmlViewStep<ViewType,ViewModelType> codeBehind(ViewType codeBehind)

This param is used to define an existing instance of the codeBehind class that is used instead of creating a new one while loading.
This can be useful when creating custom controls with the fx:root element.

Parameters:

codeBehind - the codeBehind instance that is used to load the fxml file.

Returns:

this instance of the builder step.

viewModel

public FluentViewLoader.FxmlViewStep<ViewType,ViewModelType> viewModel(ViewModelType viewModel)

This param is used to define an existing viewModel instance to be used when loading the view.
A typical use case is when you like to have two or more views that are sharing the same viewModel.

Parameters:

viewModel - the viewModel instance that is used to load the fxml file.

Returns:

this instance of the builder step.

builderFactory

public FluentViewLoader.FxmlViewStep<ViewType,ViewModelType> builderFactory(javafx.util.BuilderFactory builderFactory)

This param is used to add a BuilderFactory that is used when loading the view.
. MvvmFX supports multiple builder factories. There are two ways of defining builder factories:

1. a local builder factory by using this method. In this case the builder factory is only used for this loading procedure.
2. a global builder factory by using MvvmFX.addGlobalBuilderFactory(BuilderFactory). This defines a global builder factory that is used for all loading procedures.

For most use cases it's better to define a global builder factory. Only if you like to limit the usage of the builder factory to only this loading procedure then use this fluent API method instead.

Parameters:

builderFactory - a builder factory that is used only for this loading procedure.

Returns:

this instance of the builder step.

load

public ViewTuple<ViewType,ViewModelType> load()

The final step of the Fluent API. This method loads the view based on the given params.

Returns:

a view tuple containing the loaded view.