src/jalview/appletgui/AppletJmol.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21 package jalview.appletgui;
  22
  23 import jalview.bin.JalviewLite;
  24 import jalview.datamodel.AlignmentI;
  25 import jalview.datamodel.PDBEntry;
  26 import jalview.datamodel.SequenceI;
  27 import jalview.io.FileParse;
  28 import jalview.io.DataSourceType;
  29 import jalview.io.StructureFile;
  30 import jalview.schemes.BuriedColourScheme;
  31 import jalview.schemes.HelixColourScheme;
  32 import jalview.schemes.HydrophobicColourScheme;
  33 import jalview.schemes.PurinePyrimidineColourScheme;
  34 import jalview.schemes.StrandColourScheme;
  35 import jalview.schemes.TaylorColourScheme;
  36 import jalview.schemes.TurnColourScheme;
  37 import jalview.schemes.UserColourScheme;
  38 import jalview.schemes.ZappoColourScheme;
  39 import jalview.structure.StructureSelectionManager;
  40 import jalview.util.MessageManager;
  41
  42 import java.awt.BorderLayout;
  43 import java.awt.CheckboxMenuItem;
  44 import java.awt.Color;
  45 import java.awt.Dimension;
  46 import java.awt.Font;
  47 import java.awt.Frame;
  48 import java.awt.Graphics;
  49 import java.awt.Menu;
  50 import java.awt.MenuBar;
  51 import java.awt.MenuItem;
  52 import java.awt.Panel;
  53 import java.awt.TextArea;
  54 import java.awt.TextField;
  55 import java.awt.event.ActionEvent;
  56 import java.awt.event.ActionListener;
  57 import java.awt.event.ItemEvent;
  58 import java.awt.event.ItemListener;
  59 import java.awt.event.KeyEvent;
  60 import java.awt.event.KeyListener;
  61 import java.awt.event.WindowAdapter;
  62 import java.awt.event.WindowEvent;
  63 import java.util.ArrayList;
  64 import java.util.List;
  65 import java.util.Vector;
  66
  67 public class AppletJmol extends EmbmenuFrame implements
  68 // StructureListener,
  69         KeyListener, ActionListener, ItemListener
  70
  71 {
  72   Menu fileMenu = new Menu(MessageManager.getString("action.file"));
  73
  74   Menu viewMenu = new Menu(MessageManager.getString("action.view"));
  75
  76   Menu coloursMenu = new Menu(MessageManager.getString("action.colour"));
  77
  78   Menu chainMenu = new Menu(MessageManager.getString("action.show_chain"));
  79
  80   Menu helpMenu = new Menu(MessageManager.getString("action.help"));
  81
  82   MenuItem mappingMenuItem = new MenuItem(
  83           MessageManager.getString("label.view_mapping"));
  84
  85   CheckboxMenuItem seqColour = new CheckboxMenuItem(
  86           MessageManager.getString("action.by_sequence"), true);
  87
  88   CheckboxMenuItem jmolColour = new CheckboxMenuItem(
  89           MessageManager.getString("action.using_jmol"), false);
  90
  91   MenuItem chain = new MenuItem(MessageManager.getString("action.by_chain"));
  92
  93   MenuItem charge = new MenuItem(
  94           MessageManager.getString("label.charge_cysteine"));
  95
  96   MenuItem zappo = new MenuItem(MessageManager.getString("label.zappo"));
  97
  98   MenuItem taylor = new MenuItem(MessageManager.getString("label.taylor"));
  99
 100   MenuItem hydro = new MenuItem(
 101           MessageManager.getString("label.hydrophobicity"));
 102
 103   MenuItem helix = new MenuItem(
 104           MessageManager.getString("label.helix_propensity"));
 105
 106   MenuItem strand = new MenuItem(
 107           MessageManager.getString("label.strand_propensity"));
 108
 109   MenuItem turn = new MenuItem(
 110           MessageManager.getString("label.turn_propensity"));
 111
 112   MenuItem buried = new MenuItem(
 113           MessageManager.getString("label.buried_index"));
 114
 115   MenuItem purinepyrimidine = new MenuItem(
 116           MessageManager.getString("label.purine_pyrimidine"));
 117
 118   MenuItem user = new MenuItem(
 119           MessageManager.getString("label.user_defined_colours"));
 120
 121   MenuItem jmolHelp = new MenuItem(
 122           MessageManager.getString("label.jmol_help"));
 123
 124   Panel scriptWindow;
 125
 126   TextField inputLine;
 127
 128   TextArea history;
 129
 130   RenderPanel renderPanel;
 131
 132   AlignmentPanel ap;
 133
 134   List<AlignmentPanel> _aps = new ArrayList<AlignmentPanel>(); // remove? never
 135                                                                // added to
 136
 137   String fileLoadingError;
 138
 139   boolean loadedInline;
 140
 141   // boolean colourBySequence = true;
 142
 143   FeatureRenderer fr = null;
 144
 145   AppletJmolBinding jmb;
 146
 147   /**
 148    * datasource protocol for access to PDBEntry
 149    */
 150   String protocol = null;
 151
 152   /**
 153    * Load a bunch of pdb entries associated with sequences in the alignment and
 154    * display them - aligning them if necessary.
 155    *
 156    * @param pdbentries
 157    *          each pdb file (at least one needed)
 158    * @param boundseqs
 159    *          each set of sequences for each pdb file (must match number of pdb
 160    *          files)
 161    * @param boundchains
 162    *          the target pdb chain corresponding with each sequence associated
 163    *          with each pdb file (may be null at any level)
 164    * @param align
 165    *          true/false
 166    * @param ap
 167    *          associated alignment
 168    * @param protocol
 169    *          how to get pdb data
 170    */
 171   public AppletJmol(PDBEntry[] pdbentries, SequenceI[][] boundseqs,
 172           String[][] boundchains, boolean align, AlignmentPanel ap,
 173           String protocol)
 174   {
 175     throw new Error(MessageManager.getString("error.not_yet_implemented"));
 176   }
 177
 178   public AppletJmol(PDBEntry pdbentry, SequenceI[] seq, String[] chains,
 179           AlignmentPanel ap, DataSourceType protocol)
 180   {
 181     this.ap = ap;
 182     jmb = new AppletJmolBinding(this, ap.getStructureSelectionManager(),
 183             new PDBEntry[] { pdbentry }, new SequenceI[][] { seq },
 184             protocol);
 185     jmb.setColourBySequence(true);
 186     if (pdbentry.getId() == null || pdbentry.getId().length() < 1)
 187     {
 188       if (protocol == DataSourceType.PASTE)
 189       {
 190         pdbentry.setId("PASTED PDB"
 191                 + (chains == null ? "_" : chains.toString()));
 192       }
 193       else
 194       {
 195         pdbentry.setId(pdbentry.getFile());
 196       }
 197     }
 198
 199     if (JalviewLite.debug)
 200     {
 201       System.err
 202               .println("AppletJmol: PDB ID is '" + pdbentry.getId() + "'");
 203     }
 204
 205     String alreadyMapped = StructureSelectionManager
 206             .getStructureSelectionManager(ap.av.applet)
 207             .alreadyMappedToFile(pdbentry.getId());
 208     StructureFile reader = null;
 209     if (alreadyMapped != null)
 210     {
 211       reader = StructureSelectionManager.getStructureSelectionManager(
 212               ap.av.applet).setMapping(seq, chains, pdbentry.getFile(),
 213               protocol, null);
 214       // PROMPT USER HERE TO ADD TO NEW OR EXISTING VIEW?
 215       // FOR NOW, LETS JUST OPEN A NEW WINDOW
 216     }
 217     MenuBar menuBar = new MenuBar();
 218     menuBar.add(fileMenu);
 219     fileMenu.add(mappingMenuItem);
 220     menuBar.add(viewMenu);
 221     mappingMenuItem.addActionListener(this);
 222     viewMenu.add(chainMenu);
 223     menuBar.add(coloursMenu);
 224     menuBar.add(helpMenu);
 225
 226     charge.addActionListener(this);
 227     hydro.addActionListener(this);
 228     chain.addActionListener(this);
 229     seqColour.addItemListener(this);
 230     jmolColour.addItemListener(this);
 231     zappo.addActionListener(this);
 232     taylor.addActionListener(this);
 233     helix.addActionListener(this);
 234     strand.addActionListener(this);
 235     turn.addActionListener(this);
 236     buried.addActionListener(this);
 237     purinepyrimidine.addActionListener(this);
 238     user.addActionListener(this);
 239
 240     jmolHelp.addActionListener(this);
 241
 242     coloursMenu.add(seqColour);
 243     coloursMenu.add(chain);
 244     coloursMenu.add(charge);
 245     coloursMenu.add(zappo);
 246     coloursMenu.add(taylor);
 247     coloursMenu.add(hydro);
 248     coloursMenu.add(helix);
 249     coloursMenu.add(strand);
 250     coloursMenu.add(turn);
 251     coloursMenu.add(buried);
 252     coloursMenu.add(purinepyrimidine);
 253     coloursMenu.add(user);
 254     coloursMenu.add(jmolColour);
 255     helpMenu.add(jmolHelp);
 256     this.setLayout(new BorderLayout());
 257
 258     setMenuBar(menuBar);
 259
 260     renderPanel = new RenderPanel();
 261     embedMenuIfNeeded(renderPanel);
 262     this.add(renderPanel, BorderLayout.CENTER);
 263     scriptWindow = new Panel();
 264     scriptWindow.setVisible(false);
 265     // this.add(scriptWindow, BorderLayout.SOUTH);
 266
 267     try
 268     {
 269       jmb.allocateViewer(renderPanel, true, ap.av.applet.getName()
 270               + "_jmol_", ap.av.applet.getDocumentBase(),
 271               ap.av.applet.getCodeBase(), "-applet", scriptWindow, null);
 272     } catch (Exception e)
 273     {
 274       System.err
 275               .println("Couldn't create a jmol viewer. Args to allocate viewer were:\nDocumentBase="
 276                       + ap.av.applet.getDocumentBase()
 277                       + "\nCodebase="
 278                       + ap.av.applet.getCodeBase());
 279       e.printStackTrace();
 280       dispose();
 281       return;
 282     }
 283     // jmb.newJmolPopup(true, "Jmol", true);
 284
 285     this.addWindowListener(new WindowAdapter()
 286     {
 287       @Override
 288       public void windowClosing(WindowEvent evt)
 289       {
 290         closeViewer();
 291       }
 292     });
 293     pdbentry.setProperty("protocol", protocol);
 294     if (pdbentry.getFile() != null)
 295
 296     {
 297       // import structure data from pdbentry.getFile based on given protocol
 298       if (protocol == DataSourceType.PASTE)
 299       {
 300         // TODO: JAL-623 : correctly record file contents for matching up later
 301         // pdbentry.getProperty().put("pdbfilehash",""+pdbentry.getFile().hashCode());
 302         loadInline(pdbentry.getFile());
 303       }
 304       else if (protocol == DataSourceType.FILE
 305               || protocol == DataSourceType.URL)
 306       {
 307         jmb.viewer.openFile(pdbentry.getFile());
 308       }
 309       else
 310       {
 311         // probably CLASSLOADER based datasource..
 312         // Try and get a reader on the datasource, and pass that to Jmol
 313         try
 314         {
 315           java.io.Reader freader = null;
 316           if (reader != null)
 317           {
 318             if (jalview.bin.JalviewLite.debug)
 319             {
 320               System.err
 321                       .println("AppletJmol:Trying to reuse existing PDBfile IO parser.");
 322             }
 323             // re-use the one we opened earlier
 324             freader = reader.getReader();
 325           }
 326           if (freader == null)
 327           {
 328             if (jalview.bin.JalviewLite.debug)
 329             {
 330               System.err
 331                       .println("AppletJmol:Creating new PDBfile IO parser.");
 332             }
 333             FileParse fp = new FileParse(pdbentry.getFile(), protocol);
 334             fp.mark();
 335             // reader = new MCview.PDBfile(fp);
 336             // could set ID, etc.
 337             // if (!reader.isValid())
 338             // {
 339             // throw new Exception("Invalid datasource.
 340             // "+reader.getWarningMessage());
 341             // }
 342             // fp.reset();
 343             freader = fp.getReader();
 344           }
 345           if (freader == null)
 346           {
 347             throw new Exception(
 348                     MessageManager
 349                             .getString("exception.invalid_datasource_couldnt_obtain_reader"));
 350           }
 351           jmb.viewer.openReader(pdbentry.getFile(), pdbentry.getId(),
 352                   freader);
 353         } catch (Exception e)
 354         {
 355           // give up!
 356           System.err.println("Couldn't access pdbentry id="
 357                   + pdbentry.getId() + " and file=" + pdbentry.getFile()
 358                   + " using protocol=" + protocol);
 359           e.printStackTrace();
 360         }
 361       }
 362     }
 363
 364     jalview.bin.JalviewLite.addFrame(this, jmb.getViewerTitle(), 400, 400);
 365   }
 366
 367   public void loadInline(String string)
 368   {
 369     loadedInline = true;
 370     jmb.loadInline(string);
 371   }
 372
 373   void setChainMenuItems(List<String> chains)
 374   {
 375     chainMenu.removeAll();
 376
 377     MenuItem menuItem = new MenuItem(MessageManager.getString("label.all"));
 378     menuItem.addActionListener(this);
 379
 380     chainMenu.add(menuItem);
 381
 382     CheckboxMenuItem menuItemCB;
 383     for (String ch : chains)
 384     {
 385       menuItemCB = new CheckboxMenuItem(ch, true);
 386       menuItemCB.addItemListener(this);
 387       chainMenu.add(menuItemCB);
 388     }
 389   }
 390
 391   boolean allChainsSelected = false;
 392
 393   void centerViewer()
 394   {
 395     Vector<String> toshow = new Vector<String>();
 396     for (int i = 0; i < chainMenu.getItemCount(); i++)
 397     {
 398       if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
 399       {
 400         CheckboxMenuItem item = (CheckboxMenuItem) chainMenu.getItem(i);
 401         if (item.getState())
 402         {
 403           toshow.addElement(item.getLabel());
 404         }
 405       }
 406     }
 407     jmb.centerViewer(toshow);
 408   }
 409
 410   void closeViewer()
 411   {
 412     jmb.closeViewer();
 413     jmb = null;
 414     this.setVisible(false);
 415   }
 416
 417   @Override
 418   public void actionPerformed(ActionEvent evt)
 419   {
 420     if (evt.getSource() == mappingMenuItem)
 421     {
 422       jalview.appletgui.CutAndPasteTransfer cap = new jalview.appletgui.CutAndPasteTransfer(
 423               false, null);
 424       Frame frame = new Frame();
 425       frame.add(cap);
 426
 427       StringBuffer sb = new StringBuffer();
 428       try
 429       {
 430         cap.setText(jmb.printMappings());
 431       } catch (OutOfMemoryError ex)
 432       {
 433         frame.dispose();
 434         System.err
 435                 .println("Out of memory when trying to create dialog box with sequence-structure mapping.");
 436         return;
 437       }
 438       jalview.bin.JalviewLite.addFrame(frame,
 439               MessageManager.getString("label.pdb_sequence_mapping"), 550,
 440               600);
 441     }
 442     else if (evt.getSource() == charge)
 443     {
 444       setEnabled(charge);
 445       jmb.colourByCharge();
 446     }
 447
 448     else if (evt.getSource() == chain)
 449     {
 450       setEnabled(chain);
 451       jmb.colourByChain();
 452     }
 453     else if (evt.getSource() == zappo)
 454     {
 455       setEnabled(zappo);
 456       jmb.setJalviewColourScheme(new ZappoColourScheme());
 457     }
 458     else if (evt.getSource() == taylor)
 459     {
 460       setEnabled(taylor);
 461       jmb.setJalviewColourScheme(new TaylorColourScheme());
 462     }
 463     else if (evt.getSource() == hydro)
 464     {
 465       setEnabled(hydro);
 466       jmb.setJalviewColourScheme(new HydrophobicColourScheme());
 467     }
 468     else if (evt.getSource() == helix)
 469     {
 470       setEnabled(helix);
 471       jmb.setJalviewColourScheme(new HelixColourScheme());
 472     }
 473     else if (evt.getSource() == strand)
 474     {
 475       setEnabled(strand);
 476       jmb.setJalviewColourScheme(new StrandColourScheme());
 477     }
 478     else if (evt.getSource() == turn)
 479     {
 480       setEnabled(turn);
 481       jmb.setJalviewColourScheme(new TurnColourScheme());
 482     }
 483     else if (evt.getSource() == buried)
 484     {
 485       setEnabled(buried);
 486       jmb.setJalviewColourScheme(new BuriedColourScheme());
 487     }
 488     else if (evt.getSource() == purinepyrimidine)
 489     {
 490       jmb.setJalviewColourScheme(new PurinePyrimidineColourScheme());
 491     }
 492     else if (evt.getSource() == user)
 493     {
 494       setEnabled(user);
 495       new UserDefinedColours(this);
 496     }
 497     else if (evt.getSource() == jmolHelp)
 498     {
 499       try
 500       {
 501         ap.av.applet.getAppletContext().showDocument(
 502                 new java.net.URL(
 503                         "http://jmol.sourceforge.net/docs/JmolUserGuide/"),
 504                 "jmolHelp");
 505       } catch (java.net.MalformedURLException ex)
 506       {
 507       }
 508     }
 509     else
 510     {
 511       allChainsSelected = true;
 512       for (int i = 0; i < chainMenu.getItemCount(); i++)
 513       {
 514         if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
 515         {
 516           ((CheckboxMenuItem) chainMenu.getItem(i)).setState(true);
 517         }
 518       }
 519
 520       centerViewer();
 521       allChainsSelected = false;
 522     }
 523   }
 524
 525   /**
 526    * tick or untick the seqColour menu entry or jmoColour entry depending upon
 527    * if it was selected or not.
 528    *
 529    * @param itm
 530    */
 531   private void setEnabled(MenuItem itm)
 532   {
 533     jmolColour.setState(itm == jmolColour);
 534     seqColour.setState(itm == seqColour);
 535     jmb.setColourBySequence(itm == seqColour);
 536   }
 537
 538   @Override
 539   public void itemStateChanged(ItemEvent evt)
 540   {
 541     if (evt.getSource() == jmolColour)
 542     {
 543       setEnabled(jmolColour);
 544       jmb.setColourBySequence(false);
 545     }
 546     else if (evt.getSource() == seqColour)
 547     {
 548       setEnabled(seqColour);
 549       jmb.colourBySequence(ap);
 550     }
 551     else if (!allChainsSelected)
 552     {
 553       centerViewer();
 554     }
 555   }
 556
 557   @Override
 558   public void keyPressed(KeyEvent evt)
 559   {
 560     if (evt.getKeyCode() == KeyEvent.VK_ENTER && scriptWindow.isVisible())
 561     {
 562       jmb.eval(inputLine.getText());
 563       addToHistory("$ " + inputLine.getText());
 564       inputLine.setText("");
 565     }
 566
 567   }
 568
 569   @Override
 570   public void keyTyped(KeyEvent evt)
 571   {
 572   }
 573
 574   @Override
 575   public void keyReleased(KeyEvent evt)
 576   {
 577   }
 578
 579   public void updateColours(Object source)
 580   {
 581     AlignmentPanel panel = (AlignmentPanel) source;
 582     jmb.colourBySequence(panel);
 583   }
 584
 585   public void updateTitleAndMenus()
 586   {
 587     if (jmb.fileLoadingError != null && jmb.fileLoadingError.length() > 0)
 588     {
 589       repaint();
 590       return;
 591     }
 592     setChainMenuItems(jmb.getChainNames());
 593     jmb.colourBySequence(ap);
 594
 595     setTitle(jmb.getViewerTitle());
 596   }
 597
 598   public void showUrl(String url)
 599   {
 600     try
 601     {
 602       ap.av.applet.getAppletContext().showDocument(new java.net.URL(url),
 603               "jmolOutput");
 604     } catch (java.net.MalformedURLException ex)
 605     {
 606     }
 607   }
 608
 609   Panel splitPane = null;
 610
 611   public void showConsole(boolean showConsole)
 612   {
 613     if (showConsole)
 614     {
 615       remove(renderPanel);
 616       splitPane = new Panel();
 617
 618       splitPane.setLayout(new java.awt.GridLayout(2, 1));
 619       splitPane.add(renderPanel);
 620       splitPane.add(scriptWindow);
 621       scriptWindow.setVisible(true);
 622       this.add(splitPane, BorderLayout.CENTER);
 623       splitPane.setVisible(true);
 624       splitPane.validate();
 625     }
 626     else
 627     {
 628       scriptWindow.setVisible(false);
 629       remove(splitPane);
 630       add(renderPanel, BorderLayout.CENTER);
 631       splitPane = null;
 632     }
 633     validate();
 634   }
 635
 636   public float[][] functionXY(String functionName, int x, int y)
 637   {
 638     return null;
 639   }
 640
 641   // /End JmolStatusListener
 642   // /////////////////////////////
 643
 644   class RenderPanel extends Panel
 645   {
 646     Dimension currentSize = new Dimension();
 647
 648     @Override
 649     public void update(Graphics g)
 650     {
 651       paint(g);
 652     }
 653
 654     @Override
 655     public void paint(Graphics g)
 656     {
 657       currentSize = this.getSize();
 658
 659       if (jmb.viewer == null)
 660       {
 661         g.setColor(Color.black);
 662         g.fillRect(0, 0, currentSize.width, currentSize.height);
 663         g.setColor(Color.white);
 664         g.setFont(new Font("Verdana", Font.BOLD, 14));
 665         g.drawString(MessageManager.getString("label.retrieving_pdb_data"),
 666                 20, currentSize.height / 2);
 667       }
 668       else
 669       {
 670         jmb.viewer.renderScreenImage(g, currentSize.width,
 671                 currentSize.height);
 672       }
 673     }
 674   }
 675
 676   /*
 677    * @Override public Color getColour(int atomIndex, int pdbResNum, String
 678    * chain, String pdbId) { return jmb.getColour(atomIndex, pdbResNum, chain,
 679    * pdbId); }
 680    *
 681    * @Override public String[] getPdbFile() { return jmb.getPdbFile(); }
 682    *
 683    * @Override public void highlightAtom(int atomIndex, int pdbResNum, String
 684    * chain, String pdbId) { jmb.highlightAtom(atomIndex, pdbResNum, chain,
 685    * pdbId);
 686    *
 687    * }
 688    *
 689    * @Override public void mouseOverStructure(int atomIndex, String strInfo) {
 690    * jmb.mouseOverStructure(atomIndex, strInfo);
 691    *
 692    * }
 693    */
 694   public void setJalviewColourScheme(UserColourScheme ucs)
 695   {
 696     jmb.setJalviewColourScheme(ucs);
 697   }
 698
 699   public AlignmentPanel getAlignmentPanelFor(AlignmentI alignment)
 700   {
 701     for (int i = 0; i < _aps.size(); i++)
 702     {
 703       if (_aps.get(i).av.getAlignment() == alignment)
 704       {
 705         return (_aps.get(i));
 706       }
 707     }
 708     return ap;
 709   }
 710
 711   /**
 712    * Append the given text to the history object
 713    *
 714    * @param text
 715    */
 716   public void addToHistory(String text)
 717   {
 718     // actually currently never initialised
 719     if (history != null)
 720     {
 721       history.append("\n" + text);
 722     }
 723   }
 724 }