nu.zoom.gal.progress.desktop
Class ProgressImpl

java.lang.Object
  nu.zoom.gal.progress.desktop.ProgressImpl

All Implemented Interfaces:

Progress

public class ProgressImpl
extends Object
implements Progress

An implementation of the Progress interface. Displays progress in the zoom.nu desktop status bar.

Author:

"Johan Maasing" <johan@zoom.nu>

Nested Class Summary

class

ProgressImpl.TaskID

Constructor Summary

ProgressImpl(nu.zoom.swing.desktop.Workbench workbench)

Method Summary

Progress.TaskID	createTask() Create a new task.
void	deleteTask(Progress.TaskID taskID) The task is finished and no more progress will be reported on this task.
void	setIndeterminate(Progress.TaskID taskID) Set the status of the task to be of indeterminate length.
void	setMaximum(Progress.TaskID taskID) Set the maximum value that the progress of this task will reach.
void	setMessage(Progress.TaskID taskID, CharSequence message) Set an informational message explaining what the task is doing.
void	setValue(Progress.TaskID taskID) Report progress of the given task.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressImpl

public ProgressImpl(nu.zoom.swing.desktop.Workbench workbench)

Method Detail

createTask

public Progress.TaskID createTask()

Description copied from interface: Progress

Create a new task.

Specified by:

createTask in interface Progress

Returns:

The task identification.

deleteTask

public void deleteTask(Progress.TaskID taskID)

Description copied from interface: Progress

The task is finished and no more progress will be reported on this task.

Specified by:

deleteTask in interface Progress

Parameters:

taskID - The identification of the task. May not be null.

setIndeterminate

public void setIndeterminate(Progress.TaskID taskID)

Description copied from interface: Progress

Set the status of the task to be of indeterminate length.

Specified by:

setIndeterminate in interface Progress

Parameters:

taskID - The identification of the task. May not be null. If the taskID is unknown or deleted this method does nothing.

setMaximum

public void setMaximum(Progress.TaskID taskID)

Description copied from interface: Progress

Set the maximum value that the progress of this task will reach.

Specified by:

setMaximum in interface Progress

Parameters:

taskID - The identification of the task. May not be null. If the taskID is unknown or deleted this method does nothing.

setValue

public void setValue(Progress.TaskID taskID)

Description copied from interface: Progress

Report progress of the given task.

Specified by:

setValue in interface Progress

Parameters:

taskID - The identification of the task. May not be null. If the taskID is unknown or deleted this method does nothing.

setMessage

public void setMessage(Progress.TaskID taskID,
                       CharSequence message)

Description copied from interface: Progress

Set an informational message explaining what the task is doing.

Specified by:

setMessage in interface Progress

Parameters:

taskID - The identification of the task. May not be null. If the taskID is unknown or deleted this method does nothing.

message - The message to set. If null any previous message for the task will be removed.