|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WaitingHandler
An interface for code dealing with how to handle information that is displayed to the user during loading or processing.
Field Summary | |
---|---|
static SimpleDateFormat |
sdf
Convenience date format. |
static String |
tab
The tab space to add when using tab. |
Method Summary | |
---|---|
void |
appendReport(String report,
boolean includeDate,
boolean addNewLine)
Append text to the report. |
void |
appendReportEndLine()
Append a new line to the report. |
void |
appendReportNewLineNoDate()
Append two tabs to the report. |
int |
getMaxPrimaryProgressCounter()
Returns the max primary progress counter. |
int |
getMaxSecondaryProgressCounter()
Returns the max secondary progress counter. |
int |
getPrimaryProgressCounter()
Returns the primary progress counter. |
int |
getSecondaryProgressCounter()
Returns the secondary progress counter. |
void |
increasePrimaryProgressCounter()
Increase the primary progress counter by one "counter". |
void |
increasePrimaryProgressCounter(int increment)
Increase the primary progress counter by the given increment. |
void |
increaseSecondaryProgressCounter()
Increase the secondary progress counter by one "counter". |
void |
increaseSecondaryProgressCounter(int amount)
Increase the secondary progress counter by the given amount. |
boolean |
isReport()
Indicates whether this waiting handler supports reports. |
boolean |
isRunCanceled()
Returns true if the run is canceled. |
boolean |
isRunFinished()
Returns true if the process is finished. |
void |
resetPrimaryProgressCounter()
Reset the primary progress counter to 0. |
void |
resetSecondaryProgressCounter()
Reset the secondary progress counter to 0. |
void |
setMaxPrimaryProgressCounter(int maxProgressValue)
Set the maximum value for the primary progress counter. |
void |
setMaxSecondaryProgressCounter(int maxProgressValue)
Set the maximum value for the secondary progress counter. |
void |
setPrimaryProgressCounterIndeterminate(boolean indeterminate)
Sets whether the primary progress counter is indeterminate or not. |
void |
setRunCanceled()
Set the process as canceled. |
void |
setRunFinished()
Set the process as finished. |
void |
setSecondaryProgressCounter(int value)
Sets the secondary progress counter to the given value. |
void |
setSecondaryProgressCounterIndeterminate(boolean indeterminate)
Sets the secondary progress counter to indeterminate or not. |
void |
setSecondaryProgressText(String text)
Set the secondary progress counter text. |
void |
setWaitingText(String text)
Sets the text describing what is currently being waited for. |
Field Detail |
---|
static final SimpleDateFormat sdf
static final String tab
Method Detail |
---|
void setPrimaryProgressCounterIndeterminate(boolean indeterminate)
indeterminate
- a boolean indicating whether the primary progress
counter is indeterminate or notvoid setMaxPrimaryProgressCounter(int maxProgressValue)
maxProgressValue
- the max valuevoid increasePrimaryProgressCounter()
void increasePrimaryProgressCounter(int increment)
increment
- the increment to increase the value byvoid setMaxSecondaryProgressCounter(int maxProgressValue)
maxProgressValue
- the max valuevoid resetPrimaryProgressCounter()
void resetSecondaryProgressCounter()
void increaseSecondaryProgressCounter()
void setSecondaryProgressCounter(int value)
value
- the progress valuevoid increaseSecondaryProgressCounter(int amount)
amount
- the amount to increase the value byvoid setSecondaryProgressCounterIndeterminate(boolean indeterminate)
indeterminate
- if true, set to indeterminatevoid setRunFinished()
void setRunCanceled()
void appendReport(String report, boolean includeDate, boolean addNewLine)
report
- the text to appendincludeDate
- if the date and time is to be added to the front of
the textaddNewLine
- add a new line after the text?void appendReportNewLineNoDate()
void appendReportEndLine()
boolean isRunCanceled()
boolean isRunFinished()
void setSecondaryProgressText(String text)
text
- the text to setboolean isReport()
void setWaitingText(String text)
text
- a text describing what is currently waited forint getPrimaryProgressCounter()
int getMaxPrimaryProgressCounter()
int getSecondaryProgressCounter()
int getMaxSecondaryProgressCounter()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |