edu.northwestern.at.utils.swing
Interface ProgressReporter

All Known Implementing Classes:

PrintProgressDialog, ProgressDialog, ProgressLabelAdapter, ProgressMonitorDialog, ProgressPanel, RepaginationProgressDialog

public interface ProgressReporter

Interface for classes which report progress.

Method Summary

void	close() Close the progress display.
int	getCurrentBarValue() Get the current bar value.
int	getMaximumBarValue() Get the maximum bar value.
boolean	isCancelled() See if progress display cancelled.
void	makeVisible(boolean visible) Make the dialog visible or invisble.
void	setIndeterminate(boolean isIndeterminate) Set tbe progress bar determinate/indeterminate state.
void	setLabelColor(java.awt.Color color) Set the progress label text color.
void	setMaximumBarValue(int maxBar) Set maximum bar value.
void	setStartupTime(long startupTime) Set the startup time.
void	setTitle(java.lang.String title) Set the title.
void	updateProgress(int barValue) Update progress display.
void	updateProgress(int barValue, java.lang.String newLabel) Update progress display.
void	updateProgress(java.lang.String newLabel) Update progress display.

Method Detail

isCancelled

boolean isCancelled()

See if progress display cancelled.

Returns:

True if cancelled, false otherwise.

setStartupTime

void setStartupTime(long startupTime)

Set the startup time.

Parameters:

startupTime - The startup time in milliseconds.

updateProgress

void updateProgress(int barValue,
                    java.lang.String newLabel)

Update progress display.

Parameters:

barValue - New value for progress bar. If negative, the current value remains unchanged.

newLabel - New label text. If null, the current label text is unchanged.

updateProgress

void updateProgress(int barValue)

Update progress display.

Parameters:

barValue - New value for progress bar.

updateProgress

void updateProgress(java.lang.String newLabel)

Update progress display.

Parameters:

newLabel - New label text. If null, the current label text is unchanged.

setTitle

void setTitle(java.lang.String title)

Set the title.

Parameters:

title - The title.

setLabelColor

void setLabelColor(java.awt.Color color)

Set the progress label text color.

Parameters:

color - Text color for progress label.

setMaximumBarValue

void setMaximumBarValue(int maxBar)

Set maximum bar value.

Parameters:

maxBar - The new maximum bar value.

getCurrentBarValue

int getCurrentBarValue()

Get the current bar value.

Returns:

The current bar value.

getMaximumBarValue

int getMaximumBarValue()

Get the maximum bar value.

Returns:

The maximum value.

setIndeterminate

void setIndeterminate(boolean isIndeterminate)

Set tbe progress bar determinate/indeterminate state.

Parameters:

isIndeterminate - true if indeterminate, false otherwise.

makeVisible

void makeVisible(boolean visible)

Make the dialog visible or invisble.

Parameters:

visible - true to show dialog, false to hide.

close

void close()

Close the progress display.