Package org.zkoss.stateless.state

Class IOrganigramController<Data>

java.lang.Object

org.zkoss.stateless.state.IOrganigramController<Data>

All Implemented Interfaces:

ItemController<Data,TreeModel<Data>,IOrganigram,IOrgitem>

public class IOrganigramController<Data>
extends java.lang.Object
implements ItemController<Data,TreeModel<Data>,IOrganigram,IOrgitem>

An IOrganigram 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
IOrganigram	build()	Returns the immutable instance that the controller to build with
void	clear()	Clears all the rendered data.
TreeModel<Data>	getModel()	Returns the model, which is set through by ItemController.setModel(Object), or null.
CheckedFunction2<Data,java.lang.Integer,IOrgitem>	getRenderer()	Returns the renderer, which is set through by ItemController.setRenderer(CheckedFunction2), or a default one which is depended on implementation.
Data	getSelectedObject()	Returns the selected object.
static <D> IOrganigramController<D>	of(IOrganigram owner, TreeModel<D> model)	Returns the controller instance with the given organigram
static <D> IOrganigramController<D>	of(IOrganigram owner, TreeModel<D> model, CheckedFunction2<D,java.lang.Integer,IOrgitem> renderer)	Returns the controller instance with the given organigram
void	setModel(TreeModel<Data> model)	Sets the given model to this controller.
void	setRenderer(CheckedFunction2<Data,java.lang.Integer,IOrgitem> renderer)	Sets the renderer which is used to render each data if ItemController.getModel() is not null.
void	setSelectedObject(Data data)	Sets the selected data object, or deselects it by passing a null value.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <D> IOrganigramController<D> of(IOrganigram owner,
                                              TreeModel<D> model)

Returns the controller instance with the given organigram

Parameters:

owner - The controller to control with

model - The tree model to associate with the organigram.

of

public static <D> IOrganigramController<D> of(IOrganigram owner,
                                              TreeModel<D> model,
                                              CheckedFunction2<D,java.lang.Integer,IOrgitem> renderer)

Returns the controller instance with the given organigram

Parameters:

owner - The controller to control with

model - The tree model to associate with the organigram.

renderer - The renderer of the tree model.

setModel

public void setModel(TreeModel<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,TreeModel<Data>,IOrganigram,IOrgitem>

getModel

public TreeModel<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,TreeModel<Data>,IOrganigram,IOrgitem>

setRenderer

public void setRenderer(CheckedFunction2<Data,java.lang.Integer,IOrgitem> 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,TreeModel<Data>,IOrganigram,IOrgitem>

getRenderer

public CheckedFunction2<Data,java.lang.Integer,IOrgitem> 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,TreeModel<Data>,IOrganigram,IOrgitem>

build

public IOrganigram build()

Description copied from interface: ItemController

Returns the immutable instance that the controller to build with

Specified by:

build in interface ItemController<Data,TreeModel<Data>,IOrganigram,IOrgitem>

clear

public void clear()

Description copied from interface: ItemController

Clears all the rendered data.

Specified by:

clear in interface ItemController<Data,TreeModel<Data>,IOrganigram,IOrgitem>

getSelectedObject

public Data getSelectedObject()

Returns the selected object.

setSelectedObject

public void setSelectedObject(Data data)

Sets the selected data object, or deselects it by passing a null value.

Parameters:

data - The data object that contains in the model.