tidy imports
[jalview.git] / src / jalview / appletgui / AppletJmol.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
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  */
18 package jalview.appletgui;
19
20 import java.util.*;
21 import java.awt.*;
22 import java.awt.event.*;
23
24 import jalview.api.SequenceStructureBinding;
25 import jalview.datamodel.*;
26 import jalview.structure.*;
27 import jalview.io.*;
28
29 import org.jmol.api.*;
30
31 import org.jmol.popup.*;
32 import org.jmol.viewer.JmolConstants;
33
34 import jalview.schemes.*;
35
36 public class AppletJmol extends EmbmenuFrame implements
37 // StructureListener,
38         KeyListener, ActionListener, ItemListener, SequenceStructureBinding
39
40 {
41   Menu fileMenu = new Menu("File");
42
43   Menu viewMenu = new Menu("View");
44
45   Menu coloursMenu = new Menu("Colours");
46
47   Menu chainMenu = new Menu("Show Chain");
48
49   Menu helpMenu = new Menu("Help");
50
51   MenuItem mappingMenuItem = new MenuItem("View Mapping");
52
53   CheckboxMenuItem seqColour = new CheckboxMenuItem("By Sequence", true);
54
55   CheckboxMenuItem jmolColour = new CheckboxMenuItem("Using Jmol", false);
56   
57   MenuItem chain = new MenuItem("By Chain");
58
59   MenuItem charge = new MenuItem("Charge & Cysteine");
60
61   MenuItem zappo = new MenuItem("Zappo");
62
63   MenuItem taylor = new MenuItem("Taylor");
64
65   MenuItem hydro = new MenuItem("Hydrophobicity");
66
67   MenuItem helix = new MenuItem("Helix Propensity");
68
69   MenuItem strand = new MenuItem("Strand Propensity");
70
71   MenuItem turn = new MenuItem("Turn Propensity");
72
73   MenuItem buried = new MenuItem("Buried Index");
74   
75   MenuItem purinepyrimidine = new MenuItem("Purine/Pyrimidine");
76
77   MenuItem user = new MenuItem("User Defined Colours");
78
79   MenuItem jmolHelp = new MenuItem("Jmol Help");
80
81   Panel scriptWindow;
82
83   TextField inputLine;
84
85   TextArea history;
86
87   RenderPanel renderPanel;
88
89   AlignmentPanel ap;
90   ArrayList _aps = new ArrayList();
91
92   String fileLoadingError;
93
94   boolean loadedInline;
95
96   // boolean colourBySequence = true;
97
98   FeatureRenderer fr = null;
99
100   AppletJmolBinding jmb;
101
102   /**
103    * datasource protocol for access to PDBEntry
104    */
105   String protocol = null;
106
107   /**
108    * Load a bunch of pdb entries associated with sequences in the alignment and
109    * display them - aligning them if necessary.
110    * 
111    * @param pdbentries
112    *          each pdb file (at least one needed)
113    * @param boundseqs
114    *          each set of sequences for each pdb file (must match number of pdb
115    *          files)
116    * @param boundchains
117    *          the target pdb chain corresponding with each sequence associated
118    *          with each pdb file (may be null at any level)
119    * @param align
120    *          true/false
121    * @param ap
122    *          associated alignment
123    * @param protocol
124    *          how to get pdb data
125    */
126   public AppletJmol(PDBEntry[] pdbentries, SequenceI[][] boundseqs,
127           String[][] boundchains, boolean align, AlignmentPanel ap,
128           String protocol)
129   {
130     throw new Error("Not yet implemented.");
131   }
132
133   public AppletJmol(PDBEntry pdbentry, SequenceI[] seq, String[] chains,
134           AlignmentPanel ap, String protocol)
135   {
136     this.ap = ap;
137     jmb = new AppletJmolBinding(this, ap.getStructureSelectionManager(), new PDBEntry[]
138     { pdbentry }, new SequenceI[][]
139     { seq }, new String[][]
140     { chains }, protocol);
141     jmb.setColourBySequence(true);
142     if (pdbentry.getId() == null || pdbentry.getId().length() < 1)
143     {
144       if (protocol.equals(AppletFormatAdapter.PASTE))
145       {
146         pdbentry.setId("PASTED PDB"
147                 + (chains == null ? "_" : chains.toString()));
148       }
149       else
150       {
151         pdbentry.setId(pdbentry.getFile());
152       }
153     }
154
155     if (jalview.bin.JalviewLite.debug)
156     {
157       System.err
158               .println("AppletJmol: PDB ID is '" + pdbentry.getId() + "'");
159     }
160
161     String alreadyMapped = StructureSelectionManager
162             .getStructureSelectionManager(ap.av.applet).alreadyMappedToFile(
163                     pdbentry.getId());
164     MCview.PDBfile reader = null;
165     if (alreadyMapped != null)
166     {
167       reader = StructureSelectionManager.getStructureSelectionManager(ap.av.applet)
168               .setMapping(seq, chains, pdbentry.getFile(), 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("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(
391                           jmb.pdbentry[s].getFile()));
392           sb.append("\n");
393         }
394         cap.setText(sb.toString());
395       } catch (OutOfMemoryError ex)
396       {
397         frame.dispose();
398         System.err
399                 .println("Out of memory when trying to create dialog box with sequence-structure mapping.");
400         return;
401       }
402       jalview.bin.JalviewLite.addFrame(frame, "PDB - Sequence Mapping",
403               550, 600);
404     }
405     else if (evt.getSource() == charge)
406     {
407       setEnabled(charge);
408       jmb.colourByCharge();
409     }
410
411     else if (evt.getSource() == chain)
412     {
413       setEnabled(chain);
414       jmb.colourByChain();
415     }
416     else if (evt.getSource() == zappo)
417     {
418       setEnabled(zappo);
419       jmb.setJalviewColourScheme(new ZappoColourScheme());
420     }
421     else if (evt.getSource() == taylor)
422     {
423       setEnabled(taylor);
424       jmb.setJalviewColourScheme(new TaylorColourScheme());
425     }
426     else if (evt.getSource() == hydro)
427     {
428       setEnabled(hydro);
429       jmb.setJalviewColourScheme(new HydrophobicColourScheme());
430     }
431     else if (evt.getSource() == helix)
432     {
433       setEnabled(helix);
434       jmb.setJalviewColourScheme(new HelixColourScheme());
435     }
436     else if (evt.getSource() == strand)
437     {
438       setEnabled(strand);
439       jmb.setJalviewColourScheme(new StrandColourScheme());
440     }
441     else if (evt.getSource() == turn)
442     {
443       setEnabled(turn);
444       jmb.setJalviewColourScheme(new TurnColourScheme());
445     }
446     else if (evt.getSource() == buried)
447     {
448       setEnabled(buried);
449       jmb.setJalviewColourScheme(new BuriedColourScheme());
450     }
451     else if(evt.getSource() == purinepyrimidine)
452     {
453         jmb.setJalviewColourScheme(new PurinePyrimidineColourScheme());
454     }
455     else if (evt.getSource() == user)
456     {
457       setEnabled(user);
458       new UserDefinedColours(this);
459     }
460     else if (evt.getSource() == jmolHelp)
461     {
462       try
463       {
464         ap.av.applet.getAppletContext().showDocument(
465                 new java.net.URL(
466                         "http://jmol.sourceforge.net/docs/JmolUserGuide/"),
467                 "jmolHelp");
468       } catch (java.net.MalformedURLException ex)
469       {
470       }
471     }
472     else
473     {
474       allChainsSelected = true;
475       for (int i = 0; i < chainMenu.getItemCount(); i++)
476       {
477         if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
478           ((CheckboxMenuItem) chainMenu.getItem(i)).setState(true);
479       }
480
481       centerViewer();
482       allChainsSelected = false;
483     }
484   }
485
486   /**
487    * tick or untick the seqColour menu entry or jmoColour entry depending upon if it was selected
488    * or not.
489    * 
490    * @param itm
491    */
492   private void setEnabled(MenuItem itm)
493   {
494     jmolColour.setState(itm == jmolColour);
495     seqColour.setState(itm == seqColour);
496     jmb.setColourBySequence(itm == seqColour);
497   }
498
499   public void itemStateChanged(ItemEvent evt)
500   {
501     if (evt.getSource() == jmolColour)
502     {
503       setEnabled(jmolColour);
504       jmb.setColourBySequence(false);
505     } else
506     if (evt.getSource() == seqColour)
507     {
508       setEnabled(seqColour);
509       jmb.colourBySequence(ap.av.getShowSequenceFeatures(), ap);
510     }
511     else if (!allChainsSelected)
512       centerViewer();
513   }
514
515   public void keyPressed(KeyEvent evt)
516   {
517     if (evt.getKeyCode() == KeyEvent.VK_ENTER && scriptWindow.isVisible())
518     {
519       jmb.eval(inputLine.getText());
520       history.append("\n$ " + inputLine.getText());
521       inputLine.setText("");
522     }
523
524   }
525
526   public void keyTyped(KeyEvent evt)
527   {
528   }
529
530   public void keyReleased(KeyEvent evt)
531   {
532   }
533
534   public void updateColours(Object source)
535   {
536     AlignmentPanel ap = (AlignmentPanel) source;
537     jmb.colourBySequence(ap.av.getShowSequenceFeatures(), ap);
538   }
539
540   public void updateTitleAndMenus()
541   {
542     if (jmb.fileLoadingError != null && jmb.fileLoadingError.length() > 0)
543     {
544       repaint();
545       return;
546     }
547     setChainMenuItems(jmb.chainNames);
548     jmb.colourBySequence(ap.av.getShowSequenceFeatures(), ap);
549
550     setTitle(jmb.getViewerTitle());
551   }
552
553   public void showUrl(String url)
554   {
555     try
556     {
557       ap.av.applet.getAppletContext().showDocument(new java.net.URL(url),
558               "jmolOutput");
559     } catch (java.net.MalformedURLException ex)
560     {
561     }
562   }
563
564   Panel splitPane = null;
565
566   public void showConsole(boolean showConsole)
567   {
568     if (showConsole)
569     {
570       remove(renderPanel);
571       splitPane = new Panel();
572
573       splitPane.setLayout(new java.awt.GridLayout(2, 1));
574       splitPane.add(renderPanel);
575       splitPane.add(scriptWindow);
576       scriptWindow.setVisible(true);
577       this.add(splitPane, BorderLayout.CENTER);
578       splitPane.setVisible(true);
579       splitPane.validate();
580     }
581     else
582     {
583       scriptWindow.setVisible(false);
584       remove(splitPane);
585       add(renderPanel, BorderLayout.CENTER);
586       splitPane = null;
587     }
588     validate();
589   }
590
591   public float[][] functionXY(String functionName, int x, int y)
592   {
593     return null;
594   }
595
596   // /End JmolStatusListener
597   // /////////////////////////////
598
599   class RenderPanel extends Panel
600   {
601     Dimension currentSize = new Dimension();
602
603     Rectangle rectClip = new Rectangle();
604
605     public void update(Graphics g)
606     {
607       paint(g);
608     }
609
610     public void paint(Graphics g)
611     {
612       currentSize = this.getSize();
613       rectClip = g.getClipBounds();
614
615       if (jmb.viewer == null)
616       {
617         g.setColor(Color.black);
618         g.fillRect(0, 0, currentSize.width, currentSize.height);
619         g.setColor(Color.white);
620         g.setFont(new Font("Verdana", Font.BOLD, 14));
621         g.drawString("Retrieving PDB data....", 20, currentSize.height / 2);
622       }
623       else
624       {
625         jmb.viewer.renderScreenImage(g, currentSize, rectClip);
626       }
627     }
628   }
629
630   /*
631    * @Override public Color getColour(int atomIndex, int pdbResNum, String
632    * chain, String pdbId) { return jmb.getColour(atomIndex, pdbResNum, chain,
633    * pdbId); }
634    * 
635    * @Override public String[] getPdbFile() { return jmb.getPdbFile(); }
636    * 
637    * @Override public void highlightAtom(int atomIndex, int pdbResNum, String
638    * chain, String pdbId) { jmb.highlightAtom(atomIndex, pdbResNum, chain,
639    * pdbId);
640    * 
641    * }
642    * 
643    * @Override public void mouseOverStructure(int atomIndex, String strInfo) {
644    * jmb.mouseOverStructure(atomIndex, strInfo);
645    * 
646    * }
647    */
648   public void setJalviewColourScheme(UserColourScheme ucs)
649   {
650     jmb.setJalviewColourScheme(ucs);
651   }
652
653   public AlignmentPanel getAlignmentPanelFor(AlignmentI alignment)
654   {
655     for (int i=0;i<_aps.size();i++)
656     {
657       if (((AlignmentPanel)_aps.get(i)).av.getAlignment()==alignment)
658       {
659         return ((AlignmentPanel)_aps.get(i));
660       }
661     }
662     return ap;
663   }
664 }