Package com.vaadin.ui

Class Slider

    • Constructor Detail

      • Slider

        public Slider()
        Default slider constructor.

        The range of the slider is set to 0-100 and only integer values are allowed.

      • Slider

        public Slider​(String caption)
        Create a new slider with the caption given as parameter.

        The range of the slider is set to 0-100 and only integer values are allowed.

        Parameters:
        caption - the caption for this slider (e.g. "Volume")

      • Slider

        public Slider​(double min,
              double max,
              int resolution)
        Create a new slider with the given range and resolution.
        Parameters:
        min - The minimum value of the slider
        max - The maximum value of the slider
        resolution - The number of digits after the decimal point.

      • Slider

        public Slider​(int min,
              int max)
        Create a new slider with the given range of integers.
        Parameters:
        min - the minimum value of the slider
        max - the maximum value of the slider

      • Slider

        public Slider​(String caption,
              int min,
              int max)
        Creates a new slider with the given caption and integer range.
        Parameters:
        caption - the caption for the slider
        min - the minimum value of the slider
        max - the maximum value of the slider

    • Method Detail

      • getState

        public SliderState getState()
        Description copied from class: AbstractComponent
        Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().
        Overrides:
        getState in class AbstractField<Double>
        Returns:
        updated component shared state

      • getMax

        public double getMax()
        Gets the maximum slider value. The default value is 100.0.
        Returns:
        the largest value the slider can have

      • setMax

        public void setMax​(double max)
        Sets the maximum slider value. If the current value of the slider is larger than this, the value is set to the new maximum.
        Parameters:
        max - The new maximum slider value

      • getMin

        public double getMin()
        Gets the minimum slider value. The default value is 0.0.
        Returns:
        the smallest value the slider can have

      • setMin

        public void setMin​(double min)
        Sets the minimum slider value. If the current value of the slider is smaller than this, the value is set to the new minimum.
        Parameters:
        min - The new minimum slider value

      • getResolution

        public int getResolution()
        Gets the resolution of the slider. The resolution is the number of digits after the decimal point. The default resolution is 0 (only integers allowed).
        Returns:
        resolution the number of digits after the decimal point

      • setResolution

        public void setResolution​(int resolution)
        Set a new resolution for the slider. The resolution is the number of digits after the decimal point.
        Parameters:
        resolution - the number of digits after the decimal point
        Throws:
        IllegalArgumentException - if resolution is negative.

      • setUpdateValueOnClick

        public void setUpdateValueOnClick​(boolean updateValueOnClick)
        Sets the slider to update its value when the user clicks on it. By default, the slider value is updated by dragging the slider's handle or clicking arrows.
        Parameters:
        updateValueOnClick - true to update the value of the slider on click, false otherwise.
        Since:
        8.8

      • isUpdateValueOnClick

        public boolean isUpdateValueOnClick()
        Returns whether the slider updates its value on user click.
        Returns:
        true if the Slider updates its value on click. By default, returns false
        Since:
        8.8

      • doSetValue

        protected void doSetValue​(Double newValue)
        Description copied from class: AbstractField
        Sets the value of this field. May do sanitization or throw IllegalArgumentException if the value is invalid. Typically saves the value to shared state.
        Specified by:
        doSetValue in class AbstractField<Double>
        Parameters:
        newValue - the new value of the field

      • getValue

        public Double getValue()
        Description copied from interface: HasValue
        Returns the current value of this object.

        Implementation note: the implementing class should document whether null values may be returned or not.

        Returns:
        the current value

      • getEmptyValue

        public Double getEmptyValue()
        Description copied from interface: HasValue
        Returns the value that represents an empty value.

        By default HasValue is expected to support null as empty values. Specific implementations might not support this.

        Returns:
        empty value
        See Also:
        Binder#bind(HasValue, ValueProvider, Setter)

      • readDesign

        public void readDesign​(org.jsoup.nodes.Element design,
                       DesignContext context)
        Description copied from interface: Component
        Reads the component state from the given design.

        The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.

        It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.

        This method must not modify the design.

        Specified by:
        readDesign in interface Component
        Overrides:
        readDesign in class AbstractField<Double>
        Parameters:
        design - The element to obtain the state from
        context - The DesignContext instance used for parsing the design

      • writeDesign

        public void writeDesign​(org.jsoup.nodes.Element design,
                        DesignContext context)
        Description copied from interface: Component
        Writes the component state to the given design.

        The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.

        This method must not modify the component state.

        Specified by:
        writeDesign in interface Component
        Overrides:
        writeDesign in class AbstractField<Double>
        Parameters:
        design - The element to write the component state to. Any previous attributes or child nodes are not cleared.
        context - The DesignContext instance used for writing the design