Package org.zkoss.zul

Class Doublespinner

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.impl.FormatInputElement
org.zkoss.zul.impl.NumberInputElement
org.zkoss.zul.Doublespinner
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
public class Doublespinner extends NumberInputElement
An edit box for holding a constrained double.

Default getZclass(): z-doublespinner.

doublespinner supports below key events.

  • 0-9 : set the value on the inner text box.
  • delete : clear the value to empty (null)
    • Since:
    5.0.6
    Author:
    jumperchen
    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 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_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
      Doublespinner()
       
      Doublespinner(double value)
       

    • Method Summary

      Modifier and Type
      Method
      Description
      protected Object
      coerceFromString(String value)
      Coerces the value passed to InputElement.setText(java.lang.String).
      protected String
      coerceToString(Object value)
      Coerces the value passed to InputElement.setText(java.lang.String).
      double
      doubleValue()
      Returns the value in double.
      double
      getStep()
      Return the step of double spinner
      protected Object
      getTargetValue()
      Returns the value in the targeting type.
      Double
      getValue()
      Returns the value (in Double), might be null unless a constraint stops it.
      String
      getZclass()
       
      boolean
      isButtonVisible()
      Returns whether the button (on the right of the textbox) is visible.
      protected void
      renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
       
      void
      setButtonVisible(boolean visible)
      Sets whether the button (on the right of the textbox) is visible.
      void
      setConstraint(String constr)
       
      void
      setStep(double step)
      Set the step of double spinner
      void
      setValue(Double value)
      Sets the value (in Double).
      protected Object
      unmarshall(Object value)
      Unmarshall value returned from client if needed.

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

      formatNumber, getDefaultFormat, getDefaultLocale, getLocale, getPropertyAccess, getRoundingMode, isLocaleFormat, setLocale, setLocale, setRoundingMode, setRoundingMode, toNumberOnly

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

      getFormat, getRealFormat, setFormat

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

      checkUserError, clearErrorMessage, clearErrorMessage, clone, getCols, getConstraint, getConstraintString, getErrorboxIconSclass, getErrorboxSclass, getErrorMessage, getInputAttributes, getInstant, getMaxlength, getName, getPlaceholder, getRawText, getRawValue, getText, getType, isChildable, isDisabled, isInplace, isInstant, isMultiline, isReadonly, isValid, marshall, onWrongValue, select, service, setCols, setConstraint, setDisabled, setErrorboxIconSclass, setErrorboxSclass, setErrorMessage, setInplace, setInputAttributes, setInputAttributes, setInsertedText, setInstant, setMaxlength, setName, setPlaceholder, setRawValue, setReadonly, setSelectedText, setSelectionRange, setText, setValueDirectly, showCustomError, 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, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getSkeleton, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, 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, 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 Details

      • Doublespinner

        public Doublespinner()

      • Doublespinner

        public Doublespinner(double value) throws org.zkoss.zk.ui.WrongValueException
        Throws:
        org.zkoss.zk.ui.WrongValueException

    • Method Details

      • getValue

        public Double getValue() throws org.zkoss.zk.ui.WrongValueException
        Returns the value (in Double), might be null unless a constraint stops it.
        Throws:
        org.zkoss.zk.ui.WrongValueException - if user entered a wrong value

      • getTargetValue

        protected Object getTargetValue() throws org.zkoss.zk.ui.WrongValueException
        Description copied from class: InputElement
        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 InputElement.checkUserError() to ensure no user error.

        Overrides:
        getTargetValue in class InputElement
        Throws:
        org.zkoss.zk.ui.WrongValueException - if the user entered a wrong value
        See Also:

      • doubleValue

        public double doubleValue() throws org.zkoss.zk.ui.WrongValueException
        Returns the value in double. If null, zero is returned.
        Throws:
        org.zkoss.zk.ui.WrongValueException - if user entered a wrong value

      • setValue

        public void setValue(Double value) throws org.zkoss.zk.ui.WrongValueException
        Sets the value (in Double).
        Throws:
        org.zkoss.zk.ui.WrongValueException - if value is wrong

      • getStep

        public double getStep()
        Return the step of double spinner

      • setStep

        public void setStep(double step)
        Set the step of double spinner

      • isButtonVisible

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

        Default: true.

      • setButtonVisible

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

      • getZclass

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

      • setConstraint

        public void setConstraint(String constr)
        Overrides:
        setConstraint in class InputElement
        Parameters:
        constr - a list of constraints separated by comma. Example: no positive, no zero

      • coerceFromString

        protected Object coerceFromString(String value) throws org.zkoss.zk.ui.WrongValueException
        Description copied from class: InputElement
        Coerces the value passed to InputElement.setText(java.lang.String).

        Deriving note:
        If you want to store the value in other type, say BigDecimal, you have to override InputElement.coerceToString(java.lang.Object) and InputElement.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.

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

      • coerceToString

        protected String coerceToString(Object value)
        Description copied from class: InputElement
        Coerces the value passed to InputElement.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 InputElement.coerceToString(java.lang.Object) and InputElement.coerceFromString(java.lang.String) to convert between a string and your targeting type.

        Specified by:
        coerceToString in class InputElement

      • unmarshall

        protected Object unmarshall(Object value)
        Description copied from class: InputElement
        Unmarshall value returned from client if needed.

        Overrides it if the value returned is not JSON Compatible.

        Overrides:
        unmarshall in class InputElement
        Parameters:
        value - the value returned from client
        Returns:
        the unmarshalled value

      • renderProperties

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