Class ProgressIndicator

All Implemented Interfaces:
Drawable

public class ProgressIndicator extends Composite
A control for showing progress feedback for a long running operation. This control supports both determinate and indeterminate SWT progress bars. For indeterminate progress, we don't have to know the total amount of work in advance and no worked method needs to be called.
  • Constructor Details

    • ProgressIndicator

      public ProgressIndicator(Composite parent)
      Create a ProgressIndicator as a child under the given parent.
      Parameters:
      parent - The widgets parent
    • ProgressIndicator

      public ProgressIndicator(Composite parent, int style)
      Create a ProgressIndicator as a child under the given parent.
      Parameters:
      parent - The widgets parent
      style - the SWT style constants for progress monitors created by the receiver.
      Since:
      3.4
  • Method Details

    • beginAnimatedTask

      public void beginAnimatedTask()
      Initialize the progress bar to be animated.
    • beginTask

      public void beginTask(int max)
      Initialize the progress bar.
      Parameters:
      max - The maximum value.
    • setWork

      public void setWork(int max, int work)
      Initializes and resets the progress bar to a specific work. This allows to set a progress to less then the work already done.
      Parameters:
      max - The maximum value.
      work - The work already done.
      Since:
      3.29
    • done

      public void done()
      Progress is done.
    • sendRemainingWork

      public void sendRemainingWork()
      Moves the progress indicator to the end.
    • worked

      public void worked(double work)
      Moves the progress indicator by the given amount of work units
      Parameters:
      work - the amount of work to increment by.
    • showError

      public void showError()
      Show the receiver as showing an error.
      Since:
      3.4
    • showPaused

      public void showPaused()
      Show the receiver as being paused.
      Since:
      3.4
    • showNormal

      public void showNormal()
      Reset the progress bar to it's normal style.
      Since:
      3.4