| org.zkoss.zul.Textbox
 org.zkoss.zul.Combobox
| Combobox | | public class Combobox extends Textbox (Code) | | A combo box.
Non-XUL extension. It is used to replace XUL menulist. This class
is more flexible than menulist, such as
Combobox.setAutocompleteCombobox.setAutodrop .
Default
Combobox.getSclass : combobox.
Events: onOpen, onSelect
Developers can listen to the onOpen event and initializes it
when
org.zkoss.zk.ui.event.OpenEvent.isOpen is true, and/or
clean up if false.
Besides assign a list model, you could assign a renderer
(a
ComboitemRenderer instance) to a combobox, such that
the combobox will use this renderer to render the data returned by
ListModel.getElementAt .
If not assigned, the default renderer, which assumes a label per
combo item, is used.
In other words, the default renderer adds a label to
a row by calling toString against the object returned
by
ListModel.getElementAt . (since 3.0.2)
Note: to have better performance, onOpen is sent only if
a non-deferrable event listener is registered
(see
org.zkoss.zk.ui.event.Deferrable ).
author:
tomyeh
See Also: Comboitem |
| Combobox | | public Combobox()(Code) | | |
| close | | public void close()(Code) | | Closes the list of combo items (
Comboitem if it was
dropped down.
It is the same as setOpen(false).
since:
3.0.1 |
| getImage | | public String getImage()(Code) | | Returns the URI of the button image.
since:
2.4.1 |
| getItemAtIndex | | public Comboitem getItemAtIndex(int index)(Code) | | Returns the item at the specified index.
|
| getItemCount | | public int getItemCount()(Code) | | Returns the number of items.
|
| getItemRenderer | | public ComboitemRenderer getItemRenderer()(Code) | | Returns the renderer to render each row, or null if the default
renderer is used.
since:
3.0.2 |
| getItems | | public List getItems()(Code) | | Returns a 'live' list of all
Comboitem .
By live we mean you can add or remove them directly with
the List interface.
Currently, it is the same as
Combobox.getChildren . However,
we might add other kind of children in the future.
|
| getRealStyleFlags | | protected int getRealStyleFlags()(Code) | | Returns RS_NO_WIDTH|RS_NO_HEIGHT.
|
| getSelectedIndex | | public int getSelectedIndex()(Code) | | Returns the index of the selected item, or -1 if not selected.
since:
3.0.1 |
| getSelectedItem | | public Comboitem getSelectedItem()(Code) | | Returns the selected item.
since:
2.4.0 |
| isAutocomplete | | public boolean isAutocomplete()(Code) | | Returns whether to automatically complete this text box
by matching the nearest item (
Comboitem .
Default: false.
If true, the nearest item will be searched and the text box is
updated automatically.
If false, user has to click the item or use the DOWN or UP keys to
select it back.
Note: this feature is reserved and not yet implemented.
Don't confuse it with the auto-completion feature mentioned by
other framework. Such kind of auto-completion is supported well
by listening to the onChanging event.
|
| isAutodrop | | public boolean isAutodrop()(Code) | | Returns whether to automatically drop the list if users is changing
this text box.
Default: false.
|
| isButtonVisible | | public boolean isButtonVisible()(Code) | | Returns whether the button (on the right of the textbox) is visible.
Default: true.
|
| isChildable | | public boolean isChildable()(Code) | | Childable.
|
| onInitRender | | public void onInitRender(Event data)(Code) | | Handles a private event, onInitRender. It is used only for
implementation, and you rarely need to invoke it explicitly.
since:
3.0.2 |
| open | | public void open()(Code) | | Drops down the list of combo items (
Comboitem .
It is the same as setOpen(true).
since:
3.0.1 |
| reIndex | | final void reIndex()(Code) | | |
| removeItemAt | | public Comboitem removeItemAt(int index)(Code) | | Removes the child item in the list box at the given index.
the removed item. |
| setAutocomplete | | public void setAutocomplete(boolean autocomplete)(Code) | | Sets whether to automatically complete this text box
by matching the nearest item (
Comboitem .
|
| setAutodrop | | public void setAutodrop(boolean autodrop)(Code) | | Sets whether to automatically drop the list if users is changing
this text box.
|
| setButtonVisible | | public void setButtonVisible(boolean visible)(Code) | | Sets whether the button (on the right of the textbox) is visible.
|
| setImage | | public void setImage(String img)(Code) | | Sets the URI of the button image.
Parameters:
img - the URI of the button image. If null or empty, the defaultURI is used.
since:
2.4.1 |
| setItemRenderer | | public void setItemRenderer(ComboitemRenderer renderer)(Code) | | Sets the renderer which is used to render each row
if
Combobox.getModel is not null.
Note: changing a render will not cause the combobox to re-render.
If you want it to re-render, you could assign the same model again
(i.e., setModel(getModel())), or fire an
ListDataEvent event.
Parameters:
renderer - the renderer, or null to use the default.
exception:
UiException - if failed to initialize with the model
since:
3.0.2 |
| setModel | | public void setModel(ListModel model)(Code) | | Sets the list model associated with this combobox.
If a non-null model is assigned, no matter whether it is the same as
the previous, it will always cause re-render.
Parameters:
model - the list model to associate, or null to dis-associateany previous model.
exception:
UiException - if failed to initialize with the model
since:
3.0.2 |
| setMultiline | | public void setMultiline(boolean multiline)(Code) | | |
| setRows | | public void setRows(int rows)(Code) | | |
| setSelectedIndex | | public void setSelectedIndex(int jsel)(Code) | | Deselects the currently selected items and selects
the item with the given index.
Note: if the label of comboitem has the same more than one, the first
comboitem will be selected at client side, it is a limitation of
Combobox and it is different from
Listbox .
since:
3.0.2 |
| setSelectedItem | | public void setSelectedItem(Comboitem item)(Code) | | Deselects the currently selected items and selects the given item.
Note: if the label of comboitem has the same more than one, the first
comboitem will be selected at client side, it is a limitation of
Combobox and it is different from
Listbox .
since:
3.0.2 |
|
|