Package editor.util
Interface IProgressCallback
-
- All Known Implementing Classes:
ProgressFeedback
public interface IProgressCallbackAn callback interface for indicating progress during a lengthy operation. Copyright 2010 Guidewire Software, Inc.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetProgress()booleanincrementProgress(java.lang.String strMessage, java.lang.String... args)booleanisAbort()Should the operation abort?voidoperationComplete()Signals that the operation is completevoidsetLength(int iLength)How long is this operation in units? For a StagedProgressFeedback, this moves to the next stagebooleanupdateProgress(int iProgress, java.lang.String strMessage, java.lang.String... args)Call this when a unit of progress completes.booleanupdateProgress(java.lang.String strMessage, java.lang.String... args)Call this to update the progress message without modifying the amount of progress completed.
-
-
-
Method Detail
-
setLength
void setLength(int iLength)
How long is this operation in units? For a StagedProgressFeedback, this moves to the next stage- Parameters:
iLength- The number of units the operation is expected to execute.
-
updateProgress
boolean updateProgress(int iProgress, java.lang.String strMessage, java.lang.String... args)Call this when a unit of progress completes.- 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
boolean incrementProgress(java.lang.String strMessage, java.lang.String... args)
-
updateProgress
boolean updateProgress(java.lang.String strMessage, java.lang.String... args)Call this to update the progress message without modifying the amount of progress completed.
-
isAbort
boolean isAbort()
Should the operation abort?- Returns:
- True if the operation should abort.
-
operationComplete
void operationComplete()
Signals that the operation is complete
-
getProgress
int getProgress()
-
-