javax.ide.view

Interface ProgressMonitor

public interface ProgressMonitor

Use to Monitor the progress of time consuming operations. A progress bar can be shown to indicate the operation progress. Methods in this interface can be called from the event or other threads.

Method Summary

Modifier and Type	Method and Description
void	finish() Indicate that the operation has finished.
boolean	isCancelled() Returns true if the user hit the Cancel button in the progress bar.
void	start(GUIPanel parent, java.lang.String msg, int minValue, int maxValue, int delay) Start monitoring a time consuming operation.
void	update(int value, java.lang.String note) Indicate the progress of the operation taking place.

Method Detail

start

void start(GUIPanel parent,
           java.lang.String msg,
           int minValue,
           int maxValue,
           int delay)

Start monitoring a time consuming operation.

Parameters:

parent - the parent component for the progress dialog.

msg - a message to show the user describing the operation taking place.

minValue - the lower bound of the range.

maxValue - the upper bound of the range.

delay - the amount of time to delay the popping up of the progress bar. If the finish method is called before the delay has elapsed, the progress bar is not shown.

finish

void finish()

Indicate that the operation has finished. If the progress bar is up it will hide it. The finish method will be called automatically if the value set by update is greater or equal to the maxValue specified when the start method was called.

isCancelled

boolean isCancelled()

Returns true if the user hit the Cancel button in the progress bar.

update

void update(int value,
            java.lang.String note)

Indicate the progress of the operation taking place. If the specified value is greater or equal to the maxValue specified when the start method was called, the finish method will be automatically called.

Parameters:

value - the current progress value between the minimum and maximum specified on start.

note - an additional note to be displayed with the progress message. Its value can be null or an empty string.