Package org.jboss.hal.ballroom

Class ProgressElement

java.lang.Object

org.jboss.hal.ballroom.ProgressElement

All Implemented Interfaces:

org.jboss.elemento.IsElement, Progress

public class ProgressElement
extends Object
implements org.jboss.elemento.IsElement, Progress

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProgressElement.Label
static class	ProgressElement.Size

Field Summary

Fields inherited from interface org.jboss.hal.flow.Progress

NOOP

Constructor Summary

Constructors

Constructor	Description
ProgressElement(ProgressElement.Size size, ProgressElement.Label label, boolean reverse)

Method Summary

Modifier and Type	Method	Description
elemental2.dom.HTMLElement	element()
void	finish()	Indicates that the progress has been finished.
void	reset()	Resets the progress indicator.
void	reset(int mx, String label)	Resets the progress indicator.
void	tick(String label)	Indicates progress using a description.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.hal.flow.Progress

reset, tick

Constructor Detail

ProgressElement

public ProgressElement(ProgressElement.Size size,
                       ProgressElement.Label label,
                       boolean reverse)

Method Detail

element

public elemental2.dom.HTMLElement element()

Specified by:

element in interface org.jboss.elemento.IsElement

reset

public void reset()

Description copied from interface: Progress

Resets the progress indicator. Since now max value is given, the progress bar is indeterminate; this indicates that an activity is ongoing with no indication of how long it is expected to take.

Specified by:

reset in interface Progress

reset

public void reset(int mx,
                  String label)

Description copied from interface: Progress

Resets the progress indicator. The max parameter describes how many tasks are going to be executed.

Specified by:

reset in interface Progress

Parameters:

mx - the number of tasks executed

label - a description for the reset state

tick

public void tick(String label)

Description copied from interface: Progress

Indicates progress using a description.

Specified by:

tick in interface Progress

Parameters:

label - a description of the progress

finish

public void finish()

Description copied from interface: Progress

Indicates that the progress has been finished.

Specified by:

finish in interface Progress