de.javagl.swing.tasks

Interface SwingTaskView

public interface SwingTaskView

Interface for the communication with a view for a SwingTask. This view may, for example, be a dialog. Such a view is maintained by a SwingTaskExecutor. During the execution of the SwingTask, the SwingTaskExecutor will show, update and hide this view according to its settings.

Method Summary

Modifier and Type	Method and Description
void	setMessage(String message) Set the message that should be displayed in this view
void	setProgress(double progress) Set the current progress of the SwingTask.
void	show() Will be called when the task was started and the decision to show the task view was made.
void	taskFinished(Throwable t) Will be called when the task finished.

Method Detail

show

void show()

Will be called when the task was started and the decision to show the task view was made.

setProgress

void setProgress(double progress)

Set the current progress of the SwingTask. This will be a value between 0.0 and 1.0 (inclusive), or a value <0.0 when the progress is not known.

Parameters:

progress - The progress of the task

setMessage

void setMessage(String message)

Set the message that should be displayed in this view

Parameters:

message - The message

taskFinished

void taskFinished(Throwable t)

Will be called when the task finished. This will usually cause the view to be made invisible and disposed.

Parameters:

t - An exception that may have been caused by the task. If the task completed normally, this will be null.