Package com.vaadin.flow.component.progressbar

Class ProgressBar

  • All Implemented Interfaces:
    com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, Serializable
    @NpmPackage(value="@vaadin/progress-bar",version="23.3.27") @NpmPackage(value="@vaadin/vaadin-progress-bar",version="23.3.27")
public class ProgressBar
extends GeneratedVaadinProgressBar<ProgressBar>
implements com.vaadin.flow.component.HasSize
    Progress Bar shows the completion status of a task or process. The progress can be determinate or indeterminate. Use Progress Bar to show an ongoing process that takes a noticeable time to finish.
    Author:
    Vaadin Ltd.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      ProgressBar()
      Constructs a new object with a scale of 0 to 1, and an initial value of 0.
      ProgressBar​(double min, double max)
      Constructs a new object with a scale of min to max, and an initial value of min.
      ProgressBar​(double min, double max, double value)
      Constructs a new object with a scale of min to max, and an initial value of value.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addThemeVariants​(ProgressBarVariant... variants)
      Adds theme variants to the component.
      double getMax()
      Gets the maximum bound of the progressbar.
      double getMin()
      Gets the minimum bound of the progressbar.
      double getValue()
      Gets the current value of the progressbar
      boolean isIndeterminate()
      Get the indeterminate state of the progressbar
      void removeThemeVariants​(ProgressBarVariant... variants)
      Removes theme variants from the component.
      void setIndeterminate​(boolean indeterminate)
      Description copied from corresponding location in WebComponent:
      void setMax​(double max)
      Sets the maximum bound of the progressbar.
      void setMin​(double min)
      Sets the minimum bound of the progressbar
      void setValue​(double value)
      Sets value to the progressbar.

      • Methods inherited from class com.vaadin.flow.component.Component

        addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, setVisible

      • Methods inherited from interface com.vaadin.flow.component.AttachNotifier

        addAttachListener

      • Methods inherited from interface com.vaadin.flow.component.DetachNotifier

        addDetachListener

      • Methods inherited from interface com.vaadin.flow.component.HasElement

        getElement

      • Methods inherited from interface com.vaadin.flow.component.HasSize

        getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

      • Methods inherited from interface com.vaadin.flow.component.HasStyle

        addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

      • Methods inherited from interface com.vaadin.flow.component.HasTheme

        addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

    • Constructor Detail

      • ProgressBar

        public ProgressBar()
        Constructs a new object with a scale of 0 to 1, and an initial value of 0.

      • ProgressBar

        public ProgressBar​(double min,
                   double max)
        Constructs a new object with a scale of min to max, and an initial value of min.

        min must be less than max.

        Parameters:
        min - the low end of the scale of progress
        max - the high end of the scale of progress
        Throws:
        IllegalArgumentException - if min is not less than max

      • ProgressBar

        public ProgressBar​(double min,
                   double max,
                   double value)
        Constructs a new object with a scale of min to max, and an initial value of value.

        min must be less than max, and value must be between min and max (inclusive).

        Parameters:
        min - the low end of the scale of progress
        max - the high end of the scale of progress
        value - the initial value
        Throws:
        IllegalArgumentException - if min is not less than max, or value is not between min and max

    • Method Detail

      • getValue

        public double getValue()
        Gets the current value of the progressbar
        Returns:
        the value property of the progressbar

      • getMax

        public double getMax()
        Gets the maximum bound of the progressbar.
        Returns:
        the max property of the progressbar

      • getMin

        public double getMin()
        Gets the minimum bound of the progressbar.
        Returns:
        the min property of the progressbar

      • setIndeterminate

        public void setIndeterminate​(boolean indeterminate)
        Description copied from class: GeneratedVaadinProgressBar

        Description copied from corresponding location in WebComponent:

        Indeterminate state of the progress bar. This property takes precedence over other state properties (min, max, value).

        Overrides:
        setIndeterminate in class GeneratedVaadinProgressBar<ProgressBar>
        Parameters:
        indeterminate - the boolean value to set

      • isIndeterminate

        public boolean isIndeterminate()
        Get the indeterminate state of the progressbar

        This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

        Returns:
        the indeterminate property of the progressbar