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 java.awt.BorderLayout;
24 import java.awt.Color;
25 import java.awt.Dimension;
26 import java.awt.Graphics;
27 import java.awt.Graphics2D;
28 import java.awt.GridLayout;
29 import java.awt.Image;
30 import java.awt.MediaTracker;
31 import java.awt.RenderingHints;
32 import java.awt.event.ActionEvent;
33 import java.awt.image.BufferedImage;
34 import java.util.Locale;
35 import java.util.Vector;
37 import javax.swing.JComponent;
38 import javax.swing.JEditorPane;
39 import javax.swing.JInternalFrame;
40 import javax.swing.JPanel;
41 import javax.swing.JProgressBar;
42 import javax.swing.JScrollPane;
43 import javax.swing.JTabbedPane;
44 import javax.swing.JTextArea;
45 import javax.swing.event.HyperlinkEvent;
46 import javax.swing.event.HyperlinkListener;
47 import javax.swing.event.InternalFrameAdapter;
48 import javax.swing.event.InternalFrameEvent;
49 import javax.swing.text.html.HTMLEditorKit;
50 import javax.swing.text.html.StyleSheet;
52 import jalview.jbgui.GWebserviceInfo;
53 import jalview.util.ChannelProperties;
54 import jalview.util.MessageManager;
55 import jalview.ws.WSClientI;
58 * Base class for web service client thread and gui TODO: create StAX parser to
59 * extract html body content reliably when preparing html formatted job statuses
64 public class WebserviceInfo extends GWebserviceInfo
65 implements HyperlinkListener, IProgressIndicator
69 public static final int STATE_QUEUING = 0;
72 public static final int STATE_RUNNING = 1;
74 /** Job has finished with no errors */
75 public static final int STATE_STOPPED_OK = 2;
77 /** Job has been cancelled with no errors */
78 public static final int STATE_CANCELLED_OK = 3;
80 /** job has stopped because of some error */
81 public static final int STATE_STOPPED_ERROR = 4;
83 /** job has failed because of some unavoidable service interruption */
84 public static final int STATE_STOPPED_SERVERERROR = 5;
86 int currentStatus = STATE_QUEUING;
94 jalview.ws.WSClientI thisService;
96 boolean serviceIsCancellable;
100 private IProgressIndicator progressBar;
103 public void setVisible(boolean aFlag)
105 super.setVisible(aFlag);
106 frame.setVisible(aFlag);
109 JTabbedPane subjobs = null;
111 java.util.Vector jobPanes = null;
113 private boolean serviceCanMergeResults = false;
115 private boolean viewResultsImmediatly = true;
121 * to indicate if results will be shown in a new window as soon as
122 * they are available.
124 public boolean isViewResultsImmediatly()
126 return viewResultsImmediatly;
133 * to indicate if results will be shown in a new window as soon as
134 * they are available.
136 public void setViewResultsImmediatly(boolean viewResultsImmediatly)
138 this.viewResultsImmediatly = viewResultsImmediatly;
141 private StyleSheet getStyleSheet(HTMLEditorKit editorKit)
144 // Copied blatantly from
145 // http://www.velocityreviews.com/forums/t132265-string-into-htmldocument.html
146 StyleSheet myStyleSheet = new StyleSheet();
148 myStyleSheet.addStyleSheet(editorKit.getStyleSheet());
150 editorKit.setStyleSheet(myStyleSheet);
153 * Set the style sheet rules here by reading them from the constants
157 * for (int ix=0; ix<CSS_RULES.length; ix++) {
159 * myStyleSheet.addRule(CSS_RULES[ix]);
168 public synchronized int addJobPane()
170 JScrollPane jobpane = new JScrollPane();
171 JComponent _progressText;
174 JEditorPane progressText = new JEditorPane("text/html", "");
175 progressText.addHyperlinkListener(this);
176 _progressText = progressText;
177 // progressText.setFont(new java.awt.Font("Verdana", 0, 10));
178 // progressText.setBorder(null);
179 progressText.setEditable(false);
181 * HTMLEditorKit myEditorKit = new HTMLEditorKit();
183 * StyleSheet myStyleSheet = getStyleSheet(myEditorKit);
185 * HTMLDocument tipDocument = (HTMLDocument)
186 * (myEditorKit.createDefaultDocument());
188 * progressText.setDocument(tipDocument);
189 */progressText.setText("<html><h1>WS Job</h1></html>");
193 JTextArea progressText = new JTextArea();
194 _progressText = progressText;
196 progressText.setFont(new java.awt.Font("Verdana", 0, 10));
197 progressText.setBorder(null);
198 progressText.setEditable(false);
199 progressText.setText("WS Job");
200 progressText.setLineWrap(true);
201 progressText.setWrapStyleWord(true);
203 jobpane.setName("JobPane");
204 jobpane.getViewport().add(_progressText, null);
205 jobpane.setBorder(null);
206 if (jobPanes == null)
208 jobPanes = new Vector();
210 int newpane = jobPanes.size();
211 jobPanes.add(jobpane);
215 this.add(jobpane, BorderLayout.CENTER);
221 // revert to a tabbed pane.
222 JScrollPane firstpane;
223 this.remove(firstpane = (JScrollPane) jobPanes.get(0));
224 subjobs = new JTabbedPane();
225 this.add(subjobs, BorderLayout.CENTER);
226 subjobs.add(firstpane);
227 subjobs.setTitleAt(0, firstpane.getName());
229 subjobs.add(jobpane);
231 return newpane; // index for accessor methods below
235 * Creates a new WebserviceInfo object.
238 * short name and job type
240 * reference or other human readable description
242 * true to display the webservices window immediatly (otherwise need
243 * to call setVisible(true))
245 public WebserviceInfo(String title, String info, boolean makeVisible)
247 init(title, info, 520, 500, makeVisible);
251 * Creates a new WebserviceInfo object.
262 public WebserviceInfo(String title, String info, int width, int height,
265 init(title, info, width, height, makeVisible);
271 * @return DOCUMENT ME!
273 public jalview.ws.WSClientI getthisService()
279 * Update state of GUI based on client capabilities (like whether the job is
280 * cancellable, whether the 'merge results' button is shown.
283 * service client to query for capabilities
285 public void setthisService(jalview.ws.WSClientI newservice)
287 thisService = newservice;
288 serviceIsCancellable = newservice.isCancellable();
289 frame.setClosable(!serviceIsCancellable);
290 serviceCanMergeResults = newservice.canMergeResults();
291 rebuildButtonPanel();
294 private void rebuildButtonPanel()
296 if (buttonPanel != null)
298 buttonPanel.removeAll();
299 if (serviceIsCancellable)
301 buttonPanel.add(cancel);
302 frame.setClosable(false);
306 frame.setClosable(true);
323 void init(String title, String info, int width, int height,
326 frame = new JInternalFrame();
327 frame.setFrameIcon(null);
328 frame.setContentPane(this);
329 Desktop.addInternalFrame(frame, title, makeVisible, width, height);
330 frame.setClosable(false);
332 progressBar = new ProgressBar(statusPanel, statusBar);
337 image = ChannelProperties.getImage("rotatable_logo.48");
339 MediaTracker mt = new MediaTracker(this);
340 mt.addImage(image, 0);
345 } catch (Exception ex)
349 AnimatedPanel ap = new AnimatedPanel();
350 ap.setPreferredSize(new Dimension(60, 60));
351 titlePanel.add(ap, BorderLayout.WEST);
352 titlePanel.add(titleText, BorderLayout.CENTER);
353 setStatus(currentStatus);
355 Thread thread = new Thread(ap);
357 final WebserviceInfo thisinfo = this;
358 frame.addInternalFrameListener(new InternalFrameAdapter()
361 public void internalFrameClosed(InternalFrameEvent evt)
363 // jalview.bin.Console.outPrintln("Shutting down webservice client");
364 WSClientI service = thisinfo.getthisService();
365 if (service != null && service.isCancellable())
379 * integer status from state constants
381 public void setStatus(int status)
383 currentStatus = status;
385 String message = null;
386 switch (currentStatus)
389 message = MessageManager.getString("label.state_queueing");
393 message = MessageManager.getString("label.state_running");
396 case STATE_STOPPED_OK:
397 message = MessageManager.getString("label.state_completed");
400 case STATE_CANCELLED_OK:
401 message = MessageManager.getString("label.state_job_cancelled");
404 case STATE_STOPPED_ERROR:
405 message = MessageManager.getString("label.state_job_error");
408 case STATE_STOPPED_SERVERERROR:
409 message = MessageManager.getString("label.server_error_try_later");
412 titleText.setText(title + (message == null ? "" : " - " + message));
417 * subjob status indicator
422 public void setStatus(int jobpane, int status)
424 if (jobpane < 0 || jobpane >= jobPanes.size())
426 throw new Error(MessageManager.formatMessage(
427 "error.setstatus_called_non_existent_job_pane", new String[]
428 { Integer.valueOf(jobpane).toString() }));
433 setProgressName(jobpane + " - QUEUED", jobpane);
436 setProgressName(jobpane + " - RUNNING", jobpane);
438 case STATE_STOPPED_OK:
439 setProgressName(jobpane + " - FINISHED", jobpane);
441 case STATE_CANCELLED_OK:
442 setProgressName(jobpane + " - CANCELLED", jobpane);
444 case STATE_STOPPED_ERROR:
445 setProgressName(jobpane + " - BROKEN", jobpane);
447 case STATE_STOPPED_SERVERERROR:
448 setProgressName(jobpane + " - ALERT", jobpane);
451 setProgressName(jobpane + " - UNKNOWN STATE", jobpane);
458 * @return DOCUMENT ME!
460 public String getInfoText()
462 return infoText.getText();
471 public void setInfoText(String text)
473 infoText.setText(text);
482 public void appendInfoText(String text)
484 infoText.append(text);
490 * @return DOCUMENT ME!
492 public String getProgressText(int which)
494 if (jobPanes == null)
500 return ((JEditorPane) ((JScrollPane) jobPanes.get(which))
501 .getViewport().getComponent(0)).getText();
505 return ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
506 .getComponent(0)).getText();
516 public void setProgressText(int which, String text)
518 if (jobPanes == null)
524 ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
525 .getComponent(0)).setText(ensureHtmlTagged(text));
529 ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
530 .getComponent(0)).setText(text);
535 * extract content from <body> content </body>
539 * - set to leave the initial html tag intact
541 * - set to leave the final html tag intact
544 private String getHtmlFragment(String text, boolean leaveFirst,
551 String lowertxt = text.toLowerCase(Locale.ROOT);
552 int htmlpos = leaveFirst ? -1 : lowertxt.indexOf("<body");
554 int htmlend = leaveLast ? -1 : lowertxt.indexOf("</body");
555 int htmlpose = lowertxt.indexOf(">", htmlpos),
556 htmlende = lowertxt.indexOf(">", htmlend);
557 if (htmlend == -1 && htmlpos == -1)
563 return text.substring((htmlpos == -1 ? 0 : htmlpose + 1), htmlend);
565 return text.substring(htmlpos == -1 ? 0 : htmlpose + 1);
569 * very simple routine for adding/ensuring html tags are present in text.
572 * @return properly html tag enclosed text
574 private String ensureHtmlTagged(String text)
580 String lowertxt = text.toLowerCase(Locale.ROOT);
581 int htmlpos = lowertxt.indexOf("<body");
582 int htmlend = lowertxt.indexOf("</body");
583 int doctype = lowertxt.indexOf("<!doctype");
584 int xmltype = lowertxt.indexOf("<?xml");
587 text = text + "</body></html>";
591 if ((doctype > -1 && htmlpos > doctype)
592 || (xmltype > -1 && htmlpos > xmltype))
594 text = "<html><head></head><body>\n" + text.substring(htmlpos - 1);
599 text = "<html><head></head><body>\n" + text;
601 if (text.indexOf("<meta") > -1)
604 .println("HTML COntent: \n" + text + "<< END HTML CONTENT\n");
616 public void appendProgressText(int which, String text)
618 if (jobPanes == null)
624 String txt = getHtmlFragment(
625 ((JEditorPane) ((JScrollPane) jobPanes.get(which))
626 .getViewport().getComponent(0)).getText(),
628 ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
630 .setText(ensureHtmlTagged(
631 txt + getHtmlFragment(text, false, true)));
635 ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
636 .getComponent(0)).append(text);
641 * setProgressText(0, text)
643 public void setProgressText(String text)
645 setProgressText(0, text);
649 * appendProgressText(0, text)
651 public void appendProgressText(String text)
653 appendProgressText(0, text);
659 public String getProgressText()
661 return getProgressText(0);
665 * get the tab title for a subjob
671 public String getProgressName(int which)
673 if (jobPanes == null)
679 return subjobs.getTitleAt(which);
683 return ((JScrollPane) jobPanes.get(which)).getViewport()
684 .getComponent(0).getName();
689 * set the tab title for a subjob
696 public void setProgressName(String name, int which)
700 subjobs.setTitleAt(which, name);
701 subjobs.revalidate();
704 JScrollPane c = (JScrollPane) jobPanes.get(which);
705 c.getViewport().getComponent(0).setName(name);
710 * Gui action for cancelling the current job, if possible.
716 protected void cancel_actionPerformed(ActionEvent e)
718 if (!serviceIsCancellable)
720 // JBPNote : TODO: We should REALLY just tell the WSClientI to cancel
721 // anyhow - it has to stop threads and clean up
722 // JBPNote : TODO: Instead of a warning, we should have an optional 'Are
725 MessageManager.getString(
726 "warn.job_cannot_be_cancelled_close_window"),
727 MessageManager.getString("action.cancel_job"));
731 thisService.cancelJob();
733 frame.setClosable(true);
737 * Spawns a thread that pops up a warning dialog box with the given message
743 public void warnUser(final String message, final String title)
745 javax.swing.SwingUtilities.invokeLater(new Runnable()
750 JvOptionPane.showInternalMessageDialog(Desktop.desktop, message,
751 title, JvOptionPane.WARNING_MESSAGE);
758 * Set up GUI for user to get at results - and possibly automatically display
759 * them if viewResultsImmediatly is set.
761 public void setResultsReady()
763 frame.setClosable(true);
764 buttonPanel.remove(cancel);
765 buttonPanel.add(showResultsNewFrame);
766 if (serviceCanMergeResults)
768 buttonPanel.add(mergeResults);
769 buttonPanel.setLayout(new GridLayout(2, 1, 5, 5));
771 buttonPanel.validate();
773 if (viewResultsImmediatly)
775 showResultsNewFrame.doClick();
780 * called when job has finished but no result objects can be passed back to
783 public void setFinishedNoResults()
785 frame.setClosable(true);
786 buttonPanel.remove(cancel);
787 buttonPanel.validate();
791 class AnimatedPanel extends JPanel implements Runnable
795 BufferedImage offscreen;
800 startTime = System.currentTimeMillis();
802 float invSpeed = 15f;
804 while (currentStatus < STATE_STOPPED_OK)
806 if (currentStatus == STATE_QUEUING)
811 else if (currentStatus == STATE_RUNNING)
814 factor = (float) (0.5 + 1.5
815 * (0.5 - (0.5 * Math.sin(3.14159 / 180 * (angle + 45)))));
821 float delta = (System.currentTimeMillis() - startTime) / invSpeed;
822 angle += delta * factor;
824 startTime = System.currentTimeMillis();
826 if (currentStatus >= STATE_STOPPED_OK)
833 } catch (Exception ex)
838 cancel.setEnabled(false);
843 startTime = System.currentTimeMillis();
853 float delta = (System.currentTimeMillis() - startTime) / invSpeed;
854 angle += delta * factor;
855 startTime = System.currentTimeMillis();
863 } catch (Exception ex)
872 if (offscreen == null || offscreen.getWidth(this) != getWidth()
873 || offscreen.getHeight(this) != getHeight())
875 offscreen = new BufferedImage(getWidth(), getHeight(),
876 BufferedImage.TYPE_INT_RGB);
879 Graphics2D g = (Graphics2D) offscreen.getGraphics();
881 g.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
882 RenderingHints.VALUE_ANTIALIAS_ON);
883 g.setRenderingHint(RenderingHints.KEY_INTERPOLATION,
884 RenderingHints.VALUE_INTERPOLATION_BICUBIC);
885 g.setRenderingHint(RenderingHints.KEY_RENDERING,
886 RenderingHints.VALUE_RENDER_QUALITY);
888 g.setColor(Color.white);
889 g.fillRect(0, 0, getWidth(), getHeight());
893 int x = image.getWidth(this) / 2, y = image.getHeight(this) / 2;
894 g.rotate(3.14159 / 180 * (angle), x, y);
895 g.drawImage(image, 0, 0, this);
896 g.rotate(-3.14159 / 180 * (angle), x, y);
901 public void paintComponent(Graphics g1)
905 g1.drawImage(offscreen, 0, 0, this);
909 boolean renderAsHtml = false;
911 public void setRenderAsHtml(boolean b)
917 public void hyperlinkUpdate(HyperlinkEvent e)
919 Desktop.hyperlinkUpdate(e);
925 * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
928 public void setProgressBar(String message, long id)
930 progressBar.setProgressBar(message, id);
934 public void registerHandler(final long id,
935 final IProgressIndicatorHandler handler)
937 progressBar.registerHandler(id, handler);
942 * @return true if any progress bars are still active
945 public boolean operationInProgress()
947 return progressBar.operationInProgress();
951 public JProgressBar getProgressBar(long id)
953 return progressBar.getProgressBar(id);