java.lang.Object
- org.zkoss.stateless.state.IGridController<Data,Row>

All Implemented Interfaces:

ItemController<Data,ListModel<Data>,IGrid,Row>
```
public class IGridController<Data,Row extends IRowBase>
extends java.lang.Object
implements ItemController<Data,ListModel<Data>,IGrid,Row>
```
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

All Methods Static Methods Instance Methods Concrete Methods
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<Data,java.lang.Integer,GroupingInfo,Row>`	`getGroupsRenderer()`	Returns the groups renderer.
`ListModel<Data>`	`getModel()`	Returns the model, which is set through by `ItemController.setModel(Object)`, or null.
`CheckedFunction2<Data,java.lang.Integer,Row>`	`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, 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, GroupsModel<D,G,F> model, CheckedFunction3<D,java.lang.Integer,GroupingInfo,R> renderer)`	Returns the controller instance with the given `grid`
`static <D,R extends IRowBase> IGridController<D,R>`	`of(IGrid owner, ListModel<D> model)`	Returns the controller instance with the given `grid`
`static <D,R extends IRowBase> IGridController<D,R>`	`of(IGrid owner, ListModel<D> model, CheckedFunction2<D,java.lang.Integer,R> renderer)`	Returns the controller instance with the given `grid`
`void`	`setGroupsRenderer(CheckedFunction3<Data,java.lang.Integer,GroupingInfo,Row> renderer)`	Sets the groups renderer for `GroupsModel`
`void`	`setModel(GroupsModel<?,?,?> model)`	Sets the groups model for this controller to render.
`void`	`setModel(ListModel<Data> model)`	Sets the given model to this controller.
`void`	`setRenderer(CheckedFunction2<Data,java.lang.Integer,Row> 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,
                                                                         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,
                                                                         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,
                                                                                         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,
                                                                                         GroupsModel<D,G,F> model,
                                                                                         CheckedFunction3<D,java.lang.Integer,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(ListModel<Data> 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<Data,ListModel<Data>,IGrid,Row extends IRowBase>
  - setModel
```
public void setModel(GroupsModel<?,?,?> model)
```
    Sets the groups model for this controller to render.
    
    Parameters:
    
    model - The groups model.
  - getModel
```
public ListModel<Data> 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<Data,ListModel<Data>,IGrid,Row extends IRowBase>
  - setRenderer
```
public void setRenderer(CheckedFunction2<Data,java.lang.Integer,Row> 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<Data,ListModel<Data>,IGrid,Row extends IRowBase>
  - setGroupsRenderer
```
public void setGroupsRenderer(CheckedFunction3<Data,java.lang.Integer,GroupingInfo,Row> renderer)
```
    Sets the groups renderer for GroupsModel
    
    Parameters:
    
    renderer - The renderer for GroupsModel.
  - getRenderer
```
public CheckedFunction2<Data,java.lang.Integer,Row> 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<Data,ListModel<Data>,IGrid,Row extends IRowBase>
  - getGroupsRenderer
```
public CheckedFunction3<Data,java.lang.Integer,GroupingInfo,Row> 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<Data,ListModel<Data>,IGrid,Row extends IRowBase>
  - clear
```
public void clear()
```
    Description copied from interface: ItemController
    
    Clears all the rendered data.
    
    Specified by:
    
    clear in interface ItemController<Data,ListModel<Data>,IGrid,Row extends IRowBase>

Class IGridController<Data,​Row extends IRowBase>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

of

of

of

setModel

setModel

getModel

setRenderer

setGroupsRenderer

getRenderer

getGroupsRenderer

build

clear

Class IGridController<Data,Row extends IRowBase>