oracle.ide.controls
Interface ProgressTrackedTask

All Superinterfaces:

java.lang.Runnable

public interface ProgressTrackedTask
extends java.lang.Runnable

A ProgressTrackedTask is a background task which wants the IDE to indicate it's progress in the status bar area. This interface provides the methods necessary for the IDE to present the user with a useful indicator of progress.

For more information about implementing a ProgressTrackedTask see the examples in ProgressTracker

Method Summary

java.lang.String	getCurrentText() Used to set a textual string in the status bar.
int	getCurrentValue() Used for determinate tasks to get the current task completion status.
int	getMaximum() Used for determinate tasks to get the maximum range for the value returned by getCurrentValue()
int	getMinimum() Used for determinate tasks to get the minimum range for the value returned by getCurrentValue()
java.lang.String	getTaskDescription() Used to provide a name for the task.
boolean	isIndeterminate() Used to determine if a task is determiniate or indeterminate

Methods inherited from interface java.lang.Runnable

run

Method Detail

isIndeterminate

boolean isIndeterminate()

Used to determine if a task is determiniate or indeterminate

Returns:

true of the task is indeterminate; false if it is determinate

getCurrentValue

int getCurrentValue()

Used for determinate tasks to get the current task completion status. getCurrentValue() should always return a value in the range of getMinimum() and getMaximum()

Returns:

the current completion status of the task

getMinimum

int getMinimum()

Used for determinate tasks to get the minimum range for the value returned by getCurrentValue()

Returns:

the minumum range value

getMaximum

int getMaximum()

Used for determinate tasks to get the maximum range for the value returned by getCurrentValue()

Returns:

the maximum range value

getCurrentText

java.lang.String getCurrentText()

Used to set a textual string in the status bar. This can be used by either determinate or indeterminate tasks. When the task does not provide textual status then return null. When multiple tasks are running no textual representation will be shown in the progress bar.

Returns:

the string to show in the progress bar

getTaskDescription

java.lang.String getTaskDescription()

Used to provide a name for the task.

Returns:

the name of the task