Package com.vaadin.flow.component.progressbar

Class GeneratedVaadinProgressBar<R extends GeneratedVaadinProgressBar<R>>

  • All Implemented Interfaces:
    com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, Serializable
    Direct Known Subclasses:
    ProgressBar
    @Tag("vaadin-progress-bar")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",
            version="23.1.3")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/progress-bar/src/vaadin-progress-bar.js")
public abstract class GeneratedVaadinProgressBar<R extends GeneratedVaadinProgressBar<R>>
extends com.vaadin.flow.component.Component
implements com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme

    Description copied from corresponding location in WebComponent:

    <vaadin-progress-bar> is a Web Component for progress bars.

    <vaadin-progress-bar min="0" max="1" value="0.5"> </vaadin-progress-bar>

    Styling

    The following shadow DOM parts are available for styling:

    Part name Description
    bar Progress-bar's background
    value Progress-bar's foreground

    See ThemableMixin – how to apply styles for shadow parts

    The following custom properties are available:

    Custom property Description Default
    --vaadin-progress-value current progress value (between 0 and 1) 0

    The following state attributes are available for styling:

    Attribute Description Part name
    indeterminate Set to an indeterminate progress bar :host
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addThemeVariants​(ProgressBarVariant... variants)
      Adds theme variants to the component.
      protected double getMaxDouble()
      Description copied from corresponding location in WebComponent:
      protected double getMinDouble()
      Description copied from corresponding location in WebComponent:
      protected double getValueDouble()
      Description copied from corresponding location in WebComponent:
      protected boolean isIndeterminateBoolean()
      Description copied from corresponding location in WebComponent:
      void removeThemeVariants​(ProgressBarVariant... variants)
      Removes theme variants from the component.
      protected void setIndeterminate​(boolean indeterminate)
      Description copied from corresponding location in WebComponent:
      protected void setMax​(double max)
      Description copied from corresponding location in WebComponent:
      protected void setMin​(double min)
      Description copied from corresponding location in WebComponent:
      protected void setValue​(double value)
      Description copied from corresponding location in WebComponent:

      • 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 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.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

      • GeneratedVaadinProgressBar

        public GeneratedVaadinProgressBar()

    • Method Detail

      • addThemeVariants

        public void addThemeVariants​(ProgressBarVariant... variants)
        Adds theme variants to the component.
        Parameters:
        variants - theme variants to add

      • removeThemeVariants

        public void removeThemeVariants​(ProgressBarVariant... variants)
        Removes theme variants from the component.
        Parameters:
        variants - theme variants to remove

      • getValueDouble

        protected double getValueDouble()

        Description copied from corresponding location in WebComponent:

        Current progress value.

        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 value property from the webcomponent

      • setValue

        protected void setValue​(double value)

        Description copied from corresponding location in WebComponent:

        Current progress value.

        Parameters:
        value - the double value to set

      • getMinDouble

        protected double getMinDouble()

        Description copied from corresponding location in WebComponent:

        Minimum bound of the progress bar.

        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 min property from the webcomponent

      • setMin

        protected void setMin​(double min)

        Description copied from corresponding location in WebComponent:

        Minimum bound of the progress bar.

        Parameters:
        min - the double value to set

      • getMaxDouble

        protected double getMaxDouble()

        Description copied from corresponding location in WebComponent:

        Maximum bound of the progress bar.

        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 max property from the webcomponent

      • setMax

        protected void setMax​(double max)

        Description copied from corresponding location in WebComponent:

        Maximum bound of the progress bar.

        Parameters:
        max - the double value to set

      • isIndeterminateBoolean

        protected boolean isIndeterminateBoolean()

        Description copied from corresponding location in WebComponent:

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

        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 from the webcomponent

      • setIndeterminate

        protected void setIndeterminate​(boolean indeterminate)

        Description copied from corresponding location in WebComponent:

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

        Parameters:
        indeterminate - the boolean value to set