org.jrebirth.af.core.ui

Class AbstractView<M extends Model,N extends Node,C extends Controller<?,?>>

java.lang.Object

org.jrebirth.af.core.ui.AbstractView<M,N,C>

Type Parameters:

M - The class type of the model of the view

N - Any object that is a JavaFx2 Node

C - The class type of the controller of the view

All Implemented Interfaces:

View<M,N,C>

Direct Known Subclasses:

DefaultView

public abstract class AbstractView<M extends Model,N extends Node,C extends Controller<?,?>>
extends Object
implements View<M,N,C>

The class AbstractView. Base implementation of the view.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private static String	BASE_ANNOTATION_NAME The base name of all JRebirth Annotation.
private Object	callbackObject The callback object to use for annotation event handler.
private C	controller The view controller.
private Pane	errorNode The error node used if an error occurred.
private static JRLogger	LOGGER The class logger.
private M	model The view model.
private N	rootNode The root node of this view.

Constructor Summary

Constructors

Constructor and Description
AbstractView(M model) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private void	addHandler(Animation animation, Annotation annotation) Add an event handler on the given animation according to annotation OnFinished.
private void	addHandler(Node node, Annotation annotation) Add an event handler on the given node according to annotation OnXxxxx.
protected void	buildController() Build the view controller.
private void	buildErrorNode(CoreException ce) Build the errorNode to display the error taht occured.
protected N	buildRootNode() Build the root node.
protected void	finalize()
C	getController() Return the view controller.
Pane	getErrorNode() Return the error node.
M	getModel() Return the view model.
N	getRootNode() Return the view root node.
abstract void	hide() Handle custom tasks to do when the view is closed or hidden.
protected void	initInternalView() Initialize the view.
protected abstract void	initView() Custom method used to initialize components.
void	prepare() Prepare the view by creating all visual nodes.
private void	processAnnotations(Field property) Process all OnXxxx Annotation to attach event handler on this field.
private void	processFields() Process all fields' annotations to auto-link them with event handler.
private void	processViewAnnotation() Process view annotation.
abstract void	reload() Handle custom tasks to do at each rendering of the view (re-display).
abstract void	start() Handle custom tasks to do the first time after creation of the view.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final JRLogger LOGGER

The class logger.

BASE_ANNOTATION_NAME

private static final String BASE_ANNOTATION_NAME

The base name of all JRebirth Annotation.

See Also:

Constant Field Values

model

private final transient M extends Model model

The view model.

controller

private transient C extends Controller<?,?> controller

The view controller.

rootNode

private transient N extends Node rootNode

The root node of this view.

errorNode

private transient Pane errorNode

The error node used if an error occurred.

callbackObject

private Object callbackObject

The callback object to use for annotation event handler.

Constructor Detail

AbstractView

public AbstractView(M model)

Default Constructor.

Parameters:

model - the dedicated view model

Method Detail

buildErrorNode

private void buildErrorNode(CoreException ce)

Build the errorNode to display the error taht occured.

Parameters:

ce - the CoreException to display

prepare

public void prepare()
             throws CoreException

Prepare the view by creating all visual nodes. This method is called after Model initialization

Specified by:

prepare in interface View<M extends Model,N extends Node,C extends Controller<?,?>>

Throws:

CoreException - if the preparation fails

processViewAnnotation

private void processViewAnnotation()

Process view annotation. This will define if callback action will the view itself or its dedicated controller

processFields

private void processFields()
                    throws CoreException

Process all fields' annotations to auto-link them with event handler.

Throws:

CoreException - if annotation processing fails

processAnnotations

private void processAnnotations(Field property)
                         throws CoreException

Process all OnXxxx Annotation to attach event handler on this field.

Parameters:

property - the field to analyze

Throws:

CoreException - if annotation processing fails

addHandler

private void addHandler(Node node,
              Annotation annotation)
                 throws CoreException

Add an event handler on the given node according to annotation OnXxxxx.

Parameters:

node - the graphical node, must be not null

annotation - the OnXxxx annotation

Throws:

CoreException - if an error occurred while linking the event handler

addHandler

private void addHandler(Animation animation,
              Annotation annotation)
                 throws CoreException

Add an event handler on the given animation according to annotation OnFinished.

Parameters:

animation - the animation, must be not null

annotation - the OnXxxx annotation (only OnFinished is supported)

Throws:

CoreException - if an error occurred while linking the event handler

start

public abstract void start()

Handle custom tasks to do the first time after creation of the view. For example : you could start the show animation of the view.

Specified by:

start in interface View<M extends Model,N extends Node,C extends Controller<?,?>>

reload

public abstract void reload()

Handle custom tasks to do at each rendering of the view (re-display). For example : play from start the start animation.

Specified by:

reload in interface View<M extends Model,N extends Node,C extends Controller<?,?>>

hide

public abstract void hide()

Handle custom tasks to do when the view is closed or hidden. For example : you could start the hide animation of the view.

Specified by:

hide in interface View<M extends Model,N extends Node,C extends Controller<?,?>>

buildRootNode

protected N buildRootNode()
                                throws CoreException

Build the root node.

Returns:

the root node of the view

Throws:

CoreException - if introspection fails

buildController

protected void buildController()
                        throws CoreException

Build the view controller.

Throws:

CoreException - if introspection fails

getModel

public final M getModel()

Return the view model.

Specified by:

getModel in interface View<M extends Model,N extends Node,C extends Controller<?,?>>

Returns:

the view model

getController

public final C getController()

Return the view controller.

Specified by:

getController in interface View<M extends Model,N extends Node,C extends Controller<?,?>>

Returns:

the view controller

getRootNode

public final N getRootNode()

Return the view root node.

Specified by:

getRootNode in interface View<M extends Model,N extends Node,C extends Controller<?,?>>

Returns:

the view base javafx node

getErrorNode

public final Pane getErrorNode()

Return the error node.

Specified by:

getErrorNode in interface View<M extends Model,N extends Node,C extends Controller<?,?>>

Returns:

the error node

initInternalView

protected final void initInternalView()

Initialize the view. This method is a hook to manage generic code before initializing the view's node tree. You must implement the initView() method to setup your view.

initView

protected abstract void initView()

Custom method used to initialize components. This method must be overridden by user to create its own graphical tree

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable