Class f_subProgressMonitor

Object
  f_object
      f_progressMonitor
          f_subProgressMonitor

public class f_subProgressMonitor
extends f_progressMonitor

Classe SubProgressMonitor

Field Summary

static Number	PREPEND_MAIN_LABEL_TO_SUBTASK Style constant indicating that the main task label should be prepended to the subtask label.
static Number	SUPPRESS_SUBTASK_LABEL Style constant indicating that calls to subTask should not have any effect.

Fields inherited from class f_progressMonitor

UNKNOWN

Method Summary

void	f_cancel() Cancel the progress monitor.
void	f_done() Notifies that the work is done; that is, either the main task is completed or the user canceled it.
boolean	f_isCanceled() Returns whether cancelation of current operation has been requested.
void	f_setTaskName(String name) Sets the task name to the given value.
void	f_subTask(String name) Notifies that a subtask of the main task is beginning.

Methods inherited from class f_progressMonitor

f_beginTask, f_cancel, f_done, f_isCanceled, f_setTaskName, f_subTask, f_worked

Methods inherited from class f_object

f_getClass, toString

Methods inherited from class Object

toString

Field Detail

SUPPRESS_SUBTASK_LABEL

public static final Number SUPPRESS_SUBTASK_LABEL

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

See Also:

#SubProgressMonitor(IProgressMonitor,int,int)

PREPEND_MAIN_LABEL_TO_SUBTASK

public static final Number 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)

Method Detail

f_done

public void f_done()

Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).

Overrides:

f_done in class f_progressMonitor

f_cancel

public void f_cancel()

Cancel the progress monitor.

Overrides:

f_cancel in class f_progressMonitor

See Also:

#isCanceled()

f_subTask

public void f_subTask(String name)

Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.

Overrides:

f_subTask in class f_progressMonitor

Parameters:

name - the name (or description) of the subtask

f_setTaskName

public void f_setTaskName(String name)

Sets the task name to the given value. This method is used to restore the task label after a nested operation was executed. Normally there is no need for clients to call this method.

Overrides:

f_setTaskName in class f_progressMonitor

Parameters:

name - the name (or description) of the main task

See Also:

#beginTask(java.lang.String,

f_isCanceled

public boolean f_isCanceled()

Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.

Overrides:

f_isCanceled in class f_progressMonitor

Returns:

true if cancellation has been requested, and false otherwise

See Also:

#setCanceled(boolean)