Package org.zkoss.stateless.state

Class IChosenboxController<DataT>

java.lang.Object

org.zkoss.stateless.state.IChosenboxController<DataT>

All Implemented Interfaces:

ItemController<DataT,ListModel<DataT>,IChosenbox,java.lang.String>

public class IChosenboxController<DataT>
extends java.lang.Object
implements ItemController<DataT,ListModel<DataT>,IChosenbox,java.lang.String>

An IChosenbox 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
void	addItemToSelection(java.lang.Object o)	Add an item into selection.
IChosenbox	build()	Returns the immutable instance that the controller to build with
void	clear()	Clears all the rendered data.
void	clearSelection()	Clear all selected objects.
ListModel<DataT>	getModel()	Returns the model, which is set through by ItemController.setModel(Object), or null.
CheckedFunction2<DataT,java.lang.Integer,java.lang.String>	getRenderer()	Returns the renderer, which is set through by ItemController.setRenderer(CheckedFunction2), or a default one which is depended on implementation.
int	getSelectedIndex()	Returns the index of the selected item (-1 if no one is selected).
<T> java.util.Set<T>	getSelectedObjects()	Returns the selected objects.
static <D> IChosenboxController<D>	of(IChosenbox owner, ListModel<D> model)	Returns the controller instance with the given chosenbox
static <D> IChosenboxController<D>	of(IChosenbox owner, ListModel<D> model, CheckedFunction2<D,java.lang.Integer,java.lang.String> renderer)	Returns the controller instance with the given chosenbox
void	removeItemFromSelection(java.lang.Object o)	Remove an item from selection.
void	setModel(ListModel<DataT> model)	Sets the given model to this controller.
void	setRenderer(CheckedFunction2<DataT,java.lang.Integer,java.lang.String> renderer)	Sets the renderer which is used to render each data if ItemController.getModel() is not null.
void	setSelectedIndex(int jsel)	Sets the index of the selected item (-1 if no one is selected).
void	setSelectedObjects(java.util.Collection<DataT> objects)	Sets the selected objects.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <D> IChosenboxController<D> of(IChosenbox owner,
                                             ListModel<D> model)

Returns the controller instance with the given chosenbox

Parameters:

owner - The controller to control with

model - The list model to associate with the chosenbox.

of

public static <D> IChosenboxController<D> of(IChosenbox owner,
                                             ListModel<D> model,
                                             CheckedFunction2<D,java.lang.Integer,java.lang.String> renderer)

Returns the controller instance with the given chosenbox

Parameters:

owner - The controller to control with

model - The list model to associate with the chosenbox.

setModel

public void setModel(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,ListModel<DataT>,IChosenbox,java.lang.String>

getModel

public 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,ListModel<DataT>,IChosenbox,java.lang.String>

setRenderer

public void setRenderer(CheckedFunction2<DataT,java.lang.Integer,java.lang.String> 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,ListModel<DataT>,IChosenbox,java.lang.String>

getRenderer

public CheckedFunction2<DataT,java.lang.Integer,java.lang.String> 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,ListModel<DataT>,IChosenbox,java.lang.String>

build

public IChosenbox build()

Description copied from interface: ItemController

Returns the immutable instance that the controller to build with

Specified by:

build in interface ItemController<DataT,ListModel<DataT>,IChosenbox,java.lang.String>

clear

public void clear()

Description copied from interface: ItemController

Clears all the rendered data.

Specified by:

clear in interface ItemController<DataT,ListModel<DataT>,IChosenbox,java.lang.String>

getSelectedIndex

public int getSelectedIndex()

Returns the index of the selected item (-1 if no one is selected).

setSelectedIndex

public void setSelectedIndex(int jsel)

Sets the index of the selected item (-1 if no one is selected). If model already exists, it will update the selection of model.

Parameters:

jsel - the index to select.

getSelectedObjects

public <T> java.util.Set<T> getSelectedObjects()

Returns the selected objects.

setSelectedObjects

public void setSelectedObjects(java.util.Collection<DataT> objects)

Sets the selected objects.

Parameters:

objects - the objects to select.

clearSelection

public void clearSelection()

Clear all selected objects.

addItemToSelection

public void addItemToSelection(java.lang.Object o)

Add an item into selection.

Parameters:

o - the object to add.

removeItemFromSelection

public void removeItemFromSelection(java.lang.Object o)

Remove an item from selection.

Parameters:

o - the object to remove.