JAL-3068 tidy status bar messaging
[jalview.git] / src / jalview / io / HTMLOutput.java
index f7179cf..54e7e4b 100644 (file)
@@ -39,23 +39,34 @@ public abstract class HTMLOutput implements Runnable
 {
   protected AlignmentPanel ap;
 
+  /*
+   * key for progress or status messages
+   */
   protected long pSessionId;
 
+  /*
+   * (optional) place to write progress messages to
+   */
   protected IProgressIndicator pIndicator;
 
   protected File generatedFile;
 
   String _bioJson = null;
 
+  private String description;
+
   /**
    * Constructor given an alignment panel (which should not be null)
    * 
    * @param ap
+   * @param desc 
    */
-  public HTMLOutput(AlignmentPanel ap)
+  public HTMLOutput(AlignmentPanel ap, String desc)
   {
     this.ap = ap;
     this.pIndicator = ap.alignFrame;
+    this.description = desc;
+    this.pSessionId = System.currentTimeMillis();
   }
 
   /**
@@ -243,16 +254,6 @@ public abstract class HTMLOutput implements Runnable
 
   /**
    * This method provides implementation of consistent behaviour which should
-   * occur before a HTML file export. It MUST be called at the start of the
-   * exportHTML() method implementation.
-   */
-  protected void exportStarted()
-  {
-    pSessionId = System.currentTimeMillis();
-  }
-
-  /**
-   * This method provides implementation of consistent behaviour which should
    * occur after a HTML file export. It MUST be called at the end of the
    * exportHTML() method implementation.
    */
@@ -299,7 +300,8 @@ public abstract class HTMLOutput implements Runnable
 
   public void exportHTML(String outputFile)
   {
-    exportStarted();
+    setProgressMessage(MessageManager.formatMessage(
+        "status.exporting_alignment_as_x_file", getDescription()));
     try
     {
       if (outputFile == null)
@@ -334,5 +336,8 @@ public abstract class HTMLOutput implements Runnable
    * 
    * @return
    */
-  protected abstract String getDescription();
+  protected final String getDescription()
+  {
+       return description;
+  }
 }
\ No newline at end of file