Package editor.util

Class ProgressFeedback

java.lang.Object
editor.util.ProgressFeedback
All Implemented Interfaces:
IProgressCallback, ActionListener, EventListener
public class ProgressFeedback extends Object implements IProgressCallback, ActionListener
A helper class for displaying a ProgressWindow while a task executes in a worker thread.

  • Field Details

    • UPDATE_DELAY

      private static final int UPDATE_DELAY
      See Also:

    • _strNotice

      private String _strNotice

    • _pp

      private ProgressPanel _pp

    • _pw

      private ProgressWindow _pw

    • _bAbort

      private boolean _bAbort

    • _bHideAbortButton

      private boolean _bHideAbortButton

    • _bShowInStudioGlassPane

      private boolean _bShowInStudioGlassPane

    • _currentMessage

      private String _currentMessage

    • _currentValue

      private int _currentValue

    • _length

      private int _length

    • _changeLength

      private boolean _changeLength

    • _timer

      private Timer _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 button
      bShowInStudioGlassPane - will show in studio pane

  • Method Details

    • runWithProgress

      public 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.
      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

      public static <T> T runWithPossibleDialog(Callable<T> callable, String message)

    • shortWait

      private static boolean shortWait(long delay, boolean[] done)

    • waitForProgress

      private static void waitForProgress(boolean[] done)

    • dispose

      void dispose()
      Hides and disposes the ProgressWindow.

    • 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 interface IProgressCallback
      Parameters:
      iLength - The number of units the operation is expected to execute.

    • updateProgress

      public boolean updateProgress(int iProgress, String strMessage, String... args)
      Description copied from interface: IProgressCallback
      Call this when a unit of progress completes.
      Specified by:
      updateProgress in interface IProgressCallback
      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

      public boolean incrementProgress(String strMessage, String... args)
      Specified by:
      incrementProgress in interface IProgressCallback

    • setCurrentMessage

      private void setCurrentMessage(String strMessage, String[] args)

    • updateProgress

      public boolean updateProgress(String strMessage, String... args)
      Description copied from interface: IProgressCallback
      Call this to update the progress message without modifying the amount of progress completed.
      Specified by:
      updateProgress in interface IProgressCallback

    • getProgress

      public int getProgress()
      Specified by:
      getProgress in interface IProgressCallback

    • isAbort

      public boolean isAbort()
      Description copied from interface: IProgressCallback
      Should the operation abort?
      Specified by:
      isAbort in interface IProgressCallback
      Returns:
      True if the operation should abort.

    • actionPerformed

      public void actionPerformed(ActionEvent e)
      Specified by:
      actionPerformed in interface ActionListener

    • operationComplete

      public void operationComplete()
      Description copied from interface: IProgressCallback
      Signals that the operation is complete
      Specified by:
      operationComplete in interface IProgressCallback