From Documentation
Line 93: Line 93:
<source lang="java">
<source lang="java">
public class MyAutoComplete extends GenericForwardComposer {
public class MyAutoComplete extends SelectorComposer {
     Combobox combo;
    private Combobox combo;
     public void afterCompose() {
     public void afterCompose() {

Revision as of 03:24, 10 February 2012



Components: combobox and comboitem.

A combobox is a special text box that embeds a drop-down list. With comboboxes, users are allowed to select from a drop-down list, in addition to entering the text manually.


ZKComRef Combobox Example.PNG

     <comboitem label="Simple and Rich"/>
     <comboitem label="Cool!"/>
     <comboitem label="Ajax and RIA"/>

Combobox onAfterRender.png

		ListModelList lm = new ListModelList(Arrays.asList(new String[] { "David",
				"Thomas", "Steven" }));
	<combobox model="${lm}" onAfterRender="self.setSelectedIndex(2)"/>

Mouseless Entry Combobox

  • Alt+DOWN to pop up the list.
  • Alt+UP or ESC to close the list.
  • UP and DOWN to change the selection of the items from the list.

Live Data


By specifying the selection, you can invoke the addSelection() to select a default value, For example,

<combobox id="combobox" width="100px">
	<attribute name="onCreate"><![CDATA[
		List list2 = new ArrayList();
		ListModelList lm2 = new ListModelList(list2);
[Since 5.0.4]



Autocomplete in a Brute-force Way

The straightforward way to implement the autocomplete feature is to listen the onChanging event. For example,

  <attribute name="onChanging"><![CDATA[
  self.getChildren().clear(); //remove all children
  for (String value: getMatched(event.getValue())
    self.appendChild(new Comboitem(value));

where we assume getMatched() is an application-specific method that returns a collection of matched values.

Autocomplete by ListSubModel

To separate the data from the view (combobox) better, we could implement a list model with ListSubModel. ZK provides a set of utilities in ListModels to convert an instance of ListModel to another instance that proxies the original list model and implements ListSubModel. For example,

<combobox id="combo" apply="MyAutoComplete">

then in, you could have

public class MyAutoComplete extends SelectorComposer {
    private Combobox combo;
    public void afterCompose() {
        combo.setModel(ListModels.toListSubModel(new ListModelList(getAllItems())));
    List getAllItems() {
        //return all items

By default, it shows the first 15 items that matches the value entered by the user. If you want to have a different value or a different comparator to find out matched items, you could invoke ListModels.toListSubModel(ListModel, Comparator, int) instead.

Note: Passing an instance of ListModelList directly to a combobox will show up all items in the list model, since it doesn't implement ListSubModel.

Note: Unlike ListModelList and others, SimpleListModel implements ListSubModel by default. You can use SimpleListModel directly but it handles only an array of data.


Once set, the user is not allowed to enter type, but he still can select the items in the combobox. (Default:false )

<combobox readonly="true"/>


By default, the drop-down list won't be opened until the user clicks the button, or presses Alt+DOWN. However, you could set the autodrop property to true, meaning as soon as the user types a character the drop-down list will be opened. This is helpful for novice users, but it might be annoying for experienced users.

If you prefer the combobox to drop down the list when the user types a character, you could specify the autodrop attribute as follows.

<combobox autodrop="true"/>

If you prefer to drop down the list when gaining the focus, you could provide a client-side listener as follows.

<combobox w:onfocus="" xmlns:w="client"/>


You are able to add a description to each combo item to make it more descriptive or assign an image to every item.

		<comboitem label="Simple and Rich"
			description="The simplest way to make Web applications rich" />
		<comboitem label="Cool!"
			description="The coolest technology" />
		<comboitem label="Ajax and RIA"
			description="Rich Internet Application by Ajax" />

ZKComRef Combobox Description.PNG

Akin to other components that support images, you are able to use the setImageContent method to assign a dynamically generated image to the comboitem component. Please refer to the Image section for details.

The onOpen Event

The onOpen event is sent to the application when a user opens the drop-down list. To defer the creation of combo items, you can use the fulfill attribute as shown below.

ZKComRef Combobox Example.PNG

	<combobox fulfill="onOpen">
	    <comboitem label="Simple and Rich"/>
	    <comboitem label="Cool!"/>
	    <comboitem label="Ajax and RIA"/>

Alternatively, you can listen to the onOpen event and prepare the drop-down list or change it dynamically as demonstrated below.

		void prepare() 
			if (combo.getItemCount() == 0) 
				combo.appendItem("Simple and Rich");
				combo.appendItem("Ajax and RIA");
	<combobox id="combo" onOpen="prepare()" />		

The appendItem method is equivalent to creating a combo item and then setting the combobox as its parent.

The onChanging Event

Since a combobox is also a text box, you are also able to listen to an onChanging event. By listening to this event, you can manipulate the drop-down list as demonstrated by Google Suggests ( This feature is sometimes called auto-complete.

As illustrated below, you can populate the drop-down list based on what user is entering.

	     void suggest() 
	         if (event.value.startsWith("A")) {
	         } else if (event.value.startsWith("B")) {
	<combobox id="combo" autodrop="true" onChanging="suggest()"/>

Notice that, when the onChanging event is received, the content of the combobox has not changed. Therefore, you cannot use the value property of the combobox. Instead, you should use the value property of the InputEvent.


You could specify what value to accept for input controls by use of the constraint property. It could be a combination of no empty, and/or a regular expression.

To specify two or more constraints, use comma to separate them as follows.

<combobox constraint="no empty,/^A/">
	<comboitem label="Simple and Rich" />
	<comboitem label="Cool!" />
	<comboitem label="Ajax and RIA" />

To specify a regular expression, you may have to use the character / to enclose the regular expression as follows.

<combobox constraint="/^A/"/>


  • The above statement is XML, so do not use \\ to specify a backslash. However typing \\ is necessary, if writing in Java.
new Combobox().setConstraint("/.+@.+\\.[a-z]+/");
  • You are allowed to mix regular expressions with other constraints by separating them with a comma.

If you prefer to display different message to the default one, you can append the error message to the constraint with a colon.

<combobox constraint="/^A/: only allowed the item start with A"/>


  • The error message, if specified, must be the last element and start with colon.
  • To support multiple languages, you could use the 「l」 function as depicted in the Internationalization chapter.
<combobox constraint="/^A/: ${c:l('err.startwith.required')}"/>

Inherited Functions

Please refer to Textbox for inherited functions.

Supported Events

Event Type
Event: SelectEvent

Represents an event caused by user's the list selection is changed at the client.

Event: OpenEvent

Denotes that the user has opened or closed a component. Note: unlike onClose, this event is only a notification. The client sends this event after opening or closing the component.

It is useful to implement load-on-demand by listening to the onOpen event, and creating components when the first time the component is opened.

Event: Event

Notifies one that the model's data has been rendered.

Supported Molds

Available molds of a component are defined in lang.xml embedded in zul.jar.

Combobox mold default.png
Combobox mold rounded.png
[Since 5.0.0]

Supported Children

*  Comboitem

Use Cases

Version Description Example Location

Version History

Last Update : 2012/02/10

Version Date Content
5.0.4 August 2010 ListModels was introduced to simply the implementation of autocomplete.
5.0.4 July 2010 Combobox supported Selectable if it is also implemented with the specified ListModel.
5.0.4 July 2010 Supported onAfterRender event

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