Constructor Detail

• ProgressMonitorWrapper

  public ProgressMonitorWrapper(ProgressMonitor monitor)

  Creates a new wrapper around the given monitor.

  Parameters:

  monitor - the progress monitor to forward to.

Method Detail

• getWrappedProgressMonitor

  public ProgressMonitor getWrappedProgressMonitor()

  Returns the wrapped progress monitor.

  Returns:

  the wrapped progress monitor.

• beginTask

  public void beginTask(String name,
                        int totalWork)

  Description copied from interface: ProgressMonitor
  Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.

  Specified by:

  beginTask in interface ProgressMonitor

  Parameters:

  name - the name (or description) of the main task

  totalWork - the total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.

• done

  public void done()

  Description copied from interface: ProgressMonitor
  Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).

  Specified by:

  done in interface ProgressMonitor

• internalWorked

  public void internalWorked(double work)

  Description copied from interface: ProgressMonitor
  Internal method to handle scaling correctly. This method must not be called by a client. Clients should always use the method worked(int).

  Specified by:

  internalWorked in interface ProgressMonitor

  Parameters:

  work - the amount of work done

• isCanceled

  public boolean isCanceled()

  Description copied from interface: ProgressMonitor
  Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

  Specified by:

  isCanceled in interface ProgressMonitor

  Returns:

  true if cancellation has been requested, and false otherwise

  See Also:

  ProgressMonitor.setCanceled(boolean)

• setCanceled

  public void setCanceled(boolean value)

  Description copied from interface: ProgressMonitor
  Sets the cancel state to the given value.

  Specified by:

  setCanceled in interface ProgressMonitor

  Parameters:

  value - true indicates that cancelation has been requested (but not necessarily acknowledged); false clears this flag

  See Also:

  ProgressMonitor.isCanceled()

• setTaskName

  public void setTaskName(String name)

  Description copied from interface: ProgressMonitor
  Sets the task name to the given value. This method is used to restore the task label after a nested operation was executed. Normally there is no need for clients to call this method.

  Specified by:

  setTaskName in interface ProgressMonitor

  Parameters:

  name - the name (or description) of the main task

  See Also:

  ProgressMonitor.beginTask(java.lang.String, int)

• subTask

  public void subTask(String name)

  Description copied from interface: ProgressMonitor
  Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.

  Specified by:

  subTask in interface ProgressMonitor

  Parameters:

  name - the name (or description) of the subtask

• worked

  public void worked(int work)

  Description copied from interface: ProgressMonitor
  Notifies that a given number of work unit of the main task has been completed. Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.

  Specified by:

  worked in interface ProgressMonitor

  Parameters:

  work - the number of work units just completed