Package org.zkoss.zul

Class Textbox

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.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.sys.ComponentCtrl, Constrainted
    Direct Known Subclasses:
    Bandbox, Combobox
    public class Textbox
extends InputElement
    A textbox.

    See Specification.

    Default getZclass(): z-textbox.(since 3.5.0)

    When multiline is true, only default mold is available.

    Author:
    tomyeh
    See Also:
    Serialized Form

    • Nested Class Summary

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

        org.zkoss.zk.ui.HtmlBasedComponent.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.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_CLONED, 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
      Textbox()  
      Textbox​(java.lang.String value)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void checkBeforeSetRows()
      Internal check if there is any use of vflex and height before setRows
      java.lang.Object clone()  
      protected java.lang.Object coerceFromString​(java.lang.String value)
      Coerces the value passed to setValue(java.lang.String).
      protected java.lang.String coerceToString​(java.lang.Object value)
      Coerces the value passed to setValue(java.lang.String).
      org.zkoss.zk.ui.sys.PropertyAccess getPropertyAccess​(java.lang.String prop)  
      int getRows()
      Returns the rows.
      java.lang.String getType()
      Returns the type.
      java.lang.String getValue()
      Returns the value.
      java.lang.String getZclass()  
      boolean isMultiline()
      Returns whether it is multiline.
      boolean isSubmitByEnter()
      Returns whether it is submitByEnter, If submitByEnter is true, press enter will fire onOK event instead of move to next line, you should press shift + enter if you want to move to next line.
      boolean isTabbable()
      Returns whether TAB is allowed.
      protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)  
      void setHeight​(java.lang.String height)  
      void setMultiline​(boolean multiline)
      Sets whether it is multiline.
      void setRows​(int rows)
      Sets the rows.
      void setSubmitByEnter​(boolean submitByEnter)
      Sets whether it is submitByEnter.
      void setTabbable​(boolean tabbable)
      Sets whether TAB is allowed.
      void setType​(java.lang.String type)
      Sets the type.
      void setValue​(java.lang.String value)
      Sets the value.
      void setVflex​(java.lang.String flex)  

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

        addSclass, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getExtraCtrl, 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, beforeChildAdded, 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, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, 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, sessionDidActivate, sessionWillPassivate, 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

    • Constructor Detail

      • Textbox

        public Textbox()

      • Textbox

        public Textbox​(java.lang.String value)
        throws org.zkoss.zk.ui.WrongValueException
        Throws:
        org.zkoss.zk.ui.WrongValueException

    • Method Detail

      • getValue

        public java.lang.String getValue()
                          throws org.zkoss.zk.ui.WrongValueException
        Returns the value. The same as InputElement.getText().

        Default: "".

        Throws:
        org.zkoss.zk.ui.WrongValueException - if user entered a wrong value

      • setValue

        public void setValue​(java.lang.String value)
              throws org.zkoss.zk.ui.WrongValueException
        Sets the value.
        Parameters:
        value - the value; If null, it is considered as empty.
        Throws:
        org.zkoss.zk.ui.WrongValueException - if value is wrong

      • coerceFromString

        protected java.lang.Object coerceFromString​(java.lang.String value)
                                     throws org.zkoss.zk.ui.WrongValueException
        Coerces the value passed to setValue(java.lang.String).

        Default: convert null to an empty string.

        Specified by:
        coerceFromString in class InputElement
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • getType

        public java.lang.String getType()
        Returns the type.

        Default: text.

        Overrides:
        getType in class InputElement

      • setType

        public void setType​(java.lang.String type)
             throws org.zkoss.zk.ui.WrongValueException
        Sets the type.
        Parameters:
        type - the type. Acceptable values are "text" and "password". Unlike XUL, "timed" is redundant because it is enabled as long as onChanging is added. Since 6.5.0 type also support tel, email and url.
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • getRows

        public int getRows()
        Returns the rows.

        Default: 1.

      • setRows

        public void setRows​(int rows)
             throws org.zkoss.zk.ui.WrongValueException
        Sets the rows.

        Note: Not allowed to set rows and height/vflex at the same time

        Throws:
        org.zkoss.zk.ui.WrongValueException

      • checkBeforeSetRows

        protected void checkBeforeSetRows()
                           throws org.zkoss.zk.ui.UiException
        Internal check if there is any use of vflex and height before setRows
        Throws:
        org.zkoss.zk.ui.UiException

      • isMultiline

        public boolean isMultiline()
        Returns whether it is multiline.

        Default: false.

        Overrides:
        isMultiline in class InputElement

      • setMultiline

        public void setMultiline​(boolean multiline)
        Sets whether it is multiline.

      • isTabbable

        public boolean isTabbable()
        Returns whether TAB is allowed. If true, the user can enter TAB in the textbox, rather than change focus.

        Default: false.

        Since:
        3.6.0

      • setTabbable

        public void setTabbable​(boolean tabbable)
        Sets whether TAB is allowed. If true, the user can enter TAB in the textbox, rather than change focus.

        Default: false.

        Since:
        3.6.0

      • isSubmitByEnter

        public boolean isSubmitByEnter()
        Returns whether it is submitByEnter, If submitByEnter is true, press enter will fire onOK event instead of move to next line, you should press shift + enter if you want to move to next line.

        Default: false.

        Returns:
        true if it is submitByEnter.
        Since:
        8.5.2

      • setSubmitByEnter

        public void setSubmitByEnter​(boolean submitByEnter)
        Sets whether it is submitByEnter. If submitByEnter is true, press enter will fire onOK event instead of move to next line, you should press shift + enter if you want to move to next line.
        Parameters:
        submitByEnter - whether it is submitByEnter
        Since:
        8.5.2

      • setVflex

        public void setVflex​(java.lang.String flex)
        Overrides:
        setVflex in class org.zkoss.zk.ui.HtmlBasedComponent

      • setHeight

        public void setHeight​(java.lang.String height)
        Overrides:
        setHeight in class org.zkoss.zk.ui.HtmlBasedComponent

      • clone

        public java.lang.Object clone()
        Specified by:
        clone in interface org.zkoss.zk.ui.Component
        Overrides:
        clone in class InputElement

      • getPropertyAccess

        public org.zkoss.zk.ui.sys.PropertyAccess getPropertyAccess​(java.lang.String prop)
        Specified by:
        getPropertyAccess in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        getPropertyAccess in class InputElement

      • renderProperties

        protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws java.io.IOException
        Overrides:
        renderProperties in class InputElement
        Throws:
        java.io.IOException

      • getZclass

        public java.lang.String getZclass()
        Overrides:
        getZclass in class org.zkoss.zk.ui.HtmlBasedComponent