X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FWebserviceInfo.java;h=9f8a8a87879f2088f044767c4485457fdb448715;hb=797df64fa2a0a30773d0f48f5494d4155e5a8be3;hp=7c5c5e3c1e3daf6798e8df63309936e7caefa98b;hpb=21827c0d617758c91f62c67064a3ea23ad7f15d1;p=jalview.git

diff --git a/src/jalview/gui/WebserviceInfo.java b/src/jalview/gui/WebserviceInfo.java
index 7c5c5e3..9f8a8a8 100755
--- a/src/jalview/gui/WebserviceInfo.java
+++ b/src/jalview/gui/WebserviceInfo.java
@@ -1,332 +1,842 @@
-/*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
- */
-package jalview.gui;
-
-import jalview.jbgui.*;
-
-import java.awt.*;
-import java.awt.event.*;
-import java.awt.image.*;
-
-import javax.swing.*;
-
-
-/**
- * Base class for web service client thread and gui
- *
- * @author $author$
- * @version $Revision$
- */
-public class WebserviceInfo extends GWebserviceInfo
-{
-    /** Job is Queued */
-    public static final int STATE_QUEUING = 0;
-
-    /** Job is Running */
-    public static final int STATE_RUNNING = 1;
-
-    /** Job has finished with no errors */
-    public static final int STATE_STOPPED_OK = 2;
-
-    /** Job has been cancelled with no errors */
-    public static final int STATE_CANCELLED_OK = 3;
-
-    /** job has stopped because of some error */
-    public static final int STATE_STOPPED_ERROR = 4;
-
-    /** job has failed because of some unavoidable service interruption */
-    public static final int STATE_STOPPED_SERVERERROR = 5;
-    int currentStatus = STATE_QUEUING;
-    Image image;
-    int angle = 0;
-    String title = "";
-    jalview.ws.WSClientI thisService;
-    boolean serviceIsCancellable;
-
-    /**
-     * Creates a new WebserviceInfo object.
-     *
-     * @param title short name and job type
-     * @param info reference or other human readable description
-     */
-    public WebserviceInfo(String title, String info)
-    {
-        init(title, info, 520, 500);
-    }
-
-    /**
-     * Creates a new WebserviceInfo object.
-     *
-     * @param title DOCUMENT ME!
-     * @param info DOCUMENT ME!
-     * @param width DOCUMENT ME!
-     * @param height DOCUMENT ME!
-     */
-    public WebserviceInfo(String title, String info, int width, int height)
-    {
-        init(title, info, width, height);
-    }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public jalview.ws.WSClientI getthisService()
-    {
-        return thisService;
-    }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @param newservice DOCUMENT ME!
-     */
-    public void setthisService(jalview.ws.WSClientI newservice)
-    {
-        thisService = newservice;
-        serviceIsCancellable = newservice.isCancellable();
-    }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @param title DOCUMENT ME!
-     * @param info DOCUMENT ME!
-     * @param width DOCUMENT ME!
-     * @param height DOCUMENT ME!
-     */
-    void init(String title, String info, int width, int height)
-    {
-        JInternalFrame frame = new JInternalFrame();
-        frame.setContentPane(this);
-        Desktop.addInternalFrame(frame, title, width, height);
-
-        this.title = title;
-        setInfoText(info);
-
-        java.net.URL url = getClass().getResource("/images/logo.gif");
-        image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
-
-        MediaTracker mt = new MediaTracker(this);
-        mt.addImage(image, 0);
-
-        try
-        {
-            mt.waitForID(0);
-        }
-        catch (Exception ex)
-        {
-        }
-
-        AnimatedPanel ap = new AnimatedPanel();
-        titlePanel.add(ap, BorderLayout.CENTER);
-
-        Thread thread = new Thread(ap);
-        thread.start();
-    }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @param status integer status from state constants
-     */
-    public void setStatus(int status)
-    {
-        currentStatus = status;
-    }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public String getInfoText()
-    {
-        return infoText.getText();
-    }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @param text DOCUMENT ME!
-     */
-    public void setInfoText(String text)
-    {
-        infoText.setText(text);
-    }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @param text DOCUMENT ME!
-     */
-    public void appendInfoText(String text)
-    {
-        infoText.append(text);
-    }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @return DOCUMENT ME!
-     */
-    public String getProgressText()
-    {
-        return progressText.getText();
-    }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @param text DOCUMENT ME!
-     */
-    public void setProgressText(String text)
-    {
-        progressText.setText(text);
-    }
-
-    /**
-     * DOCUMENT ME!
-     *
-     * @param text DOCUMENT ME!
-     */
-    public void appendProgressText(String text)
-    {
-        progressText.append(text);
-    }
-
-    /**
-     * Gui action for cancelling the current job, if possible.
-     *
-     * @param e DOCUMENT ME!
-     */
-    protected void cancel_actionPerformed(ActionEvent e)
-    {
-        if (!serviceIsCancellable)
-        {
-            JOptionPane.showInternalMessageDialog(Desktop.desktop,
-                "This job cannot be cancelled.\nJust close the window.", "Cancel job",
-                JOptionPane.WARNING_MESSAGE);
-        }
-        else
-        {
-            thisService.cancelJob();
-        }
-    }
-
-    class AnimatedPanel extends JPanel implements Runnable
-    {
-        long startTime = 0;
-        BufferedImage offscreen;
-
-        public void run()
-        {
-            startTime = System.currentTimeMillis();
-            Graphics2D g = null;
-
-            while (currentStatus < STATE_STOPPED_OK)
-            {
-                try
-                {
-                    Thread.sleep(50);
-
-                    int units = (int) ( (System.currentTimeMillis() - startTime) /
-                                       10f);
-                    angle += units;
-                    angle %= 360;
-                    startTime = System.currentTimeMillis();
-
-                    if (offscreen == null || offscreen.getWidth(this) != getWidth()
-                        || offscreen.getHeight(this) != getHeight())
-                    {
-                      offscreen = new BufferedImage(getWidth(), getHeight(),
-                                                    BufferedImage.TYPE_INT_ARGB);
-                      g = (Graphics2D) offscreen.getGraphics();
-                    }
-
-                    g.setColor(Color.white);
-                    g.fillRect(0, 0, getWidth(), getHeight());
-
-                    g.setFont(new Font("Arial", Font.BOLD, 12));
-                    g.setColor(Color.black);
-
-                    switch (currentStatus)
-                    {
-                      case STATE_QUEUING:
-                        g.drawString(title.concat(" - queuing"), 60, 30);
-
-                        break;
-
-                      case STATE_RUNNING:
-                        g.drawString(title.concat(" - running"), 60, 30);
-
-                        break;
-
-                      case STATE_STOPPED_OK:
-                        g.drawString(title.concat(" - complete"), 60, 30);
-
-                        break;
-
-                      case STATE_CANCELLED_OK:
-                        g.drawString(title.concat(" - job cancelled!"), 60, 30);
-
-                        break;
-
-                      case STATE_STOPPED_ERROR:
-                        g.drawString(title.concat(" - job error!"), 60, 30);
-
-                        break;
-
-                      case STATE_STOPPED_SERVERERROR:
-                        g.drawString(title.concat(" - Server Error! (try later)"),
-                                     60,
-                                     30);
-
-                        break;
-                    }
-
-
-                    if (currentStatus >= STATE_STOPPED_OK)
-                      angle = 0;
-
-                    if (image != null)
-                    {
-                      g.rotate(Math.toRadians(angle), 28, 28);
-                      g.drawImage(image, 10, 10, this);
-                      g.rotate( -Math.toRadians(angle), 28, 28);
-                    }
-
-
-                    repaint();
-                }
-                catch (Exception ex)
-                {
-                }
-            }
-
-            cancel.setEnabled(false);
-        }
-
-        public void paintComponent(Graphics g1)
-        {
-            g1.drawImage(offscreen, 0,0,this);
-        }
-    }
-}
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ * 
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package jalview.gui;
+
+import java.util.*;
+
+import java.awt.*;
+import java.awt.event.*;
+import java.awt.image.*;
+import javax.swing.*;
+import javax.swing.event.HyperlinkEvent;
+import javax.swing.event.HyperlinkListener;
+import javax.swing.event.HyperlinkEvent.EventType;
+import javax.swing.text.html.HTMLEditorKit;
+import javax.swing.text.html.StyleSheet;
+
+import jalview.bin.Cache;
+import jalview.jbgui.*;
+import jalview.ws.WSClientI;
+
+/**
+ * Base class for web service client thread and gui TODO: create StAX parser to
+ * extract html body content reliably when preparing html formatted job statuses
+ * 
+ * @author $author$
+ * @version $Revision$
+ */
+public class WebserviceInfo extends GWebserviceInfo implements
+        HyperlinkListener
+{
+
+  /** Job is Queued */
+  public static final int STATE_QUEUING = 0;
+
+  /** Job is Running */
+  public static final int STATE_RUNNING = 1;
+
+  /** Job has finished with no errors */
+  public static final int STATE_STOPPED_OK = 2;
+
+  /** Job has been cancelled with no errors */
+  public static final int STATE_CANCELLED_OK = 3;
+
+  /** job has stopped because of some error */
+  public static final int STATE_STOPPED_ERROR = 4;
+
+  /** job has failed because of some unavoidable service interruption */
+  public static final int STATE_STOPPED_SERVERERROR = 5;
+
+  int currentStatus = STATE_QUEUING;
+
+  Image image;
+
+  int angle = 0;
+
+  String title = "";
+
+  jalview.ws.WSClientI thisService;
+
+  boolean serviceIsCancellable;
+
+  JInternalFrame frame;
+
+  JTabbedPane subjobs = null;
+
+  java.util.Vector jobPanes = null;
+
+  private boolean serviceCanMergeResults = false;
+
+  private boolean viewResultsImmediatly = true;
+
+  /**
+   * Get
+   * 
+   * @param flag
+   *          to indicate if results will be shown in a new window as soon as
+   *          they are available.
+   */
+  public boolean isViewResultsImmediatly()
+  {
+    return viewResultsImmediatly;
+  }
+
+  /**
+   * Set
+   * 
+   * @param flag
+   *          to indicate if results will be shown in a new window as soon as
+   *          they are available.
+   */
+  public void setViewResultsImmediatly(boolean viewResultsImmediatly)
+  {
+    this.viewResultsImmediatly = viewResultsImmediatly;
+  }
+
+  private StyleSheet getStyleSheet(HTMLEditorKit editorKit)
+  {
+
+    // Copied blatantly from
+    // http://www.velocityreviews.com/forums/t132265-string-into-htmldocument.html
+    StyleSheet myStyleSheet = new StyleSheet();
+
+    myStyleSheet.addStyleSheet(editorKit.getStyleSheet());
+
+    editorKit.setStyleSheet(myStyleSheet);
+
+    /*
+     * Set the style sheet rules here by reading them from the constants
+     * interface.
+     */
+    /*
+     * for (int ix=0; ix<CSS_RULES.length; ix++) {
+     * 
+     * myStyleSheet.addRule(CSS_RULES[ix]);
+     * 
+     * }
+     */
+    return myStyleSheet;
+
+  }
+
+  // tabbed or not
+  public synchronized int addJobPane()
+  {
+    JScrollPane jobpane = new JScrollPane();
+    JComponent _progressText;
+    if (renderAsHtml)
+    {
+      JEditorPane progressText = new JEditorPane("text/html", "");
+      progressText.addHyperlinkListener(this);
+      _progressText = progressText;
+      // progressText.setFont(new java.awt.Font("Verdana", 0, 10));
+      // progressText.setBorder(null);
+      progressText.setEditable(false);
+      /*
+       * HTMLEditorKit myEditorKit = new HTMLEditorKit();
+       * 
+       * StyleSheet myStyleSheet = getStyleSheet(myEditorKit);
+       * 
+       * HTMLDocument tipDocument = (HTMLDocument)
+       * (myEditorKit.createDefaultDocument());
+       * 
+       * progressText.setDocument(tipDocument);
+       */progressText.setText("<html><h1>WS Job</h1></html>");
+    }
+    else
+    {
+      JTextArea progressText = new JTextArea();
+      _progressText = progressText;
+
+      progressText.setFont(new java.awt.Font("Verdana", 0, 10));
+      progressText.setBorder(null);
+      progressText.setEditable(false);
+      progressText.setText("WS Job");
+      progressText.setLineWrap(true);
+      progressText.setWrapStyleWord(true);
+    }
+    jobpane.setName("JobPane");
+    jobpane.getViewport().add(_progressText, null);
+    jobpane.setBorder(null);
+    if (jobPanes == null)
+    {
+      jobPanes = new Vector();
+    }
+    int newpane = jobPanes.size();
+    jobPanes.add(jobpane);
+
+    if (newpane == 0)
+    {
+      this.add(jobpane, BorderLayout.CENTER);
+    }
+    else
+    {
+      if (newpane == 1)
+      {
+        // revert to a tabbed pane.
+        JScrollPane firstpane;
+        this.remove(firstpane = (JScrollPane) jobPanes.get(0));
+        subjobs = new JTabbedPane();
+        this.add(subjobs, BorderLayout.CENTER);
+        subjobs.add(firstpane);
+        subjobs.setTitleAt(0, firstpane.getName());
+      }
+      subjobs.add(jobpane);
+    }
+    return newpane; // index for accessor methods below
+  }
+
+  /**
+   * Creates a new WebserviceInfo object.
+   * 
+   * @param title
+   *          short name and job type
+   * @param info
+   *          reference or other human readable description
+   */
+  public WebserviceInfo(String title, String info)
+  {
+    init(title, info, 520, 500);
+  }
+
+  /**
+   * Creates a new WebserviceInfo object.
+   * 
+   * @param title
+   *          DOCUMENT ME!
+   * @param info
+   *          DOCUMENT ME!
+   * @param width
+   *          DOCUMENT ME!
+   * @param height
+   *          DOCUMENT ME!
+   */
+  public WebserviceInfo(String title, String info, int width, int height)
+  {
+    init(title, info, width, height);
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public jalview.ws.WSClientI getthisService()
+  {
+    return thisService;
+  }
+
+  /**
+   * Update state of GUI based on client capabilities (like whether the job is
+   * cancellable, whether the 'merge results' button is shown.
+   * 
+   * @param newservice
+   *          service client to query for capabilities
+   */
+  public void setthisService(jalview.ws.WSClientI newservice)
+  {
+    thisService = newservice;
+    serviceIsCancellable = newservice.isCancellable();
+    frame.setClosable(!serviceIsCancellable);
+    serviceCanMergeResults = newservice.canMergeResults();
+    rebuildButtonPanel();
+  }
+
+  private void rebuildButtonPanel()
+  {
+    if (buttonPanel != null)
+    {
+      buttonPanel.removeAll();
+      if (serviceIsCancellable)
+      {
+        buttonPanel.add(cancel);
+        frame.setClosable(false);
+      }
+      else
+      {
+        frame.setClosable(true);
+      }
+    }
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param title
+   *          DOCUMENT ME!
+   * @param info
+   *          DOCUMENT ME!
+   * @param width
+   *          DOCUMENT ME!
+   * @param height
+   *          DOCUMENT ME!
+   */
+  void init(String title, String info, int width, int height)
+  {
+    frame = new JInternalFrame();
+    frame.setContentPane(this);
+    Desktop.addInternalFrame(frame, title, width, height);
+    frame.setClosable(false);
+
+    this.title = title;
+    setInfoText(info);
+
+    java.net.URL url = getClass().getResource("/images/logo.gif");
+    image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
+
+    MediaTracker mt = new MediaTracker(this);
+    mt.addImage(image, 0);
+
+    try
+    {
+      mt.waitForID(0);
+    } catch (Exception ex)
+    {
+    }
+
+    AnimatedPanel ap = new AnimatedPanel();
+    titlePanel.add(ap, BorderLayout.CENTER);
+
+    Thread thread = new Thread(ap);
+    thread.start();
+    final WebserviceInfo thisinfo = this;
+    frame.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
+    {
+      public void internalFrameClosed(
+              javax.swing.event.InternalFrameEvent evt)
+      {
+        // System.out.println("Shutting down webservice client");
+        WSClientI service = thisinfo.getthisService();
+        if (service != null && service.isCancellable())
+        {
+          service.cancelJob();
+        }
+      };
+    });
+    frame.validate();
+
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param status
+   *          integer status from state constants
+   */
+  public void setStatus(int status)
+  {
+    currentStatus = status;
+  }
+
+  /**
+   * subjob status indicator
+   * 
+   * @param jobpane
+   * @param status
+   */
+  public void setStatus(int jobpane, int status)
+  {
+    if (jobpane < 0 || jobpane >= jobPanes.size())
+    {
+      throw new Error("setStatus called for non-existent job pane."
+              + jobpane);
+    }
+    switch (status)
+    {
+    case STATE_QUEUING:
+      setProgressName(jobpane + " - QUEUED", jobpane);
+      break;
+    case STATE_RUNNING:
+      setProgressName(jobpane + " - RUNNING", jobpane);
+      break;
+    case STATE_STOPPED_OK:
+      setProgressName(jobpane + " - FINISHED", jobpane);
+      break;
+    case STATE_CANCELLED_OK:
+      setProgressName(jobpane + " - CANCELLED", jobpane);
+      break;
+    case STATE_STOPPED_ERROR:
+      setProgressName(jobpane + " - BROKEN", jobpane);
+      break;
+    case STATE_STOPPED_SERVERERROR:
+      setProgressName(jobpane + " - ALERT", jobpane);
+      break;
+    default:
+      setProgressName(jobpane + " - UNKNOWN STATE", jobpane);
+    }
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public String getInfoText()
+  {
+    return infoText.getText();
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param text
+   *          DOCUMENT ME!
+   */
+  public void setInfoText(String text)
+  {
+    infoText.setText(text);
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param text
+   *          DOCUMENT ME!
+   */
+  public void appendInfoText(String text)
+  {
+    infoText.append(text);
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
+   */
+  public String getProgressText(int which)
+  {
+    if (jobPanes == null)
+    {
+      addJobPane();
+    }
+    if (renderAsHtml)
+    {
+      return ((JEditorPane) ((JScrollPane) jobPanes.get(which))
+              .getViewport().getComponent(0)).getText();
+    }
+    else
+    {
+      return ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
+              .getComponent(0)).getText();
+    }
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param text
+   *          DOCUMENT ME!
+   */
+  public void setProgressText(int which, String text)
+  {
+    if (jobPanes == null)
+    {
+      addJobPane();
+    }
+    if (renderAsHtml)
+    {
+      ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
+              .getComponent(0)).setText(ensureHtmlTagged(text));
+    }
+    else
+    {
+      ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
+              .getComponent(0)).setText(text);
+    }
+  }
+
+  /**
+   * extract content from &lt;body&gt; content &lt;/body&gt;
+   * 
+   * @param text
+   * @param leaveFirst
+   *          - set to leave the initial html tag intact
+   * @param leaveLast
+   *          - set to leave the final html tag intact
+   * @return
+   */
+  private String getHtmlFragment(String text, boolean leaveFirst,
+          boolean leaveLast)
+  {
+    if (text == null)
+    {
+      return null;
+    }
+    String lowertxt = text.toLowerCase();
+    int htmlpos = leaveFirst ? -1 : lowertxt.indexOf("<body");
+
+    int htmlend = leaveLast ? -1 : lowertxt.indexOf("</body");
+    int htmlpose = lowertxt.indexOf(">", htmlpos), htmlende = lowertxt
+            .indexOf(">", htmlend);
+    if (htmlend == -1 && htmlpos == -1)
+    {
+      return text;
+    }
+    if (htmlend > -1)
+    {
+      return text.substring((htmlpos == -1 ? 0 : htmlpose + 1), htmlend);
+    }
+    return text.substring(htmlpos == -1 ? 0 : htmlpose + 1);
+  }
+
+  /**
+   * very simple routine for adding/ensuring html tags are present in text.
+   * 
+   * @param text
+   * @return properly html tag enclosed text
+   */
+  private String ensureHtmlTagged(String text)
+  {
+    if (text == null)
+    {
+      return "";
+    }
+    String lowertxt = text.toLowerCase();
+    int htmlpos = lowertxt.indexOf("<body");
+    int htmlend = lowertxt.indexOf("</body");
+    int doctype = lowertxt.indexOf("<!doctype");
+    int xmltype = lowertxt.indexOf("<?xml");
+    if (htmlend == -1)
+    {
+      text = text + "</body></html>";
+    }
+    if (htmlpos > -1)
+    {
+      if ((doctype > -1 && htmlpos > doctype)
+              || (xmltype > -1 && htmlpos > xmltype))
+      {
+        text = "<html><head></head><body>\n" + text.substring(htmlpos - 1);
+      }
+    }
+    else
+    {
+      text = "<html><head></head><body>\n" + text;
+    }
+    if (text.indexOf("<meta") > -1)
+    {
+      System.err.println("HTML COntent: \n" + text
+              + "<< END HTML CONTENT\n");
+
+    }
+    return text;
+  }
+
+  /**
+   * DOCUMENT ME!
+   * 
+   * @param text
+   *          DOCUMENT ME!
+   */
+  public void appendProgressText(int which, String text)
+  {
+    if (jobPanes == null)
+    {
+      addJobPane();
+    }
+    if (renderAsHtml)
+    {
+      String txt = getHtmlFragment(
+              ((JEditorPane) ((JScrollPane) jobPanes.get(which))
+                      .getViewport().getComponent(0)).getText(), true,
+              false);
+      ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
+              .getComponent(0)).setText(ensureHtmlTagged(txt
+              + getHtmlFragment(text, false, true)));
+    }
+    else
+    {
+      ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
+              .getComponent(0)).append(text);
+    }
+  }
+
+  /**
+   * setProgressText(0, text)
+   */
+  public void setProgressText(String text)
+  {
+    setProgressText(0, text);
+  }
+
+  /**
+   * appendProgressText(0, text)
+   */
+  public void appendProgressText(String text)
+  {
+    appendProgressText(0, text);
+  }
+
+  /**
+   * getProgressText(0)
+   */
+  public String getProgressText()
+  {
+    return getProgressText(0);
+  }
+
+  /**
+   * get the tab title for a subjob
+   * 
+   * @param which
+   *          int
+   * @return String
+   */
+  public String getProgressName(int which)
+  {
+    if (jobPanes == null)
+    {
+      addJobPane();
+    }
+    if (subjobs != null)
+    {
+      return subjobs.getTitleAt(which);
+    }
+    else
+    {
+      return ((JScrollPane) jobPanes.get(which)).getViewport()
+              .getComponent(0).getName();
+    }
+  }
+
+  /**
+   * set the tab title for a subjob
+   * 
+   * @param name
+   *          String
+   * @param which
+   *          int
+   */
+  public void setProgressName(String name, int which)
+  {
+    if (subjobs != null)
+    {
+      subjobs.setTitleAt(which, name);
+      subjobs.revalidate();
+      subjobs.repaint();
+    }
+    JScrollPane c = (JScrollPane) jobPanes.get(which);
+    c.getViewport().getComponent(0).setName(name);
+    c.repaint();
+  }
+
+  /**
+   * Gui action for cancelling the current job, if possible.
+   * 
+   * @param e
+   *          DOCUMENT ME!
+   */
+  protected void cancel_actionPerformed(ActionEvent e)
+  {
+    if (!serviceIsCancellable)
+    {
+      // JBPNote : TODO: We should REALLY just tell the WSClientI to cancel
+      // anyhow - it has to stop threads and clean up
+      // JBPNote : TODO: Instead of a warning, we should have an optional 'Are
+      // you sure?' prompt
+      warnUser("This job cannot be cancelled.\nJust close the window.",
+              "Cancel job");
+    }
+    else
+    {
+      thisService.cancelJob();
+    }
+    frame.setClosable(true);
+  }
+
+  /**
+   * Spawns a thread that pops up a warning dialog box with the given message
+   * and title.
+   * 
+   * @param message
+   * @param title
+   */
+  public void warnUser(final String message, final String title)
+  {
+    javax.swing.SwingUtilities.invokeLater(new Runnable()
+    {
+      public void run()
+      {
+        JOptionPane.showInternalMessageDialog(Desktop.desktop, message,
+                title, JOptionPane.WARNING_MESSAGE);
+
+      }
+    });
+  }
+
+  /**
+   * Set up GUI for user to get at results - and possibly automatically display
+   * them if viewResultsImmediatly is set.
+   */
+  public void setResultsReady()
+  {
+    frame.setClosable(true);
+    buttonPanel.remove(cancel);
+    buttonPanel.add(showResultsNewFrame);
+    if (serviceCanMergeResults)
+    {
+      buttonPanel.add(mergeResults);
+      buttonPanel.setLayout(new GridLayout(2, 1, 5, 5));
+    }
+    buttonPanel.validate();
+    validate();
+    if (viewResultsImmediatly)
+    {
+      showResultsNewFrame.doClick();
+    }
+  }
+
+  /**
+   * called when job has finished but no result objects can be passed back to
+   * user
+   */
+  public void setFinishedNoResults()
+  {
+    frame.setClosable(true);
+    buttonPanel.remove(cancel);
+    buttonPanel.validate();
+    validate();
+  }
+
+  class AnimatedPanel extends JPanel implements Runnable
+  {
+    long startTime = 0;
+
+    BufferedImage offscreen;
+
+    public void run()
+    {
+      startTime = System.currentTimeMillis();
+
+      while (currentStatus < STATE_STOPPED_OK)
+      {
+        try
+        {
+          Thread.sleep(50);
+
+          int units = (int) ((System.currentTimeMillis() - startTime) / 10f);
+          angle += units;
+          angle %= 360;
+          startTime = System.currentTimeMillis();
+
+          if (currentStatus >= STATE_STOPPED_OK)
+          {
+            angle = 0;
+          }
+
+          repaint();
+        } catch (Exception ex)
+        {
+        }
+      }
+
+      cancel.setEnabled(false);
+    }
+
+    void drawPanel()
+    {
+      if (offscreen == null || offscreen.getWidth(this) != getWidth()
+              || offscreen.getHeight(this) != getHeight())
+      {
+        offscreen = new BufferedImage(getWidth(), getHeight(),
+                BufferedImage.TYPE_INT_ARGB);
+      }
+
+      Graphics2D g = (Graphics2D) offscreen.getGraphics();
+
+      g.setColor(Color.white);
+      g.fillRect(0, 0, getWidth(), getHeight());
+
+      g.setFont(new Font("Arial", Font.BOLD, 12));
+      g.setColor(Color.black);
+
+      switch (currentStatus)
+      {
+      case STATE_QUEUING:
+        g.drawString(title.concat(" - queuing"), 60, 30);
+
+        break;
+
+      case STATE_RUNNING:
+        g.drawString(title.concat(" - running"), 60, 30);
+
+        break;
+
+      case STATE_STOPPED_OK:
+        g.drawString(title.concat(" - complete"), 60, 30);
+
+        break;
+
+      case STATE_CANCELLED_OK:
+        g.drawString(title.concat(" - job cancelled!"), 60, 30);
+
+        break;
+
+      case STATE_STOPPED_ERROR:
+        g.drawString(title.concat(" - job error!"), 60, 30);
+
+        break;
+
+      case STATE_STOPPED_SERVERERROR:
+        g.drawString(title.concat(" - Server Error! (try later)"), 60, 30);
+
+        break;
+      }
+
+      if (image != null)
+      {
+        g.rotate(Math.toRadians(angle), 28, 28);
+        g.drawImage(image, 10, 10, this);
+        g.rotate(-Math.toRadians(angle), 28, 28);
+      }
+    }
+
+    public void paintComponent(Graphics g1)
+    {
+      drawPanel();
+
+      g1.drawImage(offscreen, 0, 0, this);
+    }
+  }
+
+  boolean renderAsHtml = false;
+
+  public void setRenderAsHtml(boolean b)
+  {
+    renderAsHtml = b;
+  }
+
+  public void hyperlinkUpdate(HyperlinkEvent e)
+  {
+    if (e.getEventType() == EventType.ACTIVATED)
+    {
+      String url=null;
+      try
+      {
+        url = e.getURL().toString();
+        Desktop.showUrl(url);
+      } catch (Exception x)
+      {
+        if (url!=null) { 
+          Cache.log.error("Couldn't handle string "+url+" as a URL.");
+        }
+        // ignore any exceptions due to dud links.
+      }
+
+    }
+  }
+}