Package org.zkoss.zul.impl

Class InputElement

java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.impl.InputElement
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.sys.ComponentCtrl, Constrainted
Direct Known Subclasses:
FormatInputElement, Textbox
public abstract class InputElement extends XulElement implements Constrainted, org.zkoss.zk.ui.ext.Readonly, org.zkoss.zk.ui.ext.Disable
A skeletal implementation of an input box.

Events: onChange, onChanging, onFocus, onBlur, onSelection.

Author:
tomyeh
See Also:

  • 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
    Modifier and Type
    Field
    Description
    protected int
    _cols
     
    protected Object
    _value
    The 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_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
    InputElement()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    checkUserError()
    Checks whether user entered a wrong value (and not correct it yet).
    void
    clearErrorMessage()
    Clears the error message.
    void
    clearErrorMessage(boolean revalidateRequired)
    Clears the error message.
    Object
    clone()
     
    protected abstract Object
    coerceFromString(String value)
    Coerces the value passed to setText(java.lang.String).
    protected abstract String
    coerceToString(Object value)
    Coerces the value passed to setText(java.lang.String).
    int
    getCols()
    Returns the cols.
    Constraint
    getConstraint()
    Returns the constraint, or null if no constraint at all.
    String
    getConstraintString()
    Returns the raw constraint string value if any.
    String
    getErrorboxIconSclass()
    Returns the class name of the custom style applied to the errorbox icon of this component.
    String
    getErrorboxSclass()
    Returns the class name of the custom style applied to the errorbox of this component.
    String
    getErrorMessage()
    Returns the error message that is caused when user entered invalid value, or null if no error at all.
    Map<String,String>
    getInputAttributes()
    Returns the additional attributes which is set by setInputAttributes(Map<String, String> inputAttributes).
    boolean
    getInstant()
    Returns true if onChange event is sent as soon as user types in the input component.
    int
    getMaxlength()
    Returns the maxlength.
    String
    getName()
    Returns the name of this component.
    String
    getPlaceholder()
    Returns the placeholder text
    org.zkoss.zk.ui.sys.PropertyAccess
    getPropertyAccess(String prop)
     
    String
    getRawText()
    Returns the text directly without checking whether any error message not yet fixed.
    Object
    getRawValue()
    Returns the raw value directly with checking whether any error message not yet fixed.
    protected Object
    getTargetValue()
    Returns the value in the targeting type.
    String
    getText()
    Returns the value in the String format.
    String
    getType()
    Returns the type.
    protected boolean
    isChildable()
    Not childable.
    boolean
    isDisabled()
    Returns whether it is disabled.
    boolean
    isInplace()
    Returns whether enable the inplace-editing.
    boolean
    isInstant()
    Returns true if onChange event is sent as soon as user types in the input component.
    boolean
    isMultiline()
    Returns whether it is multiline.
    boolean
    isReadonly()
    Returns whether it is readonly.
    boolean
    isValid()
    Returns the current content of this input is correct.
    protected Object
    marshall(Object value)
    Marshall value to be sent to the client if needed.
    org.zkoss.zk.ui.WrongValueException
    onWrongValue(org.zkoss.zk.ui.WrongValueException ex)
     
    protected void
    renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
     
    void
    select()
    Selects the whole text in this input.
    void
    service(org.zkoss.zk.au.AuRequest request, boolean everError)
    Processes an AU request.
    void
    setCols(int cols)
    Sets the cols which determines the visible width, in characters.
    void
    setConstraint(String constr)
     
    void
    setConstraint(Constraint constr)
    Sets the constraint.
    void
    setDisabled(boolean disabled)
    Sets whether it is disabled.
    void
    setErrorboxIconSclass(String iconSclass)
    Sets the class name of the custom style to be applied to the errorbox icon of this component.
    void
    setErrorboxSclass(String sclass)
    Sets the class name of the custom style to be applied to the errorbox of this component.
    void
    setErrorMessage(String errmsg)
    Associates an error message to this input.
    void
    setInplace(boolean inplace)
    Sets to enable the inplace-editing function that the look and feel is like a label.
    void
    setInputAttributes(String inputAttributes)
    Sets some additional attributes to the input html tag in the component.
    void
    setInputAttributes(Map<String,String> inputAttributes)
    Sets some additional attributes to the input html tag in the component.
    void
    setInsertedText(String text)
    Inserts the text at the current cursor position.
    void
    setInstant(boolean instant)
    Sets the instant attribute.
    void
    setMaxlength(int maxlength)
    Sets the maxlength.
    void
    setName(String name)
    Sets the name of this component.
    void
    setPlaceholder(String placeholder)
    Sets the placeholder text that is displayed when input is empty.
    void
    setRawValue(Object value)
    Sets the raw value directly.
    void
    setReadonly(boolean readonly)
    Sets whether it is readonly.
    void
    setSelectedText(int start, int end, String newtxt, boolean isHighLight)
    Sets the text of this InputElement to the specified text which is beginning with the new start point and ending with the new end point.
    void
    setSelectionRange(int start, int end)
    Sets the selection end to the specified position and the selection start to the specified position.
    void
    setText(String value)
    Sets the value in the String format.
    protected void
    setValueDirectly(Object value)
    Sets the value directly.
    protected org.zkoss.zk.ui.WrongValueException
    showCustomError(org.zkoss.zk.ui.WrongValueException ex)
    Shows the error message in the custom way by calling (CustomConstraint.showCustomError(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.WrongValueException), if the constraint implements CustomConstraint.
    protected Object
    unmarshall(Object value)
    Unmarshall value returned from client if needed.
    protected void
    validate(Object value)
    Validates the value returned by coerceFromString(java.lang.String).

    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, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getSkeleton, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setClientAction, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setSkeleton, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, 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, getStubonlyDescendants, 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, setStubonlyDescendants, 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

  • Field Details

    • _value

      protected Object _value
      The value.

    • _cols

      protected int _cols

  • Constructor Details

    • InputElement

      public InputElement()

  • Method Details

    • getPlaceholder

      public String getPlaceholder()
      Returns the placeholder text
      Since:
      6.5.0

    • setPlaceholder

      public void setPlaceholder(String placeholder)
      Sets the placeholder text that is displayed when input is empty. Only works for browsers supporting HTML5.
      Since:
      6.5.0

    • setInplace

      public void setInplace(boolean inplace)
      Sets to enable the inplace-editing function that the look and feel is like a label.
      Since:
      5.0.0

    • isInplace

      public boolean isInplace()
      Returns whether enable the inplace-editing.

      default: false.

      Since:
      5.0.0

    • isDisabled

      public boolean isDisabled()
      Returns whether it is disabled.

      Default: false.

      Specified by:
      isDisabled in interface org.zkoss.zk.ui.ext.Disable

    • setDisabled

      public void setDisabled(boolean disabled)
      Sets whether it is disabled.
      Specified by:
      setDisabled in interface org.zkoss.zk.ui.ext.Disable

    • isReadonly

      public boolean isReadonly()
      Returns whether it is readonly.

      Default: false.

      Specified by:
      isReadonly in interface org.zkoss.zk.ui.ext.Readonly

    • setReadonly

      public void setReadonly(boolean readonly)
      Sets whether it is readonly.
      Specified by:
      setReadonly in interface org.zkoss.zk.ui.ext.Readonly

    • getName

      public String getName()
      Returns the name of this component.

      Default: null.

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

      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.

    • setName

      public void setName(String name)
      Sets the name of this component.

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

      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.

      Parameters:
      name - the name of this component.

    • getErrorMessage

      public String getErrorMessage()
      Returns the error message that is caused when user entered invalid value, or null if no error at all.

      The error message is set when user has entered a wrong value, or setValue is called with a wrong value. It is cleared once a correct value is assigned.

      If the error message is set, we say this input is in the error mode. Any following invocation to getText() or getValue will throw any exception. Example, Textbox.getValue() and Intbox.getValue().

    • setErrorMessage

      public void setErrorMessage(String errmsg)
      Associates an error message to this input. It will cause the given error message to be shown at the client.

      Notice that the application rarely invokes this method. Rather, throw WrongValueException instead.

      Notice it does not invoke CustomConstraint.showCustomError(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.WrongValueException) even if getConstraint() implements CustomConstraint.

      Since:
      5.0.4

    • clearErrorMessage

      public void clearErrorMessage(boolean revalidateRequired)
      Clears the error message.

      The error message is cleared automatically, so you rarely need to call this method. However, if a constraint depends on multiple input fields and the error can be corrected by changing one of these fields, then you may have to clear the error message manually by invoking this method.

      For example, assume you have two Intbox and want the value of the first one to be smaller than that of the second one. Then, you have to call this method for the second intbox once the validation of the first intbox succeeds, and vice versa. Otherwise, the error message for the second intbox remains if the user fixed the error by lowering down the value of the first one Why? The second intbox got no idea to clear the error message (since its content doesn't change).

      Parameters:
      revalidateRequired - whether to re-validate the current value when getText() or others (such as Intbox.getValue()) is called. If false, the current value is assumed to be correct and the following invocation to getText() or others (such as Intbox.getValue()) won't check the value again. Note: when an input element is constructed, the initial value is assumed to be "not-validated-yet".
      Since:
      3.0.1

    • clearErrorMessage

      public void clearErrorMessage()
      Clears the error message. It is the same as clearErrorMessage(false). That is, the current value is assumed to be correct. getText() or others (such as Intbox.getValue()) won't re-validate it again.

      The error message is cleared automatically, so you rarely need to call this method.

      See Also:

    • getText

      public String getText() throws org.zkoss.zk.ui.WrongValueException
      Returns the value in the String format. In most case, you shall use the setValue method instead, e.g., Textbox.getValue() and Intbox.getValue().

      It invokes checkUserError() to ensure no user error.

      It invokes coerceToString(java.lang.Object) to convert the stored value into a string.

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

    • setText

      public void setText(String value) throws org.zkoss.zk.ui.WrongValueException
      Sets the value in the String format. In most case, you shall use the setValue method instead, e.g., Textbox.setValue(java.lang.String) and Intbox.setValue(java.lang.Integer).

      It invokes coerceFromString(java.lang.String) first and then validate(java.lang.Object). Derives might override them for type conversion and special validation.

      Parameters:
      value - the value; If null, it is considered as empty.
      Throws:
      org.zkoss.zk.ui.WrongValueException

    • coerceFromString

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

      Deriving note:
      If you want to store the value in other type, say BigDecimal, you have to override coerceToString(java.lang.Object) and coerceFromString(java.lang.String) to convert between a string and your targeting type.

      Moreover, when Textbox is called, it calls this method with value = null. Derives shall handle this case properly.

      Throws:
      org.zkoss.zk.ui.WrongValueException

    • coerceToString

      protected abstract String coerceToString(Object value)
      Coerces the value passed to setText(java.lang.String).

      Default: convert null to an empty string.

      Deriving note:
      If you want to store the value in other type, say BigDecimal, you have to override coerceToString(java.lang.Object) and coerceFromString(java.lang.String) to convert between a string and your targeting type.

    • validate

      protected void validate(Object value) throws org.zkoss.zk.ui.WrongValueException
      Validates the value returned by coerceFromString(java.lang.String).

      Default: use getConstraint()'s Constraint.validate(org.zkoss.zk.ui.Component, java.lang.Object), if not null.

      You rarely need to override this method.

      Throws:
      org.zkoss.zk.ui.WrongValueException

    • showCustomError

      protected org.zkoss.zk.ui.WrongValueException showCustomError(org.zkoss.zk.ui.WrongValueException ex)
      Shows the error message in the custom way by calling (CustomConstraint.showCustomError(org.zkoss.zk.ui.Component, org.zkoss.zk.ui.WrongValueException), if the constraint implements CustomConstraint.

      Derived class shall call this method before throwing WrongValueException, such that the constraint, if any, has a chance to show the error message in a custom way.

      Parameters:
      ex - the exception, or null to clean up the error.
      Returns:
      the exception (ex)

    • getMaxlength

      public int getMaxlength()
      Returns the maxlength.

      Default: 0 (non-positive means unlimited).

    • setMaxlength

      public void setMaxlength(int maxlength)
      Sets the maxlength.

      The length includes the format, if specified.

    • getCols

      public int getCols()
      Returns the cols.

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

    • setCols

      public void setCols(int cols) throws org.zkoss.zk.ui.WrongValueException
      Sets the cols which determines the visible width, in characters.
      Throws:
      org.zkoss.zk.ui.WrongValueException

    • getInstant

      public boolean getInstant()
      Returns true if onChange event is sent as soon as user types in the input component.

      Default: false

      Since:
      6.0.0

    • isInstant

      public boolean isInstant()
      Returns true if onChange event is sent as soon as user types in the input component.

      Default: false

      Since:
      8.0.0

    • setInstant

      public void setInstant(boolean instant)
      Sets the instant attribute. When the attribute is true, onChange event will be fired as soon as user type in the input component.
      Since:
      6.0.0

    • isMultiline

      public boolean isMultiline()
      Returns whether it is multiline.

      Default: false.

    • getType

      public String getType()
      Returns the type.

      Default: text.

    • select

      public void select()
      Selects the whole text in this input.

    • setConstraint

      public void setConstraint(String constr)

    • setConstraint

      public void setConstraint(Constraint constr)
      Description copied from interface: Constrainted
      Sets the constraint.

      Default: null (means no constraint all all).

      Specified by:
      setConstraint in interface Constrainted

    • getConstraint

      public Constraint getConstraint()
      Description copied from interface: Constrainted
      Returns the constraint, or null if no constraint at all.
      Specified by:
      getConstraint in interface Constrainted

    • getConstraintString

      public String getConstraintString()
      Returns the raw constraint string value if any.
      Since:
      10.0.0

    • getTargetValue

      protected Object getTargetValue() throws org.zkoss.zk.ui.WrongValueException
      Returns the value in the targeting type. It is used by the deriving class to implement the getValue method. For example, Intbox.getValue() is the same as this method except with a different signature.

      It invokes checkUserError() to ensure no user error.

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

    • getRawValue

      public Object getRawValue()
      Returns the raw value directly with checking whether any error message not yet fixed. In other words, it does NOT invoke checkUserError().

      Note: if the user entered an incorrect value (i.e., caused WrongValueException), the incorrect value doesn't be stored so this method returned the last correct value.

      See Also:

    • getRawText

      public String getRawText()
      Returns the text directly without checking whether any error message not yet fixed. In other words, it does NOT invoke checkUserError().

      Note: if the user entered an incorrect value (i.e., caused WrongValueException), the incorrect value doesn't be stored so this method returned the last correct value.

      See Also:

    • setRawValue

      public void setRawValue(Object value)
      Sets the raw value directly. The caller must make sure the value is correct (or intend to be incorrect), because this method doesn't do any validation.

      If you feel confusing with setValue, such as Textbox.setValue(java.lang.String), it is usually better to use setValue instead. This method is reserved for developer that really want to set an 'illegal' value (such as an empty string to a textbox with no-empty constraint).

      Note: since 3.0.1, the value will be re-validate again if getText() or others (such as Intbox.getValue()) is called. In other words, it is assumed that the specified value is not validated yet -- the same state when this component is created. If you want to avoid the re-validation, you have to invoke clearErrorMessage().

      Like setValue, the result is returned back to the server by calling getText().

      See Also:

    • setValueDirectly

      protected void setValueDirectly(Object value)
      Sets the value directly. Note: Unlike setRawValue(java.lang.Object) (nor setValue), this method assigns the value directly without clearing error message or synchronizing with the client.

      It is usually used only the constructor. Though it is also OK to use setRawValue(java.lang.Object) in the constructor, this method has better performance.

      Since:
      3.0.3

    • isValid

      public boolean isValid()
      Returns the current content of this input is correct. If the content is not correct, next call to the getValue method will throws WrongValueException.

    • setSelectedText

      public void setSelectedText(int start, int end, String newtxt, boolean isHighLight)
      Sets the text of this InputElement to the specified text which is beginning with the new start point and ending with the new end point.
      Parameters:
      start - the start position of the text (included)
      end - the end position of the text (excluded)
      newtxt - the new text to be set.
      isHighLight - Sets whether it will represent highlight style or cursor style.If the start point same with the end point always represent cursor style.

    • setSelectionRange

      public void setSelectionRange(int start, int end)
      Sets the selection end to the specified position and the selection start to the specified position. The new end point is constrained to be at or after the current selection start. If the new start point is different with the new end point, then will represent the result of highlight in this text.

      Set both arguments to the same value to move the cursor to the corresponding position without selecting text.

      Parameters:
      start - the start position of the text (included)
      end - the end position of the text (excluded)

    • setInsertedText

      public void setInsertedText(String text)
      Inserts the text at the current cursor position. It would trigger focus and change event.
      Parameters:
      text - the text to be inserted
      Since:
      8.5.1

    • checkUserError

      protected void checkUserError() throws org.zkoss.zk.ui.WrongValueException
      Checks whether user entered a wrong value (and not correct it yet). Since user might enter a wrong value and moves on to other components, this method is called when getText() or getTargetValue() is called.

      Derives rarely need to access this method if they use only getText() and getTargetValue().

      Throws:
      org.zkoss.zk.ui.WrongValueException

    • getErrorboxSclass

      public String getErrorboxSclass()
      Returns the class name of the custom style applied to the errorbox of this component.
      Returns:
      Sclass
      Since:
      8.0.1

    • setErrorboxSclass

      public void setErrorboxSclass(String sclass)
      Sets the class name of the custom style to be applied to the errorbox of this component.
      Parameters:
      sclass -
      Since:
      8.0.1

    • getErrorboxIconSclass

      public String getErrorboxIconSclass()
      Returns the class name of the custom style applied to the errorbox icon of this component.
      Returns:
      Sclass
      Since:
      8.0.1

    • setErrorboxIconSclass

      public void setErrorboxIconSclass(String iconSclass)
      Sets the class name of the custom style to be applied to the errorbox icon of this component.
      Parameters:
      iconSclass -
      Since:
      8.0.1

    • getInputAttributes

      public Map<String,String> getInputAttributes()
      Returns the additional attributes which is set by setInputAttributes(Map<String, String> inputAttributes).
      Returns:
      inputAttributes a Map with attribute names as the keys.
      Since:
      8.6.1

    • setInputAttributes

      public void setInputAttributes(Map<String,String> inputAttributes)
      Sets some additional attributes to the input html tag in the component. This will only reset the additional attributes that are set by this method.
      Parameters:
      inputAttributes - a Map with attribute names as the keys.
      Since:
      8.6.1

    • setInputAttributes

      public void setInputAttributes(String inputAttributes)
      Sets some additional attributes to the input html tag in the component. This will only reset the additional attributes that are set by this method.
      Parameters:
      inputAttributes - a String of attribute separate by ";" and follow name=value rule. for example: "spellcheck=true;autocorrect=on"
      Since:
      8.6.1

    • isChildable

      protected boolean isChildable()
      Not childable.
      Overrides:
      isChildable in class org.zkoss.zk.ui.AbstractComponent

    • onWrongValue

      public org.zkoss.zk.ui.WrongValueException onWrongValue(org.zkoss.zk.ui.WrongValueException ex)
      Specified by:
      onWrongValue in interface org.zkoss.zk.ui.sys.ComponentCtrl
      Overrides:
      onWrongValue in class org.zkoss.zk.ui.AbstractComponent

    • marshall

      protected Object marshall(Object value)
      Marshall value to be sent to the client if needed.

      Overrides it if the value to be sent to the client is not JSON Compatible.

      Parameters:
      value - the value to be sent to the client
      Returns:
      the marshalled value
      Since:
      5.0.5

    • unmarshall

      protected Object unmarshall(Object value)
      Unmarshall value returned from client if needed.

      Overrides it if the value returned is not JSON Compatible.

      Parameters:
      value - the value returned from client
      Returns:
      the unmarshalled value
      Since:
      5.0.5

    • service

      public void service(org.zkoss.zk.au.AuRequest request, boolean everError)
      Processes an AU request.

      Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean), it also handles onChange, onChanging and onError.

      Specified by:
      service in interface org.zkoss.zk.ui.sys.ComponentCtrl
      Overrides:
      service in class org.zkoss.zk.ui.HtmlBasedComponent
      Since:
      5.0.0

    • renderProperties

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

    • getPropertyAccess

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

    • clone

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