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:

AbstractFormView, DefaultView, FXMLShowCaseView, SampleView, UndoView

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

Constructor Summary

Constructors

Constructor and Description
AbstractView(M model) Default Constructor.

Method Summary

Modifier and Type	Method and Description
protected C	buildController() Build the view controller.
protected N	buildRootNode() Build the root node.
C	controller() Return the view controller.
Pane	errorNode() Return the error javafx node.
protected void	finalize()
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.
M	model() Return the view model.
N	node() Return the view root node.
Pane	pane() Return the view's pane that hold the root node.
void	prepare() Prepare the view by creating all visual nodes.
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

Constructor Detail

AbstractView

public AbstractView(M model)

Default Constructor.

Parameters:

model - the dedicated view model

Method Detail

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

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 C buildController()
                     throws CoreException

Build the view controller.

Throws:

CoreException - if introspection fails

model

public final M model()

Return the view model.

Specified by:

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

Returns:

the view model

controller

public final C controller()

Return the view controller.

Specified by:

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

Returns:

the view controller

node

public final N node()

Return the view root node.

Specified by:

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

Returns:

the view base javafx node

pane

public final Pane pane()

Return the view's pane that hold the root node.

Specified by:

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

Returns:

the view base pane

errorNode

public final Pane errorNode()

Return the error javafx node.

Specified by:

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

Returns:

the error javafx 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