org.knime.core.node.workflow
Class ConnectionProgress

java.lang.Object
  org.knime.core.node.workflow.ConnectionProgress

public final class ConnectionProgress
extends Object

Contained in a ConnectionProgressEvent which is fired when the progress information has changed.

Constructor Summary

ConnectionProgress(boolean inProgress, String message)
Create a progress event based on progress value and message.

Method Summary

String	getMessage() Returns the current progress message or null to display nothing.
boolean	hasMessage() Returns whether there is currently a message to display.
boolean	inProgress()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConnectionProgress

public ConnectionProgress(boolean inProgress,
                          String message)

Create a progress event based on progress value and message.

Parameters:

inProgress - true if currently in-progress.

message - the message to display (or null to display nothing)

Method Detail

inProgress

public boolean inProgress()

Returns:

whether we are currently in-progress. Within the UI, this determines whether we show the lines as dashed or solid. (If dashed, the lines are also animated, stepping with each event).

getMessage

public String getMessage()

Returns the current progress message or null to display nothing.

Returns:

current progress message or null to display nothing.

hasMessage

public boolean hasMessage()

Returns whether there is currently a message to display.

Returns:

whether there is currently a message to display.