org.zkoss.zul
Class Spinner

java.lang.Object
  extended by org.zkoss.zk.ui.AbstractComponent
      extended by org.zkoss.zk.ui.HtmlBasedComponent
          extended by org.zkoss.zul.impl.XulElement
              extended by org.zkoss.zul.impl.InputElement
                  extended by org.zkoss.zul.impl.FormatInputElement
                      extended by org.zkoss.zul.impl.NumberInputElement
                          extended by org.zkoss.zul.Spinner
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Component, Disable, Readonly, Scope, ComponentCtrl, Constrainted

public class Spinner
extends NumberInputElement

An edit box for holding a constrained integer.

Default getZclass(): z-spinner.

spinner supports below key events.

  • 0-9 : set the value on the inner text box.
  • delete : clear the value to empty (null)

    Since:
    3.5.0
    Author:
    gracelin
    See Also:
    Serialized Form

    Nested Class Summary
     
    Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent
    HtmlBasedComponent.ExtraCtrl
     
    Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent
    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
    CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
     
    Constructor Summary
    Spinner()
               
    Spinner(int value)
               
     
    Method Summary
    protected  java.lang.Object coerceFromString(java.lang.String value)
              Coerces the value passed to InputElement.setText(java.lang.String).
    protected  java.lang.String coerceToString(java.lang.Object value)
              Coerces the value passed to InputElement.setText(java.lang.String).
     int getStep()
              Return the step of spinner
    protected  java.lang.Object getTargetValue()
              Returns the value in the targeting type.
     java.lang.Integer getValue()
              Returns the value (in Integer), might be null unless a constraint stops it.
     java.lang.String getZclass()
              Returns the ZK Cascading Style class(es) for this component.
     int intValue()
              Returns the value in int.
     boolean isButtonVisible()
              Returns whether the button (on the right of the textbox) is visible.
    protected  void renderProperties(ContentRenderer renderer)
              Renders the content of this component, excluding the enclosing tags and children.
     void setButtonVisible(boolean visible)
              Sets whether the button (on the right of the textbox) is visible.
     void setConstraint(java.lang.String constr)
               
     void setStep(int step)
              Set the step of spinner
     void setValue(java.lang.Integer value)
              Sets the value (in Integer).
     
    Methods inherited from class org.zkoss.zul.impl.NumberInputElement
    formatNumber, getDefaultFormat, getDefaultLocale, getLocale, getRoundingMode, 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, getErrorMessage, getInstant, getMaxlength, getName, getRawText, getRawValue, getTabindex, getText, getType, isChildable, isDisabled, isInplace, isMultiline, isReadonly, isValid, marshall, onWrongValue, select, service, setCols, setConstraint, setDisabled, setErrorMessage, setInplace, setInstant, setMaxlength, setName, setRawValue, setReadonly, setSelectedText, setSelectionRange, setTabindex, setText, setValueDirectly, showCustomError, unmarshall, validate
     
    Methods inherited from class org.zkoss.zul.impl.XulElement
    getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
     
    Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent
    focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
     
    Methods inherited from class org.zkoss.zk.ui.AbstractComponent
    addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize
     
    Methods inherited from class java.lang.Object
    finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
     

    Constructor Detail

    Spinner

    public Spinner()

    Spinner

    public Spinner(int value)
            throws WrongValueException
    Throws:
    WrongValueException
    Method Detail

    getValue

    public java.lang.Integer getValue()
                               throws WrongValueException
    Returns the value (in Integer), might be null unless a constraint stops it.

    Throws:
    WrongValueException - if user entered a wrong value

    intValue

    public int intValue()
                 throws WrongValueException
    Returns the value in int. If null, zero is returned.

    Throws:
    WrongValueException

    getTargetValue

    protected java.lang.Object getTargetValue()
                                       throws 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:
    WrongValueException - if the user entered a wrong value
    See Also:
    InputElement.getText()

    setValue

    public void setValue(java.lang.Integer value)
                  throws WrongValueException
    Sets the value (in Integer).

    Throws:
    WrongValueException - if value is wrong

    getStep

    public int getStep()
    Return the step of spinner


    setStep

    public void setStep(int step)
    Set the step of 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 java.lang.String getZclass()
    Description copied from class: HtmlBasedComponent
    Returns the ZK Cascading Style class(es) for this component. It usually depends on the implementation of the mold (@{link #getMold}).

    Default: null (the default value depends on element).

    HtmlBasedComponent.setZclass(java.lang.String)) will completely replace the default style of a component. In other words, the default style of a component is associated with the default value of HtmlBasedComponent.getZclass(). Once it is changed, the default style won't be applied at all. If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String) instead.

    Overrides:
    getZclass in class HtmlBasedComponent
    See Also:
    HtmlBasedComponent.getSclass()

    setConstraint

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

    coerceFromString

    protected java.lang.Object coerceFromString(java.lang.String value)
                                         throws 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:
    WrongValueException

    coerceToString

    protected java.lang.String coerceToString(java.lang.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

    renderProperties

    protected void renderProperties(ContentRenderer renderer)
                             throws java.io.IOException
    Description copied from class: HtmlBasedComponent
    Renders the content of this component, excluding the enclosing tags and children.

    See also ZK Client-side Reference: Property Rendering

    Overrides:
    renderProperties in class NumberInputElement
    Throws:
    java.io.IOException


    Copyright © 2005-2011 Potix Corporation. All Rights Reserved. SourceForge.net Logo