Package eu.webtoolkit.jwt

Class WProgressBar

  • public class WProgressBar
extends WInteractWidget
    A progress bar.

    The progress bar can be used to indicate the progress of a certain operation. The text displayed in the progress bar can be customized by specializing getText().

    To use the progress bar, you need to give it a range (minimum and maximum value), and update the progress using setValue().

    WProgressBar is an inline widget.

    Note: With the advent of HTML5, this widget will be implemented using the native HTML5 control when available.

    • Method Detail

      • setMinimum

        public void setMinimum​(double minimum)
        Sets the minimum value.

        The minimum value is the value that corresponds to 0%.

        The default value is 0.

      • setMaximum

        public void setMaximum​(double maximum)
        Sets the maximum value.

        The maximum value is the value that corresponds to 100%.

        The default value is 100.

      • setValue

        public void setValue​(double value)
        Sets the current progress.

        value must be a value between getMinimum() and getMaximum().

      • getValue

        public double getValue()
        Returns the current progress.

      • setFormat

        public void setFormat​(java.lang.CharSequence format)
        Sets the progress format string.

        The format is used by getText() to indicate the progress value.

        The default value is "%.0f %%"

      • getText

        public WString getText()
        Returns the text displayed inside the progress bar.

        This text must be an XHTML formatted text fragment. The default text prints the current progress using getFormat(). You may want to reimplement this method to display a different text corresponding to the current getValue().

      • valueChanged

        public Signal1<java.lang.Double> valueChanged()
        A signal that indicates when the value has changed.

        This signal is emitted when setValue() is called.

        See Also:
        setValue(double value)

      • progressCompleted

        public Signal progressCompleted()
        A signal that indicates when 100% is reached.

        This signal is emitted when setValue(maximum()) is called.

        See Also:
        setValue(double value)

      • resize

        public void resize​(WLength width,
                   WLength height)
        Description copied from class: WWidget
        Resizes the widget.

        Specifies a fixed size for this widget, setting CSS width and height properties. By default a widget has automatic width and height, which sets a size for the widget following CSS rules.

        When the widget is not managed by a layout manager, the automatic (natural) size of a widget depends on whether the widget is a block or inline widget:

        • a block widget takes by default the width of the parent, and the height that it needs based on its contents
        • an inline widget takes the width and height that it needs based on its contents (possibly wrapping over multiple lines). The width and height of an inline widget cannot be changed (by the letter of CSS, although most browsers will react to it in varying ways).

        When inserted in a layout manager, the size set will be used as a widget's preferred size, but the widget may be given a different size by the layout manager based on available space and stretch factors. The actual size given by a layout manager may be retrieved by making the widget "layout size aware", using setLayoutSizeAware(). If you have defined a "wtResize()" JavaScript method for the widget, then this method will also be called.

        The default width and height of a widget is WLength.Auto.

        Overrides:
        resize in class WWebWidget
        See Also:
        WWidget.getWidth(), WWidget.getHeight()

      • setValueStyleClass

        public void setValueStyleClass​(java.lang.String valueStyleClass)
        Updates the style class of the bar part of the WProgressBar.

        This can be used to style the bar part of the WProgressBar, e.g. "progress-bar-success" or "progress-bar-danger".

      • setState

        public void setState​(double minimum,
                     double maximum,
                     double value)

      • updateBar

        protected void updateBar​(DomElement bar)
        Update the progress bar itself.

        Will be called whenever the value changes, and changes the width of the progress bar accordingly.

        You can reimplement this method to apply certain style changes to the progress bar according to the value. Don't forget to call updateBar() if you still want the width to change.