Package com.bc.ceres.swing.progress

Class DialogProgressMonitor

java.lang.Object

com.bc.ceres.swing.progress.DialogProgressMonitor

All Implemented Interfaces:

ProgressMonitor

public class DialogProgressMonitor
extends Object
implements ProgressMonitor

A ProgressMonitor which uses a Swing's ProgressMonitor to display progress.

Field Summary

Fields inherited from interface com.bc.ceres.core.ProgressMonitor

NULL, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
DialogProgressMonitor(ProgressDialog progressDialog)	Constructs an instance of this class.
DialogProgressMonitor(Component parentComponent, String title, Dialog.ModalityType modalityType)	Constructs an instance of this class.

Method Summary

Modifier and Type	Method	Description
void	beginTask(String name, int totalWork)	Notifies that the main task is beginning.
void	done()	Notifies that the work is done; that is, either the main task is completed or the user canceled it.
void	internalWorked(double work)	Internal method to handle scaling correctly.
boolean	isCanceled()	Returns whether cancelation of current operation has been requested.
void	setCanceled(boolean canceled)	Sets the cancel state to the given value.
void	setSubTaskName(String name)	Notifies that a subtask of the main task is beginning.
void	setTaskName(String name)	Sets the task name to the given value.
void	worked(int work)	Notifies that a given number of work unit of the main task has been completed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DialogProgressMonitor

public DialogProgressMonitor(Component parentComponent,
                             String title,
                             Dialog.ModalityType modalityType)

Constructs an instance of this class.

Parameters:

parentComponent - The parent component.

title - The dialog's title.

modalityType - The modality type.

DialogProgressMonitor

public DialogProgressMonitor(ProgressDialog progressDialog)

Constructs an instance of this class.

Parameters:

progressDialog - The progress dialog to be used.

Method Detail

beginTask

public void beginTask(String name,
                      int totalWork)

Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.

Specified by:

beginTask in interface ProgressMonitor

Parameters:

name - the name (or description) of the main task

totalWork - the total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.

done

public void done()

Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).

Specified by:

done in interface ProgressMonitor

internalWorked

public void internalWorked(double work)

Internal method to handle scaling correctly. This method must not be called by a client. Clients should always use the method worked(int).

Specified by:

internalWorked in interface ProgressMonitor

Parameters:

work - the amount of work done

isCanceled

public boolean isCanceled()

Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

Specified by:

isCanceled in interface ProgressMonitor

Returns:

true if cancellation has been requested, and false otherwise

See Also:

setCanceled(boolean)

setCanceled

public void setCanceled(boolean canceled)

Sets the cancel state to the given value.

Specified by:

setCanceled in interface ProgressMonitor

Parameters:

canceled - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag

See Also:

isCanceled()

setTaskName

public void setTaskName(String name)

Sets the task name to the given value. This method is used to restore the task label after a nested operation was executed. Normally there is no need for clients to call this method.

Specified by:

setTaskName in interface ProgressMonitor

Parameters:

name - the name (or description) of the main task

See Also:

beginTask(String, int)

setSubTaskName

public void setSubTaskName(String name)

Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.

Specified by:

setSubTaskName in interface ProgressMonitor

Parameters:

name - the name (or description) of the subtask

worked

public void worked(int work)

Notifies that a given number of work unit of the main task has been completed. Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.

Specified by:

worked in interface ProgressMonitor

Parameters:

work - the number of work units just completed