ag.ion.bion.officelayer.runtime
Interface IOfficeProgressMonitor

All Known Implementing Classes:

OfficeProgressMonitor

public interface IOfficeProgressMonitor

Progress monitor of the office layer.

Field Summary

static int

WORK_UNKNOWN The work of a task is unknown.

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.

Field Detail

WORK_UNKNOWN

static final int WORK_UNKNOWN

The work of a task is unknown.

See Also:

Constant Field Values

Method Detail

beginTask

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

Informs the monitor about a new task.

Parameters:

name - name of the task

totalWork - total work of the task

worked

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.

Parameters:

work - the number of work units just completed

beginSubTask

void beginSubTask(java.lang.String name)

Informs the monitor about a new subtask.

Parameters:

name - name of the substask

needsDone

boolean needsDone()

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

Returns:

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

done

void done()

Informs the progress monitor that the work is done.

setCanceled

void setCanceled(boolean canceled)

Sets information whether the work was canceled.

Parameters:

canceled - information whether the work was canceled

isCanceled

boolean isCanceled()

Returns information whether the work was canceled.

Returns:

information whether the work was canceled