Package org.zkoss.stateless.state

Class IGridController<DataT,RowT extends IRowBase>

java.lang.Object

org.zkoss.stateless.state.IGridController<DataT,RowT>

All Implemented Interfaces:

ItemController<DataT,org.zkoss.zul.ListModel<DataT>,IGrid,RowT>

public class IGridController<DataT,RowT extends IRowBase>
extends java.lang.Object
implements ItemController<DataT,org.zkoss.zul.ListModel<DataT>,IGrid,RowT>

An IGrid controller to control any operation on the given model.

Note: this class is not thread-safe, so when it's used in multi-threading environment, the developer should handle the threading issue.

Author:

katherine

Method Summary

Modifier and Type	Method	Description
IGrid	build()	Returns the immutable instance that the controller to build with
void	clear()	Clears all the rendered data.
CheckedFunction3<DataT,java.lang.Integer,org.zkoss.zul.ext.GroupingInfo,RowT>	getGroupsRenderer()	Returns the groups renderer.
org.zkoss.zul.ListModel<DataT>	getModel()	Returns the model, which is set through by ItemController.setModel(Object), or null.
CheckedFunction2<DataT,java.lang.Integer,RowT>	getRenderer()	Returns the renderer, which is set through by ItemController.setRenderer(CheckedFunction2), or a default one which is depended on implementation.
static <D,G,F,R extends IRowBase> IGridController<D,R>	of(IGrid owner, org.zkoss.zul.GroupsModel<D,G,F> model)	Returns the controller instance with the given grid
static <D,G,F,R extends IRowBase> IGridController<D,R>	of(IGrid owner, org.zkoss.zul.GroupsModel<D,G,F> model, CheckedFunction3<D,java.lang.Integer,org.zkoss.zul.ext.GroupingInfo,R> renderer)	Returns the controller instance with the given grid
static <D,R extends IRowBase> IGridController<D,R>	of(IGrid owner, org.zkoss.zul.ListModel<D> model)	Returns the controller instance with the given grid
static <D,R extends IRowBase> IGridController<D,R>	of(IGrid owner, org.zkoss.zul.ListModel<D> model, CheckedFunction2<D,java.lang.Integer,R> renderer)	Returns the controller instance with the given grid
void	setGroupsRenderer(CheckedFunction3<DataT,java.lang.Integer,org.zkoss.zul.ext.GroupingInfo,RowT> renderer)	Sets the groups renderer for GroupsModel
void	setModel(org.zkoss.zul.GroupsModel<?,?,?> model)	Sets the groups model for this controller to render.
void	setModel(org.zkoss.zul.ListModel<DataT> model)	Sets the given model to this controller.
void	setRenderer(CheckedFunction2<DataT,java.lang.Integer,RowT> renderer)	Sets the renderer which is used to render each data if ItemController.getModel() is not null.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <D,R extends IRowBase> IGridController<D,R> of(IGrid owner,
                                                                         org.zkoss.zul.ListModel<D> model)

Returns the controller instance with the given grid

Parameters:

owner - The controller to control with

model - The list model to associate with the grid.

of

public static <D,R extends IRowBase> IGridController<D,R> of(IGrid owner,
                                                                         org.zkoss.zul.ListModel<D> model,
                                                                         CheckedFunction2<D,java.lang.Integer,R> renderer)

Returns the controller instance with the given grid

Parameters:

owner - The controller to control with

model - The list model to associate with the grid.

renderer - The renderer of the list model.

of

public static <D,G,F,R extends IRowBase> IGridController<D,R> of(IGrid owner,
                                                                                         org.zkoss.zul.GroupsModel<D,G,F> model)

Returns the controller instance with the given grid

Parameters:

owner - The controller to control with

model - The groups model to associate with the grid.

of

public static <D,G,F,R extends IRowBase> IGridController<D,R> of(IGrid owner,
                                                                                         org.zkoss.zul.GroupsModel<D,G,F> model,
                                                                                         CheckedFunction3<D,java.lang.Integer,org.zkoss.zul.ext.GroupingInfo,R> renderer)

Returns the controller instance with the given grid

Parameters:

owner - The controller to control with

model - The groups model to associate with the grid.

renderer - The renderer of the groups model.

setModel

public void setModel(org.zkoss.zul.ListModel<DataT> model)

Description copied from interface: ItemController

Sets the given model to this controller.

Note: calling this method after ItemController.build(), you should invoke ItemController.build() again to take effect to replace the current one at client.
For example,

 
 uiAgent.replaceWith(locator, itemController.build());
 

Default: null

Specified by:

setModel in interface ItemController<DataT,org.zkoss.zul.ListModel<DataT>,IGrid,RowT extends IRowBase>

setModel

public void setModel(org.zkoss.zul.GroupsModel<?,?,?> model)

Sets the groups model for this controller to render.

Parameters:

model - The groups model.

getModel

public org.zkoss.zul.ListModel<DataT> getModel()

Description copied from interface: ItemController

Returns the model, which is set through by ItemController.setModel(Object), or null.

Specified by:

getModel in interface ItemController<DataT,org.zkoss.zul.ListModel<DataT>,IGrid,RowT extends IRowBase>

setRenderer

public void setRenderer(CheckedFunction2<DataT,java.lang.Integer,RowT> renderer)

Description copied from interface: ItemController

Sets the renderer which is used to render each data if ItemController.getModel() is not null.

Note: calling this method after ItemController.build(), you should invoke ItemController.build() again to take effect to replace the current one at client.
For example,

 
 uiAgent.replaceWith(locator, itemController.build());
 

Default: null, or depended on the implementation

Specified by:

setRenderer in interface ItemController<DataT,org.zkoss.zul.ListModel<DataT>,IGrid,RowT extends IRowBase>

setGroupsRenderer

public void setGroupsRenderer(CheckedFunction3<DataT,java.lang.Integer,org.zkoss.zul.ext.GroupingInfo,RowT> renderer)

Sets the groups renderer for GroupsModel

Parameters:

renderer - The renderer for GroupsModel.

getRenderer

public CheckedFunction2<DataT,java.lang.Integer,RowT> getRenderer()

Description copied from interface: ItemController

Returns the renderer, which is set through by ItemController.setRenderer(CheckedFunction2), or a default one which is depended on implementation.

Specified by:

getRenderer in interface ItemController<DataT,org.zkoss.zul.ListModel<DataT>,IGrid,RowT extends IRowBase>

getGroupsRenderer

public CheckedFunction3<DataT,java.lang.Integer,org.zkoss.zul.ext.GroupingInfo,RowT> getGroupsRenderer()

Returns the groups renderer.

Default: null

build

public IGrid build()

Description copied from interface: ItemController

Returns the immutable instance that the controller to build with

Specified by:

build in interface ItemController<DataT,org.zkoss.zul.ListModel<DataT>,IGrid,RowT extends IRowBase>

clear

public void clear()

Description copied from interface: ItemController

Clears all the rendered data.

Specified by:

clear in interface ItemController<DataT,org.zkoss.zul.ListModel<DataT>,IGrid,RowT extends IRowBase>