nu.zoom.gal.progress
Interface Progress

All Known Implementing Classes:

ProgressImpl

public interface Progress

Used to show the user progress for background tasks. To use first create a taskID, then use the JProgress-like methods to indicate progress. When the task finishes please call the delete method.

Author:

"Johan Maasing" <johan@zoom.nu>

Nested Class Summary

static interface

Progress.TaskID

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.

Method Detail

createTask

Progress.TaskID createTask()

Create a new task.

Returns:

The task identification.

deleteTask

void deleteTask(Progress.TaskID taskID)

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

Parameters:

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

setIndeterminate

void setIndeterminate(Progress.TaskID taskID)

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

Parameters:

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

setMaximum

void setMaximum(Progress.TaskID taskID)

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

Parameters:

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

setValue

void setValue(Progress.TaskID taskID)

Report progress of the given task.

Parameters:

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

setMessage

void setMessage(Progress.TaskID taskID,
                CharSequence message)

Set an informational message explaining what the task is doing.

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.