org.zkoss.zul
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, Component, Scope, ComponentCtrl

public class Slider
extends XulElement

A slider.

Default getZclass() as follows: (since 3.5.0)

1. Case 1: If getOrient() is vertical, "z-slider-ver" is assumed
2. Case 2: If getOrient() is horizontal, "z-slider-hor" is assumed

Author:

tomyeh

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.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.
int	getMaxpos() Returns the maximum position of the slider.
java.lang.String	getName() Returns the name of this component.
java.lang.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.
java.lang.String	getSlidingtext() Returns the sliding text.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
protected boolean	isChildable() Not childable.
boolean	isVertical() Returns whether it is a vertical slider.
protected void	renderProperties(ContentRenderer renderer) Renders the content of this component, excluding the enclosing tags and children.
void	service(AuRequest request, boolean everError) Processes an AU request.
void	setCurpos(int curpos) Sets the current position of the slider.
void	setMaxpos(int maxpos) Sets the maximum position of the slider.
void	setMold(java.lang.String mold) Sets the mold.
void	setName(java.lang.String name) Sets the name of this component.
void	setOrient(java.lang.String orient) Sets the orient.
void	setPageIncrement(int pginc) Sets the amount that the value of getCurpos() changes by when the tray of the scroll bar is clicked.
void	setSlidingtext(java.lang.String slidingtext) Sets the sliding text.

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, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, 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, 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, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, 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

Slider

public Slider()

Slider

public Slider(int curpos)

Parameters:

curpos - the current position (default: 0)

Method Detail

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()

getOrient

public java.lang.String getOrient()

Returns the orient.

Default: "horizontal".

setOrient

public void setOrient(java.lang.String orient)
               throws WrongValueException

Sets the orient.

Default : "horizontal"

Parameters:

orient - either "horizontal" or "vertical".

Throws:

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.

setCurpos

public void setCurpos(int curpos)
               throws WrongValueException

Sets the current position of the slider. If negative, 0 is assumed. If larger than getMaxpos(), getMaxpos() is assumed.

Throws:

WrongValueException

getMaxpos

public int getMaxpos()

Returns the maximum position of the slider.

Default: 100.

setMaxpos

public void setMaxpos(int maxpos)
               throws WrongValueException

Sets the maximum position of the slider.

Throws:

WrongValueException - if non-positive maxpos is passed

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).

setPageIncrement

public void setPageIncrement(int pginc)
                      throws 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:

WrongValueException

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:

setMold in interface Component

Overrides:

setMold in class AbstractComponent

Parameters:

mold - default , scale

See Also:

ComponentDefinition

isChildable

protected boolean isChildable()

Not childable.

Overrides:

isChildable in class AbstractComponent

service

public void service(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 ComponentCtrl

Overrides:

service in class HtmlBasedComponent

everError - whether any error ever occured before processing this request.

Since:

5.0.0

See Also:

AbstractComponent.setAuService(org.zkoss.zk.au.AuService)

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 XulElement

Throws:

java.io.IOException