Class FWProgressTaskEvent
java.lang.Object
net.simplace.pipe.progress.FWProgressTaskEvent
Event sent to
FWProgressTaskListeners when the state of a progress task changes. An event without task
(null) is sent when a pipeline run has ended.- Author:
- Andreas Enders
-
Constructor Summary
ConstructorsConstructorDescriptionFWProgressTaskEvent(FWProgressTask aTaskObject, JPanel aSourcePanel) FWProgressTaskEvent(FWProgressTask aTaskObject, JPanel aSourcePanel, net.simplace.core.FWObservable aObservable) -
Method Summary
Modifier and TypeMethodDescriptionintnet.simplace.core.FWObservableintgetState()booleanvoidsetSourcePanel(JPanel aSourcePanel) toString()
-
Constructor Details
-
FWProgressTaskEvent
public FWProgressTaskEvent(FWProgressTask aTaskObject, JPanel aSourcePanel, net.simplace.core.FWObservable aObservable) - Parameters:
aTaskObject- the task whose state changed, ornullat the end of a runaSourcePanel- panel to show in the progress view, ornullaObservable- parameters used to replace tokens in the message, ornull
-
FWProgressTaskEvent
- Parameters:
aTaskObject- the task whose state changed, ornullat the end of a runaSourcePanel- panel to show in the progress view, ornull
-
-
Method Details
-
isState
- Parameters:
aProgressState- a state, one of the constants inFWProgressTask.State- Returns:
trueif the task is in the given state
-
getProgressTask
- Returns:
- the task, or
nullat the end of a run
-
getState
- Returns:
- state of progressTask
-
getPercentOfTaskDone
public int getPercentOfTaskDone()- Returns:
- progress of the task in percent (0-100)
-
toString
-
getNumberOfTask
public int getNumberOfTask()- Returns:
- position of the task in the range of tasks, or 0 without task
-
getSourcePanel
- Returns:
- the sourcePanel
-
setSourcePanel
- Parameters:
aSourcePanel- panel to show in the progress view
-
getObservable
public net.simplace.core.FWObservable getObservable()- Returns:
- the parameters of the event, or
null
-