Package com.inductiveautomation.ignition.client.util.gui

Class CompoundProgressRangeModel.InternalProgressListener

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getContribution​(int resolution)
      Returns this progress listener's contribution to the total progress, which is:
      (Value/Max)*Resolution
      Unless indeterminate, in which case it's 0.
      boolean isCanceled()
      Indicates to the running task that it has been canceled and should stop as soon as possible.
      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​(java.lang.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.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • InternalProgressListener

        protected InternalProgressListener()

    • Method Detail

      • setProgressMax

        public void setProgressMax​(int max)
        Description copied from interface: ProgressListener
        Used to indicate the upper bound of value that will be passed to setProgress.
        Specified by:
        setProgressMax in interface ProgressListener

      • setProgress

        public void setProgress​(int val)
        Description copied from interface: ProgressListener
        Used to update the current progress value, should be between 0 and the value sent to setProgressMax.
        Specified by:
        setProgress in interface ProgressListener

      • setNote

        public void setNote​(java.lang.String note)
        Description copied from interface: ProgressListener
        Sets some sort of note or information about the current position.
        Specified by:
        setNote in interface ProgressListener

      • setIndeterminate

        public void setIndeterminate​(boolean bool)
        Description copied from interface: ProgressListener
        Allows the object performing the action to indicate that it won't be able to report back progress information.
        Specified by:
        setIndeterminate in interface ProgressListener

      • getContribution

        public int getContribution​(int resolution)
        Returns this progress listener's contribution to the total progress, which is:
        (Value/Max)*Resolution
        Unless indeterminate, in which case it's 0.

      • isCanceled

        public boolean isCanceled()
        Description copied from interface: TaskProgressListener
        Indicates to the running task that it has been canceled and should stop as soon as possible.
        Specified by:
        isCanceled in interface TaskProgressListener