Package editor.util
Class ProgressFeedback
java.lang.Object
editor.util.ProgressFeedback
- All Implemented Interfaces:
IProgressCallback
,ActionListener
,EventListener
A helper class for displaying a
ProgressWindow
while a task
executes in a worker thread.-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private boolean
private boolean
private boolean
private String
private int
private int
private ProgressPanel
private ProgressWindow
private String
private Timer
private static final int
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ProgressFeedback
(String strNotice, boolean bHideAbortButton, boolean bShowInStudioGlassPane) Construct a ProgressFeedback with a given text notice. -
Method Summary
Modifier and TypeMethodDescriptionvoid
(package private) void
dispose()
Hides and disposes theProgressWindow
.int
boolean
incrementProgress
(String strMessage, String... args) boolean
isAbort()
Should the operation abort?void
Signals that the operation is completestatic <T> T
runWithPossibleDialog
(Callable<T> callable, String message) protected static ProgressFeedback
runWithProgress
(IRunnableWithProgress task, ProgressFeedback progressFeedback) static ProgressFeedback
runWithProgress
(String strNotice, IRunnableWithProgress task) A helper method that executes a task in a worker thread and displays feedback in a progress windows.static ProgressFeedback
runWithProgress
(String strNotice, IRunnableWithProgress task, boolean bHideAbortBtn) static ProgressFeedback
runWithProgress
(String strNotice, IRunnableWithProgress task, boolean bHideAbortBtn, boolean bShowInStudioGlassPane) private void
setCurrentMessage
(String strMessage, String[] args) void
setLength
(int iLength) How long is this operation in units? For a StagedProgressFeedback, this moves to the next stageprivate static boolean
shortWait
(long delay, boolean[] done) private void
private void
boolean
updateProgress
(int iProgress, String strMessage, String... args) Call this when a unit of progress completes.boolean
updateProgress
(String strMessage, String... args) Call this to update the progress message without modifying the amount of progress completed.private static void
waitForProgress
(boolean[] done)
-
Field Details
-
UPDATE_DELAY
private static final int UPDATE_DELAY- See Also:
-
_strNotice
-
_pp
-
_pw
-
_bAbort
private boolean _bAbort -
_bHideAbortButton
private boolean _bHideAbortButton -
_bShowInStudioGlassPane
private boolean _bShowInStudioGlassPane -
_currentMessage
-
_currentValue
private int _currentValue -
_length
private int _length -
_changeLength
private boolean _changeLength -
_timer
-
-
Constructor Details
-
ProgressFeedback
protected ProgressFeedback(String strNotice, boolean bHideAbortButton, boolean bShowInStudioGlassPane) Construct a ProgressFeedback with a given text notice.- Parameters:
strNotice
- The text notice to display in the ProgressWindow.bHideAbortButton
- will hide abort buttonbShowInStudioGlassPane
- will show in studio pane
-
-
Method Details
-
runWithProgress
A helper method that executes a task in a worker thread and displays feedback in a progress windows.- Parameters:
strNotice
- The text notice to display in the ProgressWindow.task
- The task to execute in a separate (worker) thread.
-
runWithProgress
public static ProgressFeedback runWithProgress(String strNotice, IRunnableWithProgress task, boolean bHideAbortBtn) -
runWithProgress
public static ProgressFeedback runWithProgress(String strNotice, IRunnableWithProgress task, boolean bHideAbortBtn, boolean bShowInStudioGlassPane) -
runWithProgress
protected static ProgressFeedback runWithProgress(IRunnableWithProgress task, ProgressFeedback progressFeedback) -
runWithPossibleDialog
-
shortWait
private static boolean shortWait(long delay, boolean[] done) -
waitForProgress
private static void waitForProgress(boolean[] done) -
dispose
void dispose()Hides and disposes theProgressWindow
. -
startTimer
private void startTimer() -
stopTimer
private void stopTimer() -
setLength
public void setLength(int iLength) Description copied from interface:IProgressCallback
How long is this operation in units? For a StagedProgressFeedback, this moves to the next stage- Specified by:
setLength
in interfaceIProgressCallback
- Parameters:
iLength
- The number of units the operation is expected to execute.
-
updateProgress
Description copied from interface:IProgressCallback
Call this when a unit of progress completes.- Specified by:
updateProgress
in interfaceIProgressCallback
- Parameters:
iProgress
- The unit of progress completed.strMessage
- A short message describing the progress.- Returns:
- Whether or not the operation should abort. True to abort operation.
-
incrementProgress
- Specified by:
incrementProgress
in interfaceIProgressCallback
-
setCurrentMessage
-
updateProgress
Description copied from interface:IProgressCallback
Call this to update the progress message without modifying the amount of progress completed.- Specified by:
updateProgress
in interfaceIProgressCallback
-
getProgress
public int getProgress()- Specified by:
getProgress
in interfaceIProgressCallback
-
isAbort
public boolean isAbort()Description copied from interface:IProgressCallback
Should the operation abort?- Specified by:
isAbort
in interfaceIProgressCallback
- Returns:
- True if the operation should abort.
-
actionPerformed
- Specified by:
actionPerformed
in interfaceActionListener
-
operationComplete
public void operationComplete()Description copied from interface:IProgressCallback
Signals that the operation is complete- Specified by:
operationComplete
in interfaceIProgressCallback
-