org.cytoscape.work

Interface TaskMonitor

public interface TaskMonitor

Used by Tasks to modify its user interface.

Author:

Pasteur

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

Method Summary

Methods

Modifier and Type	Method and Description
void	setProgress(double progress) Sets the progress completed by the Task.
void	setStatusMessage(String statusMessage) Sets the status message that describes what a Task is currently doing.
void	setTitle(String title) Sets the title of the Task.

Method Detail

setTitle

void setTitle(String title)

Sets the title of the Task. The title is a succinct description of the Task's purpose. This method should only be called once and at the beginning of the run method.

Parameters:

title - Succinct description of the Task's purpose.

setProgress

void setProgress(double progress)

Sets the progress completed by the Task.

Parameters:

progress - Usually a value between 0.0 and 1.0. A negative value is used to specify an indefinite progress bar.

setStatusMessage

void setStatusMessage(String statusMessage)

Sets the status message that describes what a Task is currently doing. This method can be called throughout the course of the run method.

Parameters:

statusMessage - String that describe what a Task is currently doing.