Class Spinner
- java.lang.Object
-
- 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, AbstractComponent.ForwardInfo, 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_PAGE_ATTACHED, AFTER_PAGE_DETACHED, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.Object
coerceFromString(java.lang.String value)
Coerces the value passed toInputElement.setText(java.lang.String)
.protected java.lang.String
coerceToString(java.lang.Object value)
Coerces the value passed toInputElement.setText(java.lang.String)
.int
getStep()
Returns the step of spinnerprotected 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 for this component.int
intValue()
Returns the value in integer.boolean
isButtonVisible()
Returns whether the button (on the right of the spinner) 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 spinner) is visible.void
setConstraint(java.lang.String constr)
void
setStep(int step)
Sets the step of spinnervoid
setValue(java.lang.Integer value)
Sets the value (in Integer).-
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, unmarshall, 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, 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, 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
-
-
-
-
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 integer. If null, zero is returned.- Throws:
WrongValueException
- if user entered a wrong value
-
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 classInputElement
- 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()
Returns the step of spinner
-
setStep
public void setStep(int step)
Sets the step of spinner
-
isButtonVisible
public boolean isButtonVisible()
Returns whether the button (on the right of the spinner) is visible.Default: true.
-
setButtonVisible
public void setButtonVisible(boolean visible)
Sets whether the button (on the right of the spinner) is visible.
-
getZclass
public java.lang.String getZclass()
Description copied from class:HtmlBasedComponent
Returns the ZK Cascading Style class for this component. It usually depends on the implementation of the mold (AbstractComponent.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 ofHtmlBasedComponent.getZclass()
. Once it is changed, the default style won't be applied at all. If you want to perform small adjustments, useHtmlBasedComponent.setSclass(java.lang.String)
instead.- Overrides:
getZclass
in classHtmlBasedComponent
- See Also:
HtmlBasedComponent.getSclass()
-
setConstraint
public void setConstraint(java.lang.String constr)
- Overrides:
setConstraint
in classInputElement
- 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 toInputElement.setText(java.lang.String)
.Deriving note:
If you want to store the value in other type, say BigDecimal, you have to overrideInputElement.coerceToString(java.lang.Object)
andInputElement.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 classInputElement
- Throws:
WrongValueException
-
coerceToString
protected java.lang.String coerceToString(java.lang.Object value)
Description copied from class:InputElement
Coerces the value passed toInputElement.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 overrideInputElement.coerceToString(java.lang.Object)
andInputElement.coerceFromString(java.lang.String)
to convert between a string and your targeting type.- Specified by:
coerceToString
in classInputElement
-
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.- Overrides:
renderProperties
in classNumberInputElement
- Throws:
java.io.IOException
-
-