|
Cytoscape 2.3.1 (c) 2004 ISB, MSKCC, UCSD | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
void |
cancel()
Gets called by the CytoscapeProgressMonitor when the user
click on the Cancel button. |
boolean |
done()
Returns true if the task is done. |
int |
getCurrent()
Returns the currentProgress parameter. |
int |
getLengthOfTask()
Returns the lenghtOfTask parameter. |
String |
getMessage()
Returns a String, possibly the message to be printed on a dialog. |
String |
getTaskName()
Returns a String, possibly the message that describes the task being performed. |
void |
go(boolean wait)
Initializes currentProgress (generally to zero) and then spawns a SwingWorker to start doing the work. |
void |
incrementProgress()
Increments the progress by one |
void |
stop()
Stops the task by simply setting currentProgress to lengthOfTask, or if a boolean "done" variable is used, setting it to true. |
boolean |
wasCanceled()
|
Method Detail |
public boolean done()
public int getCurrent()
public int getLengthOfTask()
public String getMessage()
public String getTaskName()
public void go(boolean wait)
wait
- whether or not the method should wait for the task to be done before returning
if true, should call SwingWorker.get() before returningpublic void incrementProgress()
public void stop()
public void cancel()
CytoscapeProgressMonitor
when the user
click on the Cancel button.
public boolean wasCanceled()
|
www.cytoscape.org | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |