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.ProgressBar
All Implemented Interfaces:
AttachNotifier, DetachNotifier, HasElement, HasSize, HasStyle, HasTheme, HasThemeVariant<ProgressBarVariant>, Serializable
@Tag("vaadin-progress-bar")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.7.0-alpha7") @NpmPackage(value="@vaadin/progress-bar",version="24.7.0-alpha7")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/progress-bar/src/vaadin-progress-bar.js")
public class ProgressBar
extends Component
implements HasSize, HasStyle, HasThemeVariant<ProgressBarVariant>
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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs 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
Modifier and TypeMethodDescriptiondoublegetMax()Gets the maximum bound of the progressbar.
doublegetMin()Gets the minimum bound of the progressbar.
doublegetValue()Gets the current value of the progressbar
booleanGet the indeterminate state of the progressbar
voidsetIndeterminate(boolean indeterminate) Indeterminate state of the progressbar.
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.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, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods 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, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNameMethods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeNameMethods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant
addThemeVariants, removeThemeVariants
-
Constructor Details
-
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 Details
-
setValue
public void setValue(double value) Sets value to the 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.
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
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) Indeterminate state of the progressbar. This property takes precedence over other state properties (min, max, value).
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
-