ZK Component Reference/Essential Components/Selectbox

Selectbox

• Demonstration: N/A
• Java API: Selectbox
• JavaScript API: Selectbox
• Style Guide: N/A

Employment/Purpose

Selectbox is a lightweight dropdown list and it can support ListModel, Renderer, and Databinding as well. The benefit of it is not to create child widgets for each data, so the memory usage is much lower at the server.

Example

<zk>
	<zscript>
		<![CDATA[
		String[] userName = { "Tony", "Ryan", "Jumper", "Wing", "Sam" };
		ListModelList model = new ListModelList(userName);
	]]></zscript>
	<selectbox model="${model}" onSelect='alert(model.get(event.getData()));'>
		<template name="model">
			Name is ${each}
		</template>
	</selectbox>
</zk>

For initial select an item, for example, Tony, add the line below after model created:

model.addToSelection ("Tony");

Databinding

Here is the example for Databinding.

<?init class="org.zkoss.zkplus.databind.AnnotateDataBinderInit"?>
<zk>
	<zscript><![CDATA[
	public class MyUserBean {
		private String[] userList = { "Tony", "Ryan", "Jumper", "Wing", "Sam" };
		private int index = 0;

		public ListModelList getUserList() {
			return new ListModelList(Arrays.asList(userList));
		}

		public void setUserList() {
		}

		public void setIndex(int ind) {
			index = ind;
		}

		public int getIndex() {
			return index;
		}

		public String getCurrentName() {
			return userList[index];
		}
	}
	MyUserBean mybean = new MyUserBean();
/**   Implements ItemRenderer without using template
       org.zkoss.zul.ItemRenderer render = new org.zkoss.zul.ItemRenderer() {
		public String render(Component owner, Object data, int index) throws Exception {
			return data.toString();
		}
	};
*/
	]]></zscript>
	<div>
		Select User:
		<selectbox id="box" model="@{mybean.userList}"
			selectedIndex="@{mybean.index}">
			<template name="model">${each}</template>
		</selectbox>

	</div>
	Selected:
	<label id="val" value="@{mybean.currentName}" />
</zk>

Supported Events

Name	Event Type
onSelect	Event: SelectEvent Notifies one that the user has selected a new item in the selectbox.

• Inherited Supported Events: HtmlBasedComponent

Supported Children

*NONE

Use Cases

Version	Description	Example Location

Version History

Version	Date	Content
6.0.0	October 4, 2011	Add the new Selectbox component
6.0.0-RC2	December 6, 2011	Rename OptionRenderer to ItemRenderer