com.canto.cumulus.events

Interface ProgressListener<_Source>

All Superinterfaces:

BaseEventListener<_Source>, java.util.EventListener

public interface ProgressListener<_Source>
extends BaseEventListener<_Source>

The listener interface for a progress.

Since:

9.2

Method Summary

Methods

Modifier and Type	Method and Description
void	addValue(long addValue) New value to be added to the current value for a progress.
void	init(java.lang.String text, boolean enableCancel, boolean isIndeterminate) Usually called when a long running operation starts.
boolean	isCanceled() Return true in case the user selected to cancel the running progress, false otherwise.
void	setMaxValue(long maxValue) New maximum value for a progress.
void	setText(java.lang.String text) Server requests to update the UI text.
void	setValue(long currentValue) New current value for a progress.

Method Detail

init

void init(java.lang.String text,
        boolean enableCancel,
        boolean isIndeterminate)

Usually called when a long running operation starts.

Parameters:

text - initial text for the progress dialog

enableCancel - true if the operation supports cancel, false otherwise

isIndeterminate - true if the operation is unable to give progress information

setText

void setText(java.lang.String text)

Server requests to update the UI text.

Parameters:

text - new text to show

setMaxValue

void setMaxValue(long maxValue)

New maximum value for a progress.

Parameters:

maxValue - new maximum value for a progress

setValue

void setValue(long currentValue)

New current value for a progress.

Parameters:

currentValue - new current value for a progress

addValue

void addValue(long addValue)

New value to be added to the current value for a progress.

Parameters:

addValue - value to be added to the current value

isCanceled

boolean isCanceled()

Return true in case the user selected to cancel the running progress, false otherwise.

Returns:

true in case the user selected to cancel the running progress, false otherwise