X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FWebserviceInfo.java;h=cd93277bfb14f0aa5e1fb05a23f3b7be73fdcec1;hb=2273eba5668e5340354da60fed329c6c716cc439;hp=4d0c63485bb1177a3bd1917945125c411058ebc5;hpb=153dd62dc91da13ae732600e6ea55ddbe15eab39;p=jalview.git

diff --git a/src/jalview/gui/WebserviceInfo.java b/src/jalview/gui/WebserviceInfo.java
old mode 100755
new mode 100644
index 4d0c634..cd93277
--- a/src/jalview/gui/WebserviceInfo.java
+++ b/src/jalview/gui/WebserviceInfo.java
@@ -1,39 +1,68 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
+ * Copyright (C) 2014 The Jalview Authors
  * 
  * 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.
- * 
+ * 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/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.gui;
 
-import java.util.*;
-
-import java.awt.*;
-import java.awt.event.*;
-import java.awt.image.*;
-import javax.swing.*;
-
-import jalview.jbgui.*;
+import jalview.jbgui.GWebserviceInfo;
+import jalview.util.MessageManager;
 import jalview.ws.WSClientI;
 
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.Font;
+import java.awt.Graphics;
+import java.awt.Graphics2D;
+import java.awt.GridLayout;
+import java.awt.Image;
+import java.awt.MediaTracker;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.image.BufferedImage;
+import java.util.Hashtable;
+import java.util.Vector;
+
+import javax.swing.JButton;
+import javax.swing.JComponent;
+import javax.swing.JEditorPane;
+import javax.swing.JInternalFrame;
+import javax.swing.JLabel;
+import javax.swing.JOptionPane;
+import javax.swing.JPanel;
+import javax.swing.JProgressBar;
+import javax.swing.JScrollPane;
+import javax.swing.JTabbedPane;
+import javax.swing.JTextArea;
+import javax.swing.event.HyperlinkEvent;
+import javax.swing.event.HyperlinkListener;
+import javax.swing.text.html.HTMLEditorKit;
+import javax.swing.text.html.StyleSheet;
+
 /**
- * Base class for web service client thread and gui
+ * 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
+public class WebserviceInfo extends GWebserviceInfo implements
+        HyperlinkListener, IProgressIndicator
 {
 
   /** Job is Queued */
@@ -68,6 +97,13 @@ public class WebserviceInfo extends GWebserviceInfo
 
   JInternalFrame frame;
 
+  @Override
+  public void setVisible(boolean aFlag)
+  {
+    super.setVisible(aFlag);
+    frame.setVisible(aFlag);
+  };
+
   JTabbedPane subjobs = null;
 
   java.util.Vector jobPanes = null;
@@ -76,19 +112,94 @@ public class WebserviceInfo extends GWebserviceInfo
 
   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();
-    JTextArea progressText = new JTextArea();
-    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);
+    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.getViewport().add(_progressText, null);
     jobpane.setBorder(null);
     if (jobPanes == null)
     {
@@ -125,10 +236,13 @@ public class WebserviceInfo extends GWebserviceInfo
    *          short name and job type
    * @param info
    *          reference or other human readable description
+   * @param makeVisible
+   *          true to display the webservices window immediatly (otherwise need
+   *          to call setVisible(true))
    */
-  public WebserviceInfo(String title, String info)
+  public WebserviceInfo(String title, String info, boolean makeVisible)
   {
-    init(title, info, 520, 500);
+    init(title, info, 520, 500, makeVisible);
   }
 
   /**
@@ -143,9 +257,10 @@ public class WebserviceInfo extends GWebserviceInfo
    * @param height
    *          DOCUMENT ME!
    */
-  public WebserviceInfo(String title, String info, int width, int height)
+  public WebserviceInfo(String title, String info, int width, int height,
+          boolean makeVisible)
   {
-    init(title, info, width, height);
+    init(title, info, width, height, makeVisible);
   }
 
   /**
@@ -203,17 +318,19 @@ public class WebserviceInfo extends GWebserviceInfo
    * @param height
    *          DOCUMENT ME!
    */
-  void init(String title, String info, int width, int height)
+  void init(String title, String info, int width, int height,
+          boolean makeVisible)
   {
     frame = new JInternalFrame();
     frame.setContentPane(this);
-    Desktop.addInternalFrame(frame, title, width, height);
+    Desktop.addInternalFrame(frame, title, makeVisible, width, height);
     frame.setClosable(false);
 
     this.title = title;
     setInfoText(info);
 
-    java.net.URL url = getClass().getResource("/images/logo.gif");
+    java.net.URL url = getClass().getResource(
+            "/images/Jalview_Logo_small.png");
     image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
 
     MediaTracker mt = new MediaTracker(this);
@@ -270,8 +387,7 @@ public class WebserviceInfo extends GWebserviceInfo
   {
     if (jobpane < 0 || jobpane >= jobPanes.size())
     {
-      throw new Error("setStatus called for non-existent job pane."
-              + jobpane);
+      throw new Error(MessageManager.formatMessage("error.setstatus_called_non_existent_job_pane", new String[]{Integer.valueOf(jobpane).toString()}));
     }
     switch (status)
     {
@@ -341,8 +457,16 @@ public class WebserviceInfo extends GWebserviceInfo
     {
       addJobPane();
     }
-    return ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
-            .getComponent(0)).getText();
+    if (renderAsHtml)
+    {
+      return ((JEditorPane) ((JScrollPane) jobPanes.get(which))
+              .getViewport().getComponent(0)).getText();
+    }
+    else
+    {
+      return ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
+              .getComponent(0)).getText();
+    }
   }
 
   /**
@@ -357,8 +481,92 @@ public class WebserviceInfo extends GWebserviceInfo
     {
       addJobPane();
     }
-    ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
-            .getComponent(0)).setText(text);
+    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;
   }
 
   /**
@@ -373,8 +581,21 @@ public class WebserviceInfo extends GWebserviceInfo
     {
       addJobPane();
     }
-    ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
-            .getComponent(0)).append(text);
+    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);
+    }
   }
 
   /**
@@ -460,8 +681,8 @@ public class WebserviceInfo extends GWebserviceInfo
       // 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");
+      warnUser(MessageManager.getString("warn.job_cannot_be_cancelled_close_window"),
+              MessageManager.getString("action.cancel_job"));
     }
     else
     {
@@ -579,41 +800,62 @@ public class WebserviceInfo extends GWebserviceInfo
       switch (currentStatus)
       {
       case STATE_QUEUING:
-        g.drawString(title.concat(" - queuing"), 60, 30);
+        g.drawString(
+                title.concat(" - ").concat(
+                        MessageManager.getString("label.state_queueing")),
+                60, 30);
 
         break;
 
       case STATE_RUNNING:
-        g.drawString(title.concat(" - running"), 60, 30);
+        g.drawString(
+                title.concat(" - ").concat(
+                        MessageManager.getString("label.state_running")),
+                60, 30);
 
         break;
 
       case STATE_STOPPED_OK:
-        g.drawString(title.concat(" - complete"), 60, 30);
+        g.drawString(
+                title.concat(" - ").concat(
+                        MessageManager.getString("label.state_completed")),
+                60, 30);
 
         break;
 
       case STATE_CANCELLED_OK:
-        g.drawString(title.concat(" - job cancelled!"), 60, 30);
+        g.drawString(
+                title.concat(" - ").concat(
+                        MessageManager
+                                .getString("label.state_job_cancelled")),
+                60, 30);
 
         break;
 
       case STATE_STOPPED_ERROR:
-        g.drawString(title.concat(" - job error!"), 60, 30);
+        g.drawString(
+                title.concat(" - ").concat(
+                        MessageManager.getString("label.state_job_error")),
+                60, 30);
 
         break;
 
       case STATE_STOPPED_SERVERERROR:
-        g.drawString(title.concat(" - Server Error! (try later)"), 60, 30);
+        g.drawString(
+                title.concat(" - ").concat(
+                        MessageManager
+                                .getString("label.server_error_try_later")),
+                60, 30);
 
         break;
       }
 
       if (image != null)
       {
-        g.rotate(Math.toRadians(angle), 28, 28);
+        int x = image.getWidth(this) / 2, y = image.getHeight(this) / 2;
+        g.rotate(Math.toRadians(angle), 10 + x, 10 + y);
         g.drawImage(image, 10, 10, this);
-        g.rotate(-Math.toRadians(angle), 28, 28);
+        g.rotate(-Math.toRadians(angle), 10 + x, 10 + y);
       }
     }
 
@@ -624,4 +866,116 @@ public class WebserviceInfo extends GWebserviceInfo
       g1.drawImage(offscreen, 0, 0, this);
     }
   }
+
+  boolean renderAsHtml = false;
+
+  public void setRenderAsHtml(boolean b)
+  {
+    renderAsHtml = b;
+  }
+
+  public void hyperlinkUpdate(HyperlinkEvent e)
+  {
+    Desktop.hyperlinkUpdate(e);
+  }
+
+  // methods for implementing IProgressIndicator
+  // need to refactor to a reusable stub class
+  Hashtable progressBars, progressBarHandlers;
+
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
+   */
+  @Override
+  public void setProgressBar(String message, long id)
+  {
+    if (progressBars == null)
+    {
+      progressBars = new Hashtable();
+      progressBarHandlers = new Hashtable();
+    }
+
+    JPanel progressPanel;
+    Long lId = new Long(id);
+    GridLayout layout = (GridLayout) statusPanel.getLayout();
+    if (progressBars.get(lId) != null)
+    {
+      progressPanel = (JPanel) progressBars.get(new Long(id));
+      statusPanel.remove(progressPanel);
+      progressBars.remove(lId);
+      progressPanel = null;
+      if (message != null)
+      {
+        statusBar.setText(message);
+      }
+      if (progressBarHandlers.contains(lId))
+      {
+        progressBarHandlers.remove(lId);
+      }
+      layout.setRows(layout.getRows() - 1);
+    }
+    else
+    {
+      progressPanel = new JPanel(new BorderLayout(10, 5));
+
+      JProgressBar progressBar = new JProgressBar();
+      progressBar.setIndeterminate(true);
+
+      progressPanel.add(new JLabel(message), BorderLayout.WEST);
+      progressPanel.add(progressBar, BorderLayout.CENTER);
+
+      layout.setRows(layout.getRows() + 1);
+      statusPanel.add(progressPanel);
+
+      progressBars.put(lId, progressPanel);
+    }
+    // update GUI
+    // setMenusForViewport();
+    validate();
+  }
+
+  @Override
+  public void registerHandler(final long id,
+          final IProgressIndicatorHandler handler)
+  {
+    if (progressBarHandlers == null || !progressBars.contains(new Long(id)))
+    {
+      throw new Error(MessageManager.getString("error.call_setprogressbar_before_registering_handler"));
+    }
+    progressBarHandlers.put(new Long(id), handler);
+    final JPanel progressPanel = (JPanel) progressBars.get(new Long(id));
+    if (handler.canCancel())
+    {
+      JButton cancel = new JButton(
+              MessageManager.getString("action.cancel"));
+      final IProgressIndicator us = this;
+      cancel.addActionListener(new ActionListener()
+      {
+
+        @Override
+        public void actionPerformed(ActionEvent e)
+        {
+          handler.cancelActivity(id);
+          us.setProgressBar(MessageManager.formatMessage("label.cancelled_params", new String[]{((JLabel) progressPanel.getComponent(0)).getText()}), id);
+        }
+      });
+      progressPanel.add(cancel, BorderLayout.EAST);
+    }
+  }
+
+  /**
+   * 
+   * @return true if any progress bars are still active
+   */
+  @Override
+  public boolean operationInProgress()
+  {
+    if (progressBars != null && progressBars.size() > 0)
+    {
+      return true;
+    }
+    return false;
+  }
 }