Package org.gvsig.utils.swing.threads

Interface IProgressMonitorIF

All Known Implementing Classes:
ProgressMonitorAdapter, UndefinedProgressMonitor
public interface IProgressMonitorIF
IProgressMonitorIF must be all classes which monitors the process of a long costly task.
It is designed to monitor defined tasks (those which we know what number of steps have) and undefined tasks.
It must has associated a GUI component to show progress of the task (usually a Progress Bar and a cancel button).
Author:
azabala

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cancel()
    Sends cancel message to monitored task.
    void
    close()
    Closes associated GUI component
    int
    getCurrentStep()
     
    int
    getInitialStep()
     
    int
    getLastStep()
     
    boolean
    isCanceled()
    Returns if has received cancel message
    boolean
    isIndeterminated()
     
    void
    open()
    Sets associated gui component visible
    void
    setBarString(String barString)
    Sets complementary text to progress bar.
    void
    setBarStringDrawed(boolean stringDrawed)
    Sets if the progress bar associated to monitor must draw a complementary text to progress bar
    void
    setCurrentStep(int step)
    sets current step number of the task monitored
    void
    setIndeterminated(boolean indeterminated)
    Sets if the monitored task is defined (known number of steps) or undefined (unknown)
    void
    setInitialStep(int step)
    sets initial step number of the task monitored
    void
    setLastStep(int step)
    sets final step number of the task monitored
    void
    setMainTitleLabel(String text)
    Set main text of GUI component
    void
    setNote(String note)
     

  • Method Details

    • setInitialStep

      void setInitialStep(int step)
      sets initial step number of the task monitored
      Parameters:
      step -

    • setLastStep

      void setLastStep(int step)
      sets final step number of the task monitored
      Parameters:
      step -

    • setCurrentStep

      void setCurrentStep(int step)
      sets current step number of the task monitored
      Parameters:
      step -

    • getInitialStep

      int getInitialStep()

    • getLastStep

      int getLastStep()

    • getCurrentStep

      int getCurrentStep()

    • setIndeterminated

      void setIndeterminated(boolean indeterminated)
      Sets if the monitored task is defined (known number of steps) or undefined (unknown)
      Parameters:
      indeterminated -

    • isIndeterminated

      boolean isIndeterminated()

    • setBarStringDrawed

      void setBarStringDrawed(boolean stringDrawed)
      Sets if the progress bar associated to monitor must draw a complementary text to progress bar
      Parameters:
      stringDrawed -

    • setBarString

      void setBarString(String barString)
      Sets complementary text to progress bar.
      Parameters:
      barString -

    • setMainTitleLabel

      void setMainTitleLabel(String text)
      Set main text of GUI component
      Parameters:
      text -

    • setNote

      void setNote(String note)

    • cancel

      void cancel()
      Sends cancel message to monitored task.

    • isCanceled

      boolean isCanceled()
      Returns if has received cancel message
      Returns:

    • close

      void close()
      Closes associated GUI component

    • open

      void open()
      Sets associated gui component visible