org.jrebirth.af.api.ui

Interface View<M extends Model,N extends javafx.scene.Node,C extends Controller<?,?>>

Type Parameters:

M - A class that implement the Model interface, this is the model of the view

N - A class that extend the JavaFX node, this is the base component of the view

C - The class type which will control this view, it must implements the controller interface

All Known Subinterfaces:

NullView

public interface View<M extends Model,N extends javafx.scene.Node,C extends Controller<?,?>>

The interface View. The contract for the view layer.

Author:

Sébastien Bordes

Method Summary

Modifier and Type	Method and Description
C	controller() Return the view controller.
javafx.scene.layout.Pane	errorNode() Return the error javafx node.
void	hide() Handle custom tasks to do when the view is closed or hidden.
M	model() Return the view model.
N	node() Return the view root node.
javafx.scene.layout.Pane	pane() Return the view's pane that hold the root node.
void	prepare() Prepare the view by creating all visual nodes.
void	reload() Handle custom tasks to do at each rendering of the view (re-display).
void	start() Handle custom tasks to do the first time after creation of the view.

Method Detail

node

N node()

Return the view root node.

Returns:

the view base javafx node

pane

javafx.scene.layout.Pane pane()

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

Returns:

the view base pane

errorNode

javafx.scene.layout.Pane errorNode()

Return the error javafx node.

Returns:

the error javafx node

model

M model()

Return the view model.

Returns:

the view model

controller

C controller()

Return the view controller.

Returns:

the view controller

prepare

void prepare()
      throws CoreException

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

Throws:

CoreException - if the preparation fails

start

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.

reload

void reload()

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

hide

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.