io.datafx.controller

Class ViewFactory

java.lang.Object

io.datafx.controller.ViewFactory

public class ViewFactory
extends java.lang.Object

This class contains static methods to create views in the DataFX Container context. All views that will use DataFX controller or Flow features have to be created by this class. Normally a developer doesn't need to use this class because the Flow API will call the methods internally whenever a new view is created in a flow. If a developers doesn't want to use the flow API and only want to create a single view that uses DataFX controller features this class can be used to create the view.

Method Summary

Modifier and Type	Method and Description
<T> ViewContext<T>	createByController(java.lang.Class<T> controllerClass) Creates a new MVC based view by using the given controller class.
<T> ViewContext<T>	createByController(java.lang.Class<T> controllerClass, java.lang.String fxmlName) Creates a new MVC based view by using the given controller class.
<T> ViewContext<T>	createByController(java.lang.Class<T> controllerClass, java.lang.String fxmlName, ViewConfiguration viewConfiguration, java.lang.Object... viewContextResources) Creates a new MVC based view by using the given controller class.
<T> javafx.scene.control.Tab	createTab(java.lang.Class<T> controllerClass) This methods creates a tab that contains the given view.
<T> javafx.scene.control.Tab	createTab(java.lang.Class<T> controllerClass, io.datafx.core.ExceptionHandler exceptionHandler) This methods creates a tab that contains the given view.
<T> javafx.scene.control.Tab	createTab(ViewContext<T> context) This methods creates a tab that contains the given view.
<T> javafx.scene.control.Tab	createTab(ViewContext<T> context, io.datafx.core.ExceptionHandler exceptionHandler) This methods creates a tab that contains the given view.
static ViewFactory	getInstance() Returns the single instance of the ViewFactory class (singleton pattern)
void	showInStage(javafx.stage.Stage stage, java.lang.Class<?> controllerClass) Helper method that will show exactly one view in a stage.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ViewFactory getInstance()

Returns the single instance of the ViewFactory class (singleton pattern)

Returns:

the ViewFactory singleton

createByController

public <T> ViewContext<T> createByController(java.lang.Class<T> controllerClass)
                                      throws FxmlLoadException

Creates a new MVC based view by using the given controller class. The class needs a default constructor (no parameters) and a ViewController annotation to link to the fxml file. You can skip the annotation if you want to use the controller API conventions. By doing so the fxml files has to be in the package as the controller and must fit to a naming convention (see ViewController for more informations). The method returns a ViewContext. This is a wrapper around the view (view-node and controller) and can be used to register your datamodel to the view. The doc of ViewContext will provide more information about this topic.

Parameters:

controllerClass - the class of the controller.

Returns:

a ViewContext that encapsulate the complete MVC

Throws:

FxmlLoadException - if the fxml file can not be loaded

createByController

public <T> ViewContext<T> createByController(java.lang.Class<T> controllerClass,
                                             java.lang.String fxmlName)
                                      throws FxmlLoadException

Creates a new MVC based view by using the given controller class. The class needs a default constructor (no parameters) and a ViewController annotation to link to the fxml file. You can skip the annotation if you want to use the controller API conventions. By doing so the fxml files has to be in the package as the controller and must fit to a naming convention (see ViewController for more informations). The method returns a ViewContext. This is a wrapper around the view (view-node and controller) and can be used to register your datamodel to the view. The doc of ViewContext will provide more information about this topic. By using this method you can overwrite the path to your fxml file.

Parameters:

controllerClass - the class of the controller.

fxmlName - path to the fxml file that will be used for the generated MVC context

Returns:

a ViewContext that encapsulate the complete MVC

Throws:

FxmlLoadException - if the fxml file can not be loaded

createByController

public <T> ViewContext<T> createByController(java.lang.Class<T> controllerClass,
                                             java.lang.String fxmlName,
                                             ViewConfiguration viewConfiguration,
                                             java.lang.Object... viewContextResources)
                                      throws FxmlLoadException

Creates a new MVC based view by using the given controller class. The class needs a default constructor (no parameters) and a ViewController annotation to link to the fxml file. You can skip the annotation if you want to use the controller API conventions. By doing so the fxml files has to be in the package as the controller and must fit to a naming convention (see ViewController for more information). The method returns a ViewContext. This is a wrapper around the view (view-node and controller) and can be used to register your datamodel to the view. The doc of ViewContext will provide more information about this topic. By using this method you can overwrite the path to your fxml file.

Type Parameters:

T -

Parameters:

controllerClass -

fxmlName -

viewConfiguration - The configuration for the view

viewContextResources - initial resources that will be added to the view context

Returns:

Throws:

FxmlLoadException

showInStage

public void showInStage(javafx.stage.Stage stage,
                        java.lang.Class<?> controllerClass)
                 throws FxmlLoadException

Helper method that will show exactly one view in a stage. This method can be used to create a simple one view application or test a view by only some lines of code

Parameters:

stage - The stage in that the view will be shown

controllerClass - the class of the controller that defines the view

Throws:

FxmlLoadException

createTab

public <T> javafx.scene.control.Tab createTab(java.lang.Class<T> controllerClass)
                                       throws FxmlLoadException

This methods creates a tab that contains the given view. By doing so the metadata of the view will be bound to the tab properties. So the text and icon of the tab can be changed by the view.

Parameters:

controllerClass - the class that defines the controller of the view

Throws:

FxmlLoadException

createTab

public <T> javafx.scene.control.Tab createTab(java.lang.Class<T> controllerClass,
                                              io.datafx.core.ExceptionHandler exceptionHandler)
                                       throws FxmlLoadException

This methods creates a tab that contains the given view. By doing so the metadata of the view will be bound to the tab properties. So the text and icon of the tab can be changed by the view.

Parameters:

controllerClass - the class that defines the controller of the view

exceptionHandler - the exception handle for the view. This handler will handle all exceptions that will be thrown in the DataFX container context

Throws:

FxmlLoadException

createTab

public <T> javafx.scene.control.Tab createTab(ViewContext<T> context)

This methods creates a tab that contains the given view. By doing so the metadata of the view will be bound to the tab properties. So the text and icon of the tab can be changed by the view.

Parameters:

context - the context of the view. This includes the view and its controller instance so that all needed informations are part of the context

createTab

public <T> javafx.scene.control.Tab createTab(ViewContext<T> context,
                                              io.datafx.core.ExceptionHandler exceptionHandler)

This methods creates a tab that contains the given view. By doing so the metadata of the view will be bound to the tab properties. So the text and icon of the tab can be changed by the view.

Parameters:

context - the context of the view. This includes the view and its controller instance so that all needed informations are part of the context

exceptionHandler - the exception handle for the view. This handler will handle all exceptions that will be thrown in the DataFX container context