|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.core.node.DefaultNodeProgressMonitor.SubNodeProgressMonitor
static class DefaultNodeProgressMonitor.SubNodeProgressMonitor
Progress monitor that is used by "sub-progresses", it doesn't have the range [0, 1] but only [0, b] where b is user-defined.
Constructor Summary | |
---|---|
DefaultNodeProgressMonitor.SubNodeProgressMonitor(NodeProgressMonitor parent,
double max)
Creates new sub progress monitor. |
Method Summary | |
---|---|
void |
addProgressListener(NodeProgressListener l)
Must not be called. |
(package private) void |
appendMessage(String append)
|
void |
checkCanceled()
Delegates to parent. |
String |
getMessage()
The current progress message displayed. |
Double |
getProgress()
Get the subprogress, the value scaled to [0, 1]. |
void |
removeAllProgressListener()
Must not be called. |
void |
removeProgressListener(NodeProgressListener l)
Must not be called. |
void |
reset()
Reset progress, message and cancel flag. |
void |
setExecuteCanceled()
Must not be called. |
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)
Delegates to parent. |
(package private) void |
setProgress(String message,
boolean append)
Internal setter method, subject to override in silent progress mon. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
DefaultNodeProgressMonitor.SubNodeProgressMonitor(NodeProgressMonitor parent, double max)
parent
- The parent of this monitor, i.e. where to report
progress to and get the canceled status from.max
- The maximum progress (w.r.t parent) that this monitor
should report.Method Detail |
---|
public void addProgressListener(NodeProgressListener l)
addProgressListener
in interface NodeProgressMonitor
l
- The progress listener to add.public void checkCanceled() throws CanceledExecutionException
checkCanceled
in interface NodeProgressMonitor
CanceledExecutionException
- If the execution of the
NodeModel
has been canceled during execute.public String getMessage()
getMessage
in interface NodeProgressMonitor
public Double getProgress()
null
if no progress available.
getProgress
in interface NodeProgressMonitor
null
.public void reset()
reset
in interface NodeProgressMonitor
public void removeAllProgressListener()
removeAllProgressListener
in interface NodeProgressMonitor
NodeProgressMonitor.removeAllProgressListener()
public void removeProgressListener(NodeProgressListener l)
removeProgressListener
in interface NodeProgressMonitor
l
- The progress listener to remove.public void setExecuteCanceled()
setExecuteCanceled
in interface NodeProgressMonitor
public void setMessage(String message)
setMessage
in interface NodeProgressMonitor
message
- A convenience message shown in the progress monitor.NodeProgressMonitor.setProgress(String)
public void setProgress(String message)
setProgress
in interface NodeProgressMonitor
message
- A convenience message shown in the progress monitor.void setProgress(String message, boolean append)
message
- new messageappend
- whether to appendvoid appendMessage(String append)
append
- Message to appendpublic void setProgress(double progress, String message)
setProgress
in interface NodeProgressMonitor
progress
- The value between 0 and 1.message
- A convenience message shown in the progress monitor or
null
.public void setProgress(double progress)
setProgress
in interface NodeProgressMonitor
progress
- The value between 0 and 1.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |