org.zkoss.zul.api
Interface Spinner

All Superinterfaces:
java.lang.Cloneable, Component, Constrainted, FormatInputElement, HtmlBasedComponent, InputElement, NumberInputElement, Scope, java.io.Serializable, XulElement
All Known Implementing Classes:
Spinner

public interface Spinner
extends NumberInputElement

An edit box for holding a constrained integer.

Default HtmlBasedComponent.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.2
    Author:
    gracelin

    Field Summary
     
    Fields inherited from interface org.zkoss.zk.ui.Component
    APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
     
    Method Summary
     int getStep()
              Return the step of spinner
     java.lang.Integer getValue()
              Returns the value (in Integer), might be null unless a constraint stops it.
     int intValue()
              Returns the value in int.
     boolean isButtonVisible()
              Returns whether the button (on the right of the textbox) is visible.
     void setButtonVisible(boolean visible)
              Sets whether the button (on the right of the textbox) is visible.
     void setStep(int step)
              Set the step of spinner
     void setValue(java.lang.Integer value)
              Sets the value (in Integer).
     
    Methods inherited from interface org.zkoss.zul.impl.api.NumberInputElement
    getRoundingMode, setRoundingMode, setRoundingMode
     
    Methods inherited from interface org.zkoss.zul.impl.api.FormatInputElement
    getFormat, setFormat
     
    Methods inherited from interface org.zkoss.zul.impl.api.InputElement
    clearErrorMessage, clearErrorMessage, getCols, getErrorMessage, getMaxlength, getName, getRawText, getRawValue, getTabindex, getText, getType, isDisabled, isMultiline, isReadonly, isValid, select, setCols, setConstraint, setDisabled, setMaxlength, setName, setRawValue, setReadonly, setSelectedText, setSelectionRange, setTabindex, setText
     
    Methods inherited from interface org.zkoss.zul.impl.api.XulElement
    getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
     
    Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
    focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
     
    Methods inherited from interface org.zkoss.zk.ui.Component
    addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
     
    Methods inherited from interface org.zkoss.zk.ui.ext.Scope
    addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
     
    Methods inherited from interface org.zkoss.zul.ext.Constrainted
    getConstraint, setConstraint
     

    Method Detail

    getValue

    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

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

    Throws:
    WrongValueException

    setValue

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

    Throws:
    WrongValueException - if value is wrong

    getStep

    int getStep()
    Return the step of spinner


    setStep

    void setStep(int step)
    Set the step of spinner


    isButtonVisible

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

    Default: true.


    setButtonVisible

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



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