Package com.vaadin.ui

Class Slider

    • Constructor Detail

      • Slider

        public Slider()
        Default slider constructor. Sets all values to defaults and the slide handle at minimum value.

      • 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 that only allows integer values.
        Parameters:
        min - The minimum value of the slider
        max - The maximum value of the slider

      • Slider

        public Slider​(String caption,
              int min,
              int max)
        Create a new slider with the given caption and range that only allows integer values.
        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
        Returns:
        the largest value the slider can have

      • setMax

        public void setMax​(double max)
        Set 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
        Returns:
        the smallest value the slider can have

      • setMin

        public void setMin​(double min)
        Set 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()
        Get the current resolution of the slider. The resolution is the number of digits after the decimal point.
        Returns:
        resolution

      • 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 -
        Throws:
        IllegalArgumentException - if resolution is negative.

      • setValue

        protected void setValue​(Double value,
                        boolean repaintIsNotNeeded)
        Sets the value of the slider.
        Overrides:
        setValue in class AbstractField<Double>
        Parameters:
        value - The new value of the slider.
        repaintIsNotNeeded - If true, client-side is not requested to repaint itself.
        Throws:
        Slider.ValueOutOfBoundsException - If the given value is not inside the range of the slider.
        See Also:
        setMin(double)

      • setInternalValue

        protected void setInternalValue​(Double newValue)
        Description copied from class: AbstractField
        Sets the internal field value. This is purely used by AbstractField to change the internal Field value. It does not trigger valuechange events. It can be overridden by the inheriting classes to update all dependent variables. Subclasses can also override AbstractField.getInternalValue() if necessary.
        Overrides:
        setInternalValue in class AbstractField<Double>
        Parameters:
        newValue - the new value to be set.

      • getType

        public Class<Double> getType()
        Description copied from class: AbstractField
        Returns the type of the Field. The methods getValue and setValue must be compatible with this type: one must be able to safely cast the value returned from getValue to the given type and pass any variable assignable to this type as an argument to setValue.
        Specified by:
        getType in interface Property<Double>
        Specified by:
        getType in class AbstractField<Double>
        Returns:
        the type of the Field

      • clear

        public void clear()
        Description copied from interface: Field
        Clears the value of the field.

        The field value is typically reset to the initial value of the field. Calling Field.isEmpty() on a cleared field must always returns true.

        Specified by:
        clear in interface Field<Double>
        Overrides:
        clear in class AbstractField<Double>

      • isEmpty

        public boolean isEmpty()
        Description copied from interface: Field
        Is the field empty? In general, "empty" state is same as null. As an exception, TextField also treats empty string as "empty".
        Specified by:
        isEmpty in interface Field<Double>
        Overrides:
        isEmpty in class AbstractField<Double>
        Returns:
        true if the field is empty, false otherwise

      • 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