X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fgui%2FWebserviceInfo.java;h=82257ff94e00562c804b2384ee06f015dc120668;hb=17e77c3f2949a0729322b4a8d907f3f34b6a9914;hp=63a289f0ecb0e9d5e981407ce161399990ec81bf;hpb=615b41750fca2811d8e26a22c71224725383c218;p=jalview.git diff --git a/src/jalview/gui/WebserviceInfo.java b/src/jalview/gui/WebserviceInfo.java old mode 100755 new mode 100644 index 63a289f..82257ff --- a/src/jalview/gui/WebserviceInfo.java +++ b/src/jalview/gui/WebserviceInfo.java @@ -1,139 +1,912 @@ -package jalview.gui; - -import java.awt.*; -import java.awt.event.*; -import javax.swing.*; -import jalview.jbgui.GWebserviceInfo; - -public class WebserviceInfo extends GWebserviceInfo -{ - - public static final int STATE_QUEUING = 0; - public static final int STATE_RUNNING = 1; - public static final int STATE_STOPPED_OK = 2; - public static final int STATE_STOPPED_ERROR = 3; - int currentStatus = STATE_QUEUING; - Image image; - int angle = 0; - - String title=""; - - public WebserviceInfo(String title, String info) - { - init(title, info, 520, 500); - } - - public WebserviceInfo(String title, String info, int width, int height) - { - init(title, info, width, height); - } - - void init(String title, String info, int width, int height) - { - JInternalFrame frame = new JInternalFrame(); - frame.setContentPane(this); - Desktop.addInternalFrame(frame, title, width, height); - - this.title = title; - setInfoText(info); - java.net.URL url = getClass().getResource("/images/logo.gif"); - image = java.awt.Toolkit.getDefaultToolkit().createImage(url); - MediaTracker mt = new MediaTracker(this); - mt.addImage(image, 0); - try - { - mt.waitForID(0); - } - catch (Exception ex) - {} - - - AnimatedPanel ap = new AnimatedPanel(); - titlePanel.add(ap, BorderLayout.CENTER); - Thread thread = new Thread(ap); - thread.start(); - } - - public void setStatus(int status) - { - currentStatus = status; - } - - public String getInfoText() - { return infoText.getText(); } - - public void setInfoText(String text) - { infoText.setText(text); } - - public void appendInfoText(String text) - { infoText.append(text); } - - public String getProgressText() - { return progressText.getText(); } - - public void setProgressText(String text) - { progressText.setText(text); } - - public void appendProgressText(String text) - { progressText.append(text); } - - protected void cancel_actionPerformed(ActionEvent e) - { - JOptionPane.showInternalMessageDialog(Desktop.desktop, - "Cancel not implemented yet!!" , - "Cancel job" - ,JOptionPane.WARNING_MESSAGE); - } - - - class AnimatedPanel extends JPanel implements Runnable - { - public void run() - { - while(currentStatus. + * The Jalview Authors are detailed in the 'AUTHORS' file. + */ +package jalview.gui; + +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.JOptionPane; +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 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 */ + public static final int STATE_QUEUING = 0; + + /** Job is Running */ + public static final int STATE_RUNNING = 1; + + /** Job has finished with no errors */ + public static final int STATE_STOPPED_OK = 2; + + /** Job has been cancelled with no errors */ + public static final int STATE_CANCELLED_OK = 3; + + /** job has stopped because of some error */ + public static final int STATE_STOPPED_ERROR = 4; + + /** job has failed because of some unavoidable service interruption */ + public static final int STATE_STOPPED_SERVERERROR = 5; + + int currentStatus = STATE_QUEUING; + + Image image; + + int angle = 0; + + String title = ""; + + jalview.ws.WSClientI thisService; + + boolean serviceIsCancellable; + + 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 serviceCanMergeResults = false; + + 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

WS Job

"); + } + 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.setBorder(null); + if (jobPanes == null) + { + jobPanes = new Vector(); + } + int newpane = jobPanes.size(); + jobPanes.add(jobpane); + + if (newpane == 0) + { + this.add(jobpane, BorderLayout.CENTER); + } + else + { + if (newpane == 1) + { + // revert to a tabbed pane. + JScrollPane firstpane; + this.remove(firstpane = (JScrollPane) jobPanes.get(0)); + subjobs = new JTabbedPane(); + this.add(subjobs, BorderLayout.CENTER); + subjobs.add(firstpane); + subjobs.setTitleAt(0, firstpane.getName()); + } + subjobs.add(jobpane); + } + return newpane; // index for accessor methods below + } + + /** + * Creates a new WebserviceInfo object. + * + * @param title + * 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, boolean makeVisible) + { + init(title, info, 520, 500, makeVisible); + } + + /** + * Creates a new WebserviceInfo object. + * + * @param title + * DOCUMENT ME! + * @param info + * DOCUMENT ME! + * @param width + * DOCUMENT ME! + * @param height + * DOCUMENT ME! + */ + public WebserviceInfo(String title, String info, int width, int height, + boolean makeVisible) + { + init(title, info, width, height, makeVisible); + } + + /** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ + public jalview.ws.WSClientI getthisService() + { + return thisService; + } + + /** + * Update state of GUI based on client capabilities (like whether the job is + * cancellable, whether the 'merge results' button is shown. + * + * @param newservice + * service client to query for capabilities + */ + public void setthisService(jalview.ws.WSClientI newservice) + { + thisService = newservice; + serviceIsCancellable = newservice.isCancellable(); + frame.setClosable(!serviceIsCancellable); + serviceCanMergeResults = newservice.canMergeResults(); + rebuildButtonPanel(); + } + + private void rebuildButtonPanel() + { + if (buttonPanel != null) + { + buttonPanel.removeAll(); + if (serviceIsCancellable) + { + buttonPanel.add(cancel); + frame.setClosable(false); + } + else + { + frame.setClosable(true); + } + } + } + + /** + * DOCUMENT ME! + * + * @param title + * DOCUMENT ME! + * @param info + * DOCUMENT ME! + * @param width + * DOCUMENT ME! + * @param height + * DOCUMENT ME! + */ + void init(String title, String info, int width, int height, + boolean makeVisible) + { + frame = new JInternalFrame(); + frame.setContentPane(this); + 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/Jalview_Logo_small.png"); + image = java.awt.Toolkit.getDefaultToolkit().createImage(url); + + MediaTracker mt = new MediaTracker(this); + mt.addImage(image, 0); + + try + { + mt.waitForID(0); + } catch (Exception ex) + { + } + + AnimatedPanel ap = new AnimatedPanel(); + titlePanel.add(ap, BorderLayout.CENTER); + + Thread thread = new Thread(ap); + thread.start(); + final WebserviceInfo thisinfo = this; + frame.addInternalFrameListener(new javax.swing.event.InternalFrameAdapter() + { + public void internalFrameClosed( + javax.swing.event.InternalFrameEvent evt) + { + // System.out.println("Shutting down webservice client"); + WSClientI service = thisinfo.getthisService(); + if (service != null && service.isCancellable()) + { + service.cancelJob(); + } + }; + }); + frame.validate(); + + } + + /** + * DOCUMENT ME! + * + * @param status + * integer status from state constants + */ + public void setStatus(int status) + { + currentStatus = status; + } + + /** + * subjob status indicator + * + * @param jobpane + * @param status + */ + public void setStatus(int jobpane, int status) + { + if (jobpane < 0 || jobpane >= jobPanes.size()) + { + throw new Error(MessageManager.formatMessage( + "error.setstatus_called_non_existent_job_pane", + new String[] { Integer.valueOf(jobpane).toString() })); + } + switch (status) + { + case STATE_QUEUING: + setProgressName(jobpane + " - QUEUED", jobpane); + break; + case STATE_RUNNING: + setProgressName(jobpane + " - RUNNING", jobpane); + break; + case STATE_STOPPED_OK: + setProgressName(jobpane + " - FINISHED", jobpane); + break; + case STATE_CANCELLED_OK: + setProgressName(jobpane + " - CANCELLED", jobpane); + break; + case STATE_STOPPED_ERROR: + setProgressName(jobpane + " - BROKEN", jobpane); + break; + case STATE_STOPPED_SERVERERROR: + setProgressName(jobpane + " - ALERT", jobpane); + break; + default: + setProgressName(jobpane + " - UNKNOWN STATE", jobpane); + } + } + + /** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ + public String getInfoText() + { + return infoText.getText(); + } + + /** + * DOCUMENT ME! + * + * @param text + * DOCUMENT ME! + */ + public void setInfoText(String text) + { + infoText.setText(text); + } + + /** + * DOCUMENT ME! + * + * @param text + * DOCUMENT ME! + */ + public void appendInfoText(String text) + { + infoText.append(text); + } + + /** + * DOCUMENT ME! + * + * @return DOCUMENT ME! + */ + public String getProgressText(int which) + { + if (jobPanes == null) + { + addJobPane(); + } + 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! + */ + public void setProgressText(int which, String text) + { + if (jobPanes == null) + { + addJobPane(); + } + 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("", 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(""; + } + if (htmlpos > -1) + { + if ((doctype > -1 && htmlpos > doctype) + || (xmltype > -1 && htmlpos > xmltype)) + { + text = "\n" + text.substring(htmlpos - 1); + } + } + else + { + text = "\n" + text; + } + if (text.indexOf(" -1) + { + System.err.println("HTML COntent: \n" + text + + "<< END HTML CONTENT\n"); + + } + return text; + } + + /** + * DOCUMENT ME! + * + * @param text + * DOCUMENT ME! + */ + public void appendProgressText(int which, String text) + { + if (jobPanes == null) + { + addJobPane(); + } + 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); + } + } + + /** + * setProgressText(0, text) + */ + public void setProgressText(String text) + { + setProgressText(0, text); + } + + /** + * appendProgressText(0, text) + */ + public void appendProgressText(String text) + { + appendProgressText(0, text); + } + + /** + * getProgressText(0) + */ + public String getProgressText() + { + return getProgressText(0); + } + + /** + * get the tab title for a subjob + * + * @param which + * int + * @return String + */ + public String getProgressName(int which) + { + if (jobPanes == null) + { + addJobPane(); + } + if (subjobs != null) + { + return subjobs.getTitleAt(which); + } + else + { + return ((JScrollPane) jobPanes.get(which)).getViewport() + .getComponent(0).getName(); + } + } + + /** + * set the tab title for a subjob + * + * @param name + * String + * @param which + * int + */ + public void setProgressName(String name, int which) + { + if (subjobs != null) + { + subjobs.setTitleAt(which, name); + subjobs.revalidate(); + subjobs.repaint(); + } + JScrollPane c = (JScrollPane) jobPanes.get(which); + c.getViewport().getComponent(0).setName(name); + c.repaint(); + } + + /** + * Gui action for cancelling the current job, if possible. + * + * @param e + * DOCUMENT ME! + */ + protected void cancel_actionPerformed(ActionEvent e) + { + if (!serviceIsCancellable) + { + // JBPNote : TODO: We should REALLY just tell the WSClientI to cancel + // 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( + MessageManager + .getString("warn.job_cannot_be_cancelled_close_window"), + MessageManager.getString("action.cancel_job")); + } + else + { + thisService.cancelJob(); + } + frame.setClosable(true); + } + + /** + * 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() + { + public void run() + { + JOptionPane.showInternalMessageDialog(Desktop.desktop, message, + title, JOptionPane.WARNING_MESSAGE); + + } + }); + } + + /** + * Set up GUI for user to get at results - and possibly automatically display + * them if viewResultsImmediatly is set. + */ + public void setResultsReady() + { + frame.setClosable(true); + buttonPanel.remove(cancel); + buttonPanel.add(showResultsNewFrame); + if (serviceCanMergeResults) + { + buttonPanel.add(mergeResults); + buttonPanel.setLayout(new GridLayout(2, 1, 5, 5)); + } + buttonPanel.validate(); + validate(); + if (viewResultsImmediatly) + { + showResultsNewFrame.doClick(); + } + } + + /** + * called when job has finished but no result objects can be passed back to + * user + */ + public void setFinishedNoResults() + { + frame.setClosable(true); + buttonPanel.remove(cancel); + buttonPanel.validate(); + validate(); + } + + class AnimatedPanel extends JPanel implements Runnable + { + long startTime = 0; + + BufferedImage offscreen; + + public void run() + { + startTime = System.currentTimeMillis(); + + while (currentStatus < STATE_STOPPED_OK) + { + try + { + Thread.sleep(50); + + int units = (int) ((System.currentTimeMillis() - startTime) / 10f); + angle += units; + angle %= 360; + startTime = System.currentTimeMillis(); + + if (currentStatus >= STATE_STOPPED_OK) + { + angle = 0; + } + + repaint(); + } catch (Exception ex) + { + } + } + + cancel.setEnabled(false); + } + + void drawPanel() + { + if (offscreen == null || offscreen.getWidth(this) != getWidth() + || offscreen.getHeight(this) != getHeight()) + { + offscreen = new BufferedImage(getWidth(), getHeight(), + BufferedImage.TYPE_INT_ARGB); + } + + Graphics2D g = (Graphics2D) offscreen.getGraphics(); + + g.setColor(Color.white); + g.fillRect(0, 0, getWidth(), getHeight()); + + g.setFont(new Font("Arial", Font.BOLD, 12)); + g.setColor(Color.black); + + switch (currentStatus) + { + case STATE_QUEUING: + g.drawString( + title.concat(" - ").concat( + MessageManager.getString("label.state_queueing")), + 60, 30); + + break; + + case STATE_RUNNING: + g.drawString( + title.concat(" - ").concat( + MessageManager.getString("label.state_running")), + 60, 30); + + break; + + case STATE_STOPPED_OK: + g.drawString( + title.concat(" - ").concat( + MessageManager.getString("label.state_completed")), + 60, 30); + + break; + + case STATE_CANCELLED_OK: + g.drawString( + title.concat(" - ").concat( + MessageManager + .getString("label.state_job_cancelled")), + 60, 30); + + break; + + case STATE_STOPPED_ERROR: + g.drawString( + title.concat(" - ").concat( + MessageManager.getString("label.state_job_error")), + 60, 30); + + break; + + case STATE_STOPPED_SERVERERROR: + g.drawString( + title.concat(" - ").concat( + MessageManager + .getString("label.server_error_try_later")), + 60, 30); + + break; + } + + if (image != null) + { + 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), 10 + x, 10 + y); + } + } + + public void paintComponent(Graphics g1) + { + drawPanel(); + + g1.drawImage(offscreen, 0, 0, this); + } + } + + boolean renderAsHtml = false; + + public void setRenderAsHtml(boolean b) + { + renderAsHtml = b; + } + + 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(); + } +}