org.jrebirth.af.core.ui

Class AbstractBaseModel<M extends Model>

java.lang.Object

org.jrebirth.af.core.link.AbstractReady<R>

org.jrebirth.af.core.link.AbstractWaveReady<Model>

org.jrebirth.af.core.ui.AbstractBaseModel<M>

Type Parameters:

M - the class type of the current model

All Implemented Interfaces:

FacadeReady<Model>, WaveReady<Model>, CommandReady, LinkMessages, ModelReady, ServiceReady, MessageContainer, Model

Direct Known Subclasses:

AbstractModel

public abstract class AbstractBaseModel<M extends Model>
extends AbstractWaveReady<Model>
implements Model

The interface AbstractBaseModel. Base implementation of the model.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private Map<InnerModel,Model>	innerModelMap The map that store inner models loaded.
private Model	rootModel The root model not null for inner model.
private boolean	viewDisplayed Flag used to determine if a view has been already displayed, useful to manage first time animation.

Fields inherited from class org.jrebirth.af.core.link.AbstractWaveReady

PROCESS_WAVE_METHOD_NAME

Fields inherited from interface org.jrebirth.af.core.link.LinkMessages

CALL_ANNOTATED_METHOD_ERROR, COMMAND_NOT_FOUND_ERROR, COMMAND_NOT_FOUND_MESSAGE, COMPONENT_INJECTION_FAILURE, CUSTOM_METHOD_NOT_FOUND, LISTEN_WAVE_TYPE, MODEL_NOT_FOUND_ERROR, MODEL_NOT_FOUND_MESSAGE, NO_WAVE_LISTENER, NOTIFIER_CONSUMES, SEND_WAVE, SERVICE_NOT_FOUND_ERROR, SERVICE_NOT_FOUND_MESSAGE, UNLISTEN_WAVE_TYPE, USE_DEFAULT_WAVE_HANDLER, WAVE_BEAN_CREATION_ERROR, WAVE_DISPATCH_ERROR, WAVE_HANDLING_ERROR, WAVE_LOST, WAVE_LOST_CONTEXT, WAVE_SENDING_ERROR

Constructor Summary

Constructors

Constructor and Description
AbstractBaseModel()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	bind() Bind method to implement for adding custom bindings.
protected abstract void	bindInternal() Bind current object to view's widget.
protected void	finalize()
Model	getInnerModel(InnerModel innerModel) Get an inner model.
Model	getRootModel() Return the root model (for inner model).
Node	getRootNode() Return the root node.
protected void	hideInternalView() Hide the view.
protected abstract void	hideView() Perform custom action before hiding the view.
protected abstract void	initInnerModels() Initialize method for inner models to implement for adding custom processes.
protected void	initInternalInnerModels() Initialize the included models.
protected abstract void	initInternalModel() Initialize the model.
protected abstract void	initModel() Initialize method to implement for adding custom processes.
protected abstract void	processWave(Wave wave) Process the wave.
protected void	ready() The component is now ready to do custom initialization tasks.
void	setRootModel(Model rootModel) Define the root model for an inner model.
protected void	showInternalView() Show the view.
protected abstract void	showView() Perform custom user action before showing the view.

Methods inherited from class org.jrebirth.af.core.link.AbstractWaveReady

attachUi, callCommand, callCommand, getReturnCommand, getReturnWaveType, listen, listen, listen, registerCallback, registerCallback, registerCallback, release, returnData, sendWave, sendWave, setup, unlisten

Methods inherited from class org.jrebirth.af.core.link.AbstractReady

getCommand, getFirstKeyPart, getKey, getListKeyPart, getLocalFacade, getModel, getSecondKeyPart, getService, getThirdKeyPart, setKey, setLocalFacade

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jrebirth.af.core.ui.Model

doHideView, doShowView, getView

Methods inherited from interface org.jrebirth.af.core.facade.WaveReady

getReturnCommand, getReturnWaveType, listen, listen, listen, registerCallback, registerCallback, registerCallback, sendWave, sendWave, unlisten

Methods inherited from interface org.jrebirth.af.core.facade.FacadeReady

getKey, getLocalFacade, release, setKey, setLocalFacade, setup

Methods inherited from interface org.jrebirth.af.core.link.ModelReady

attachUi, getModel

Methods inherited from interface org.jrebirth.af.core.link.ServiceReady

getService, returnData

Methods inherited from interface org.jrebirth.af.core.link.CommandReady

callCommand, callCommand, getCommand

Field Detail

rootModel

private Model rootModel

The root model not null for inner model.

innerModelMap

private final Map<InnerModel,Model> innerModelMap

The map that store inner models loaded.

viewDisplayed

private boolean viewDisplayed

Flag used to determine if a view has been already displayed, useful to manage first time animation.

Constructor Detail

AbstractBaseModel

public AbstractBaseModel()

Method Detail

ready

protected final void ready()
                    throws CoreException

The component is now ready to do custom initialization tasks.

Specified by:

ready in class AbstractWaveReady<Model>

Throws:

CoreException - if an error occurred

initInternalModel

protected abstract void initInternalModel()
                                   throws CoreException

Initialize the model.

Throws:

CoreException - if the creation of the view fails

initModel

protected abstract void initModel()

Initialize method to implement for adding custom processes. This method is a hook to manage generic code before initializing current model. You must implement the initModel() method to setup your model.

initInternalInnerModels

protected final void initInternalInnerModels()

Initialize the included models. This method is a hook to manage generic code before initializing inner models. You must implement the initInnerModels() method to setup your inner models.

initInnerModels

protected abstract void initInnerModels()

Initialize method for inner models to implement for adding custom processes.

bindInternal

protected abstract void bindInternal()

Bind current object to view's widget. This method is a hook to manage generic code before binding model's object. You must implement the bind() method to add your bindings.

bind

protected abstract void bind()

Bind method to implement for adding custom bindings.

showInternalView

protected final void showInternalView()

Show the view.
In example : start the show transition This method is a hook to manage generic code before initializing the view's node tree. It will call #org.jrebirth.af.core.ui.View.start() or #org.jrebirth.af.core.ui.View.reload() method You must implement the showView() method to setup your view.

showView

protected abstract void showView()

Perform custom user action before showing the view.

hideInternalView

protected final void hideInternalView()

Hide the view.
In example : start the hide transition Will call the #org.jrebirth.af.core.ui.View.hide() method

hideView

protected abstract void hideView()

Perform custom action before hiding the view.

getRootNode

public Node getRootNode()

Return the root node.

Specified by:

getRootNode in interface Model

Returns:

the root node of the managed view

getRootModel

public Model getRootModel()

Return the root model (for inner model).

Specified by:

getRootModel in interface Model

Returns:

the root model or null

setRootModel

public void setRootModel(Model rootModel)

Define the root model for an inner model.

Specified by:

setRootModel in interface Model

Parameters:

rootModel - The rootModel to set.

getInnerModel

public final Model getInnerModel(InnerModel innerModel)

Get an inner model. If the model isn't registered create it

Specified by:

getInnerModel in interface Model

Parameters:

innerModel - the enumeration entry that describe the inner model

Returns:

the inner model instance

processWave

protected abstract void processWave(Wave wave)

Process the wave. Typically by using a switch on the waveType.

Specified by:

processWave in class AbstractWaveReady<Model>

Parameters:

wave - the wave received

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable