zkmax.inp

Class Chosenbox

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zkmax.inp.Chosenbox

public class Chosenbox
extends Widget

A component that similar to Combobox but handle the multi-selection and the select order.

Default Widget.getZclass(): z-chosenbox. It does not create child widgets for each data, so the memory usage is much lower at the server.

Since:

6.0.1

Author:

benbai

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
String	getCreateMessage() Returns the create message of this component.
String	getEmptyMessage() Returns the emptyMessage, it will be displayed if no selected items while not focused.
String	getName() Returns the name of the input of this component.
String	getNoResultsText() Returns the no-result text of this component.
int	getSelectedIndex() Returns the index of the selected item (-1 if no one is selected).
String	getSeparator() Returns the separate chars of this component.
int	getTabindex() Returns the tab order of the input of this component.
boolean	isCreatable() Returns whether can create new item, The input will considered to be a new item if it is not exist and this property is true.
boolean	isDisabled() Returns whether it is disabled.
boolean	isInplace() Return whether to display Chosenbox's selection as a comma separate label, under inplace="true", when user clicks the label, it turns into a chosenbox.
boolean	isOpen() Returns the open status of drop down list.
void	setCreatable(boolean creatable) Sets whether can create new item.
void	setCreateMessage(String createMessage) Sets the create message of this component.
void	setDisabled(boolean disabled) Sets whether it is disabled.
void	setEmptyMessage(String emptyMessage) Sets the emptyMessage.
void	setInplace(boolean inplace) Set whether to display Chosenbox's selection as a comma separate label, under inplace="true", when user clicks the label, it turns into a chosenbox.
void	setName(String name) Sets the name of the input of this component.
void	setNoResultsText(String noResultsText) Sets the no-result text of this component.
void	setOpen(boolean open) Sets the drop down list open status, and open/close drop down list as need.
void	setPartialUpdateListContentData() Internal use only, for partial update listContent.
void	setSelectedIndex(int selectedIndex) Selects the item with the given index.
void	setSeparator(String createMessage) Sets the separate chars of this component.
void	setTabindex(int tabindex) Sets the tab order of the input of this component.

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

setTabindex

public void setTabindex(int tabindex)

Sets the tab order of the input of this component.

Overrides:

setTabindex in class Widget

Parameters:

tabindex -

getTabindex

public int getTabindex()

Returns the tab order of the input of this component.

Default: 0 (means the same as browser's default).

Overrides:

getTabindex in class Widget

Returns:

int

setSelectedIndex

public void setSelectedIndex(int selectedIndex)

Selects the item with the given index.

Parameters:

selectedIndex -

getSelectedIndex

public int getSelectedIndex()

Returns the index of the selected item (-1 if no one is selected).

Returns:

int

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

setName

public void setName(String name)

Sets the name of the input of this component.

The name is used only to work with "legacy" Web application that handles user's request by servlets. It works only with HTTP/HTML-based browsers. It doesn't work with other kind of clients.

Don't use this method if your application is purely based on ZK's event-driven model.

Parameters:

name - the name of this component.

getName

public String getName()

Returns the name of the input of this component.

Default: null.

The name is used only to work with "legacy" Web application that handles user's request by servlets. It works only with HTTP/HTML-based browsers. It doesn't work with other kind of clients.

Don't use this method if your application is purely based on ZK's event-driven model.

Returns:

String

setEmptyMessage

public void setEmptyMessage(String emptyMessage)

Sets the emptyMessage.

Parameters:

emptyMessage -

getEmptyMessage

public String getEmptyMessage()

Returns the emptyMessage, it will be displayed if no selected items while not focused.

Returns:

String

setNoResultsText

public void setNoResultsText(String noResultsText)

Sets the no-result text of this component.

The no-result text will be displayed in popup if nothing match to the input value and can not create either, the syntax "{0}" will be replaced with the input value at client side.

Parameters:

noResultsText - the no-result text of this component.

getNoResultsText

public String getNoResultsText()

Returns the no-result text of this component.

Default: null.

The no-result text will be displayed in popup if nothing match to the input value and can not create either, the syntax "{0}" will be replaced with the input value at client side.

Returns:

String

setCreateMessage

public void setCreateMessage(String createMessage)

Sets the create message of this component.

The create message will be displayed in popup if nothing match to the input value but can create as new label, the syntax "{0}" will be replaced with the input value at client side.

Parameters:

createMessage - the create message of this component.

getCreateMessage

public String getCreateMessage()

Returns the create message of this component.

Default: null.

The create message will be displayed in popup if nothing match to the input value but can create as new label, the syntax "{0}" will be replaced with the input value at client side.

Returns:

String

setSeparator

public void setSeparator(String createMessage)

Sets the separate chars of this component.

Support: 0-9, A-Z (case insensitive), and ,.;'[]/\-=

The separate chars will work as 'Enter' key, it will not considered as input value but send onSerch or onSearching while key up.

Parameters:

createMessage - the create message of this component.

getSeparator

public String getSeparator()

Returns the separate chars of this component.

Support: 0-9, A-Z (case insensitive), and ,.;'[]/\-=

Default: null.

The separate chars will work as 'Enter' key, it will not considered as input value but send onSerch or onSearching while key up.

Returns:

String

setCreatable

public void setCreatable(boolean creatable)

Sets whether can create new item.

Parameters:

creatable -

isCreatable

public boolean isCreatable()

Returns whether can create new item, The input will considered to be a new item if it is not exist and this property is true.

Returns:

boolean

setOpen

public void setOpen(boolean open)

Sets the drop down list open status, and open/close drop down list as need.

Parameters:

open -

isOpen

public boolean isOpen()

Returns the open status of drop down list.

Returns:

boolean

setInplace

public void setInplace(boolean inplace)

Set whether to display Chosenbox's selection as a comma separate label, under inplace="true", when user clicks the label, it turns into a chosenbox.

Parameters:

inplace -

Since:

8.5.2

isInplace

public boolean isInplace()

Return whether to display Chosenbox's selection as a comma separate label, under inplace="true", when user clicks the label, it turns into a chosenbox.

Returns:

boolean

Since:

8.5.2

setPartialUpdateListContentData

public void setPartialUpdateListContentData()

Internal use only, for partial update listContent.