ui
Interface Status

All Known Implementing Classes:
SysTrayMain

public interface Status

The status interface provides common methods for reporting an objects progress and description. The common Status object to use is the StatusBar object.


Method Summary
 boolean isCancelled()
          Returns a boolean value for whether or not the object reporting a status has been cancelled.
 void resetStatus()
          Resets the status object.
 void setBackgroundText(java.lang.String str)
          The string displaying the current background monitoring status.
 void setIndeterminateProgress(boolean b)
          Sets the reported progress of a task to an indeterminate length either on or off.
 void setProgress(int progress)
          The current progress of a running a task from 0 - 100.
 void setStatusText(java.lang.String str)
          The text string diplaying the current status of a task.
 

Method Detail

setStatusText

void setStatusText(java.lang.String str)
The text string diplaying the current status of a task.

Parameters:
str - The text string displaying the current status of a task.

setBackgroundText

void setBackgroundText(java.lang.String str)
The string displaying the current background monitoring status.

Parameters:
str - The string displaying the current background monitoring status.

setProgress

void setProgress(int progress)
The current progress of a running a task from 0 - 100.

Parameters:
progress - The current progress of a running a task from 0 - 100.

setIndeterminateProgress

void setIndeterminateProgress(boolean b)
Sets the reported progress of a task to an indeterminate length either on or off.

Parameters:
b - Sets the progress of a task to an indeterminate length of time to either on or off.

resetStatus

void resetStatus()
Resets the status object.


isCancelled

boolean isCancelled()
Returns a boolean value for whether or not the object reporting a status has been cancelled.

Returns:
If true, the object reporting status has been cancelled.