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.

Module: work-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>work-api</artifactId>
</dependency>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TaskMonitor.Level Used by the showMessage method to indicate the severity of the message.

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.
void	showMessage(TaskMonitor.Level level, String message) Shows a message to the user.

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 - A value between 0.0 and 1.0. Any negative value sets the progress bar to an indefinite state.

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.

showMessage

void showMessage(TaskMonitor.Level level,
               String message)

Shows a message to the user. This method can be called throughout the course of the run method. This method should not be used for debugging purposes. Either use System.out.println or a logger to issue debug messages.