Class Slider
- java.lang.Object
-
- org.zkoss.zk.ui.AbstractComponent
-
- org.zkoss.zk.ui.HtmlBasedComponent
-
- org.zkoss.zul.impl.XulElement
-
- org.zkoss.zul.Slider
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,org.zkoss.zk.ui.Component,org.zkoss.zk.ui.ext.Scope,org.zkoss.zk.ui.sys.ComponentCtrl
public class Slider extends XulElement
A slider.Default
getZclass(): z-slider.- Author:
- tomyeh
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringDECIMALRepresent decimal slider.static java.lang.StringINTEGERRepresent integer slider.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description doublegetAngleArc()Returns the degree of arc of the knob slider.intgetCurpos()Returns the current position of the slider.doublegetCurposInDouble()Returns the double value of slider's current position.intgetMaxpos()Returns the maximum position of the slider.doublegetMaxposInDouble()Returns the double value of slider's maximum position.intgetMinpos()Returns the minimum position of the slider.doublegetMinposInDouble()Returns the double value of slider's minimum position.java.lang.StringgetName()Returns the name of this component.java.lang.StringgetOrient()Returns the orient.intgetPageIncrement()Returns the amount that the value ofgetCurpos()changes by when the tray of the scroll bar is clicked.doublegetPageIncrementInDouble()Returns the amount that the value ofgetCurpos()changes by when the tray of the scroll bar is clicked.doublegetScaleInput()Returns the scale ratio of the input in knob mold.java.lang.StringgetSlidingtext()Returns the sliding text.intgetStep()Returns the step of sliderdoublegetStepInDouble()Returns the step of sliderdoublegetStrokeWidth()Returns the stroke width of the knob slider.java.lang.StringgetZclass()protected booleanisChildable()Not childable.booleanisDecimal()Returns whether it is a decimal slider.booleanisVertical()Returns whether it is a vertical slider.protected voidrenderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)voidservice(org.zkoss.zk.au.AuRequest request, boolean everError)Processes an AU request.voidsetAngleArc(double angleArc)Sets the degree of arc for the knob slider.voidsetCurpos(double curpos)Sets the current position of the slider.voidsetCurpos(int curpos)Sets the current position of the slider.voidsetMaxpos(double maxpos)Sets the maximum position of the slider.voidsetMaxpos(int maxpos)Sets the maximum position of the slider.voidsetMinpos(double minpos)Sets the minimum position of the slider.voidsetMinpos(int minpos)Sets the minimum position of the slider.voidsetMode(java.lang.String mode)Sets the mode.voidsetMold(java.lang.String mold)Sets the mold.voidsetName(java.lang.String name)Sets the name of this component.voidsetOrient(java.lang.String orient)Sets the orient.voidsetPageIncrement(double pginc)Sets the amount that the value ofgetCurpos()changes by when the tray of the scroll bar is clicked.voidsetPageIncrement(int pginc)Sets the amount that the value ofgetCurpos()changes by when the tray of the scroll bar is clicked.voidsetRange(double minpos, double maxpos)Sets the range of slider.voidsetRange(int minpos, int maxpos)Sets the range of slider.voidsetScaleInput(double scaleInput)Sets the scale ratio of the input in knob mold.voidsetSlidingtext(java.lang.String slidingtext)Sets the sliding text.voidsetStep(double step)Sets the step of slidervoidsetStep(int step)Sets the step of slidervoidsetStrokeWidth(double strokeWidth)Sets the stroke width of the knob slider.-
Methods inherited from class org.zkoss.zul.impl.XulElement
clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, 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, onWrongValue, 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, 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
-
-
-
-
Field Detail
-
INTEGER
public static final java.lang.String INTEGER
Represent integer slider.- Since:
- 7.0.1
- See Also:
- Constant Field Values
-
DECIMAL
public static final java.lang.String DECIMAL
Represent decimal slider.- Since:
- 7.0.1
- See Also:
- Constant Field Values
-
-
Method Detail
-
getZclass
public java.lang.String getZclass()
- Overrides:
getZclassin classorg.zkoss.zk.ui.HtmlBasedComponent
-
getOrient
public java.lang.String getOrient()
Returns the orient.Default: "horizontal".
-
setOrient
public void setOrient(java.lang.String orient) throws org.zkoss.zk.ui.WrongValueExceptionSets the orient.Default : "horizontal"
- Parameters:
orient- either "horizontal" or "vertical".- Throws:
org.zkoss.zk.ui.WrongValueException- Since:
- 3.5.0
-
getSlidingtext
public java.lang.String getSlidingtext()
Returns the sliding text.Default : "{0}"
- Since:
- 3.0.1
-
setSlidingtext
public void setSlidingtext(java.lang.String slidingtext)
Sets the sliding text. The syntax "{0}" will be replaced with the position at client side.- Since:
- 3.0.1
-
getCurpos
public int getCurpos()
Returns the current position of the slider.Default: 0.
-
getCurposInDouble
public double getCurposInDouble()
Returns the double value of slider's current position.Default: 0.
- Since:
- 7.0.1
-
setCurpos
public void setCurpos(int curpos)
Sets the current position of the slider. If negative, 0 is assumed. If larger thangetMaxpos(),getMaxpos()is assumed.
-
setCurpos
public void setCurpos(double curpos) throws org.zkoss.zk.ui.WrongValueExceptionSets the current position of the slider. If negative, 0 is assumed. If larger thangetMaxpos(),getMaxpos()is assumed.- Throws:
org.zkoss.zk.ui.WrongValueException- Since:
- 7.0.1
-
getMinpos
public int getMinpos()
Returns the minimum position of the slider.Default: 0.
-
getMinposInDouble
public double getMinposInDouble()
Returns the double value of slider's minimum position.Default: 0.
- Since:
- 7.0.1
-
setMinpos
public void setMinpos(int minpos)
Sets the minimum position of the slider.- Throws:
org.zkoss.zk.ui.WrongValueException- if non-positive minimum is passed
-
setMinpos
public void setMinpos(double minpos) throws org.zkoss.zk.ui.WrongValueExceptionSets the minimum position of the slider.- Throws:
org.zkoss.zk.ui.WrongValueException- if non-positive minimum is passed- Since:
- 7.0.1
-
getMaxpos
public int getMaxpos()
Returns the maximum position of the slider.Default: 100.
-
getMaxposInDouble
public double getMaxposInDouble()
Returns the double value of slider's maximum position.Default: 100.
- Since:
- 7.0.1
-
setMaxpos
public void setMaxpos(int maxpos)
Sets the maximum position of the slider.- Throws:
org.zkoss.zk.ui.WrongValueException- if non-positive maxpos is passed
-
setMaxpos
public void setMaxpos(double maxpos) throws org.zkoss.zk.ui.WrongValueExceptionSets the maximum position of the slider.- Throws:
org.zkoss.zk.ui.WrongValueException- if non-positive maxpos is passed- Since:
- 7.0.1
-
isVertical
public boolean isVertical()
Returns whether it is a vertical slider.- Since:
- 3.5.0
-
getPageIncrement
public int getPageIncrement()
Returns the amount that the value ofgetCurpos()changes by when the tray of the scroll bar is clicked.Default: -1 (means it will scroll to the position the user clicks).
-
getPageIncrementInDouble
public double getPageIncrementInDouble()
Returns the amount that the value ofgetCurpos()changes by when the tray of the scroll bar is clicked.Default: -1 (means it will scroll to the position the user clicks).
- Since:
- 7.0.1
-
setPageIncrement
public void setPageIncrement(int pginc)
Sets the amount that the value ofgetCurpos()changes by when the tray of the scroll bar is clicked.Default: -1 (means it will scroll to the position the user clicks).
- Parameters:
pginc- the page increment. If negative, slider will scroll to the position that user clicks.
-
setPageIncrement
public void setPageIncrement(double pginc) throws org.zkoss.zk.ui.WrongValueExceptionSets the amount that the value ofgetCurpos()changes by when the tray of the scroll bar is clicked.Default: -1 (means it will scroll to the position the user clicks).
- Parameters:
pginc- the page increment. If negative, slider will scroll to the position that user clicks.- Throws:
org.zkoss.zk.ui.WrongValueException- Since:
- 7.0.1
-
getStep
public int getStep()
Returns the step of sliderDefault: -1 (means it will scroll to the position the user clicks). Note: In "decimal" mode, the fraction part only contains one digit if step is -1.
- Since:
- 7.0.1
-
getStepInDouble
public double getStepInDouble()
Returns the step of sliderDefault: -1 (means it will scroll to the position the user clicks). Note: In "decimal" mode, the fraction part only contains one digit if step is -1.
- Since:
- 7.0.1
-
setStep
public void setStep(int step)
Sets the step of slider- Parameters:
step- the step of slider. If negative, slider will not step.- Since:
- 7.0.1
-
setStep
public void setStep(double step) throws org.zkoss.zk.ui.WrongValueExceptionSets the step of slider- Parameters:
step- the step of slider. If negative, slider will not step.- Throws:
org.zkoss.zk.ui.WrongValueException- Since:
- 7.0.1
-
getName
public java.lang.String getName()
Returns the name of this component.Default: null.
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.
Don't use this method if your application is purely based on ZK's event-driven model.
- Since:
- 3.0.0
-
setName
public void setName(java.lang.String name)
Sets the name of this component.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.
Don't use this method if your application is purely based on ZK's event-driven model.
- Parameters:
name- the name of this component.- Since:
- 3.0.0
-
setMold
public void setMold(java.lang.String mold)
Sets the mold.- Specified by:
setMoldin interfaceorg.zkoss.zk.ui.Component- Overrides:
setMoldin classorg.zkoss.zk.ui.AbstractComponent- Parameters:
mold- default , scale
-
setMode
public void setMode(java.lang.String mode)
Sets the mode.Default : "integer" Note: Knob mold does not support this method, please use
setStep(double)instead.- Parameters:
mode- either "integer" or "decimal".- Since:
- 7.0.1
-
isDecimal
public boolean isDecimal()
Returns whether it is a decimal slider.- Since:
- 7.0.1
-
setRange
public void setRange(int minpos, int maxpos)Sets the range of slider.- Parameters:
minpos- the minimum position of the slider.maxpos- the maximum position of the slider.- Since:
- 7.0.1
-
setRange
public void setRange(double minpos, double maxpos)Sets the range of slider.- Parameters:
minpos- the minimum position of the slider.maxpos- the maximum position of the slider.- Since:
- 7.0.1
-
setAngleArc
public void setAngleArc(double angleArc)
Sets the degree of arc for the knob slider.Default : 360.0
- Parameters:
angleArc- is the degree of arc of the knob slider. The unit is degrees (360° for a circle).- Since:
- 8.6.0
-
getAngleArc
public double getAngleArc()
Returns the degree of arc of the knob slider.Default: 360.0
- Returns:
- double
- Since:
- 8.6.0
-
setStrokeWidth
public void setStrokeWidth(double strokeWidth)
Sets the stroke width of the knob slider.Default: 10.0
- Parameters:
strokeWidth- is the stroke width for the knob slider- Since:
- 8.6.0
-
getStrokeWidth
public double getStrokeWidth()
Returns the stroke width of the knob slider.Default: 10.0
- Returns:
- double
- Since:
- 8.6.0
-
setScaleInput
public void setScaleInput(double scaleInput)
Sets the scale ratio of the input in knob mold. e.g.: 1.5 This will enlarge or narrow the whole input the scale ratio. Default: 1.0- Parameters:
scaleInput- is a number in double that scales the input size.- Since:
- 8.6.0
-
getScaleInput
public double getScaleInput()
Returns the scale ratio of the input in knob mold.- Returns:
- double
- Since:
- 8.6.0
-
isChildable
protected boolean isChildable()
Not childable.- Overrides:
isChildablein classorg.zkoss.zk.ui.AbstractComponent
-
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 onOpen.- Specified by:
servicein interfaceorg.zkoss.zk.ui.sys.ComponentCtrl- Overrides:
servicein classorg.zkoss.zk.ui.HtmlBasedComponent- Since:
- 5.0.0
-
renderProperties
protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) throws java.io.IOException- Overrides:
renderPropertiesin classXulElement- Throws:
java.io.IOException
-
-