org.zkoss.zul
Class Slider

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.Slider
All Implemented Interfaces:
Serializable, 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

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
 
Field Summary
static String DECIMAL
          Represent decimal slider.
static String INTEGER
          Represent integer slider.
 
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
Slider()
           
Slider(int curpos)
           
 
Method Summary
 int getCurpos()
          Returns the current position of the slider.
 double getCurposInDouble()
          Returns the double value of slider's current position.
 int getMaxpos()
          Returns the maximum position of the slider.
 double getMaxposInDouble()
          Returns the double value of slider's maximum position.
 int getMinpos()
          Returns the minimum position of the slider.
 double getMinposInDouble()
          Returns the double value of slider's minimum position.
 String getName()
          Returns the name of this component.
 String getOrient()
          Returns the orient.
 int getPageIncrement()
          Returns the amount that the value of getCurpos() changes by when the tray of the scroll bar is clicked.
 double getPageIncrementInDouble()
          Returns the amount that the value of getCurpos() changes by when the tray of the scroll bar is clicked.
 String getSlidingtext()
          Returns the sliding text.
 int getStep()
          Returns the step of slider Default: -1 (means it will scroll to the position the user clicks).
 double getStepInDouble()
          Returns the step of slider Default: -1 (means it will scroll to the position the user clicks).
 String getZclass()
           
protected  boolean isChildable()
          Not childable.
 boolean isDecimal()
          Returns whether it is a decimal slider.
 boolean isVertical()
          Returns whether it is a vertical slider.
protected  void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
           
 void service(org.zkoss.zk.au.AuRequest request, boolean everError)
          Processes an AU request.
 void setCurpos(double curpos)
          Sets the current position of the slider.
 void setCurpos(int curpos)
          Sets the current position of the slider.
 void setMaxpos(double maxpos)
          Sets the maximum position of the slider.
 void setMaxpos(int maxpos)
          Sets the maximum position of the slider.
 void setMinpos(double minpos)
          Sets the minimum position of the slider.
 void setMinpos(int minpos)
          Sets the minimum position of the slider.
 void setMode(String mode)
          Sets the mode.
 void setMold(String mold)
          Sets the mold.
 void setName(String name)
          Sets the name of this component.
 void setOrient(String orient)
          Sets the orient.
 void setPageIncrement(double pginc)
          Sets the amount that the value of getCurpos() changes by when the tray of the scroll bar is clicked.
 void setPageIncrement(int pginc)
          Sets the amount that the value of getCurpos() changes by when the tray of the scroll bar is clicked.
 void setRange(double minpos, double maxpos)
          Sets the range of slider.
 void setRange(int minpos, int maxpos)
          Sets the range of slider.
 void setSlidingtext(String slidingtext)
          Sets the sliding text.
 void setStep(double step)
          Sets the step of slider
 void setStep(int step)
          Sets the step of slider
 
Methods inherited from class org.zkoss.zul.impl.XulElement
clone, 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, 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, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, 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
 

Field Detail

INTEGER

public static final String INTEGER
Represent integer slider.

Since:
7.0.1
See Also:
Constant Field Values

DECIMAL

public static final String DECIMAL
Represent decimal slider.

Since:
7.0.1
See Also:
Constant Field Values
Constructor Detail

Slider

public Slider()

Slider

public Slider(int curpos)
Parameters:
curpos - the current position (default: 0)
Method Detail

getZclass

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

getOrient

public String getOrient()
Returns the orient.

Default: "horizontal".


setOrient

public void setOrient(String orient)
               throws org.zkoss.zk.ui.WrongValueException
Sets the orient.

Default : "horizontal"

Parameters:
orient - either "horizontal" or "vertical".
Throws:
org.zkoss.zk.ui.WrongValueException
Since:
3.5.0

getSlidingtext

public String getSlidingtext()
Returns the sliding text.

Default : "{0}"

Since:
3.0.1

setSlidingtext

public void setSlidingtext(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 than getMaxpos(), getMaxpos() is assumed.


setCurpos

public void setCurpos(double curpos)
               throws org.zkoss.zk.ui.WrongValueException
Sets the current position of the slider. If negative, 0 is assumed. If larger than getMaxpos(), 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.WrongValueException
Sets 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.WrongValueException
Sets 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 of getCurpos() 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 of getCurpos() 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 of getCurpos() 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.WrongValueException
Sets the amount that the value of getCurpos() 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 slider

Default: -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 slider

Default: -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.WrongValueException
Sets 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 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(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(String mold)
Sets the mold.

Specified by:
setMold in interface org.zkoss.zk.ui.Component
Overrides:
setMold in class org.zkoss.zk.ui.AbstractComponent
Parameters:
mold - default , scale

setMode

public void setMode(String mode)
Sets the mode.

Default : "integer"

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

isChildable

protected boolean isChildable()
Not childable.

Overrides:
isChildable in class org.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:
service in interface org.zkoss.zk.ui.sys.ComponentCtrl
Overrides:
service in class org.zkoss.zk.ui.HtmlBasedComponent
Since:
5.0.0

renderProperties

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


Copyright © 2014. All rights reserved.