Package org.adempiere.webui.component

Class Combobox

java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.impl.InputElement
org.zkoss.zul.Textbox
org.zkoss.zul.Combobox
org.adempiere.webui.component.Combobox
All Implemented Interfaces:
Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Readonly, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.IdSpace, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.ext.Constrainted
Direct Known Subclasses:
AutoComplete
public class Combobox extends org.zkoss.zul.Combobox implements org.zkoss.zk.ui.IdSpace
Extend Combobox
Author:
Ashley G Ramdass
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.zkoss.zul.Combobox

    org.zkoss.zul.Combobox.ExtraCtrl

    Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

    org.zkoss.zk.ui.AbstractComponent.Children, org.zkoss.zk.ui.AbstractComponent.ForwardInfo, org.zkoss.zk.ui.AbstractComponent.TargetInfo

  • Field Summary

    Fields inherited from class org.zkoss.zul.Combobox

    ICON_SCLASS

    Fields inherited from class org.zkoss.zul.impl.InputElement

    _cols, _value

    Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

    _zclass

    Fields inherited from interface org.zkoss.zk.ui.Component

    APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

    Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

    AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

  • Constructor Summary

    Constructors
    Constructor
    Description
    Combobox()
    Default constructor
    Combobox(String value)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addScrollSelectedIntoViewListener()
    Add widget listener to auto scroll selected item to view (i.e make visible)
    org.zkoss.zul.Comboitem
    appendItem(String label)
    Add new combo item
    void
    appendItem(String name, Object value)
    Add new combo item
    void
    clearLastSel()
     
    boolean
    isEnabled()
     
    boolean
    isSelected(Object value)
     
    void
    onPageDetached(org.zkoss.zk.ui.Page page)
     
    void
    removeAllItems()
    Remove all items
    void
    setEnabled(boolean enabled)
     
    void
    setValue(Object value)
    Set selected item for the combo box based on the value of combo item.
    Set selected to none if no item found matching the value given or value is null.

    Methods inherited from class org.zkoss.zul.Combobox

    beforeChildAdded, clone, close, coerceToString, getEmptySearchMessage, getExtraCtrl, getIconSclass, getItemAtIndex, getItemCount, getItemRenderer, getItems, getModel, getPopupWidth, getPropertyAccess, getSelectedIndex, getSelectedItem, getZclass, isAutocomplete, isAutodrop, isButtonVisible, isChildable, isInstantSelect, isOpen, onChildAdded, onChildRemoved, onInitRender, onPageAttached, open, removeItemAt, renderProperties, service, sessionDidActivate, sessionWillPassivate, setAutocomplete, setAutodrop, setButtonVisible, setEmptySearchMessage, setIconSclass, setInstantSelect, setItemRenderer, setItemRenderer, setModel, setMultiline, setOpen, setPopupWidth, setRows, setSelectedIndex, setSelectedItem

    Methods inherited from class org.zkoss.zul.Textbox

    checkBeforeSetRows, coerceFromString, getRows, getType, getValue, isMultiline, isSubmitByEnter, isTabbable, setHeight, setSubmitByEnter, setTabbable, setType, setValue, setVflex

    Methods inherited from class org.zkoss.zul.impl.InputElement

    checkUserError, clearErrorMessage, clearErrorMessage, getCols, getConstraint, getConstraintString, getErrorboxIconSclass, getErrorboxSclass, getErrorMessage, getInputAttributes, getInstant, getMaxlength, getName, getPlaceholder, getRawText, getRawValue, getTargetValue, getText, isDisabled, isInplace, isInstant, isReadonly, isValid, marshall, onWrongValue, select, setCols, setConstraint, setConstraint, setDisabled, setErrorboxIconSclass, setErrorboxSclass, setErrorMessage, setInplace, setInputAttributes, setInputAttributes, setInsertedText, setInstant, setMaxlength, setName, setPlaceholder, setRawValue, setReadonly, setSelectedText, setSelectionRange, setText, setValueDirectly, showCustomError, unmarshall, validate

    Methods inherited from class org.zkoss.zul.impl.XulElement

    getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

    Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

    addSclass, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setClientAction, setDraggable, setDroppable, setFocus, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

    Methods inherited from class org.zkoss.zk.ui.AbstractComponent

    addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, destroyIndexCacheMap, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, disableHostChanged, enableBindingAnnotation, enableHostChanged, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getForwards, getId, getIndexCacheMap, getLastChild, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, initIndexCacheMap, insertBefore, invalidate, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onParentChanged, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, renderPropertiesOnly, replace, response, response, response, service, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.zkoss.zk.ui.IdSpace

    getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow

    Methods inherited from interface org.zkoss.zk.ui.ext.Scope

    addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

  • Constructor Details

    • Combobox

      public Combobox()
      Default constructor

    • Combobox

      public Combobox(String value) throws org.zkoss.zk.ui.WrongValueException
      Parameters:
      value -
      Throws:
      org.zkoss.zk.ui.WrongValueException

  • Method Details

    • setEnabled

      public void setEnabled(boolean enabled)
      Parameters:
      enabled -

    • appendItem

      public org.zkoss.zul.Comboitem appendItem(String label)
      Add new combo item
      Overrides:
      appendItem in class org.zkoss.zul.Combobox
      Parameters:
      label -
      Returns:
      added Comboitem

    • isEnabled

      public boolean isEnabled()
      Returns:
      true if enable, false otherwise

    • removeAllItems

      public void removeAllItems()
      Remove all items

    • appendItem

      public void appendItem(String name, Object value)
      Add new combo item
      Parameters:
      name -
      value -

    • setValue

      public void setValue(Object value)
      Set selected item for the combo box based on the value of combo item.
      Set selected to none if no item found matching the value given or value is null.
      Parameters:
      value - Value of ComboItem to set as selected

    • isSelected

      public boolean isSelected(Object value)
      Parameters:
      value -
      Returns:
      true if current selected combo item is with value equal to value parameter

    • clearLastSel

      public void clearLastSel()

    • addScrollSelectedIntoViewListener

      public void addScrollSelectedIntoViewListener()
      Add widget listener to auto scroll selected item to view (i.e make visible)

    • onPageDetached

      public void onPageDetached(org.zkoss.zk.ui.Page page)
      Specified by:
      onPageDetached in interface org.zkoss.zk.ui.sys.ComponentCtrl
      Overrides:
      onPageDetached in class org.zkoss.zul.Combobox