ag.ion.noa4e.ui.operations
Class OfficeProgressMonitor

java.lang.Object
  ag.ion.noa4e.ui.operations.OfficeProgressMonitor

All Implemented Interfaces:

IOfficeProgressMonitor

public class OfficeProgressMonitor
extends java.lang.Object
implements IOfficeProgressMonitor

Progress monitor for the office layer. This office progress monitor can be used in order to wrap an Eclipse IProgressMonitor.

Field Summary

Fields inherited from interface ag.ion.bion.officelayer.runtime.IOfficeProgressMonitor

WORK_UNKNOWN

Constructor Summary

OfficeProgressMonitor(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Constructs new OfficeProgressMonitor.

Method Summary

void	beginSubTask(java.lang.String name) Informs the monitor about a new subtask.
void	beginTask(java.lang.String name, int totalWork) Informs the monitor about a new task.
void	done() Informs the progress monitor that the work is done.
boolean	isCanceled() Returns information whether the work was canceled.
boolean	needsDone() Returns information whether the progress monitor needs to be notified about the end of the main task.
void	setCanceled(boolean canceled) Sets information whether the work was canceled.
void	worked(int work) Notifies that a given number of work unit of the main task has been completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

OfficeProgressMonitor

public OfficeProgressMonitor(org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Constructs new OfficeProgressMonitor.

Parameters:

progressMonitor - progress monitor to be used

Method Detail

beginTask

public void beginTask(java.lang.String name,
                      int totalWork)

Informs the monitor about a new task.

Specified by:

beginTask in interface IOfficeProgressMonitor

Parameters:

name - name of the task

totalWork - total work of the task

worked

public void worked(int work)

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 IOfficeProgressMonitor

Parameters:

work - the number of work units just completed

beginSubTask

public void beginSubTask(java.lang.String name)

Informs the monitor about a new subtask.

Specified by:

beginSubTask in interface IOfficeProgressMonitor

Parameters:

name - name of the substask

needsDone

public boolean needsDone()

Returns information whether the progress monitor needs to be notified about the end of the main task.

Specified by:

needsDone in interface IOfficeProgressMonitor

Returns:

information whether the progress monitor needs to be notified about the end of the main task

done

public void done()

Informs the progress monitor that the work is done.

Specified by:

done in interface IOfficeProgressMonitor

setCanceled

public void setCanceled(boolean canceled)

Sets information whether the work was canceled.

Specified by:

setCanceled in interface IOfficeProgressMonitor

Parameters:

canceled - information whether the work was canceled

isCanceled

public boolean isCanceled()

Returns information whether the work was canceled.

Specified by:

isCanceled in interface IOfficeProgressMonitor

Returns:

information whether the work was canceled