Eclipse Plug-in Developer Guide (Galileo) - SubProgressMonitor (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.core.runtime
Class SubProgressMonitor


java.lang.Object
  

org.eclipse.core.runtime.ProgressMonitorWrapper
      
org.eclipse.core.runtime.SubProgressMonitor

All Implemented Interfaces:: IProgressMonitor, IProgressMonitorWithBlocking

public class SubProgressMonitor
extends ProgressMonitorWrapper
extends ProgressMonitorWrapper

For new implementations consider using SubMonitor. A progress monitor that uses a given amount of work ticks from a parent monitor. It can be used as follows:

     try {
         pm.beginTask("Main Task", 100);
         doSomeWork(pm, 30);
         SubProgressMonitor subMonitor= new SubProgressMonitor(pm, 40);
         try {
             subMonitor.beginTask("", 300);
             doSomeWork(subMonitor, 300);
         } finally {
             subMonitor.done();
         }
         doSomeWork(pm, 30);
     } finally {
         pm.done();
     }

This class can be used without OSGi running.

This class may be instantiated or subclassed by clients.

See Also:: SubMonitor

Field Summary

static int PREPEND_MAIN_LABEL_TO_SUBTASK
          Style constant indicating that the main task label should be prepended to the subtask label.

static int SUPPRESS_SUBTASK_LABEL
          Style constant indicating that calls to subTask should not have any effect.

Fields inherited from interface org.eclipse.core.runtime. IProgressMonitor

UNKNOWN

Constructor Summary

SubProgressMonitor ( IProgressMonitor monitor, int ticks)
          Creates a new sub-progress monitor for the given monitor.

SubProgressMonitor ( IProgressMonitor monitor, int ticks, int style)
          Creates a new sub-progress monitor for the given monitor.

Method Summary

void beginTask ( String name, int totalWork)
          This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.

void done ()
          This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.

void internalWorked (double work)
          This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.

void subTask ( String name)
          This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.

void worked (int work)
          This implementation of a IProgressMonitor method forwards to the wrapped progress monitor.

Methods inherited from class org.eclipse.core.runtime. ProgressMonitorWrapper

clearBlocked, getWrappedProgressMonitor, isCanceled, setBlocked, setCanceled, setTaskName

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUPPRESS_SUBTASK_LABEL

public static final int SUPPRESS_SUBTASK_LABEL

Style constant indicating that calls to subTask should not have any effect.

See Also:: SubProgressMonitor(IProgressMonitor,int,int), Constant Field Values

PREPEND_MAIN_LABEL_TO_SUBTASK

public static final int PREPEND_MAIN_LABEL_TO_SUBTASK

Style constant indicating that the main task label should be prepended to the subtask label.

See Also:: SubProgressMonitor(IProgressMonitor,int,int), Constant Field Values

Constructor Detail

SubProgressMonitor

public SubProgressMonitor(
IProgressMonitor monitor,
                          int ticks)

Creates a new sub-progress monitor for the given monitor. The sub progress monitor uses the given number of work ticks from its parent monitor.

Parameters:: monitor - the parent progress monitor; ticks - the number of work ticks allocated from the parent monitor

SubProgressMonitor

public SubProgressMonitor(
IProgressMonitor monitor,
                          int ticks,
                          int style)

Creates a new sub-progress monitor for the given monitor. The sub progress monitor uses the given number of work ticks from its parent monitor.

Parameters:

monitor - the parent progress monitor

ticks - the number of work ticks allocated from the parent monitor

style - one of

SUPPRESS_SUBTASK_LABEL
PREPEND_MAIN_LABEL_TO_SUBTASK

Method Detail