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