Package org.zkoss.zkex.zul

Class Rangeslider

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
    public class Rangeslider
extends org.zkoss.zul.impl.XulElement
implements org.zkoss.zk.ui.ext.Disable
    A rangeslider. Like ZK Slider, but it supports a range value in slider.
    Since:
    9.0.0
    Author:
    jameschu
    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, org.zkoss.zk.ui.AbstractComponent.ForwardInfo, org.zkoss.zk.ui.AbstractComponent.TargetInfo

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ON_RANGE_VALUE_CHANGE  

      • 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_CLONED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

    • Constructor Summary

      Constructors 
      Constructor Description
      Rangeslider()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void beforeChildAdded​(org.zkoss.zk.ui.Component child, org.zkoss.zk.ui.Component refChild)  
      int getEndValue()
      Returns the end value of this rangeslider.
      java.util.Map<java.lang.Integer,​java.lang.String> getMarks()
      Returns marks information map of the rangeslider.
      int getMarkScale()
      Returns mark scale of the rangeslider.
      int getMax()
      Returns the maximum value of the rangeslider.
      int getMin()
      Returns the minimum value of the rangeslider.
      java.lang.String getOrient()
      Returns the orient.
      int getStartValue()
      Returns the start value of this rangeslider.
      int getStep()
      Returns the step of rangeslider.
      java.lang.String getZclass()
      The default zclass is "z-rangeslider"
      protected void handleOtherButtonsValues​(Sliderbuttons child)  
      protected void initSliderButtons()  
      boolean isDisabled()
      Returns whether it is disabled.
      boolean isTooltipVisible()
      Returns whether it is tooltipVisible.
      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 setDisabled​(boolean disabled)
      Sets whether it is disabled.
      void setEndValue​(int value)
      Sets the end value of this sliderbuttons.
      void setMarks​(java.util.Map<java.lang.Integer,​java.lang.String> marks)
      Sets the marks information map for displaying value marks.
      void setMarkScale​(int markScale)
      Sets the mark scale for displaying value marks.
      void setMax​(int max)
      Sets the maximum value of the rangeslider.
      void setMin​(int min)
      Sets the minimum value of the rangeslider.
      void setOrient​(java.lang.String orient)
      Default : "horizontal"
      void setStartValue​(int value)
      Sets the start value of this sliderbuttons.
      void setStep​(int step)
      Sets the step of rangeslider
      void setTooltipVisible​(boolean tooltipVisible)
      Sets whether it is tooltipVisible.

      • 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, 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, isChildable, 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, 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

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • ON_RANGE_VALUE_CHANGE

        public static final java.lang.String ON_RANGE_VALUE_CHANGE
        See Also:
        Constant Field Values

    • Constructor Detail

      • Rangeslider

        public Rangeslider()

    • Method Detail

      • initSliderButtons

        protected void initSliderButtons()

      • getMin

        public int getMin()
        Returns the minimum value of the rangeslider.

        Default: 0.

      • setMin

        public void setMin​(int min)
        Sets the minimum value of the rangeslider.
        Throws:
        org.zkoss.zk.ui.WrongValueException - if negative value is passed

      • getMax

        public int getMax()
        Returns the maximum value of the rangeslider.

        Default: 100.

      • setMax

        public void setMax​(int max)
        Sets the maximum value of the rangeslider.
        Throws:
        org.zkoss.zk.ui.WrongValueException - if negative value is passed

      • getStep

        public int getStep()
        Returns the step of rangeslider. When the user drags the slider buttons, the buttons would increase/decrease value by the step count.

        Default: 1

      • setStep

        public void setStep​(int step)
        Sets the step of rangeslider
        Parameters:
        step - the step of slider.
        Throws:
        org.zkoss.zk.ui.WrongValueException - if non-positive minimum is passed

      • getStartValue

        public int getStartValue()
        Returns the start value of this rangeslider.

        Default: 0.

      • setStartValue

        public void setStartValue​(int value)
        Sets the start value of this sliderbuttons.
        Parameters:
        value -

      • getEndValue

        public int getEndValue()
        Returns the end value of this rangeslider.

        Default: 0.

      • setEndValue

        public void setEndValue​(int value)
        Sets the end value of this sliderbuttons.
        Parameters:
        value -

      • getMarkScale

        public int getMarkScale()
        Returns mark scale of the rangeslider. Refer to setMarkScale(int) for more details.

      • setMarkScale

        public void setMarkScale​(int markScale)
        Sets the mark scale for displaying value marks.

        Default: 20. The value marks would be displayed every number value (ex. 20) start from the minimum value. (if min is 0, then display "0 20 40 ...")

        Notice that it's not allowed to use markScale and marks at the same time.

        Parameters:
        markScale - the value marks displaying scale

      • setMarks

        public void setMarks​(java.util.Map<java.lang.Integer,​java.lang.String> marks)
        Sets the marks information map for displaying value marks. In this map, the key represents the number value of slider, and the value represents the displayed scale text.

        Default: null.

        Parameters:
        marks - the value marks displaying information

      • isDisabled

        public boolean isDisabled()
        Returns whether it is disabled.

        Default: false.

        Specified by:
        isDisabled in interface org.zkoss.zk.ui.ext.Disable

      • setDisabled

        public void setDisabled​(boolean disabled)
        Sets whether it is disabled.
        Specified by:
        setDisabled in interface org.zkoss.zk.ui.ext.Disable
        Parameters:
        disabled -

      • getOrient

        public java.lang.String getOrient()
        Returns the orient.

        Default: "horizontal".

      • setOrient

        public void setOrient​(java.lang.String orient)
               throws org.zkoss.zk.ui.WrongValueException

        Default : "horizontal"

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

      • setTooltipVisible

        public void setTooltipVisible​(boolean tooltipVisible)
        Sets whether it is tooltipVisible. If true, the tooltips of the slider buttons would be always visible.
        Parameters:
        tooltipVisible -

      • isTooltipVisible

        public boolean isTooltipVisible()
        Returns whether it is tooltipVisible. If true, the tooltips of the slider buttons would be always visible.

        Default: false.

      • beforeChildAdded

        public void beforeChildAdded​(org.zkoss.zk.ui.Component child,
                             org.zkoss.zk.ui.Component refChild)
        Specified by:
        beforeChildAdded in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        beforeChildAdded in class org.zkoss.zk.ui.AbstractComponent

      • renderProperties

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

      • service

        public void service​(org.zkoss.zk.au.AuRequest request,
                    boolean everError)
        Processes an AU request.
        Specified by:
        service in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        service in class org.zkoss.zk.ui.HtmlBasedComponent

      • handleOtherButtonsValues

        protected void handleOtherButtonsValues​(Sliderbuttons child)

      • getZclass

        public java.lang.String getZclass()
        The default zclass is "z-rangeslider"
        Overrides:
        getZclass in class org.zkoss.zk.ui.HtmlBasedComponent