org.zkoss.zul
Interface ListitemRendererExt

public interface ListitemRendererExt

Provides additional control to ListitemRenderer.

Author:

tomyeh

See Also:

ListitemRenderer

Field Summary

static int	DETACH_ON_RENDER Returned by getControls() to indicate that the list cells added by newListcell(org.zkoss.zul.Listitem) must be detached before calling ListitemRenderer.render(org.zkoss.zul.Listitem, java.lang.Object).
static int	DETACH_ON_UNLOAD Deprecated. As of release 3.5.0, all rendered list items are detached to minimize the side effect.
static int	RETAIN_CELLS_ON_UNLOAD Deprecated. As of release 3.5.0, all rendered list items are detached to minimize the side effect.

Method Summary

int	getControls() Returns how a listbox shall render the live data.
Listcell	newListcell(Listitem item) Create an instance of Listcell as the first cell of the list item.
Listitem	newListitem(Listbox listbox) Creates an instance of Listitem for rendering.

Field Detail

DETACH_ON_RENDER

static final int DETACH_ON_RENDER

Returned by getControls() to indicate that the list cells added by newListcell(org.zkoss.zul.Listitem) must be detached before calling ListitemRenderer.render(org.zkoss.zul.Listitem, java.lang.Object).

Default: true.
If this interface is not specified, this flag is assumed to be specified.

If you implement this interface and doesn't return this flag in getControls(), the implementation of ListitemRenderer.render(org.zkoss.zul.Listitem, java.lang.Object) must be aware of the existence of the first cell (of the passed list item).

See Also:

Constant Field Values

DETACH_ON_UNLOAD

static final int DETACH_ON_UNLOAD

Deprecated. As of release 3.5.0, all rendered list items are detached to minimize the side effect.

See Also:

Constant Field Values

RETAIN_CELLS_ON_UNLOAD

static final int RETAIN_CELLS_ON_UNLOAD

Deprecated. As of release 3.5.0, all rendered list items are detached to minimize the side effect.

See Also:

Constant Field Values

Method Detail

newListitem

Listitem newListitem(Listbox listbox)

Creates an instance of Listitem for rendering. The created component will be passed to ListitemRenderer.render(org.zkoss.zul.Listitem, java.lang.Object).

Note: remember to invoke AbstractComponent.applyProperties() to initialize the properties, defined in the component definition, properly.

If null is returned, the default list item is created as follow.

final Listitem item = new Listitem();
item.applyProperties();
return item;

Note: DO NOT call AbstractComponent.setParent(org.zkoss.zk.ui.Component).

Returns:

the list item if you'd like to create it differently, or null if you want Listbox to create it for you

newListcell

Listcell newListcell(Listitem item)

Create an instance of Listcell as the first cell of the list item.

Note: remember to invoke AbstractComponent.applyProperties() to initialize the properties, defined in the component definition, properly.

Note: DO NOT call AbstractComponent.setParent(org.zkoss.zk.ui.Component). Don't create cells for other columns.

If null is returned, the default list cell is created as follow.

final Listcell cell = new Listcell();
cell.applyProperties();
return cell;

Note: DO NOT call AbstractComponent.setParent(org.zkoss.zk.ui.Component).

Parameters:

item - the list item. It is the same as that is returned by newListitem(org.zkoss.zul.Listbox)

Returns:

the list cell if you'd like to create it differently, or null if you want Listbox to create it for you

getControls

int getControls()

Returns how a listbox shall render the live data.

Note: if this interface is not implemented, DETACH_ON_RENDER is assumed.

Returns:

DETACH_ON_RENDER or 0 to indicate how to render the live data.