/*
- * Jalview - A Sequence Alignment Editor and Viewer
- * Copyright (C) 2007 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
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ 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.
- *
- * 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.
- *
+ *
+ * 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 this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ * 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.image.BufferedImage;
+import java.util.Vector;
+
+import javax.swing.JComponent;
+import javax.swing.JEditorPane;
+import javax.swing.JInternalFrame;
+import javax.swing.JPanel;
+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
+ implements HyperlinkListener, IProgressIndicator
{
/** Job is Queued */
JInternalFrame frame;
+ private IProgressIndicator progressBar;
+
+ @Override
+ public void setVisible(boolean aFlag)
+ {
+ super.setVisible(aFlag);
+ frame.setVisible(aFlag);
+ };
+
JTabbedPane subjobs = null;
java.util.Vector jobPanes = null;
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)
{
* Creates a new WebserviceInfo object.
*
* @param title
- * short name and job type
+ * short name and job type
* @param info
- * reference or other human readable description
+ * 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);
}
/**
* Creates a new WebserviceInfo object.
*
* @param title
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param info
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param width
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param height
- * DOCUMENT ME!
+ * 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);
}
/**
* cancellable, whether the 'merge results' button is shown.
*
* @param newservice
- * service client to query for capabilities
+ * service client to query for capabilities
*/
public void setthisService(jalview.ws.WSClientI newservice)
{
* DOCUMENT ME!
*
* @param title
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param info
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param width
- * DOCUMENT ME!
+ * DOCUMENT ME!
* @param height
- * DOCUMENT ME!
+ * 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);
+ progressBar = new ProgressBar(statusPanel, statusBar);
+
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);
Thread thread = new Thread(ap);
thread.start();
final WebserviceInfo thisinfo = this;
- frame
- .addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
+ frame.addInternalFrameListener(
+ new javax.swing.event.InternalFrameAdapter()
{
+ @Override
public void internalFrameClosed(
javax.swing.event.InternalFrameEvent evt)
{
// System.out.println("Shutting down webservice client");
WSClientI service = thisinfo.getthisService();
- if (service != null)
+ if (service != null && service.isCancellable())
{
service.cancelJob();
}
};
});
+ frame.validate();
}
* DOCUMENT ME!
*
* @param status
- * integer status from state constants
+ * integer status from state constants
*/
public void setStatus(int status)
{
{
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)
{
* DOCUMENT ME!
*
* @param text
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
public void setInfoText(String text)
{
* DOCUMENT ME!
*
* @param text
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
public void appendInfoText(String text)
{
{
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();
+ }
}
/**
* DOCUMENT ME!
*
* @param text
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
public void setProgressText(int which, String text)
{
{
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 <body> content </body>
+ *
+ * @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!
+ * DOCUMENT ME!
*/
public void appendProgressText(int which, String text)
{
{
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);
+ }
}
/**
* get the tab title for a subjob
*
* @param which
- * int
+ * int
* @return String
*/
public String getProgressName(int which)
* set the tab title for a subjob
*
* @param name
- * String
+ * String
* @param which
- * int
+ * int
*/
public void setProgressName(String name, int which)
{
* Gui action for cancelling the current job, if possible.
*
* @param e
- * DOCUMENT ME!
+ * DOCUMENT ME!
*/
+ @Override
protected void cancel_actionPerformed(ActionEvent e)
{
if (!serviceIsCancellable)
// anyhow - it has to stop threads and clean up
// JBPNote : TODO: Instead of a warning, we should have an optional 'Are
// you sure?' prompt
- JOptionPane.showInternalMessageDialog(Desktop.desktop,
- "This job cannot be cancelled.\nJust close the window.",
- "Cancel job", JOptionPane.WARNING_MESSAGE);
+ warnUser(
+ MessageManager.getString(
+ "warn.job_cannot_be_cancelled_close_window"),
+ MessageManager.getString("action.cancel_job"));
}
else
{
}
/**
+ * 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()
+ {
+ @Override
+ public void run()
+ {
+ JvOptionPane.showInternalMessageDialog(Desktop.desktop, message,
+ title, JvOptionPane.WARNING_MESSAGE);
+
+ }
+ });
+ }
+
+ /**
* Set up GUI for user to get at results - and possibly automatically display
* them if viewResultsImmediatly is set.
*/
BufferedImage offscreen;
+ @Override
public void run()
{
startTime = System.currentTimeMillis();
{
Thread.sleep(50);
- int units = (int) ((System.currentTimeMillis() - startTime) / 10f);
+ int units = (int) ((System.currentTimeMillis() - startTime)
+ / 10f);
angle += units;
angle %= 360;
startTime = System.currentTimeMillis();
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);
}
}
+ @Override
public void paintComponent(Graphics g1)
{
drawPanel();
g1.drawImage(offscreen, 0, 0, this);
}
}
+
+ boolean renderAsHtml = false;
+
+ public void setRenderAsHtml(boolean b)
+ {
+ renderAsHtml = b;
+ }
+
+ @Override
+ public void hyperlinkUpdate(HyperlinkEvent e)
+ {
+ Desktop.hyperlinkUpdate(e);
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
+ */
+ @Override
+ public void setProgressBar(String message, long id)
+ {
+ progressBar.setProgressBar(message, id);
+ }
+
+ @Override
+ public void registerHandler(final long id,
+ final IProgressIndicatorHandler handler)
+ {
+ progressBar.registerHandler(id, handler);
+ }
+
+ /**
+ *
+ * @return true if any progress bars are still active
+ */
+ @Override
+ public boolean operationInProgress()
+ {
+ return progressBar.operationInProgress();
+ }
}