zkmax.inp

Class Searchbox

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zkmax.inp.Searchbox

public class Searchbox
extends Widget

A dropdown list that allows users to search and select items.

Available in ZK EE.

Since:

9.0.0

Author:

rudyhuang

Field Summary

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
void	clearSelection() Clears the selection.
void	close() Closes the list of items.
String	getPlaceholder() Returns the placeholder text.
String	getSearchMessage() Returns the placeholder message of the search text field, or null to use the default message.
boolean	isAutoclose() Returns whether to automatically close the list if a user is selected any item.
boolean	isDisabled() Returns whether it is disabled.
boolean	isMultiple() Returns whether multiple selections are allowed.
boolean	isOpen() Returns whether this searchbox is open.
void	open() Drops down the list of items.
void	setAutoclose(boolean autoclose) Sets whether to automatically close the list if a user is selected any item.
void	setDisabled(boolean disabled) Sets whether it is disabled.
void	setMultiple(boolean multiple) Sets whether multiple selections are allowed.
void	setOpen(boolean open) Drops down or closes the list of items.
void	setPlaceholder(String placeholder) Sets the placeholder text that is displayed when selected item is empty.
void	setSearchMessage(String message) Sets the placeholder message of the search text field.

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, getTabindex, 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, setTabindex, 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

setSearchMessage

public void setSearchMessage(String message)

Sets the placeholder message of the search text field.

Parameters:

message -

getSearchMessage

public String getSearchMessage()

Returns the placeholder message of the search text field, or null to use the default message.

Returns:

String

setPlaceholder

public void setPlaceholder(String placeholder)

Sets the placeholder text that is displayed when selected item is empty.

Parameters:

placeholder -

getPlaceholder

public String getPlaceholder()

Returns the placeholder text.

Returns:

String

setMultiple

public void setMultiple(boolean multiple)

Sets whether multiple selections are allowed.

Notice that, if a model is assigned, it will change the model's state.

Parameters:

multiple -

isMultiple

public boolean isMultiple()

Returns whether multiple selections are allowed.

Default: false.

Returns:

boolean

setDisabled

public void setDisabled(boolean disabled)

Sets whether it is disabled.

Parameters:

disabled -

isDisabled

public boolean isDisabled()

Returns whether it is disabled.

Default: false.

Returns:

boolean

setAutoclose

public void setAutoclose(boolean autoclose)

Sets whether to automatically close the list if a user is selected any item.

Parameters:

autoclose -

isAutoclose

public boolean isAutoclose()

Returns whether to automatically close the list if a user is selected any item.

Default: false

Returns:

boolean

setOpen

public void setOpen(boolean open)

Drops down or closes the list of items.

Parameters:

open -

isOpen

public boolean isOpen()

Returns whether this searchbox is open.

Default: false.

Returns:

boolean

open

public void open()

Drops down the list of items.

close

public void close()

Closes the list of items.

clearSelection

public void clearSelection()

Clears the selection.

Since:

9.5.0