org.progeeks.util
Interface ProgressReporter

All Known Implementing Classes:

DefaultProgressReporter, SwingProgressReporter

public interface ProgressReporter

Defines an object that can report status to the user.

Version:

$Revision: 1.1 $

Author:

Paul Speed

Method Summary

void	done() Indicates that the operation has completed.
int	getMaximum() Returns the maximum progress value.
java.lang.String	getMessage() Returns the string message associated with the current part of the task being performed.
int	getMinimum() Returns the minimum progress value.
int	getProgress() Returns the current progress amount.
boolean	isCanceled() Returns true when the operation has been canceled by the user.
void	setMaximum(int val) Sets the maximum progress value.
void	setMessage(java.lang.String message) Sets the string message associated with the current part of the task being performed.
void	setMinimum(int val) Sets the minimum progress value.
void	setProgress(int val) Sets the current progress amount.

Method Detail

setMessage

void setMessage(java.lang.String message)

Sets the string message associated with the current part of the task being performed.

getMessage

java.lang.String getMessage()

Returns the string message associated with the current part of the task being performed.

setProgress

void setProgress(int val)

Sets the current progress amount.

getProgress

int getProgress()

Returns the current progress amount.

setMinimum

void setMinimum(int val)

Sets the minimum progress value.

getMinimum

int getMinimum()

Returns the minimum progress value.

setMaximum

void setMaximum(int val)

Sets the maximum progress value.

getMaximum

int getMaximum()

Returns the maximum progress value.

isCanceled

boolean isCanceled()

Returns true when the operation has been canceled by the user. The active task should check this flag to discontinue its operation in the event of a user-cancel.

done

void done()

Indicates that the operation has completed.