src/jalview/appletgui/AppletJmol.java

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