act.util

Interface ProgressGauge

All Known Implementing Classes:

SimpleProgressGauge

public interface ProgressGauge

Class implement this interface can track progress

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ProgressGauge.Listener

Method Summary

Modifier and Type	Method and Description
void	addListener(ProgressGauge.Listener listener) Add an listener to this gauge that monitors the progress update
int	currentSteps() Report the current progress steps
boolean	isDone() Check if the progress has been finished
void	markAsDone() Mark the progress as done
int	maxHint() Returns the max hint
void	setId(String id) Set ID to the gauge
void	step() Advances the progress by one step
void	stepBy(int steps) Advances the progress by specified steps
void	stepTo(int steps) Log progress
void	updateMaxHint(int maxHint) Update max hint.

Method Detail

setId

void setId(String id)

Set ID to the gauge

Parameters:

id - the gauge ID

updateMaxHint

void updateMaxHint(int maxHint)

Update max hint. If the number is negative, then it indicate the progress is indefinite

Parameters:

maxHint - the max steps hint

step

void step()

Advances the progress by one step

stepBy

void stepBy(int steps)

Advances the progress by specified steps

Parameters:

steps - the step size

stepTo

void stepTo(int steps)

Log progress

Parameters:

steps - the new progress value

currentSteps

int currentSteps()

Report the current progress steps

Returns:

the current progress

maxHint

int maxHint()

Returns the max hint

Returns:

the max hint setting

isDone

boolean isDone()

Check if the progress has been finished

markAsDone

void markAsDone()

Mark the progress as done

addListener

void addListener(ProgressGauge.Listener listener)

Add an listener to this gauge that monitors the progress update

Parameters:

listener - the listener