Package com.inductiveautomation.ignition.common.gui.progress

Interface ProgressListener

All Known Subinterfaces:
TaskProgressListener
All Known Implementing Classes:
ClientProgressManager.ClientRunningTask.ListeningProgressState, CompoundProgressRangeModel.InternalProgressListener, DummyTaskProgressListener, TaskProgressState, TaskProgressUpdater
public interface ProgressListener
Interface for listening to something that can be tracked. Passed into an object that performs some action, that object will report back the max, progress, and notes.

It also supports an indeterminate mode, where the object can tell how progress is going.

If you want to be able to cancel the operation, use TaskProgressListener instead.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    setIndeterminate(boolean bool)
    Allows the object performing the action to indicate that it won't be able to report back progress information.
    void
    setNote(String note)
    Sets some sort of note or information about the current position.
    void
    setProgress(int val)
    Used to update the current progress value, should be between 0 and the value sent to setProgressMax.
    void
    setProgressMax(int max)
    Used to indicate the upper bound of value that will be passed to setProgress.

  • Method Details

    • setProgressMax

      void setProgressMax(int max)
      Used to indicate the upper bound of value that will be passed to setProgress.

    • setProgress

      void setProgress(int val)
      Used to update the current progress value, should be between 0 and the value sent to setProgressMax.

    • setNote

      void setNote(String note)
      Sets some sort of note or information about the current position.

    • setIndeterminate

      void setIndeterminate(boolean bool)
      Allows the object performing the action to indicate that it won't be able to report back progress information.