Package org.zkoss.stateless.state

Class IRadiogroupController<Data>

java.lang.Object

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

All Implemented Interfaces:

ItemController<Data,ListModel<Data>,IRadiogroup,IRadio>

public class IRadiogroupController<Data>
extends java.lang.Object
implements ItemController<Data,ListModel<Data>,IRadiogroup,IRadio>

An IRadiogroup 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
IRadiogroup	build()	Returns the immutable instance that the controller to build with
void	clear()	Clears all the rendered data.
ListModel<Data>	getModel()	Returns the model, which is set through by ItemController.setModel(Object), or null.
CheckedFunction2<Data,java.lang.Integer,IRadio>	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, or -1 if not selected.
Data	getSelectedObject()	Returns the data object which is selected or null.
static <D> IRadiogroupController<D>	of(IRadiogroup owner, ListModel<D> model)	Returns the controller instance with the given radiogroup
static <D> IRadiogroupController<D>	of(IRadiogroup owner, ListModel<D> model, CheckedFunction2<D,java.lang.Integer,IRadio> renderer)	Returns the controller instance with the given radiogroup
void	setModel(ListModel<Data> model)	Sets the given model to this controller.
void	setRenderer(CheckedFunction2<Data,java.lang.Integer,IRadio> renderer)	Sets the renderer which is used to render each data if ItemController.getModel() is not null.
void	setSelectedIndex(int index)	Deselects the currently selected items and selects the item with the given index.
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> IRadiogroupController<D> of(IRadiogroup owner,
                                              ListModel<D> model)

Returns the controller instance with the given radiogroup

Parameters:

owner - The controller to control with

model - The list model to associate with the listbox.

of

public static <D> IRadiogroupController<D> of(IRadiogroup owner,
                                              ListModel<D> model,
                                              CheckedFunction2<D,java.lang.Integer,IRadio> renderer)

Returns the controller instance with the given radiogroup

Parameters:

owner - The controller to control with

model - The list model to associate with the listbox.

renderer - The renderer of the list 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>,IRadiogroup,IRadio>

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>,IRadiogroup,IRadio>

setRenderer

public void setRenderer(CheckedFunction2<Data,java.lang.Integer,IRadio> 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>,IRadiogroup,IRadio>

getRenderer

public CheckedFunction2<Data,java.lang.Integer,IRadio> 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>,IRadiogroup,IRadio>

build

public IRadiogroup 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>,IRadiogroup,IRadio>

getSelectedObject

public Data getSelectedObject()

Returns the data object which is selected or null.

Default: null

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.

getSelectedIndex

public int getSelectedIndex()

Returns the index of the selected item, or -1 if not selected.

setSelectedIndex

public void setSelectedIndex(int index)

Deselects the currently selected items and selects the item with the given index.

clear

public void clear()

Description copied from interface: ItemController

Clears all the rendered data.

Specified by:

clear in interface ItemController<Data,ListModel<Data>,IRadiogroup,IRadio>