We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.progressbar.
Class ProgressBar
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.progressbar.GeneratedVaadinProgressBar<ProgressBar>
-
- com.vaadin.flow.component.progressbar.ProgressBar
-
All Implemented Interfaces:
AttachNotifier,DetachNotifier,HasElement,HasSize,HasStyle,HasTheme,Serializable@NpmPackage(value="@vaadin/progress-bar",version="23.1.15") @NpmPackage(value="@vaadin/vaadin-progress-bar",version="23.1.15") public class ProgressBar extends GeneratedVaadinProgressBar<ProgressBar> implements HasSizeProgress 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:
-
-
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
mintomax, and an initial value ofmin.ProgressBar(double min, double max, double value)Constructs a new object with a scale of
mintomax, and an initial value ofvalue.
-
Method Summary
All Methods Modifier and Type Method Description doublegetMax()Gets the maximum bound of the progressbar.
doublegetMin()Gets the minimum bound of the progressbar.
doublegetValue()Gets the current value of the progressbar
booleanisIndeterminate()Get the indeterminate state of the progressbar
voidsetIndeterminate(boolean indeterminate)Description copied from corresponding location in WebComponent:
voidsetMax(double max)Sets the maximum bound of the progressbar.
voidsetMin(double min)Sets the minimum bound of the progressbar
voidsetValue(double value)Sets value to the progressbar.
-
Methods inherited from class com.vaadin.flow.component.progressbar.GeneratedVaadinProgressBar
addThemeVariants, getMaxDouble, getMinDouble, getValueDouble, isIndeterminateBoolean, removeThemeVariants
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, scrollIntoView, set, setElement, setId, setVisible
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
mintomax, and an initial value ofmin.minmust be less thanmax.Parameters:
min- the low end of the scale of progressmax- the high end of the scale of progressThrows:
IllegalArgumentException- ifminis not less thanmax
-
ProgressBar
public ProgressBar(double min, double max, double value)Constructs a new object with a scale of
mintomax, and an initial value ofvalue.minmust be less thanmax, andvaluemust be betweenminandmax(inclusive).Parameters:
min- the low end of the scale of progressmax- the high end of the scale of progressvalue- the initial valueThrows:
IllegalArgumentException- ifminis not less thanmax, orvalueis not betweenminandmax
-
-
Method Detail
-
setValue
public void setValue(double value)Sets value to the progressbar.
Overrides:
setValuein classGeneratedVaadinProgressBar<ProgressBar>Parameters:
value- the double value to set
-
getValue
public double getValue()Gets the current value of the progressbar
Returns:
the
valueproperty of the progressbar
-
setMax
public void setMax(double max)Sets the maximum bound of the progressbar.
Overrides:
setMaxin classGeneratedVaadinProgressBar<ProgressBar>Parameters:
max- the double value to set
-
getMax
public double getMax()Gets the maximum bound of the progressbar.
Returns:
the
maxproperty of the progressbar
-
setMin
public void setMin(double min)Sets the minimum bound of the progressbar
Overrides:
setMinin classGeneratedVaadinProgressBar<ProgressBar>Parameters:
min- the double value to set
-
getMin
public double getMin()Gets the minimum bound of the progressbar.
Returns:
the
minproperty of the progressbar
-
setIndeterminate
public void setIndeterminate(boolean indeterminate)Description copied from class:
GeneratedVaadinProgressBarDescription copied from corresponding location in WebComponent:
Indeterminate state of the progress bar. This property takes precedence over other state properties (min, max, value).
Overrides:
setIndeterminatein classGeneratedVaadinProgressBar<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
indeterminateproperty of the progressbar
-
-