zul.inp

Class Combobox

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zul.inp.InputWidget

zul.inp.ComboWidget

zul.inp.Combobox

public class Combobox
extends ComboWidget

A combobox.

Non-XUL extension. It is used to replace XUL menulist. This class is more flexible than menulist, such as setAutocomplete(boolean) ComboWidget.setAutodrop(boolean).

Default Widget.getZclass(): z-combobox.

Like Datebox, the value of a read-only comobobox (InputWidget.isReadonly()) can be changed by dropping down the list and selecting an combo item (though users cannot type anything in the input box).

See Also:

Comboitem

Field Summary

Fields inherited from class zul.inp.InputWidget

onChangingDelay, onChangingForced

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
String	getEmptySearchMessage() Returns the message to display when no matching results was found
boolean	isAutocomplete() Returns whether to automatically complete this text box by matching the nearest item (Comboitem.
boolean	isInstantSelect() Returns true if onSelect event is sent as soon as user selects using keyboard navigation.
void	setAutocomplete(boolean autocomplete) Sets whether to automatically complete this text box by matching the nearest item (Comboitem.
void	setEmptySearchMessage(String msg) Sets the message to display when no matching results was found
void	setInstantSelect(boolean instantSelect) Sets the instantSelect attribute.
void	setRepos() For internal use only.
protected void	setSelectedItemUuid_() For internal use only
void	validateStrict(String val) called by SimpleConstraint

Methods inherited from class zul.inp.ComboWidget

close, enterPressed_, escPressed_, getIconSclass, getPopupNode_, getPopupSize_, getPopupWidth, getType, isAutodrop, isButtonVisible, isOpen, open, presize_, redraw_, redrawpp_, setAutodrop, setButtonVisible, setIconSclass, setOpen, setPopupWidth, setType, slideDown_, slideUp_

Methods inherited from class zul.inp.InputWidget

clearErrorMessage, coerceFromString_, coerceToString_, fireOnChange, getCols, getConstraint, getErrorboxIconSclass, getErrorboxSclass, getErrorMessage, getErrorMesssage, getInplaceCSS, getInputAttributes, getInputNode, getMaxlength, getName, getPlaceholder, getTabindex, getText, getValue, inRoundedMold, isDisabled, isInplace, isInstant, isMultiline, isReadonly, select, setCols, setConstraint, setDisabled, setErrorboxIconSclass, setErrorboxSclass, setErrorMessage, setInplace, setInputAttributes, setInsertedText, setInstant, setMaxlength, setName, setPlaceholder, setReadonly, setTabindex, setText, setValue, shallUpdate_, showError_, textAttrs_, updateChange_, validate_

Methods inherited from class zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setAutocomplete

public void setAutocomplete(boolean autocomplete)

Sets whether to automatically complete this text box by matching the nearest item (Comboitem.

Parameters:

autocomplete -

isAutocomplete

public boolean isAutocomplete()

Returns whether to automatically complete this text box by matching the nearest item (Comboitem. It is also known as auto-type-ahead.

Default: true

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.

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.

Returns:

boolean

setEmptySearchMessage

public void setEmptySearchMessage(String msg)

Sets the message to display when no matching results was found

Parameters:

msg -

Since:

8.5.1

getEmptySearchMessage

public String getEmptySearchMessage()

Returns the message to display when no matching results was found

Returns:

String

Since:

8.5.1

setInstantSelect

public void setInstantSelect(boolean instantSelect)

Sets the instantSelect attribute. When the attribute is true, onSelect event will be fired as soon as user selects using keyboard navigation. If the attribute is false, user needs to press Enter key to finish the selection using keyboard navigation.

Parameters:

instantSelect -

Since:

8.6.1

isInstantSelect

public boolean isInstantSelect()

Returns true if onSelect event is sent as soon as user selects using keyboard navigation.

Default: true

Returns:

boolean

Since:

8.6.1

setSelectedItemUuid_

protected void setSelectedItemUuid_()

For internal use only

setRepos

public void setRepos()

For internal use only. Update the value of the input element in this component

Overrides:

setRepos in class ComboWidget

validateStrict

public void validateStrict(String val)

called by SimpleConstraint

Parameters:

val - the name of flag, such as "no positive".