org.dominokit.domino.ui.progress

Class ProgressBar

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,ProgressBar>

org.dominokit.domino.ui.progress.ProgressBar

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,ProgressBar,ProgressBar>, HasChildren<ProgressBar>, HasWavesElement, IsCollapsible<ProgressBar>, IsReadOnly<ProgressBar>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class ProgressBar
extends BaseDominoElement<elemental2.dom.HTMLDivElement,ProgressBar>

A component to show the progress for a single operation within a Progress

example

 Progress.create()
         .appendChild(ProgressBar.create(100).setValue(50));
 

See Also:

Progress

Nested Class Summary

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Constructor Summary

Constructors

Constructor and Description
ProgressBar(int maxValue)
ProgressBar(int maxValue, String textExpression)

Method Summary

Modifier and Type	Method and Description
ProgressBar	animate() Adds an animation effect to the ProgressBar
static ProgressBar	create(int maxValue)
ProgressBar	danger() Apply the ProgressStyles.progress_bar_danger
elemental2.dom.HTMLDivElement	element()
double	getMaxValue()
double	getValue()
ProgressBar	info() Apply the ProgressStyles.progress_bar_info
ProgressBar	setBackground(Color background)
ProgressBar	setMaxValue(double maxValue)
ProgressBar	setValue(double value)
ProgressBar	showText() Make progress text visible on the ProgressBar
ProgressBar	striped() Apply the ProgressStyles.progress_bar_success
ProgressBar	success() Apply the ProgressStyles.progress_bar_success
ProgressBar	textExpression(String expression)
ProgressBar	warning() Apply the ProgressStyles.progress_bar_warning

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

ProgressBar

public ProgressBar(int maxValue)

Parameters:

maxValue - int max value of the operation progress

ProgressBar

public ProgressBar(int maxValue,
                   String textExpression)

Parameters:

maxValue - int max value of the operation progress

textExpression - String that contains the parameter one or all of the parameters percent,value,maxValue

example

                           "Finished {percent}% of the items - {value}/{maxValue}"
                       

Method Detail

create

public static ProgressBar create(int maxValue)

Parameters:

maxValue - int max value of the operation progress

Returns:

new ProgressBar instance

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,ProgressBar>

Returns:

the HTML element of type E which is the root element of the component

getValue

public double getValue()

Returns:

double current progress value

showText

public ProgressBar showText()

Make progress text visible on the ProgressBar

Returns:

same Progressbar instance

setValue

public ProgressBar setValue(double value)

Parameters:

value - double value of progress

Returns:

same Progressbar instance

animate

public ProgressBar animate()

Adds an animation effect to the ProgressBar

Returns:

same ProgressBar instance

striped

public ProgressBar striped()

Apply the ProgressStyles.progress_bar_success

Returns:

same Progressbar instance

success

public ProgressBar success()

Apply the ProgressStyles.progress_bar_success

Returns:

same Progressbar instance

warning

public ProgressBar warning()

Apply the ProgressStyles.progress_bar_warning

Returns:

same Progressbar instance

info

public ProgressBar info()

Apply the ProgressStyles.progress_bar_info

Returns:

same Progressbar instance

danger

public ProgressBar danger()

Apply the ProgressStyles.progress_bar_danger

Returns:

same Progressbar instance

setBackground

public ProgressBar setBackground(Color background)

Parameters:

background - Color of the Progressbar

Returns:

same ProgressBar instance

getMaxValue

public double getMaxValue()

Returns:

double max value

setMaxValue

public ProgressBar setMaxValue(double maxValue)

Parameters:

maxValue - double

Returns:

same ProgressBar instance

textExpression

public ProgressBar textExpression(String expression)

Parameters:

expression - String that contains the parameter one or all of the parameters percent,value,maxValue

example

                           "Finished {percent}% of the items - {value}/{maxValue}"
                       

Returns:

same ProgressBar instance