Class AutoComplete

  • 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:
    WAutoCompleterCity

    public class AutoComplete
    extends Combobox
    Auto-complete with combobox. Based on ZK's Auto-complete
    Author:
    Niraj Sohun Aug 20, 2007
    See Also:
    Serialized Form
    • 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
    • Field Summary

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

        _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, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getContent​(org.zkoss.zul.Comboitem item)  
      void onChanging​(org.zkoss.zk.ui.event.InputEvent evt)
      Event handler responsible to reducing number of items Method is invoked each time something is typed in the combobox
      void refresh​(String val)
      Refresh comboitem based on the specified value.
      void setContents​(String[] vals)
      Set content of menu items
      void setDescription​(String[] vals)
      Set description of menu items
      void setDict​(String[] vals)
      Set menu labels
      void setDict​(String[] vals, boolean sort)  
      void setImages​(String[] images)  
      void setValue​(String value)  
      void setValues​(Object[] values)  
      • Methods inherited from class org.zkoss.zul.Combobox

        beforeChildAdded, clone, close, coerceToString, getExtraCtrl, getIconSclass, getItemAtIndex, getItemCount, getItemRenderer, getItems, getModel, getPopupWidth, getPropertyAccess, getSelectedIndex, getSelectedItem, getZclass, isAutocomplete, isAutodrop, isButtonVisible, isChildable, isInstantSelect, isOpen, onChildAdded, onChildRemoved, onInitRender, onPageAttached, onPageDetached, 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, setVflex
      • Methods inherited from class org.zkoss.zul.impl.InputElement

        checkUserError, clearErrorMessage, clearErrorMessage, getCols, getConstraint, 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, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, 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, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, 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, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, invalidatePartial, isInitialized, isInvalidated, isListenerAvailable, isVisible, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, 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, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize
      • Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

        invalidatePartial
      • 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 Detail

      • AutoComplete

        public AutoComplete()
        Constructor
      • AutoComplete

        public AutoComplete​(String value)
    • Method Detail

      • setDict

        public void setDict​(String[] vals)
        Set menu labels
        Parameters:
        vals - Menu labels
      • setDict

        public void setDict​(String[] vals,
                            boolean sort)
      • setDescription

        public void setDescription​(String[] vals)
        Set description of menu items
        Parameters:
        vals - Description of menu items
      • setContents

        public void setContents​(String[] vals)
        Set content of menu items
        Parameters:
        vals - Content of menu items
      • setImages

        public void setImages​(String[] images)
      • setValues

        public void setValues​(Object[] values)
      • setValue

        public void setValue​(String value)
        Overrides:
        setValue in class org.zkoss.zul.Textbox
      • onChanging

        public void onChanging​(org.zkoss.zk.ui.event.InputEvent evt)
        Event handler responsible to reducing number of items Method is invoked each time something is typed in the combobox
        Parameters:
        evt - The event
      • refresh

        public void refresh​(String val)
        Refresh comboitem based on the specified value.
      • getContent

        public String getContent​(org.zkoss.zul.Comboitem item)