zul.inp
Class ComboWidget

java.lang.Object
  extended by zk.Object
      extended by zk.Widget
          extended by zul.Widget
              extended by zul.inp.InputWidget
                  extended by zul.inp.ComboWidget
Direct Known Subclasses:
Bandbox, Combobox

public class ComboWidget
extends InputWidget

A skeletal implementation for a combo widget.


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
 void close(Map opts)
          Closes the list of combo items (Comboitem if it was dropped down.
protected  void enterPressed_(Event evt)
          Called when the user presses enter when this widget has the focus (Widget.focus(int)).
protected  void escPressed_(Event evt)
          Called when the user presses escape key when this widget has the focus (Widget.focus(int)).
protected  void getIconClass_()
          Returns the icon class for this combo widget.
protected  DOMElement getPopupNode_(boolean inner)
          Returns the DOM element of the popup.
protected  Array getPopupSize_()
          Returns [width, height] for the popup if specified by user.
 boolean isAutodrop()
          Returns whether to automatically drop the list if users is changing this text box.
 boolean isButtonVisible()
          Returns whether the button (on the right of the textbox) is visible.
 boolean isOpen()
          Returns whether the list of combo items is open
 void open(Map opts)
          Drops down the list of combo items (Comboitem.
protected  void presize_()
          Extra handling for min size of popup widget.
protected  void redraw_(Array out)
          Utility to implement Widget.redraw(_global_.Array).
protected  void redrawpp_(Array out)
          Called by redraw_(_global_.Array) to redraw popup.
 void setAutodrop(boolean autodrop)
          Sets whether to automatically drop the list if users is changing this text box.
 void setButtonVisible(boolean visible)
          Sets whether the button (on the right of the textbox) is visible.
 void setOpen(boolean open, Map opts)
          Drops down or closes the list of combo items (Comboitem.
protected  void slideDown_(DOMElement pp)
          Slides down the drop-down list.
protected  void slideUp_(DOMElement pp)
          Slides up the drop-down list.
 
Methods inherited from class zul.inp.InputWidget
clearErrorMessage, coerceFromString_, coerceToString_, fireOnChange, getCols, getConstraint, getErrorMessage, getErrorMesssage, getInplaceCSS, getInputNode, getMaxlength, getName, getPlaceholder, getTabindex, getText, getType, getValue, inRoundedMold, isDisabled, isInplace, isInstant, isMultiline, isReadonly, select, setCols, setConstraint, setDisabled, setErrorMessage, setInplace, 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, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseEnter_, doMouseLeave_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, 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, scrollIntoView, sendAU_, set, set, setAction, setChildren, 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_, 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

setButtonVisible

public void setButtonVisible(boolean visible)
Sets whether the button (on the right of the textbox) is visible.

Parameters:
visible -

isButtonVisible

public boolean isButtonVisible()
Returns whether the button (on the right of the textbox) is visible.

Default: true.

Returns:
boolean

setAutodrop

public void setAutodrop(boolean autodrop)
Sets whether to automatically drop the list if users is changing this text box.

Parameters:
autodrop -

isAutodrop

public boolean isAutodrop()
Returns whether to automatically drop the list if users is changing this text box.

Default: false.

Returns:
boolean

setOpen

public void setOpen(boolean open,
                    Map opts)
Drops down or closes the list of combo items (Comboitem.

Parameters:
open -
opts - the options.
See Also:
open(_global_.Map), close(_global_.Map)

isOpen

public boolean isOpen()
Returns whether the list of combo items is open

Returns:
boolean

open

public void open(Map opts)
Drops down the list of combo items (Comboitem. It is the same as setOpen(true).

Parameters:
opts - the options.

slideDown_

protected void slideDown_(DOMElement pp)
Slides down the drop-down list.

Default: zk(pp).slideDown(this, {afterAnima: this._afterSlideDown});

Parameters:
pp - the DOM element of the drop-down list.
Since:
5.0.4

slideUp_

protected void slideUp_(DOMElement pp)
Slides up the drop-down list.

Default: pp.style.display = "none";
In other words, it just hides it without any animation effect.

Parameters:
pp - the DOM element of the drop-down list.
Since:
5.0.4

getPopupNode_

protected DOMElement getPopupNode_(boolean inner)
Returns the DOM element of the popup. Default: inner ? this.$n("cave"): this.$n("pp"). Override it if it is not the case.

Parameters:
inner - whether to return the inner popup. ComboWidget assumes there is at least one popup and returned by getPopupNode_(), and there might be an inner DOM element returned by getPopupNode_(true).
Returns:
DOMElement
Since:
5.0.4

close

public void close(Map opts)
Closes the list of combo items (Comboitem if it was dropped down. It is the same as setOpen(false).

Parameters:
opts - the options.

enterPressed_

protected void enterPressed_(Event evt)
Called when the user presses enter when this widget has the focus (Widget.focus(int)).

call the close function

Parameters:
evt - the widget event. The original DOM event and target can be retrieved by Event.domEvent and Event.domTarget
See Also:
close(_global_.Map)

escPressed_

protected void escPressed_(Event evt)
Called when the user presses escape key when this widget has the focus (Widget.focus(int)).

call the close function

Parameters:
evt - the widget event. The original DOM event and target can be retrieved by Event.domEvent and Event.domTarget
See Also:
close(_global_.Map)

getPopupSize_

protected Array getPopupSize_()
Returns [width, height] for the popup if specified by user. Default: ['auto', 'auto']

Returns:
Array

redrawpp_

protected void redrawpp_(Array out)
Called by redraw_(_global_.Array) to redraw popup.

Default: does nothing

Parameters:
out - an array of HTML fragments.

presize_

protected void presize_()
Extra handling for min size of popup widget. Return true if size is affected.


getIconClass_

protected void getIconClass_()
Returns the icon class for this combo widget. (override by subclass only)


redraw_

protected void redraw_(Array out)
Utility to implement Widget.redraw(_global_.Array).

Parameters:
out - an array of HTML fragments.


Copyright © 2005-2011 Potix Corporation. All Rights Reserved. SourceForge.net Logo