Package org.vaadin.addons.tatu

Class CircularProgressBar

  • All Implemented Interfaces:
    com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.shared.HasTooltip, java.io.Serializable
    @JsModule("./circular-progress-bar.ts")
@Tag("circular-progress-bar")
public class CircularProgressBar
extends com.vaadin.flow.component.Component
implements com.vaadin.flow.component.HasSize, com.vaadin.flow.component.shared.HasTooltip
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void setAnimation​(boolean animation)
      Use true to set animation on.
      void setBorder​(boolean border)
      Use true to add border in the progress indicator, default false.
      void setCaption​(java.lang.String caption)
      Set the caption text shown in the middle of the component below the percentage value.
      void setColor​(java.lang.String color)
      Set the color used for filling of the progress indicator.
      void setDelay​(int delay)
      Set the animation frame delay, default 10ms.
      void setPercent​(double percent)
      Set the percentage.
      void setScale​(double scale)
      Set scaling factor.

      • 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, scrollIntoView, set, setElement, setId, setVisible

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

        getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

      • Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

        getTooltip, setTooltipText

    • Constructor Detail

      • CircularProgressBar

        public CircularProgressBar()

    • Method Detail

      • setScale

        public void setScale​(double scale)
        Set scaling factor. E.g. if scale is 0.5 and percent is 0.5, progress indicator will show complete. Default 1.0.
        Parameters:
        scale - double value.

      • setPercent

        public void setPercent​(double percent)
        Set the percentage.
        Parameters:
        percent - double value between 0..1.

      • setCaption

        public void setCaption​(java.lang.String caption)
        Set the caption text shown in the middle of the component below the percentage value.
        Parameters:
        caption - String value.

      • setColor

        public void setColor​(java.lang.String color)
        Set the color used for filling of the progress indicator.
        Parameters:
        color - CSS compatible color string.

      • setAnimation

        public void setAnimation​(boolean animation)
        Use true to set animation on.
        Parameters:
        animation - boolean value
        See Also:
        setDelay(int)

      • setDelay

        public void setDelay​(int delay)
        Set the animation frame delay, default 10ms.
        Parameters:
        delay - int value in millis.
        See Also:
        setAnimation(boolean)

      • setBorder

        public void setBorder​(boolean border)
        Use true to add border in the progress indicator, default false.
        Parameters:
        border - Boolean value