| org.swingml.task.monitoring.ITaskMonitor
All known Subclasses: org.swingml.component.StatusBar, org.swingml.task.monitoring.TaskMonitorDialog, org.swingml.task.monitoring.NullTaskMonitor,
| ITaskMonitor | | public interface ITaskMonitor (Code) | | Monitor passed in to tasks so that they can report progress on their behavior.
author:
CrossLogic |
| Method Summary | |
| void | beginTask(ITask task)
Should only be called once, at the start of the task. | | void | endTask(ITask task)
Should only be called once, at the end of the task. | | void | progressMade(ITask task)
| | void | progressMade(ITask task, int ticks)
Reports that 'ticks' units of work have been completed since the last report. | | void | progressMade(ITask task, String aMessage)
Reports that 1 'tick' of progress was made, but also provides a message to display. | | void | progressMade(ITask task, int ticks, String aMessage)
Reports that 'ticks' units of work have been completed, but also provides a message to display. | | void | setMessage(ITask task, String aMessage)
Displays the given notification message to the UI. |
| beginTask | | void beginTask(ITask task)(Code) | | Should only be called once, at the start of the task. Reports the name of the task to execute, and the number of ticks it will take to complete.
Parameters:
name -
Parameters:
totalTicks - |
| endTask | | void endTask(ITask task)(Code) | | Should only be called once, at the end of the task.
|
| progressMade | | void progressMade(ITask task, int ticks)(Code) | | Reports that 'ticks' units of work have been completed since the last report. This value is not absolute, but is relative to the last call.
Parameters:
ticks - |
| progressMade | | void progressMade(ITask task, String aMessage)(Code) | | Reports that 1 'tick' of progress was made, but also provides a message to display.
Parameters:
message - |
| progressMade | | void progressMade(ITask task, int ticks, String aMessage)(Code) | | Reports that 'ticks' units of work have been completed, but also provides a message to display.
Parameters:
message - |
| setMessage | | void setMessage(ITask task, String aMessage)(Code) | | Displays the given notification message to the UI.
Parameters:
message - |
|
|