Contact us
Create app
com.vaadin.ui.

Class ProgressBar

    • Constructor Detail

      • ProgressBar

        public ProgressBar()

        Creates a new progress bar initially set to 0% progress.

      • ProgressBar

        public ProgressBar​(float progress)

        Creates a new progress bar with the given initial value.

        Parameters:

        progress - the initial progress value

    • Method Detail

      • getValue

        public float getValue()

        Gets the value of this progress bar. The value is a float between 0 and 1 where 0 represents no progress at all and 1 represents fully completed.

        Returns:

        the current progress value

      • setValue

        public void setValue​(float newValue)

        Sets the value of this progress bar. The value is a float between 0 and 1 where 0 represents no progress at all and 1 represents fully completed.

        Parameters:

        newValue - the current progress value

        Since:

        8.0

      • getState

        protected ProgressBarState 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 AbstractComponent

        Returns:

        updated component shared state

      • setIndeterminate

        public void setIndeterminate​(boolean indeterminate)

        Sets whether or not this progress indicator is indeterminate. In indeterminate mode there is an animation indicating that the task is running but without providing any information about the current progress.

        Parameters:

        indeterminate - true to set to indeterminate mode; otherwise false

      • isIndeterminate

        public boolean isIndeterminate()

        Gets whether or not this progress indicator is indeterminate. In indeterminate mode there is an animation indicating that the task is running but without providing any information about the current progress.

        Returns:

        true if set to indeterminate mode; otherwise false

      • readDesign

        public void readDesign​(org.jsoup.nodes.Element design,
                       DesignContext designContext)

        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 AbstractComponent

        Parameters:

        design - The element to obtain the state from

        designContext - The DesignContext instance used for parsing the design

      • writeDesign

        public void writeDesign​(org.jsoup.nodes.Element design,
                        DesignContext designContext)

        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 AbstractComponent

        Parameters:

        design - The element to write the component state to. Any previous attributes or child nodes are not cleared.

        designContext - The DesignContext instance used for writing the design

      • reset

        public void reset()

        Resets the value of this component, effectively displaying zero progress.

        Since:

        8.0