de.saxsys.mvvmfx.FluentViewLoader Maven / Gradle / Ivy
package de.saxsys.mvvmfx;
import java.util.ResourceBundle;
import de.saxsys.mvvmfx.internal.viewloader.FxmlViewLoader;
import de.saxsys.mvvmfx.internal.viewloader.JavaViewLoader;
import de.saxsys.mvvmfx.internal.viewloader.ResourceBundleManager;
/**
* Fluent API for loading Views.
*
* The typical usage will look like this:
*
*
*
*
* public class MyCoolViewModel implements ViewModel {...}
* public class MyCoolView implements FxmlView{@code } {...}
*
*
* public class MyApp extends Application {
*
* {@literal @}Override
* public void start(Stage stage) {
* ViewTuple{@code } viewTuple
* = FluentViewLoader.fxmlView(MyCoolView.class).load();
*
* Parent root = viewTuple.getView();
* stage.setScene(new Scene(root));
* stage.show();
* }
* }
*
*
*
*
* This class is implemented as a Step-Builder. You can choose between {@link FxmlView} and {@link JavaView} with the
* first method call. After that you will only get builder-methods that are suitable for the view type you have chosen.
*
* @author manuel.mauky
*/
public class FluentViewLoader {
/**
* This class is the builder step to load a java based view. It is accessed from the {@link FluentViewLoader} with
* the method {@link FluentViewLoader#javaView(Class)}.
*
* @param
* the generic type of the View that should be loaded. This type has to implement
* {@link de.saxsys.mvvmfx.JavaView}.
* @param
* the generic type of the ViewModel. This type has to implement {@link de.saxsys.mvvmfx.ViewModel}.
*/
public static class JavaViewStep, ViewModelType extends ViewModel> {
private Class viewType;
private ResourceBundle resourceBundle;
private ViewModelType viewModel;
JavaViewStep(Class viewType) {
this.viewType = viewType;
}
/**
* Provide a {@link ResourceBundle} that is used while loading this view.
* Note: It is possible to provide a global application-wide resourceBundle via {@link 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.
*
* @param resourceBundle
* the resource bundle that is used while loading the view.
* @return this instance of the builder step.
*/
public JavaViewStep resourceBundle(ResourceBundle resourceBundle) {
this.resourceBundle = resourceBundle;
return this;
}
/**
* 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.
*
* @param viewModel
* the viewModel instance that is used to load the java view.
* @return this instance of the builder step.
*/
public JavaViewStep viewModel(ViewModelType viewModel) {
this.viewModel = viewModel;
return this;
}
/**
* The final step of the Fluent API. This method loads the view based on the given params.
*
* @return a view tuple containing the loaded view.
*/
public ViewTuple load() {
JavaViewLoader javaViewLoader = new JavaViewLoader();
return javaViewLoader.loadJavaViewTuple(viewType, ResourceBundleManager.getInstance().mergeWithGlobal(resourceBundle), viewModel);
}
}
/**
* This class is the builder step to load a fxml based view. It is accessed from the {@link FluentViewLoader} with
* the method {@link FluentViewLoader#fxmlView(Class)}.
*
* @param
* the generic type of the View that should be loaded. This type has to implement
* {@link de.saxsys.mvvmfx.FxmlView}.
* @param
* the generic type of the ViewModel. This type has to implement {@link de.saxsys.mvvmfx.ViewModel}.
*/
public static class FxmlViewStep, ViewModelType extends ViewModel> {
private Class viewType;
private ResourceBundle resourceBundle;
private Object root;
private ViewType codeBehind;
private ViewModelType viewModel;
FxmlViewStep(Class viewType) {
this.viewType = viewType;
}
/**
* Provide a {@link ResourceBundle} that is used while loading this view.
* Note: It is possible to provide a global application-wide resourceBundle via {@link 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.
*
* @param resourceBundle
* the resource bundle that is used while loading the view.
* @return this instance of the builder step.
*/
public FxmlViewStep resourceBundle(ResourceBundle resourceBundle) {
this.resourceBundle = resourceBundle;
return this;
}
/**
* 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.
*
* @param root
* the root element that is used to load the fxml file.
* @return this instance of the builder step.
*/
public FxmlViewStep root(Object root) {
this.root = root;
return this;
}
/**
* 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.
*
* @param codeBehind
* the codeBehind instance that is used to load the fxml file.
* @return this instance of the builder step.
*/
public FxmlViewStep codeBehind(ViewType codeBehind) {
this.codeBehind = codeBehind;
return this;
}
/**
* 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.
*
* @param viewModel
* the viewModel instance that is used to load the fxml file.
* @return this instance of the builder step.
*/
public FxmlViewStep viewModel(ViewModelType viewModel) {
this.viewModel = viewModel;
return this;
}
/**
* The final step of the Fluent API. This method loads the view based on the given params.
*
* @return a view tuple containing the loaded view.
*/
public ViewTuple load() {
FxmlViewLoader fxmlViewLoader = new FxmlViewLoader();
return fxmlViewLoader.loadFxmlViewTuple(viewType, ResourceBundleManager.getInstance().mergeWithGlobal(resourceBundle), codeBehind, root, viewModel);
}
}
/**
* This method is the entry point of the Fluent API to load a java based view.
*
* @param viewType
* the type of the view that should be loaded.
* @param
* the type of the View that should be loaded. This type has to implement
* {@link de.saxsys.mvvmfx.JavaView}.
* @param
* the type of the ViewModel. This type has to implement {@link de.saxsys.mvvmfx.ViewModel}.
*
* @return a builder step that can be further configured and then load the actual view.
*/
public static , ViewModelType extends ViewModel>
JavaViewStep javaView(Class viewType) {
return new JavaViewStep<>(viewType);
}
/**
* This method is the entry point of the Fluent API to load a fxml based View.
*
* @param viewType
* the type of the view that should be loaded.
* @param
* the generic type of the View that should be loaded. This type has to implement
* {@link de.saxsys.mvvmfx.FxmlView}.
* @param
* the generic type of the ViewModel. This type has to implement {@link de.saxsys.mvvmfx.ViewModel}.
*
* @return a builder step that can be further configured and then load the actual view.
*/
public static , ViewModelType extends ViewModel>
FxmlViewStep fxmlView(Class viewType) {
return new FxmlViewStep<>(viewType);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy