Qizx/open API

net.axyana.qizxopen.util
Interface ProgressHandler


public interface ProgressHandler

Measures the progress of a time-consuming task and optionally allows to cancel it.


Method Summary
 void finishTask()
          Signals end of task.
 void fractionDone(double fraction)
          signals progress as a fraction between 0 and 1.
 boolean isCancelled()
          Tests whether the task is cancelled.
 void quantityDone(long size)
          signals progress as an estimated size: it is up to the client code to convert it to a fraction.
 void startTask(java.lang.String taskName, java.lang.String taskArgument)
          Starts a new task (name and arguments are application dependent).
 

Method Detail

startTask

public void startTask(java.lang.String taskName,
                      java.lang.String taskArgument)
Starts a new task (name and arguments are application dependent).


fractionDone

public void fractionDone(double fraction)
signals progress as a fraction between 0 and 1.


quantityDone

public void quantityDone(long size)
signals progress as an estimated size: it is up to the client code to convert it to a fraction.


finishTask

public void finishTask()
Signals end of task.


isCancelled

public boolean isCancelled()
Tests whether the task is cancelled.


© 2005 Axyana Software