2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
23 import jalview.jbgui.GWebserviceInfo;
24 import jalview.util.MessageManager;
25 import jalview.ws.WSClientI;
27 import java.awt.BorderLayout;
28 import java.awt.Color;
29 import java.awt.Dimension;
30 import java.awt.Graphics;
31 import java.awt.Graphics2D;
32 import java.awt.GridLayout;
33 import java.awt.Image;
34 import java.awt.MediaTracker;
35 import java.awt.RenderingHints;
36 import java.awt.event.ActionEvent;
37 import java.awt.image.BufferedImage;
38 import java.util.Vector;
40 import javax.swing.JComponent;
41 import javax.swing.JEditorPane;
42 import javax.swing.JInternalFrame;
43 import javax.swing.JPanel;
44 import javax.swing.JScrollPane;
45 import javax.swing.JTabbedPane;
46 import javax.swing.JTextArea;
47 import javax.swing.event.HyperlinkEvent;
48 import javax.swing.event.HyperlinkListener;
49 import javax.swing.event.InternalFrameAdapter;
50 import javax.swing.event.InternalFrameEvent;
51 import javax.swing.text.html.HTMLEditorKit;
52 import javax.swing.text.html.StyleSheet;
55 * Base class for web service client thread and gui TODO: create StAX parser to
56 * extract html body content reliably when preparing html formatted job statuses
61 public class WebserviceInfo extends GWebserviceInfo
62 implements HyperlinkListener, IProgressIndicator
66 public static final int STATE_QUEUING = 0;
69 public static final int STATE_RUNNING = 1;
71 /** Job has finished with no errors */
72 public static final int STATE_STOPPED_OK = 2;
74 /** Job has been cancelled with no errors */
75 public static final int STATE_CANCELLED_OK = 3;
77 /** job has stopped because of some error */
78 public static final int STATE_STOPPED_ERROR = 4;
80 /** job has failed because of some unavoidable service interruption */
81 public static final int STATE_STOPPED_SERVERERROR = 5;
83 int currentStatus = STATE_QUEUING;
91 jalview.ws.WSClientI thisService;
93 boolean serviceIsCancellable;
97 private IProgressIndicator progressBar;
100 public void setVisible(boolean aFlag)
102 super.setVisible(aFlag);
103 frame.setVisible(aFlag);
106 JTabbedPane subjobs = null;
108 java.util.Vector jobPanes = null;
110 private boolean serviceCanMergeResults = false;
112 private boolean viewResultsImmediatly = true;
118 * to indicate if results will be shown in a new window as soon as
119 * they are available.
121 public boolean isViewResultsImmediatly()
123 return viewResultsImmediatly;
130 * to indicate if results will be shown in a new window as soon as
131 * they are available.
133 public void setViewResultsImmediatly(boolean viewResultsImmediatly)
135 this.viewResultsImmediatly = viewResultsImmediatly;
138 private StyleSheet getStyleSheet(HTMLEditorKit editorKit)
141 // Copied blatantly from
142 // http://www.velocityreviews.com/forums/t132265-string-into-htmldocument.html
143 StyleSheet myStyleSheet = new StyleSheet();
145 myStyleSheet.addStyleSheet(editorKit.getStyleSheet());
147 editorKit.setStyleSheet(myStyleSheet);
150 * Set the style sheet rules here by reading them from the constants
154 * for (int ix=0; ix<CSS_RULES.length; ix++) {
156 * myStyleSheet.addRule(CSS_RULES[ix]);
165 public synchronized int addJobPane()
167 JScrollPane jobpane = new JScrollPane();
168 JComponent _progressText;
171 JEditorPane progressText = new JEditorPane("text/html", "");
172 progressText.addHyperlinkListener(this);
173 _progressText = progressText;
174 // progressText.setFont(new java.awt.Font("Verdana", 0, 10));
175 // progressText.setBorder(null);
176 progressText.setEditable(false);
178 * HTMLEditorKit myEditorKit = new HTMLEditorKit();
180 * StyleSheet myStyleSheet = getStyleSheet(myEditorKit);
182 * HTMLDocument tipDocument = (HTMLDocument)
183 * (myEditorKit.createDefaultDocument());
185 * progressText.setDocument(tipDocument);
186 */progressText.setText("<html><h1>WS Job</h1></html>");
190 JTextArea progressText = new JTextArea();
191 _progressText = progressText;
193 progressText.setFont(new java.awt.Font("Verdana", 0, 10));
194 progressText.setBorder(null);
195 progressText.setEditable(false);
196 progressText.setText("WS Job");
197 progressText.setLineWrap(true);
198 progressText.setWrapStyleWord(true);
200 jobpane.setName("JobPane");
201 jobpane.getViewport().add(_progressText, null);
202 jobpane.setBorder(null);
203 if (jobPanes == null)
205 jobPanes = new Vector();
207 int newpane = jobPanes.size();
208 jobPanes.add(jobpane);
212 this.add(jobpane, BorderLayout.CENTER);
218 // revert to a tabbed pane.
219 JScrollPane firstpane;
220 this.remove(firstpane = (JScrollPane) jobPanes.get(0));
221 subjobs = new JTabbedPane();
222 this.add(subjobs, BorderLayout.CENTER);
223 subjobs.add(firstpane);
224 subjobs.setTitleAt(0, firstpane.getName());
226 subjobs.add(jobpane);
228 return newpane; // index for accessor methods below
232 * Creates a new WebserviceInfo object.
235 * short name and job type
237 * reference or other human readable description
239 * true to display the webservices window immediatly (otherwise need
240 * to call setVisible(true))
242 public WebserviceInfo(String title, String info, boolean makeVisible)
244 init(title, info, 520, 500, makeVisible);
248 * Creates a new WebserviceInfo object.
259 public WebserviceInfo(String title, String info, int width, int height,
262 init(title, info, width, height, makeVisible);
268 * @return DOCUMENT ME!
270 public jalview.ws.WSClientI getthisService()
276 * Update state of GUI based on client capabilities (like whether the job is
277 * cancellable, whether the 'merge results' button is shown.
280 * service client to query for capabilities
282 public void setthisService(jalview.ws.WSClientI newservice)
284 thisService = newservice;
285 serviceIsCancellable = newservice.isCancellable();
286 frame.setClosable(!serviceIsCancellable);
287 serviceCanMergeResults = newservice.canMergeResults();
288 rebuildButtonPanel();
291 private void rebuildButtonPanel()
293 if (buttonPanel != null)
295 buttonPanel.removeAll();
296 if (serviceIsCancellable)
298 buttonPanel.add(cancel);
299 frame.setClosable(false);
303 frame.setClosable(true);
320 void init(String title, String info, int width, int height,
323 frame = new JInternalFrame();
324 frame.setContentPane(this);
325 Desktop.addInternalFrame(frame, title, makeVisible, width, height);
326 frame.setClosable(false);
328 progressBar = new ProgressBar(statusPanel, statusBar);
333 java.net.URL url = getClass()
334 .getResource("/images/Jalview_Logo_small_with_border.png");
335 image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
337 MediaTracker mt = new MediaTracker(this);
338 mt.addImage(image, 0);
343 } catch (Exception ex)
347 AnimatedPanel ap = new AnimatedPanel();
348 ap.setPreferredSize(new Dimension(60, 60));
349 titlePanel.add(ap, BorderLayout.WEST);
350 titlePanel.add(titleText, BorderLayout.CENTER);
351 setStatus(currentStatus);
353 Thread thread = new Thread(ap);
355 final WebserviceInfo thisinfo = this;
356 frame.addInternalFrameListener(
357 new InternalFrameAdapter()
360 public void internalFrameClosed(InternalFrameEvent evt)
362 // System.out.println("Shutting down webservice client");
363 WSClientI service = thisinfo.getthisService();
364 if (service != null && service.isCancellable())
378 * integer status from state constants
380 public void setStatus(int status)
382 currentStatus = status;
384 String message = null;
385 switch (currentStatus)
388 message = MessageManager.getString("label.state_queueing");
392 message = MessageManager.getString("label.state_running");
395 case STATE_STOPPED_OK:
396 message = MessageManager.getString("label.state_completed");
399 case STATE_CANCELLED_OK:
400 message = MessageManager.getString("label.state_job_cancelled");
403 case STATE_STOPPED_ERROR:
404 message = MessageManager.getString("label.state_job_error");
407 case STATE_STOPPED_SERVERERROR:
408 message = MessageManager.getString("label.server_error_try_later");
411 titleText.setText(title + (message == null ? "" : " - " + message));
416 * subjob status indicator
421 public void setStatus(int jobpane, int status)
423 if (jobpane < 0 || jobpane >= jobPanes.size())
425 throw new Error(MessageManager.formatMessage(
426 "error.setstatus_called_non_existent_job_pane", new String[]
427 { Integer.valueOf(jobpane).toString() }));
432 setProgressName(jobpane + " - QUEUED", jobpane);
435 setProgressName(jobpane + " - RUNNING", jobpane);
437 case STATE_STOPPED_OK:
438 setProgressName(jobpane + " - FINISHED", jobpane);
440 case STATE_CANCELLED_OK:
441 setProgressName(jobpane + " - CANCELLED", jobpane);
443 case STATE_STOPPED_ERROR:
444 setProgressName(jobpane + " - BROKEN", jobpane);
446 case STATE_STOPPED_SERVERERROR:
447 setProgressName(jobpane + " - ALERT", jobpane);
450 setProgressName(jobpane + " - UNKNOWN STATE", jobpane);
457 * @return DOCUMENT ME!
459 public String getInfoText()
461 return infoText.getText();
470 public void setInfoText(String text)
472 infoText.setText(text);
481 public void appendInfoText(String text)
483 infoText.append(text);
489 * @return DOCUMENT ME!
491 public String getProgressText(int which)
493 if (jobPanes == null)
499 return ((JEditorPane) ((JScrollPane) jobPanes.get(which))
500 .getViewport().getComponent(0)).getText();
504 return ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
505 .getComponent(0)).getText();
515 public void setProgressText(int which, String text)
517 if (jobPanes == null)
523 ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
524 .getComponent(0)).setText(ensureHtmlTagged(text));
528 ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
529 .getComponent(0)).setText(text);
534 * extract content from <body> content </body>
538 * - set to leave the initial html tag intact
540 * - set to leave the final html tag intact
543 private String getHtmlFragment(String text, boolean leaveFirst,
550 String lowertxt = text.toLowerCase();
551 int htmlpos = leaveFirst ? -1 : lowertxt.indexOf("<body");
553 int htmlend = leaveLast ? -1 : lowertxt.indexOf("</body");
554 int htmlpose = lowertxt.indexOf(">", htmlpos),
555 htmlende = lowertxt.indexOf(">", htmlend);
556 if (htmlend == -1 && htmlpos == -1)
562 return text.substring((htmlpos == -1 ? 0 : htmlpose + 1), htmlend);
564 return text.substring(htmlpos == -1 ? 0 : htmlpose + 1);
568 * very simple routine for adding/ensuring html tags are present in text.
571 * @return properly html tag enclosed text
573 private String ensureHtmlTagged(String text)
579 String lowertxt = text.toLowerCase();
580 int htmlpos = lowertxt.indexOf("<body");
581 int htmlend = lowertxt.indexOf("</body");
582 int doctype = lowertxt.indexOf("<!doctype");
583 int xmltype = lowertxt.indexOf("<?xml");
586 text = text + "</body></html>";
590 if ((doctype > -1 && htmlpos > doctype)
591 || (xmltype > -1 && htmlpos > xmltype))
593 text = "<html><head></head><body>\n" + text.substring(htmlpos - 1);
598 text = "<html><head></head><body>\n" + text;
600 if (text.indexOf("<meta") > -1)
603 .println("HTML COntent: \n" + text + "<< END HTML CONTENT\n");
615 public void appendProgressText(int which, String text)
617 if (jobPanes == null)
623 String txt = getHtmlFragment(
624 ((JEditorPane) ((JScrollPane) jobPanes.get(which))
625 .getViewport().getComponent(0)).getText(),
627 ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
629 .setText(ensureHtmlTagged(
630 txt + getHtmlFragment(text, false, true)));
634 ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
635 .getComponent(0)).append(text);
640 * setProgressText(0, text)
642 public void setProgressText(String text)
644 setProgressText(0, text);
648 * appendProgressText(0, text)
650 public void appendProgressText(String text)
652 appendProgressText(0, text);
658 public String getProgressText()
660 return getProgressText(0);
664 * get the tab title for a subjob
670 public String getProgressName(int which)
672 if (jobPanes == null)
678 return subjobs.getTitleAt(which);
682 return ((JScrollPane) jobPanes.get(which)).getViewport()
683 .getComponent(0).getName();
688 * set the tab title for a subjob
695 public void setProgressName(String name, int which)
699 subjobs.setTitleAt(which, name);
700 subjobs.revalidate();
703 JScrollPane c = (JScrollPane) jobPanes.get(which);
704 c.getViewport().getComponent(0).setName(name);
709 * Gui action for cancelling the current job, if possible.
715 protected void cancel_actionPerformed(ActionEvent e)
717 if (!serviceIsCancellable)
719 // JBPNote : TODO: We should REALLY just tell the WSClientI to cancel
720 // anyhow - it has to stop threads and clean up
721 // JBPNote : TODO: Instead of a warning, we should have an optional 'Are
724 MessageManager.getString(
725 "warn.job_cannot_be_cancelled_close_window"),
726 MessageManager.getString("action.cancel_job"));
730 thisService.cancelJob();
732 frame.setClosable(true);
736 * Spawns a thread that pops up a warning dialog box with the given message
742 public void warnUser(final String message, final String title)
744 javax.swing.SwingUtilities.invokeLater(new Runnable()
749 JvOptionPane.showInternalMessageDialog(Desktop.desktop, message,
750 title, JvOptionPane.WARNING_MESSAGE);
757 * Set up GUI for user to get at results - and possibly automatically display
758 * them if viewResultsImmediatly is set.
760 public void setResultsReady()
762 frame.setClosable(true);
763 buttonPanel.remove(cancel);
764 buttonPanel.add(showResultsNewFrame);
765 if (serviceCanMergeResults)
767 buttonPanel.add(mergeResults);
768 buttonPanel.setLayout(new GridLayout(2, 1, 5, 5));
770 buttonPanel.validate();
772 if (viewResultsImmediatly)
774 showResultsNewFrame.doClick();
779 * called when job has finished but no result objects can be passed back to
782 public void setFinishedNoResults()
784 frame.setClosable(true);
785 buttonPanel.remove(cancel);
786 buttonPanel.validate();
790 class AnimatedPanel extends JPanel implements Runnable
794 BufferedImage offscreen;
799 startTime = System.currentTimeMillis();
801 float invSpeed = 15f;
803 while (currentStatus < STATE_STOPPED_OK)
805 if (currentStatus == STATE_QUEUING)
810 else if (currentStatus == STATE_RUNNING)
813 factor = (float) (0.5 + 1.5
814 * (0.5 - (0.5 * Math.sin(3.14159 / 180 * (angle + 45)))));
820 float delta = (System.currentTimeMillis() - startTime) / invSpeed;
821 angle += delta * factor;
823 startTime = System.currentTimeMillis();
825 if (currentStatus >= STATE_STOPPED_OK)
832 } catch (Exception ex)
837 cancel.setEnabled(false);
842 startTime = System.currentTimeMillis();
852 float delta = (System.currentTimeMillis() - startTime) / invSpeed;
853 angle += delta * factor;
854 startTime = System.currentTimeMillis();
862 } catch (Exception ex)
871 if (offscreen == null || offscreen.getWidth(this) != getWidth()
872 || offscreen.getHeight(this) != getHeight())
874 offscreen = new BufferedImage(getWidth(), getHeight(),
875 BufferedImage.TYPE_INT_RGB);
878 Graphics2D g = (Graphics2D) offscreen.getGraphics();
880 g.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
881 RenderingHints.VALUE_ANTIALIAS_ON);
882 g.setRenderingHint(RenderingHints.KEY_INTERPOLATION,
883 RenderingHints.VALUE_INTERPOLATION_BICUBIC);
884 g.setRenderingHint(RenderingHints.KEY_RENDERING,
885 RenderingHints.VALUE_RENDER_QUALITY);
887 g.setColor(Color.white);
888 g.fillRect(0, 0, getWidth(), getHeight());
892 int x = image.getWidth(this) / 2, y = image.getHeight(this) / 2;
893 g.rotate(3.14159 / 180 * (angle), x, y);
894 g.drawImage(image, 0, 0, this);
895 g.rotate(-3.14159 / 180 * (angle), x, y);
900 public void paintComponent(Graphics g1)
904 g1.drawImage(offscreen, 0, 0, this);
908 boolean renderAsHtml = false;
910 public void setRenderAsHtml(boolean b)
916 public void hyperlinkUpdate(HyperlinkEvent e)
918 Desktop.hyperlinkUpdate(e);
924 * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
927 public void setProgressBar(String message, long id)
929 progressBar.setProgressBar(message, id);
933 public void registerHandler(final long id,
934 final IProgressIndicatorHandler handler)
936 progressBar.registerHandler(id, handler);
941 * @return true if any progress bars are still active
944 public boolean operationInProgress()
946 return progressBar.operationInProgress();