2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
3 * Copyright (C) 2014 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 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
17 * The Jalview Authors are detailed in the 'AUTHORS' file.
24 import java.awt.event.*;
25 import java.awt.image.*;
27 import javax.swing.event.HyperlinkEvent;
28 import javax.swing.event.HyperlinkListener;
29 import javax.swing.text.html.HTMLEditorKit;
30 import javax.swing.text.html.StyleSheet;
32 import jalview.jbgui.*;
33 import jalview.util.MessageManager;
34 import jalview.ws.WSClientI;
37 * Base class for web service client thread and gui TODO: create StAX parser to
38 * extract html body content reliably when preparing html formatted job statuses
43 public class WebserviceInfo extends GWebserviceInfo implements
44 HyperlinkListener, IProgressIndicator
48 public static final int STATE_QUEUING = 0;
51 public static final int STATE_RUNNING = 1;
53 /** Job has finished with no errors */
54 public static final int STATE_STOPPED_OK = 2;
56 /** Job has been cancelled with no errors */
57 public static final int STATE_CANCELLED_OK = 3;
59 /** job has stopped because of some error */
60 public static final int STATE_STOPPED_ERROR = 4;
62 /** job has failed because of some unavoidable service interruption */
63 public static final int STATE_STOPPED_SERVERERROR = 5;
65 int currentStatus = STATE_QUEUING;
73 jalview.ws.WSClientI thisService;
75 boolean serviceIsCancellable;
79 JTabbedPane subjobs = null;
81 java.util.Vector jobPanes = null;
83 private boolean serviceCanMergeResults = false;
85 private boolean viewResultsImmediatly = true;
91 * to indicate if results will be shown in a new window as soon as
94 public boolean isViewResultsImmediatly()
96 return viewResultsImmediatly;
103 * to indicate if results will be shown in a new window as soon as
104 * they are available.
106 public void setViewResultsImmediatly(boolean viewResultsImmediatly)
108 this.viewResultsImmediatly = viewResultsImmediatly;
111 private StyleSheet getStyleSheet(HTMLEditorKit editorKit)
114 // Copied blatantly from
115 // http://www.velocityreviews.com/forums/t132265-string-into-htmldocument.html
116 StyleSheet myStyleSheet = new StyleSheet();
118 myStyleSheet.addStyleSheet(editorKit.getStyleSheet());
120 editorKit.setStyleSheet(myStyleSheet);
123 * Set the style sheet rules here by reading them from the constants
127 * for (int ix=0; ix<CSS_RULES.length; ix++) {
129 * myStyleSheet.addRule(CSS_RULES[ix]);
138 public synchronized int addJobPane()
140 JScrollPane jobpane = new JScrollPane();
141 JComponent _progressText;
144 JEditorPane progressText = new JEditorPane("text/html", "");
145 progressText.addHyperlinkListener(this);
146 _progressText = progressText;
147 // progressText.setFont(new java.awt.Font("Verdana", 0, 10));
148 // progressText.setBorder(null);
149 progressText.setEditable(false);
151 * HTMLEditorKit myEditorKit = new HTMLEditorKit();
153 * StyleSheet myStyleSheet = getStyleSheet(myEditorKit);
155 * HTMLDocument tipDocument = (HTMLDocument)
156 * (myEditorKit.createDefaultDocument());
158 * progressText.setDocument(tipDocument);
159 */progressText.setText("<html><h1>WS Job</h1></html>");
163 JTextArea progressText = new JTextArea();
164 _progressText = progressText;
166 progressText.setFont(new java.awt.Font("Verdana", 0, 10));
167 progressText.setBorder(null);
168 progressText.setEditable(false);
169 progressText.setText("WS Job");
170 progressText.setLineWrap(true);
171 progressText.setWrapStyleWord(true);
173 jobpane.setName("JobPane");
174 jobpane.getViewport().add(_progressText, null);
175 jobpane.setBorder(null);
176 if (jobPanes == null)
178 jobPanes = new Vector();
180 int newpane = jobPanes.size();
181 jobPanes.add(jobpane);
185 this.add(jobpane, BorderLayout.CENTER);
191 // revert to a tabbed pane.
192 JScrollPane firstpane;
193 this.remove(firstpane = (JScrollPane) jobPanes.get(0));
194 subjobs = new JTabbedPane();
195 this.add(subjobs, BorderLayout.CENTER);
196 subjobs.add(firstpane);
197 subjobs.setTitleAt(0, firstpane.getName());
199 subjobs.add(jobpane);
201 return newpane; // index for accessor methods below
205 * Creates a new WebserviceInfo object.
208 * short name and job type
210 * reference or other human readable description
212 public WebserviceInfo(String title, String info)
214 init(title, info, 520, 500);
218 * Creates a new WebserviceInfo object.
229 public WebserviceInfo(String title, String info, int width, int height)
231 init(title, info, width, height);
237 * @return DOCUMENT ME!
239 public jalview.ws.WSClientI getthisService()
245 * Update state of GUI based on client capabilities (like whether the job is
246 * cancellable, whether the 'merge results' button is shown.
249 * service client to query for capabilities
251 public void setthisService(jalview.ws.WSClientI newservice)
253 thisService = newservice;
254 serviceIsCancellable = newservice.isCancellable();
255 frame.setClosable(!serviceIsCancellable);
256 serviceCanMergeResults = newservice.canMergeResults();
257 rebuildButtonPanel();
260 private void rebuildButtonPanel()
262 if (buttonPanel != null)
264 buttonPanel.removeAll();
265 if (serviceIsCancellable)
267 buttonPanel.add(cancel);
268 frame.setClosable(false);
272 frame.setClosable(true);
289 void init(String title, String info, int width, int height)
291 frame = new JInternalFrame();
292 frame.setContentPane(this);
293 Desktop.addInternalFrame(frame, title, width, height);
294 frame.setClosable(false);
299 java.net.URL url = getClass().getResource(
300 "/images/Jalview_Logo_small.png");
301 image = java.awt.Toolkit.getDefaultToolkit().createImage(url);
303 MediaTracker mt = new MediaTracker(this);
304 mt.addImage(image, 0);
309 } catch (Exception ex)
313 AnimatedPanel ap = new AnimatedPanel();
314 titlePanel.add(ap, BorderLayout.CENTER);
316 Thread thread = new Thread(ap);
318 final WebserviceInfo thisinfo = this;
319 frame.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter()
321 public void internalFrameClosed(
322 javax.swing.event.InternalFrameEvent evt)
324 // System.out.println("Shutting down webservice client");
325 WSClientI service = thisinfo.getthisService();
326 if (service != null && service.isCancellable())
340 * integer status from state constants
342 public void setStatus(int status)
344 currentStatus = status;
348 * subjob status indicator
353 public void setStatus(int jobpane, int status)
355 if (jobpane < 0 || jobpane >= jobPanes.size())
357 throw new Error("setStatus called for non-existent job pane."
363 setProgressName(jobpane + " - QUEUED", jobpane);
366 setProgressName(jobpane + " - RUNNING", jobpane);
368 case STATE_STOPPED_OK:
369 setProgressName(jobpane + " - FINISHED", jobpane);
371 case STATE_CANCELLED_OK:
372 setProgressName(jobpane + " - CANCELLED", jobpane);
374 case STATE_STOPPED_ERROR:
375 setProgressName(jobpane + " - BROKEN", jobpane);
377 case STATE_STOPPED_SERVERERROR:
378 setProgressName(jobpane + " - ALERT", jobpane);
381 setProgressName(jobpane + " - UNKNOWN STATE", jobpane);
388 * @return DOCUMENT ME!
390 public String getInfoText()
392 return infoText.getText();
401 public void setInfoText(String text)
403 infoText.setText(text);
412 public void appendInfoText(String text)
414 infoText.append(text);
420 * @return DOCUMENT ME!
422 public String getProgressText(int which)
424 if (jobPanes == null)
430 return ((JEditorPane) ((JScrollPane) jobPanes.get(which))
431 .getViewport().getComponent(0)).getText();
435 return ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
436 .getComponent(0)).getText();
446 public void setProgressText(int which, String text)
448 if (jobPanes == null)
454 ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
455 .getComponent(0)).setText(ensureHtmlTagged(text));
459 ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
460 .getComponent(0)).setText(text);
465 * extract content from <body> content </body>
469 * - set to leave the initial html tag intact
471 * - set to leave the final html tag intact
474 private String getHtmlFragment(String text, boolean leaveFirst,
481 String lowertxt = text.toLowerCase();
482 int htmlpos = leaveFirst ? -1 : lowertxt.indexOf("<body");
484 int htmlend = leaveLast ? -1 : lowertxt.indexOf("</body");
485 int htmlpose = lowertxt.indexOf(">", htmlpos), htmlende = lowertxt
486 .indexOf(">", htmlend);
487 if (htmlend == -1 && htmlpos == -1)
493 return text.substring((htmlpos == -1 ? 0 : htmlpose + 1), htmlend);
495 return text.substring(htmlpos == -1 ? 0 : htmlpose + 1);
499 * very simple routine for adding/ensuring html tags are present in text.
502 * @return properly html tag enclosed text
504 private String ensureHtmlTagged(String text)
510 String lowertxt = text.toLowerCase();
511 int htmlpos = lowertxt.indexOf("<body");
512 int htmlend = lowertxt.indexOf("</body");
513 int doctype = lowertxt.indexOf("<!doctype");
514 int xmltype = lowertxt.indexOf("<?xml");
517 text = text + "</body></html>";
521 if ((doctype > -1 && htmlpos > doctype)
522 || (xmltype > -1 && htmlpos > xmltype))
524 text = "<html><head></head><body>\n" + text.substring(htmlpos - 1);
529 text = "<html><head></head><body>\n" + text;
531 if (text.indexOf("<meta") > -1)
533 System.err.println("HTML COntent: \n" + text
534 + "<< END HTML CONTENT\n");
546 public void appendProgressText(int which, String text)
548 if (jobPanes == null)
554 String txt = getHtmlFragment(
555 ((JEditorPane) ((JScrollPane) jobPanes.get(which))
556 .getViewport().getComponent(0)).getText(), true,
558 ((JEditorPane) ((JScrollPane) jobPanes.get(which)).getViewport()
559 .getComponent(0)).setText(ensureHtmlTagged(txt
560 + getHtmlFragment(text, false, true)));
564 ((JTextArea) ((JScrollPane) jobPanes.get(which)).getViewport()
565 .getComponent(0)).append(text);
570 * setProgressText(0, text)
572 public void setProgressText(String text)
574 setProgressText(0, text);
578 * appendProgressText(0, text)
580 public void appendProgressText(String text)
582 appendProgressText(0, text);
588 public String getProgressText()
590 return getProgressText(0);
594 * get the tab title for a subjob
600 public String getProgressName(int which)
602 if (jobPanes == null)
608 return subjobs.getTitleAt(which);
612 return ((JScrollPane) jobPanes.get(which)).getViewport()
613 .getComponent(0).getName();
618 * set the tab title for a subjob
625 public void setProgressName(String name, int which)
629 subjobs.setTitleAt(which, name);
630 subjobs.revalidate();
633 JScrollPane c = (JScrollPane) jobPanes.get(which);
634 c.getViewport().getComponent(0).setName(name);
639 * Gui action for cancelling the current job, if possible.
644 protected void cancel_actionPerformed(ActionEvent e)
646 if (!serviceIsCancellable)
648 // JBPNote : TODO: We should REALLY just tell the WSClientI to cancel
649 // anyhow - it has to stop threads and clean up
650 // JBPNote : TODO: Instead of a warning, we should have an optional 'Are
652 warnUser("This job cannot be cancelled.\nJust close the window.",
657 thisService.cancelJob();
659 frame.setClosable(true);
663 * Spawns a thread that pops up a warning dialog box with the given message
669 public void warnUser(final String message, final String title)
671 javax.swing.SwingUtilities.invokeLater(new Runnable()
675 JOptionPane.showInternalMessageDialog(Desktop.desktop, message,
676 title, JOptionPane.WARNING_MESSAGE);
683 * Set up GUI for user to get at results - and possibly automatically display
684 * them if viewResultsImmediatly is set.
686 public void setResultsReady()
688 frame.setClosable(true);
689 buttonPanel.remove(cancel);
690 buttonPanel.add(showResultsNewFrame);
691 if (serviceCanMergeResults)
693 buttonPanel.add(mergeResults);
694 buttonPanel.setLayout(new GridLayout(2, 1, 5, 5));
696 buttonPanel.validate();
698 if (viewResultsImmediatly)
700 showResultsNewFrame.doClick();
705 * called when job has finished but no result objects can be passed back to
708 public void setFinishedNoResults()
710 frame.setClosable(true);
711 buttonPanel.remove(cancel);
712 buttonPanel.validate();
716 class AnimatedPanel extends JPanel implements Runnable
720 BufferedImage offscreen;
724 startTime = System.currentTimeMillis();
726 while (currentStatus < STATE_STOPPED_OK)
732 int units = (int) ((System.currentTimeMillis() - startTime) / 10f);
735 startTime = System.currentTimeMillis();
737 if (currentStatus >= STATE_STOPPED_OK)
743 } catch (Exception ex)
748 cancel.setEnabled(false);
753 if (offscreen == null || offscreen.getWidth(this) != getWidth()
754 || offscreen.getHeight(this) != getHeight())
756 offscreen = new BufferedImage(getWidth(), getHeight(),
757 BufferedImage.TYPE_INT_ARGB);
760 Graphics2D g = (Graphics2D) offscreen.getGraphics();
762 g.setColor(Color.white);
763 g.fillRect(0, 0, getWidth(), getHeight());
765 g.setFont(new Font("Arial", Font.BOLD, 12));
766 g.setColor(Color.black);
768 switch (currentStatus)
771 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.state_queueing")), 60, 30);
776 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.state_running")), 60, 30);
780 case STATE_STOPPED_OK:
781 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.state_completed")), 60, 30);
785 case STATE_CANCELLED_OK:
786 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.state_job_cancelled")), 60, 30);
790 case STATE_STOPPED_ERROR:
791 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.state_job_error")), 60, 30);
795 case STATE_STOPPED_SERVERERROR:
796 g.drawString(title.concat(" - ").concat(MessageManager.getString("label.server_error_try_later")), 60, 30);
803 int x = image.getWidth(this) / 2, y = image.getHeight(this) / 2;
804 g.rotate(Math.toRadians(angle), 10 + x, 10 + y);
805 g.drawImage(image, 10, 10, this);
806 g.rotate(-Math.toRadians(angle), 10 + x, 10 + y);
810 public void paintComponent(Graphics g1)
814 g1.drawImage(offscreen, 0, 0, this);
818 boolean renderAsHtml = false;
820 public void setRenderAsHtml(boolean b)
825 public void hyperlinkUpdate(HyperlinkEvent e)
827 Desktop.hyperlinkUpdate(e);
830 // methods for implementing IProgressIndicator
831 // need to refactor to a reusable stub class
832 Hashtable progressBars, progressBarHandlers;
837 * @see jalview.gui.IProgressIndicator#setProgressBar(java.lang.String, long)
840 public void setProgressBar(String message, long id)
842 if (progressBars == null)
844 progressBars = new Hashtable();
845 progressBarHandlers = new Hashtable();
848 JPanel progressPanel;
849 Long lId = new Long(id);
850 GridLayout layout = (GridLayout) statusPanel.getLayout();
851 if (progressBars.get(lId) != null)
853 progressPanel = (JPanel) progressBars.get(new Long(id));
854 statusPanel.remove(progressPanel);
855 progressBars.remove(lId);
856 progressPanel = null;
859 statusBar.setText(message);
861 if (progressBarHandlers.contains(lId))
863 progressBarHandlers.remove(lId);
865 layout.setRows(layout.getRows() - 1);
869 progressPanel = new JPanel(new BorderLayout(10, 5));
871 JProgressBar progressBar = new JProgressBar();
872 progressBar.setIndeterminate(true);
874 progressPanel.add(new JLabel(message), BorderLayout.WEST);
875 progressPanel.add(progressBar, BorderLayout.CENTER);
877 layout.setRows(layout.getRows() + 1);
878 statusPanel.add(progressPanel);
880 progressBars.put(lId, progressPanel);
883 // setMenusForViewport();
888 public void registerHandler(final long id,
889 final IProgressIndicatorHandler handler)
891 if (progressBarHandlers == null || !progressBars.contains(new Long(id)))
894 "call setProgressBar before registering the progress bar's handler.");
896 progressBarHandlers.put(new Long(id), handler);
897 final JPanel progressPanel = (JPanel) progressBars.get(new Long(id));
898 if (handler.canCancel())
900 JButton cancel = new JButton(MessageManager.getString("action.cancel"));
901 final IProgressIndicator us = this;
902 cancel.addActionListener(new ActionListener()
906 public void actionPerformed(ActionEvent e)
908 handler.cancelActivity(id);
911 + ((JLabel) progressPanel.getComponent(0))
915 progressPanel.add(cancel, BorderLayout.EAST);
921 * @return true if any progress bars are still active
924 public boolean operationInProgress()
926 if (progressBars != null && progressBars.size() > 0)