io.datafx.controller.context

Class ViewContext<U>

java.lang.Object

io.datafx.controller.context.AbstractContext

io.datafx.controller.context.ViewContext<U>

Type Parameters:

U - Controller class of the MVC view that is defined in this context

public class ViewContext<U>
extends AbstractContext

The view context is the context with a life time of one view. For each view there is exactly one ViewContext. By using the ViewFactory to create MVC views a ViewContext will be automatically created.
Example:

 
 ViewContext<MyController> context =
 ViewFactory.getInstance().createByController(MyController.class);

 
 

How to use a context
A context has a defined life time and can hold the data model of your application or of a part of your application. To do so you can easily register objects to your context:

DataModel model = ...
context.register(model);

In your controller:
DataModel model = context.getRegisteredObject(DataModel.class);

If you need more than one instance of a class in your context you can simple register the by using string based keys:

DataModel model1 = ...
DataModel model2 = ...
context.register("firstModel", model);
context.register("secondModel", model);

In your controller:
DataModel firstModel = context.getRegisteredObject("firstModel");

A context can simple used in a controller by injecting the context. DataFX provides annotations to inject all different context types:

"@FXMLApplicationContext"
ApplicationContext myApplicationContext;

By doing so you can easily access all your data in your controller and share data between different controllers.

Constructor Summary

Constructors

Constructor and Description
ViewContext(javafx.scene.Node rootNode, U controller, ViewMetadata metadata, ViewConfiguration configuration, java.lang.Object... resources) Create a new ViewContext for a (view-)Node and a controller.

Method Summary

Modifier and Type	Method and Description
void	addContextDestroyedListener(ContextDestroyedListener<U> listener)
void	destroy() Destroyes the context.
ApplicationContext	getApplicationContext() Returns the global application context
ViewConfiguration	getConfiguration()
U	getController() Returns the controller of the MVC view that is wrapped by this context.
ViewMetadata	getMetadata()
ContextResolver<U>	getResolver()
javafx.scene.Node	getRootNode() Returns the JavaFX view node of the MVC view that is wrapped by this context.
void	removeContextDestroyedListener(ContextDestroyedListener<U> listener)

Methods inherited from class io.datafx.controller.context.AbstractContext

getId, getRegisteredObject, getRegisteredObject, register, register, register, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewContext

public ViewContext(javafx.scene.Node rootNode,
                   U controller,
                   ViewMetadata metadata,
                   ViewConfiguration configuration,
                   java.lang.Object... resources)

Create a new ViewContext for a (view-)Node and a controller. Normally this constructor is used by the ViewFactory and should not be used in application code.

Parameters:

rootNode - the (view-)node

controller - the controller

metadata -

configuration -

resources -

Method Detail

getResolver

public ContextResolver<U> getResolver()

getController

public U getController()

Returns the controller of the MVC view that is wrapped by this context.

Returns:

the controller

getRootNode

public javafx.scene.Node getRootNode()

Returns the JavaFX view node of the MVC view that is wrapped by this context.

Returns:

the view node

getApplicationContext

public ApplicationContext getApplicationContext()

Returns the global application context

Returns:

application context

destroy

public void destroy()
             throws java.lang.IllegalAccessException,
                    java.lang.IllegalArgumentException,
                    java.lang.reflect.InvocationTargetException

Destroyes the context. This will be called by the flow API if a view is closed. Normally an application should never call this.

Throws:

java.lang.IllegalAccessException - if the context can't be destroyed

java.lang.IllegalArgumentException - if the context can't be destroyed

java.lang.reflect.InvocationTargetException - if the context can't be destroyed

addContextDestroyedListener

public void addContextDestroyedListener(ContextDestroyedListener<U> listener)

removeContextDestroyedListener

public void removeContextDestroyedListener(ContextDestroyedListener<U> listener)

getConfiguration

public ViewConfiguration getConfiguration()

getMetadata

public ViewMetadata getMetadata()