Package org.zkoss.zul

Class Slider

    • 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
    • Constructor Detail

      • Slider

        public Slider()
      • Slider

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

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

      • 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.
      • 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:
        WrongValueException - if non-positive minimum is passed
      • setMinpos

        public void setMinpos​(double minpos)
                       throws WrongValueException
        Sets the minimum position of the slider.
        Throws:
        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:
        WrongValueException - if non-positive maxpos is passed
      • setMaxpos

        public void setMaxpos​(double maxpos)
                       throws WrongValueException
        Sets the maximum position of the slider.
        Throws:
        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 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
        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 WrongValueException
        Sets the step of slider
        Parameters:
        step - the step of slider. If negative, slider will not step.
        Throws:
        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
      • 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