Package net.simplace.pipe.progress

Class FWProgressTask

java.lang.Object
net.simplace.pipe.progress.FWProgressTask
All Implemented Interfaces:
Comparable<FWProgressTask>
public class FWProgressTask extends Object implements Comparable<FWProgressTask>
Author:
Andreas Enders, Sebastian Brocks, Martin Schmitz A task that should be displayed in a FWProgressViewPane
Changes:
  • MS-01, 11.05.2009 (Martin Schmitz)
    Tries to avoid memory incriminating object references. Instead of holding the whole Observable, on store its ID (for which the Observable is needed at all).

  • Constructor Details

    • FWProgressTask

      public FWProgressTask(String aProgressID, String aX, String aY, String aSystemID)
      Parameters:
      aProgressID -
      aX -
      aY -
      aSystemID -
      aFixedLabel -

  • Method Details

    • getTextLabel

      public JLabel getTextLabel()
      get the textlabel for this task may be null if this task doesn't need a textual description
      Returns:
      the JLabel

    • getImageLabel

      public JLabel getImageLabel()
      get the imagelabel for this task
      Returns:
      the JLabel

    • getProgressID

      public String getProgressID()
      Returns:
      the iD

    • isImageUsed

      public boolean isImageUsed()
      Returns:
      the iD

    • getMessage

      public String getMessage()
      Returns:
      the message of the Task

    • setMessage

      public void setMessage(String aMessage)
      Parameters:
      aMessage - the message to set

    • setFixedLabel

      public void setFixedLabel(String aFixedLabel)
      Parameters:
      aFixedLabel - the fixedLabel to set

    • setStateProgressing

      public void setStateProgressing(int aPercentDone, String aMessage)
      Parameters:
      aPercentDone -
      aMessage -
      the - statusOfTask is set to progressing. percentDone (0-100).

    • getPercentDone

      public int getPercentDone()
      Returns:
      the percentDone (0-100)

    • getNumberInRange

      public int getNumberInRange()
      Returns:
      the number of the Task in the range of Tasks to be performed

    • setNumberInRange

      public void setNumberInRange(int aNumberInRange)
      sets the number of the Task in the range of Tasks to be performed
      Parameters:
      aNumberInRange -

    • getStateOfTask

      public String getStateOfTask()
      Returns:
      the statusOfTask

    • setStateOfTask

      public void setStateOfTask(String aStatusOfTask, FWObservable aParameterMap)
      Parameters:
      aStatusOfTask - the statusOfTask to set - use Variables in class State
      aParameterMap -

    • getClonedTask

      public FWProgressTask getClonedTask()
      Parameters:
      aFixedLabel -
      Returns:
      a clone of FWProgressTask

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • compareTo

      public int compareTo(FWProgressTask aO)
      Specified by:
      compareTo in interface Comparable<FWProgressTask>