Package 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

      • ProgressBar

        public ProgressBar​(Property<?> dataSource)
        Creates a new progress bar bound to the given data source.
        Parameters:
        dataSource - the property to bind this progress bar to

    • Method Detail

      • beforeClientResponse

        public void beforeClientResponse​(boolean initial)
        Description copied from interface: ClientConnector
        Called before the shared state and RPC invocations are sent to the client. Gives the connector an opportunity to set computed/dynamic state values or to invoke last minute RPC methods depending on other component features.
        Specified by:
        beforeClientResponse in interface ClientConnector
        Overrides:
        beforeClientResponse in class AbstractField<Float>
        Parameters:
        initial - true if the client-side connector will be created and initialized after this method has been invoked. false if there is already an initialized client-side connector.

      • 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.
        Specified by:
        getValue in interface Property<Float>
        Overrides:
        getValue in class AbstractField<Float>
        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.
        Specified by:
        setValue in interface Property<Float>
        Overrides:
        setValue in class AbstractField<Float>
        Parameters:
        newValue - the current progress value

      • getType

        public Class<Float> getType()
        Description copied from class: AbstractField
        Returns the type of the Field. The methods getValue and setValue must be compatible with this type: one must be able to safely cast the value returned from getValue to the given type and pass any variable assignable to this type as an argument to setValue.
        Specified by:
        getType in interface Property<Float>
        Specified by:
        getType in class AbstractField<Float>
        Returns:
        the type of the Field

      • 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 AbstractField<Float>
        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

      • setInternalValue

        protected void setInternalValue​(Float newValue)
        Description copied from class: AbstractField
        Sets the internal field value. This is purely used by AbstractField to change the internal Field value. It does not trigger valuechange events. It can be overridden by the inheriting classes to update all dependent variables. Subclasses can also override AbstractField.getInternalValue() if necessary.
        Overrides:
        setInternalValue in class AbstractField<Float>
        Parameters:
        newValue - the new value to be set.

      • 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 AbstractField<Float>
        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 AbstractField<Float>
        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

      • clear

        public void clear()
        Description copied from interface: Field
        Clears the value of the field.

        The field value is typically reset to the initial value of the field. Calling Field.isEmpty() on a cleared field must always returns true.

        Specified by:
        clear in interface Field<Float>
        Overrides:
        clear in class AbstractField<Float>

      • isEmpty

        public boolean isEmpty()
        Description copied from interface: Field
        Is the field empty? In general, "empty" state is same as null. As an exception, TextField also treats empty string as "empty".
        Specified by:
        isEmpty in interface Field<Float>
        Overrides:
        isEmpty in class AbstractField<Float>
        Returns:
        true if the field is empty, false otherwise