Listbox Renderer

From Documentation
Revision as of 09:34, 8 February 2012 by Tomyeh (talk | contribs) (Created page with "{{ZKDevelopersReferencePageHeader}} Here we describe how to implement a custom renderer for a listbox (<javadoc type="interface">org.zkoss.zul.ListitemRenderer</javadoc>). For t...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Here we describe how to implement a custom renderer for a listbox (ListitemRenderer). For the concepts about component, model and renderer, please refer to the Model-driven Display section.

When a listbox (Listbox) is assigned with a model, a default renderer is assigned too. The default renderer will assume that each tree item has only one column, and it converts the data into a string directly[1]. If you want to display multiple columns or retrieve a particular field of the data, you have to implement ListitemRenderer to handle the rendering.

For example,

public class MyRenderer implements ListitemRenderer{
	public void render(Listitem listitem, Object data, int index) {
		Listcell cell = new Listcell();
		if (data instanceof String[]){
			cell.appendChild(new Label(((String[])data)[0].toString()));
		} else if (data instanceof String){
			cell.appendChild(new Label(data.toString()));
		} else {
			cell.appendChild(new Label("UNKNOW:"+data.toString()));

  1. If the tree is assigned a template called model, then the template will be used to render the tree. For more information, please refer to the Listbox Template section.

Version History

Last Update : 2012/02/08

Version Date Content
6.0.0 February 2012 The index argument was introduced.

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.