public interface WaitingHandler
Modifier and Type | Field and Description |
---|---|
static SimpleDateFormat |
sdf
Convenience date format.
|
static String |
tab
The tab space to add when using tab.
|
Modifier and Type | Method and Description |
---|---|
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.
|
void |
displayHtmlMessage(JEditorPane messagePane,
String title,
int messageType)
Display a given HTML containing message to the user separately from the
main output.
|
void |
displayMessage(String message,
String title,
int messageType)
Display a given message to the user separately from the main output.
|
JProgressBar |
getPrimaryProgressBar()
Returns the primary progress bar for updates from external processes.
|
JProgressBar |
getSecondaryProgressBar()
Returns the secondary progress bar for updates from external processes.
|
void |
increaseProgressValue()
Increase the progress bar value by one "counter".
|
void |
increaseProgressValue(int increment)
Increase the progress bar value by the given number.
|
void |
increaseSecondaryProgressValue()
Increase the secondary progress bar value by one "counter".
|
void |
increaseSecondaryProgressValue(int amount)
Increase the secondary progress bar value by the given amount.
|
boolean |
isRunCanceled()
Returns true if the run is canceled.
|
boolean |
isRunFinished()
Returns true if the run is finished.
|
void |
resetSecondaryProgressBar()
Reset the secondary progress bar value to 0.
|
void |
setIndeterminate(boolean indeterminate)
Sets whether the primary progress bar is indeterminate or not.
|
void |
setMaxProgressValue(int maxProgressValue)
Set the maximum value of the progress bar.
|
void |
setMaxSecondaryProgressValue(int maxProgressValue)
Set the maximum value of the secondary progress bar.
|
void |
setRunCanceled()
Set the analysis as canceled.
|
void |
setRunFinished()
Set the analysis as finished.
|
void |
setSecondaryProgressDialogIndeterminate(boolean indeterminate)
Sets the secondary progress bar to indeterminate or not.
|
void |
setSecondaryProgressValue(int value)
Sets the secondary progress bar to the given value.
|
void |
setWaitingText(String text)
Sets the text describing what is currently waited for.
|
static final SimpleDateFormat sdf
static final String tab
void setIndeterminate(boolean indeterminate)
indeterminate
- a boolean indicating whether the primary progress
bar shall be indeterminate or notvoid setMaxProgressValue(int maxProgressValue)
maxProgressValue
- the max valuevoid increaseProgressValue()
void increaseProgressValue(int increment)
increment
- the increment to increase the value byvoid setMaxSecondaryProgressValue(int maxProgressValue)
maxProgressValue
- the max valuevoid resetSecondaryProgressBar()
void increaseSecondaryProgressValue()
void setSecondaryProgressValue(int value)
value
- the progress valuevoid increaseSecondaryProgressValue(int amount)
amount
- the amount to increase the value byvoid setSecondaryProgressDialogIndeterminate(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()
JProgressBar getSecondaryProgressBar()
JProgressBar getPrimaryProgressBar()
void displayMessage(String message, String title, int messageType)
message
- the message to displaytitle
- the title of the messagemessageType
- the message type in the, e.g.,
JOptionPane.INFORMATION_MESSAGEvoid displayHtmlMessage(JEditorPane messagePane, String title, int messageType)
messagePane
- title
- messageType
- void setWaitingText(String text)
text
- a text describing what is currently waited forCopyright © 2013. All Rights Reserved.