com.netphantom.eclipse

Interface IProgressMonitor

All Superinterfaces:

ICancel

All Known Subinterfaces:

IFeedBack

All Known Implementing Classes:

ProgressMonitor

public interface IProgressMonitor
extends ICancel

Interface that provides feedback to current operation, e.g. at load, compile or build.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
static IProgressMonitor	NULL_MONITOR A Null monitor.

Fields inherited from interface com.netphantom.eclipse.ICancel

NO_CANCEL

Method Summary

Modifier and Type	Method and Description
void	beginTask(String text, int count) Begins work.
void	done() Completed work.
IProgressMonitor	getSubMonitor() Gets a sub-monitor of one work unit in parent.
IProgressMonitor	getSubMonitor(int count) Gets a sub-operation that takes a certain amount of work units in parent.
void	setTaskName(String name) Sets the task name.
void	subTask(String name) Sets the subtask name.
void	worked() A work unit is done.
void	worked(int count) Some work units are done.
void	worked(int count, String text) Some work units are done, sets text for next operation.
void	worked(String text) A work unit is done, sets text for next operation.

Methods inherited from interface com.netphantom.eclipse.ICancel

isCanceled

Field Detail

NULL_MONITOR

static final IProgressMonitor NULL_MONITOR

A Null monitor.

Method Detail

beginTask

void beginTask(String text,
               int count)

Begins work.

setTaskName

void setTaskName(String name)

Sets the task name.

subTask

void subTask(String name)

Sets the subtask name.

worked

void worked()

A work unit is done.

worked

void worked(String text)

A work unit is done, sets text for next operation.

worked

void worked(int count)

Some work units are done.

worked

void worked(int count,
            String text)

Some work units are done, sets text for next operation.

getSubMonitor

IProgressMonitor getSubMonitor()

Gets a sub-monitor of one work unit in parent.

getSubMonitor

IProgressMonitor getSubMonitor(int count)

Gets a sub-operation that takes a certain amount of work units in parent.

done

void done()

Completed work.