|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NodeProgressMonitor
Implement this interface if you want to get informed about progress change events and if you want to can ask for cancelation.
Method Summary | |
---|---|
void |
addProgressListener(NodeProgressListener l)
Adds a new listener to the list of instances which are interested in receiving progress events. |
void |
checkCanceled()
|
String |
getMessage()
The current progress message displayed. |
Double |
getProgress()
The current progress value or null if no progress available. |
void |
removeAllProgressListener()
Removes all registered progress listeners. |
void |
removeProgressListener(NodeProgressListener l)
Removes the given listener from the list and will therefore no longer receive progress events. |
void |
reset()
Reset progress, message and cancel flag. |
void |
setExecuteCanceled()
Sets the cancel requested flag. |
void |
setMessage(String message)
Displays the message as given by the argument. |
void |
setProgress(double progress)
Sets a new progress value. |
void |
setProgress(double progress,
String message)
Sets a new progress value. |
void |
setProgress(String message)
Displays the message as given by the argument. |
Method Detail |
---|
void checkCanceled() throws CanceledExecutionException
CanceledExecutionException
- If the execution of the
NodeModel
has been canceled during execute.void setProgress(double progress)
progress
- The value between 0 and 1.Double getProgress()
null
if no progress available.
null
.void setProgress(double progress, String message)
progress
- The value between 0 and 1.message
- A convenience message shown in the progress monitor or
null
.void setMessage(String message)
message
- A convenience message shown in the progress monitor.setProgress(String)
void setProgress(String message)
message
- A convenience message shown in the progress monitor.String getMessage()
void setExecuteCanceled()
void reset()
void addProgressListener(NodeProgressListener l)
l
- The progress listener to add.void removeProgressListener(NodeProgressListener l)
l
- The progress listener to remove.void removeAllProgressListener()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |