org.fujion.model

Class ModelAndView<T extends BaseComponent,M>

java.lang.Object

org.fujion.model.ModelAndView<T,M>

Type Parameters:

T - The component type to be rendered.

M - The model type.

All Implemented Interfaces:

IListModel.IListModelListener, IModelAndView<T,M>, IPaginator.IPagingListener

public class ModelAndView<T extends BaseComponent,M>
extends Object
implements IListModel.IListModelListener, IPaginator.IPagingListener, IModelAndView<T,M>

Associates a model with a view renderer.

Constructor Summary

Constructors

Constructor and Description
ModelAndView(BaseComponent parent)
ModelAndView(BaseComponent parent, IListModel<M> model, IComponentRenderer<T,M> renderer)

Method Summary

Modifier and Type	Method and Description
void	destroy() Clean up all resources.
protected void	destroyChild(int modelIndex) Destroys the child component corresponding to the model object at the specified index.
boolean	getDeferredRendering() Returns deferred rendering setting.
IListModel<M>	getModel() Returns the list model, or null if none set.
IPaginator	getPaginator() Returns the paging controller, if any.
IComponentRenderer<T,M>	getRenderer() Returns the renderer, or null if none set.
void	onListChange(IListModel.ListEventType type, int startIndex, int endIndex) Dynamically updates the rendering when the model changes.
void	onPagingChange(IPaginator.PagingEventType type, int oldValue, int newValue)
protected void	onRenderStart() If deferred rendering is active, sets the synchronizer to queueing mode.
protected void	onRenderStop() If deferred rendering is active, sets the synchronizer to non-queueing mode and flushes its queue.
protected T	renderChild(int modelIndex) Renders a child.
void	rerender() Force a re-rendering of the model.
T	rerender(int modelIndex) Re-render a specific model object given its index.
T	rerender(M object) Re-render a specific model object.
void	setDeferredRendering(boolean value) Sets the deferred rendering setting.
void	setModel(IListModel<M> model) Sets the list model.
void	setRenderer(IComponentRenderer<T,M> renderer) Sets the renderer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelAndView

public ModelAndView(BaseComponent parent)

ModelAndView

public ModelAndView(BaseComponent parent,
                    IListModel<M> model,
                    IComponentRenderer<T,M> renderer)

Method Detail

getRenderer

public IComponentRenderer<T,M> getRenderer()

Description copied from interface: IModelAndView

Returns the renderer, or null if none set.

Specified by:

getRenderer in interface IModelAndView<T extends BaseComponent,M>

Returns:

The renderer, possibly null.

setRenderer

public void setRenderer(IComponentRenderer<T,M> renderer)

Description copied from interface: IModelAndView

Sets the renderer. If not null and a model has been set, the model will be re-rendered immediately. If null, any previous rendering will be removed.

Specified by:

setRenderer in interface IModelAndView<T extends BaseComponent,M>

Parameters:

renderer - The renderer, or null to remove an existing one.

getModel

public IListModel<M> getModel()

Description copied from interface: IModelAndView

Returns the list model, or null if none set.

Specified by:

getModel in interface IModelAndView<T extends BaseComponent,M>

Returns:

The list model, possibly null.

setModel

public void setModel(IListModel<M> model)

Description copied from interface: IModelAndView

Sets the list model. If not null and a renderer has been set, the model will be re-rendered immediately. If null, any previous rendering will be removed.

Specified by:

setModel in interface IModelAndView<T extends BaseComponent,M>

Parameters:

model - The list model, or null to remove an existing one.

rerender

public void rerender()

Description copied from interface: IModelAndView

Force a re-rendering of the model. If either a model or a renderer has not been set, this will have no effect.

Specified by:

rerender in interface IModelAndView<T extends BaseComponent,M>

onRenderStart

protected void onRenderStart()

If deferred rendering is active, sets the synchronizer to queueing mode.

onRenderStop

protected void onRenderStop()

If deferred rendering is active, sets the synchronizer to non-queueing mode and flushes its queue.

renderChild

protected T renderChild(int modelIndex)

Renders a child.

Parameters:

modelIndex - The index of the model object to be rendered.

Returns:

The rendered child component, or null if no renderer has been registered or pagination is active and the child falls outside the current page.

destroyChild

protected void destroyChild(int modelIndex)

Destroys the child component corresponding to the model object at the specified index.

Parameters:

modelIndex - The index of the model object.

destroy

public void destroy()

Clean up all resources.

onListChange

public void onListChange(IListModel.ListEventType type,
                         int startIndex,
                         int endIndex)

Dynamically updates the rendering when the model changes.

Specified by:

onListChange in interface IListModel.IListModelListener

See Also:

IListModel.IListModelListener.onListChange(org.fujion.model.IListModel.ListEventType, int, int)

rerender

public T rerender(M object)

Description copied from interface: IModelAndView

Re-render a specific model object.

Specified by:

rerender in interface IModelAndView<T extends BaseComponent,M>

Parameters:

object - The model object to re-render.

Returns:

The rendered model object.

rerender

public T rerender(int modelIndex)

Description copied from interface: IModelAndView

Re-render a specific model object given its index.

Specified by:

rerender in interface IModelAndView<T extends BaseComponent,M>

Parameters:

modelIndex - The index of the model object to re-render.

Returns:

The rendered model object.

getDeferredRendering

public boolean getDeferredRendering()

Description copied from interface: IModelAndView

Returns deferred rendering setting. If true, rendering to the client is deferred until all model objects are rendered, then client updates are sent in bulk. This can be more efficient when rendering a large number of items.

Specified by:

getDeferredRendering in interface IModelAndView<T extends BaseComponent,M>

Returns:

The deferred rendering setting.

setDeferredRendering

public void setDeferredRendering(boolean value)

Description copied from interface: IModelAndView

Sets the deferred rendering setting. If true, rendering to the client is deferred until all model objects are rendered, then client updates are sent in bulk. This can be more efficient when rendering a large number of items.

Specified by:

setDeferredRendering in interface IModelAndView<T extends BaseComponent,M>

Parameters:

value - The deferred rendering setting.

getPaginator

public IPaginator getPaginator()

Description copied from interface: IModelAndView

Returns the paging controller, if any.

Specified by:

getPaginator in interface IModelAndView<T extends BaseComponent,M>

Returns:

The paging controller, possibly null.

onPagingChange

public void onPagingChange(IPaginator.PagingEventType type,
                           int oldValue,
                           int newValue)

Specified by:

onPagingChange in interface IPaginator.IPagingListener