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.datamodel.AlignmentI;
  24 import jalview.datamodel.PDBEntry;
  25 import jalview.datamodel.SequenceI;
  26 import jalview.io.AppletFormatAdapter;
  27 import jalview.io.FileParse;
  28 import jalview.io.StructureFile;
  29 import jalview.schemes.BuriedColourScheme;
  30 import jalview.schemes.HelixColourScheme;
  31 import jalview.schemes.HydrophobicColourScheme;
  32 import jalview.schemes.PurinePyrimidineColourScheme;
  33 import jalview.schemes.StrandColourScheme;
  34 import jalview.schemes.TaylorColourScheme;
  35 import jalview.schemes.TurnColourScheme;
  36 import jalview.schemes.UserColourScheme;
  37 import jalview.schemes.ZappoColourScheme;
  38 import jalview.structure.StructureSelectionManager;
  39 import jalview.util.MessageManager;
  40
  41 import java.awt.BorderLayout;
  42 import java.awt.CheckboxMenuItem;
  43 import java.awt.Color;
  44 import java.awt.Dimension;
  45 import java.awt.Font;
  46 import java.awt.Frame;
  47 import java.awt.Graphics;
  48 import java.awt.Menu;
  49 import java.awt.MenuBar;
  50 import java.awt.MenuItem;
  51 import java.awt.Panel;
  52 import java.awt.TextArea;
  53 import java.awt.TextField;
  54 import java.awt.event.ActionEvent;
  55 import java.awt.event.ActionListener;
  56 import java.awt.event.ItemEvent;
  57 import java.awt.event.ItemListener;
  58 import java.awt.event.KeyEvent;
  59 import java.awt.event.KeyListener;
  60 import java.awt.event.WindowAdapter;
  61 import java.awt.event.WindowEvent;
  62 import java.util.ArrayList;
  63 import java.util.Hashtable;
  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, String protocol)
 180   {
 181     this.ap = ap;
 182     jmb = new AppletJmolBinding(this, ap.getStructureSelectionManager(),
 183             new PDBEntry[] { pdbentry }, new SequenceI[][] { seq },
 184             new String[][] { chains }, protocol);
 185     jmb.setColourBySequence(true);
 186     if (pdbentry.getId() == null || pdbentry.getId().length() < 1)
 187     {
 188       if (protocol.equals(AppletFormatAdapter.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 (jalview.bin.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);
 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     if (pdbentry.getProperty() == null)
 294     {
 295       pdbentry.setProperty(new Hashtable());
 296       pdbentry.getProperty().put("protocol", protocol);
 297     }
 298     if (pdbentry.getFile() != null)
 299     {
 300       // import structure data from pdbentry.getFile based on given protocol
 301       if (protocol.equals(AppletFormatAdapter.PASTE))
 302       {
 303         // TODO: JAL-623 : correctly record file contents for matching up later
 304         // pdbentry.getProperty().put("pdbfilehash",""+pdbentry.getFile().hashCode());
 305         loadInline(pdbentry.getFile());
 306       }
 307       else if (protocol.equals(AppletFormatAdapter.FILE)
 308               || protocol.equals(AppletFormatAdapter.URL))
 309       {
 310         jmb.viewer.openFile(pdbentry.getFile());
 311       }
 312       else
 313       {
 314         // probably CLASSLOADER based datasource..
 315         // Try and get a reader on the datasource, and pass that to Jmol
 316         try
 317         {
 318           java.io.Reader freader = null;
 319           if (reader != null)
 320           {
 321             if (jalview.bin.JalviewLite.debug)
 322             {
 323               System.err
 324                       .println("AppletJmol:Trying to reuse existing PDBfile IO parser.");
 325             }
 326             // re-use the one we opened earlier
 327             freader = reader.getReader();
 328           }
 329           if (freader == null)
 330           {
 331             if (jalview.bin.JalviewLite.debug)
 332             {
 333               System.err
 334                       .println("AppletJmol:Creating new PDBfile IO parser.");
 335             }
 336             FileParse fp = new FileParse(pdbentry.getFile(), protocol);
 337             fp.mark();
 338             // reader = new MCview.PDBfile(fp);
 339             // could set ID, etc.
 340             // if (!reader.isValid())
 341             // {
 342             // throw new Exception("Invalid datasource.
 343             // "+reader.getWarningMessage());
 344             // }
 345             // fp.reset();
 346             freader = fp.getReader();
 347           }
 348           if (freader == null)
 349           {
 350             throw new Exception(
 351                     MessageManager
 352                             .getString("exception.invalid_datasource_couldnt_obtain_reader"));
 353           }
 354           jmb.viewer.openReader(pdbentry.getFile(), pdbentry.getId(),
 355                   freader);
 356         } catch (Exception e)
 357         {
 358           // give up!
 359           System.err.println("Couldn't access pdbentry id="
 360                   + pdbentry.getId() + " and file=" + pdbentry.getFile()
 361                   + " using protocol=" + protocol);
 362           e.printStackTrace();
 363         }
 364       }
 365     }
 366
 367     jalview.bin.JalviewLite.addFrame(this, jmb.getViewerTitle(), 400, 400);
 368   }
 369
 370   public void loadInline(String string)
 371   {
 372     loadedInline = true;
 373     jmb.loadInline(string);
 374   }
 375
 376   void setChainMenuItems(Vector<String> chains)
 377   {
 378     chainMenu.removeAll();
 379
 380     MenuItem menuItem = new MenuItem(MessageManager.getString("label.all"));
 381     menuItem.addActionListener(this);
 382
 383     chainMenu.add(menuItem);
 384
 385     CheckboxMenuItem menuItemCB;
 386     for (String ch : chains)
 387     {
 388       menuItemCB = new CheckboxMenuItem(ch, true);
 389       menuItemCB.addItemListener(this);
 390       chainMenu.add(menuItemCB);
 391     }
 392   }
 393
 394   boolean allChainsSelected = false;
 395
 396   void centerViewer()
 397   {
 398     Vector<String> toshow = new Vector<String>();
 399     for (int i = 0; i < chainMenu.getItemCount(); i++)
 400     {
 401       if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
 402       {
 403         CheckboxMenuItem item = (CheckboxMenuItem) chainMenu.getItem(i);
 404         if (item.getState())
 405         {
 406           toshow.addElement(item.getLabel());
 407         }
 408       }
 409     }
 410     jmb.centerViewer(toshow);
 411   }
 412
 413   void closeViewer()
 414   {
 415     jmb.closeViewer();
 416     jmb = null;
 417     this.setVisible(false);
 418   }
 419
 420   @Override
 421   public void actionPerformed(ActionEvent evt)
 422   {
 423     if (evt.getSource() == mappingMenuItem)
 424     {
 425       jalview.appletgui.CutAndPasteTransfer cap = new jalview.appletgui.CutAndPasteTransfer(
 426               false, null);
 427       Frame frame = new Frame();
 428       frame.add(cap);
 429
 430       StringBuffer sb = new StringBuffer();
 431       try
 432       {
 433         cap.setText(jmb.printMappings());
 434       } catch (OutOfMemoryError ex)
 435       {
 436         frame.dispose();
 437         System.err
 438                 .println("Out of memory when trying to create dialog box with sequence-structure mapping.");
 439         return;
 440       }
 441       jalview.bin.JalviewLite.addFrame(frame,
 442               MessageManager.getString("label.pdb_sequence_mapping"), 550,
 443               600);
 444     }
 445     else if (evt.getSource() == charge)
 446     {
 447       setEnabled(charge);
 448       jmb.colourByCharge();
 449     }
 450
 451     else if (evt.getSource() == chain)
 452     {
 453       setEnabled(chain);
 454       jmb.colourByChain();
 455     }
 456     else if (evt.getSource() == zappo)
 457     {
 458       setEnabled(zappo);
 459       jmb.setJalviewColourScheme(new ZappoColourScheme());
 460     }
 461     else if (evt.getSource() == taylor)
 462     {
 463       setEnabled(taylor);
 464       jmb.setJalviewColourScheme(new TaylorColourScheme());
 465     }
 466     else if (evt.getSource() == hydro)
 467     {
 468       setEnabled(hydro);
 469       jmb.setJalviewColourScheme(new HydrophobicColourScheme());
 470     }
 471     else if (evt.getSource() == helix)
 472     {
 473       setEnabled(helix);
 474       jmb.setJalviewColourScheme(new HelixColourScheme());
 475     }
 476     else if (evt.getSource() == strand)
 477     {
 478       setEnabled(strand);
 479       jmb.setJalviewColourScheme(new StrandColourScheme());
 480     }
 481     else if (evt.getSource() == turn)
 482     {
 483       setEnabled(turn);
 484       jmb.setJalviewColourScheme(new TurnColourScheme());
 485     }
 486     else if (evt.getSource() == buried)
 487     {
 488       setEnabled(buried);
 489       jmb.setJalviewColourScheme(new BuriedColourScheme());
 490     }
 491     else if (evt.getSource() == purinepyrimidine)
 492     {
 493       jmb.setJalviewColourScheme(new PurinePyrimidineColourScheme());
 494     }
 495     else if (evt.getSource() == user)
 496     {
 497       setEnabled(user);
 498       new UserDefinedColours(this);
 499     }
 500     else if (evt.getSource() == jmolHelp)
 501     {
 502       try
 503       {
 504         ap.av.applet.getAppletContext().showDocument(
 505                 new java.net.URL(
 506                         "http://jmol.sourceforge.net/docs/JmolUserGuide/"),
 507                 "jmolHelp");
 508       } catch (java.net.MalformedURLException ex)
 509       {
 510       }
 511     }
 512     else
 513     {
 514       allChainsSelected = true;
 515       for (int i = 0; i < chainMenu.getItemCount(); i++)
 516       {
 517         if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
 518         {
 519           ((CheckboxMenuItem) chainMenu.getItem(i)).setState(true);
 520         }
 521       }
 522
 523       centerViewer();
 524       allChainsSelected = false;
 525     }
 526   }
 527
 528   /**
 529    * tick or untick the seqColour menu entry or jmoColour entry depending upon
 530    * if it was selected or not.
 531    *
 532    * @param itm
 533    */
 534   private void setEnabled(MenuItem itm)
 535   {
 536     jmolColour.setState(itm == jmolColour);
 537     seqColour.setState(itm == seqColour);
 538     jmb.setColourBySequence(itm == seqColour);
 539   }
 540
 541   @Override
 542   public void itemStateChanged(ItemEvent evt)
 543   {
 544     if (evt.getSource() == jmolColour)
 545     {
 546       setEnabled(jmolColour);
 547       jmb.setColourBySequence(false);
 548     }
 549     else if (evt.getSource() == seqColour)
 550     {
 551       setEnabled(seqColour);
 552       jmb.colourBySequence(ap);
 553     }
 554     else if (!allChainsSelected)
 555     {
 556       centerViewer();
 557     }
 558   }
 559
 560   @Override
 561   public void keyPressed(KeyEvent evt)
 562   {
 563     if (evt.getKeyCode() == KeyEvent.VK_ENTER && scriptWindow.isVisible())
 564     {
 565       jmb.eval(inputLine.getText());
 566       addToHistory("$ " + inputLine.getText());
 567       inputLine.setText("");
 568     }
 569
 570   }
 571
 572   @Override
 573   public void keyTyped(KeyEvent evt)
 574   {
 575   }
 576
 577   @Override
 578   public void keyReleased(KeyEvent evt)
 579   {
 580   }
 581
 582   public void updateColours(Object source)
 583   {
 584     AlignmentPanel panel = (AlignmentPanel) source;
 585     jmb.colourBySequence(panel);
 586   }
 587
 588   public void updateTitleAndMenus()
 589   {
 590     if (jmb.fileLoadingError != null && jmb.fileLoadingError.length() > 0)
 591     {
 592       repaint();
 593       return;
 594     }
 595     setChainMenuItems(jmb.chainNames);
 596     jmb.colourBySequence(ap);
 597
 598     setTitle(jmb.getViewerTitle());
 599   }
 600
 601   public void showUrl(String url)
 602   {
 603     try
 604     {
 605       ap.av.applet.getAppletContext().showDocument(new java.net.URL(url),
 606               "jmolOutput");
 607     } catch (java.net.MalformedURLException ex)
 608     {
 609     }
 610   }
 611
 612   Panel splitPane = null;
 613
 614   public void showConsole(boolean showConsole)
 615   {
 616     if (showConsole)
 617     {
 618       remove(renderPanel);
 619       splitPane = new Panel();
 620
 621       splitPane.setLayout(new java.awt.GridLayout(2, 1));
 622       splitPane.add(renderPanel);
 623       splitPane.add(scriptWindow);
 624       scriptWindow.setVisible(true);
 625       this.add(splitPane, BorderLayout.CENTER);
 626       splitPane.setVisible(true);
 627       splitPane.validate();
 628     }
 629     else
 630     {
 631       scriptWindow.setVisible(false);
 632       remove(splitPane);
 633       add(renderPanel, BorderLayout.CENTER);
 634       splitPane = null;
 635     }
 636     validate();
 637   }
 638
 639   public float[][] functionXY(String functionName, int x, int y)
 640   {
 641     return null;
 642   }
 643
 644   // /End JmolStatusListener
 645   // /////////////////////////////
 646
 647   class RenderPanel extends Panel
 648   {
 649     Dimension currentSize = new Dimension();
 650
 651     @Override
 652     public void update(Graphics g)
 653     {
 654       paint(g);
 655     }
 656
 657     @Override
 658     public void paint(Graphics g)
 659     {
 660       currentSize = this.getSize();
 661
 662       if (jmb.viewer == null)
 663       {
 664         g.setColor(Color.black);
 665         g.fillRect(0, 0, currentSize.width, currentSize.height);
 666         g.setColor(Color.white);
 667         g.setFont(new Font("Verdana", Font.BOLD, 14));
 668         g.drawString(MessageManager.getString("label.retrieving_pdb_data"),
 669                 20, currentSize.height / 2);
 670       }
 671       else
 672       {
 673         jmb.viewer.renderScreenImage(g, currentSize.width,
 674                 currentSize.height);
 675       }
 676     }
 677   }
 678
 679   /*
 680    * @Override public Color getColour(int atomIndex, int pdbResNum, String
 681    * chain, String pdbId) { return jmb.getColour(atomIndex, pdbResNum, chain,
 682    * pdbId); }
 683    *
 684    * @Override public String[] getPdbFile() { return jmb.getPdbFile(); }
 685    *
 686    * @Override public void highlightAtom(int atomIndex, int pdbResNum, String
 687    * chain, String pdbId) { jmb.highlightAtom(atomIndex, pdbResNum, chain,
 688    * pdbId);
 689    *
 690    * }
 691    *
 692    * @Override public void mouseOverStructure(int atomIndex, String strInfo) {
 693    * jmb.mouseOverStructure(atomIndex, strInfo);
 694    *
 695    * }
 696    */
 697   public void setJalviewColourScheme(UserColourScheme ucs)
 698   {
 699     jmb.setJalviewColourScheme(ucs);
 700   }
 701
 702   public AlignmentPanel getAlignmentPanelFor(AlignmentI alignment)
 703   {
 704     for (int i = 0; i < _aps.size(); i++)
 705     {
 706       if (_aps.get(i).av.getAlignment() == alignment)
 707       {
 708         return (_aps.get(i));
 709       }
 710     }
 711     return ap;
 712   }
 713
 714   /**
 715    * Append the given text to the history object
 716    *
 717    * @param text
 718    */
 719   public void addToHistory(String text)
 720   {
 721     // actually currently never initialised
 722     if (history != null)
 723     {
 724       history.append("\n" + text);
 725     }
 726   }
 727 }