Package io.github.jonestimd.swing
Interface StatusIndicator
-
- All Known Implementing Classes:
DeferredStatusIndicator
,ExceptionDialog
,FormDialog
,LoggerStatusIndicator
,MessageDialog
,StatusFrame
,ValidatedDialog
public interface StatusIndicator
An interface for providing UI feedback while a background task is running.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description void
disableUI(java.lang.String message)
Disable the UI while a background task is running.void
enableUI()
Enable the UI after a background task has completed.static StatusIndicator
forComponent(java.awt.Component component)
Get or create a status indicator for a component.void
setStatusMessage(java.lang.String message)
Change the status message to indicate the progress of a background task.
-
-
-
Method Detail
-
setStatusMessage
void setStatusMessage(java.lang.String message)
Change the status message to indicate the progress of a background task.
-
disableUI
void disableUI(java.lang.String message)
Disable the UI while a background task is running.- Parameters:
message
- the message to display to the user while the task is running.
-
enableUI
void enableUI()
Enable the UI after a background task has completed.
-
forComponent
static StatusIndicator forComponent(java.awt.Component component)
Get or create a status indicator for a component. This method should only be called from the Swing event dispatch thread.- Returns:
- the ancestor
StatusIndicator
, aDeferredStatusIndicator
if the component is not showing orLoggerStatusIndicator.INSTANCE
-
-