TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.tools.internal
Class SimpleProgressMonitor

java.lang.Object
  extended by org.eclipse.tptp.platform.report.tools.internal.SimpleProgressMonitor
All Implemented Interfaces:
IDProgressMonitor
Direct Known Subclasses:
SWTViewer.ViewerProgressMonitor

Deprecated. As of TPTP 4.5.0, use the TPTP Business Intelligence and Reporting Tools (BIRT) reporting infrastructure (org.eclipse.tptp.platform.report.birt).

public class SimpleProgressMonitor
extends java.lang.Object
implements IDProgressMonitor

This class provides a progress monitor which do nothing


Field Summary
 
Fields inherited from interface org.eclipse.tptp.platform.report.tools.internal.IDProgressMonitor
UNKNOWN
 
Constructor Summary
SimpleProgressMonitor()
          Deprecated.  
 
Method Summary
 void beginTask(java.lang.String name, int total_works)
          Deprecated. Start a task identified with a name, total_works can be UNKNOWN
 void done()
          Deprecated. free any resource held by task, can be called more than once
 java.lang.String getTaskName()
          Deprecated.  
 int getTotalWorks()
          Deprecated.  
 int getWorkCount()
          Deprecated.  
 boolean isCanceled()
          Deprecated.  
 boolean isInProgress()
          Deprecated.  
 void setCanceled(boolean value)
          Deprecated. Request a cancel of current task.
 void setTotalWorks(int tw)
          Deprecated. sets the total work
 void worked(int work)
          Deprecated. advance current progress by work amount
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SimpleProgressMonitor

public SimpleProgressMonitor()
Deprecated. 
Method Detail

beginTask

public void beginTask(java.lang.String name,
                      int total_works)
Deprecated. 
Description copied from interface: IDProgressMonitor
Start a task identified with a name, total_works can be UNKNOWN

Specified by:
beginTask in interface IDProgressMonitor

done

public void done()
Deprecated. 
Description copied from interface: IDProgressMonitor
free any resource held by task, can be called more than once

Specified by:
done in interface IDProgressMonitor

isCanceled

public boolean isCanceled()
Deprecated. 
Specified by:
isCanceled in interface IDProgressMonitor
Returns:
true if a cancel of task was requested

setCanceled

public void setCanceled(boolean value)
Deprecated. 
Description copied from interface: IDProgressMonitor
Request a cancel of current task. Task must take into account this request as soon as possible

Specified by:
setCanceled in interface IDProgressMonitor

worked

public void worked(int work)
Deprecated. 
Description copied from interface: IDProgressMonitor
advance current progress by work amount

Specified by:
worked in interface IDProgressMonitor

getWorkCount

public int getWorkCount()
Deprecated. 
Specified by:
getWorkCount in interface IDProgressMonitor
Returns:
the total work count

setTotalWorks

public void setTotalWorks(int tw)
Deprecated. 
Description copied from interface: IDProgressMonitor
sets the total work

Specified by:
setTotalWorks in interface IDProgressMonitor

getTotalWorks

public int getTotalWorks()
Deprecated. 
Specified by:
getTotalWorks in interface IDProgressMonitor
Returns:
the total work

isInProgress

public boolean isInProgress()
Deprecated. 
Specified by:
isInProgress in interface IDProgressMonitor
Returns:
true if the progress is starting and not finishing

getTaskName

public java.lang.String getTaskName()
Deprecated. 
Specified by:
getTaskName in interface IDProgressMonitor
Returns:
the task name

TPTP 4.5.0 Platform Project
Internal API Specification