ee0bfafdf497c697521b85bde53537ea06ed3f7e
[jalview.git] / src / jalview / gui / TreePanel.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
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
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.gui;
22
23 import java.beans.*;
24 import java.io.*;
25 import java.util.*;
26 import java.util.List;
27
28 import javax.imageio.*;
29
30 import java.awt.*;
31 import java.awt.event.*;
32 import java.awt.image.*;
33 import javax.swing.*;
34
35 import org.jibble.epsgraphics.*;
36 import jalview.analysis.*;
37 import jalview.commands.CommandI;
38 import jalview.commands.OrderCommand;
39 import jalview.datamodel.*;
40 import jalview.io.*;
41 import jalview.jbgui.*;
42 import jalview.util.MessageManager;
43
44 /**
45  * DOCUMENT ME!
46  * 
47  * @author $author$
48  * @version $Revision$
49  */
50 public class TreePanel extends GTreePanel
51 {
52   String type;
53
54   String pwtype;
55
56   TreeCanvas treeCanvas;
57
58   NJTree tree;
59
60   AlignViewport av;
61
62   /**
63    * Creates a new TreePanel object.
64    * 
65    * @param av
66    *          DOCUMENT ME!
67    * @param seqVector
68    *          DOCUMENT ME!
69    * @param type
70    *          DOCUMENT ME!
71    * @param pwtype
72    *          DOCUMENT ME!
73    * @param s
74    *          DOCUMENT ME!
75    * @param e
76    *          DOCUMENT ME!
77    */
78   public TreePanel(AlignmentPanel ap, String type, String pwtype)
79   {
80     super();
81     initTreePanel(ap, type, pwtype, null, null);
82
83     // We know this tree has distances. JBPNote TODO: prolly should add this as
84     // a userdefined default
85     // showDistances(true);
86   }
87
88   /**
89    * Creates a new TreePanel object.
90    * 
91    * @param av
92    *          DOCUMENT ME!
93    * @param seqVector
94    *          DOCUMENT ME!
95    * @param newtree
96    *          DOCUMENT ME!
97    * @param type
98    *          DOCUMENT ME!
99    * @param pwtype
100    *          DOCUMENT ME!
101    */
102   public TreePanel(AlignmentPanel ap, String type, String pwtype,
103           NewickFile newtree)
104   {
105     super();
106     initTreePanel(ap, type, pwtype, newtree, null);
107   }
108
109   public TreePanel(AlignmentPanel av, String type, String pwtype,
110           NewickFile newtree, AlignmentView inputData)
111   {
112     super();
113     initTreePanel(av, type, pwtype, newtree, inputData);
114   }
115
116   public AlignmentI getAlignment()
117   {
118     return treeCanvas.av.getAlignment();
119   }
120
121   public AlignViewport getViewPort()
122   {
123     return treeCanvas.av;
124   }
125
126   void initTreePanel(AlignmentPanel ap, String type, String pwtype,
127           NewickFile newTree, AlignmentView inputData)
128   {
129
130     av = ap.av;
131     this.type = type;
132     this.pwtype = pwtype;
133
134     treeCanvas = new TreeCanvas(this, ap, scrollPane);
135     scrollPane.setViewportView(treeCanvas);
136
137     PaintRefresher.Register(this, ap.av.getSequenceSetId());
138
139     buildAssociatedViewMenu();
140
141     av.addPropertyChangeListener(new java.beans.PropertyChangeListener()
142     {
143       public void propertyChange(PropertyChangeEvent evt)
144       {
145         if (evt.getPropertyName().equals("alignment"))
146         {
147           if (tree == null)
148           {
149             System.out.println("tree is null");
150             // TODO: deal with case when a change event is received whilst a
151             // tree is still being calculated - should save reference for
152             // processing message later.
153             return;
154           }
155           if (evt.getNewValue() == null)
156           {
157             System.out
158                     .println("new alignment sequences vector value is null");
159           }
160
161           tree.UpdatePlaceHolders((List<SequenceI>) evt.getNewValue());
162           treeCanvas.nameHash.clear(); // reset the mapping between canvas
163           // rectangles and leafnodes
164           repaint();
165         }
166       }
167     });
168
169     TreeLoader tl = new TreeLoader(newTree);
170     if (inputData != null)
171     {
172       tl.odata = inputData;
173     }
174     tl.start();
175
176   }
177
178   public void viewMenu_menuSelected()
179   {
180     buildAssociatedViewMenu();
181   }
182
183   void buildAssociatedViewMenu()
184   {
185     AlignmentPanel[] aps = PaintRefresher.getAssociatedPanels(av
186             .getSequenceSetId());
187     if (aps.length == 1 && treeCanvas.ap == aps[0])
188     {
189       associateLeavesMenu.setVisible(false);
190       return;
191     }
192
193     associateLeavesMenu.setVisible(true);
194
195     if ((viewMenu.getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
196     {
197       viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
198     }
199
200     associateLeavesMenu.removeAll();
201
202     JRadioButtonMenuItem item;
203     ButtonGroup buttonGroup = new ButtonGroup();
204     int i, iSize = aps.length;
205     final TreePanel thisTreePanel = this;
206     for (i = 0; i < iSize; i++)
207     {
208       final AlignmentPanel ap = aps[i];
209       item = new JRadioButtonMenuItem(ap.av.viewName, ap == treeCanvas.ap);
210       buttonGroup.add(item);
211       item.addActionListener(new ActionListener()
212       {
213         public void actionPerformed(ActionEvent evt)
214         {
215           treeCanvas.applyToAllViews = false;
216           treeCanvas.ap = ap;
217           treeCanvas.av = ap.av;
218           PaintRefresher.Register(thisTreePanel, ap.av.getSequenceSetId());
219         }
220       });
221
222       associateLeavesMenu.add(item);
223     }
224
225     final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem("All Views");
226     buttonGroup.add(itemf);
227     itemf.setSelected(treeCanvas.applyToAllViews);
228     itemf.addActionListener(new ActionListener()
229     {
230       public void actionPerformed(ActionEvent evt)
231       {
232         treeCanvas.applyToAllViews = itemf.isSelected();
233       }
234     });
235     associateLeavesMenu.add(itemf);
236
237   }
238
239   class TreeLoader extends Thread
240   {
241     NewickFile newtree;
242
243     jalview.datamodel.AlignmentView odata = null;
244
245     public TreeLoader(NewickFile newtree)
246     {
247       this.newtree = newtree;
248       if (newtree != null)
249       {
250         // Must be outside run(), as Jalview2XML tries to
251         // update distance/bootstrap visibility at the same time
252         showBootstrap(newtree.HasBootstrap());
253         showDistances(newtree.HasDistances());
254       }
255     }
256
257     public void run()
258     {
259
260       if (newtree != null)
261       {
262         if (odata == null)
263         {
264           tree = new NJTree(av.getAlignment().getSequencesArray(), newtree);
265         }
266         else
267         {
268           tree = new NJTree(av.getAlignment().getSequencesArray(), odata,
269                   newtree);
270         }
271         if (!tree.hasOriginalSequenceData())
272         {
273           allowOriginalSeqData(false);
274         }
275       }
276       else
277       {
278         int start, end;
279         SequenceI[] seqs;
280         boolean selview = av.getSelectionGroup() != null
281                 && av.getSelectionGroup().getSize() > 1;
282         AlignmentView seqStrings = av.getAlignmentView(selview);
283         if (!selview)
284         {
285           start = 0;
286           end = av.getAlignment().getWidth();
287           seqs = av.getAlignment().getSequencesArray();
288         }
289         else
290         {
291           start = av.getSelectionGroup().getStartRes();
292           end = av.getSelectionGroup().getEndRes() + 1;
293           seqs = av.getSelectionGroup().getSequencesInOrder(
294                   av.getAlignment());
295         }
296
297         tree = new NJTree(seqs, seqStrings, type, pwtype, start, end);
298         showDistances(true);
299       }
300
301       tree.reCount(tree.getTopNode());
302       tree.findHeight(tree.getTopNode());
303       treeCanvas.setTree(tree);
304       treeCanvas.repaint();
305       av.setCurrentTree(tree);
306       if (av.getSortByTree())
307       {
308         sortByTree_actionPerformed(null);
309       }
310     }
311   }
312
313   public void showDistances(boolean b)
314   {
315     treeCanvas.setShowDistances(b);
316     distanceMenu.setSelected(b);
317   }
318
319   public void showBootstrap(boolean b)
320   {
321     treeCanvas.setShowBootstrap(b);
322     bootstrapMenu.setSelected(b);
323   }
324
325   public void showPlaceholders(boolean b)
326   {
327     placeholdersMenu.setState(b);
328     treeCanvas.setMarkPlaceholders(b);
329   }
330
331   private void allowOriginalSeqData(boolean b)
332   {
333     originalSeqData.setVisible(b);
334   }
335
336   /**
337    * DOCUMENT ME!
338    * 
339    * @return DOCUMENT ME!
340    */
341   public NJTree getTree()
342   {
343     return tree;
344   }
345
346   /**
347    * DOCUMENT ME!
348    * 
349    * @param e
350    *          DOCUMENT ME!
351    */
352   public void textbox_actionPerformed(ActionEvent e)
353   {
354     CutAndPasteTransfer cap = new CutAndPasteTransfer();
355
356     StringBuffer buffer = new StringBuffer();
357
358     if (type.equals("AV"))
359     {
360       buffer.append("Average distance tree using ");
361     }
362     else
363     {
364       buffer.append("Neighbour joining tree using ");
365     }
366
367     if (pwtype.equals("BL"))
368     {
369       buffer.append("BLOSUM62");
370     }
371     else
372     {
373       buffer.append("PID");
374     }
375
376     jalview.io.NewickFile fout = new jalview.io.NewickFile(
377             tree.getTopNode());
378     try
379     {
380       cap.setText(fout.print(tree.isHasBootstrap(), tree.isHasDistances(),
381               tree.isHasRootDistance()));
382       Desktop.addInternalFrame(cap, buffer.toString(), 500, 100);
383     } catch (OutOfMemoryError oom)
384     {
385       new OOMWarning("generating newick tree file", oom);
386       cap.dispose();
387     }
388
389   }
390
391   /**
392    * DOCUMENT ME!
393    * 
394    * @param e
395    *          DOCUMENT ME!
396    */
397   public void saveAsNewick_actionPerformed(ActionEvent e)
398   {
399     JalviewFileChooser chooser = new JalviewFileChooser(
400             jalview.bin.Cache.getProperty("LAST_DIRECTORY"));
401     chooser.setFileView(new JalviewFileView());
402     chooser.setDialogTitle(MessageManager.getString("label.save_tree_as_newick"));
403     chooser.setToolTipText(MessageManager.getString("action.save"));
404
405     int value = chooser.showSaveDialog(null);
406
407     if (value == JalviewFileChooser.APPROVE_OPTION)
408     {
409       String choice = chooser.getSelectedFile().getPath();
410       jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
411               .getSelectedFile().getParent());
412
413       try
414       {
415         jalview.io.NewickFile fout = new jalview.io.NewickFile(
416                 tree.getTopNode());
417         String output = fout.print(tree.isHasBootstrap(),
418                 tree.isHasDistances(), tree.isHasRootDistance());
419         java.io.PrintWriter out = new java.io.PrintWriter(
420                 new java.io.FileWriter(choice));
421         out.println(output);
422         out.close();
423       } catch (Exception ex)
424       {
425         ex.printStackTrace();
426       }
427     }
428   }
429
430   /**
431    * DOCUMENT ME!
432    * 
433    * @param e
434    *          DOCUMENT ME!
435    */
436   public void printMenu_actionPerformed(ActionEvent e)
437   {
438     // Putting in a thread avoids Swing painting problems
439     treeCanvas.startPrinting();
440   }
441
442   public void originalSeqData_actionPerformed(ActionEvent e)
443   {
444     if (!tree.hasOriginalSequenceData())
445     {
446       jalview.bin.Cache.log
447               .info("Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
448       return;
449     }
450     // decide if av alignment is sufficiently different to original data to
451     // warrant a new window to be created
452     // create new alignmnt window with hidden regions (unhiding hidden regions
453     // yields unaligned seqs)
454     // or create a selection box around columns in alignment view
455     // test Alignment(SeqCigar[])
456     char gc = '-';
457     try
458     {
459       // we try to get the associated view's gap character
460       // but this may fail if the view was closed...
461       gc = av.getGapCharacter();
462
463     } catch (Exception ex)
464     {
465     }
466     ;
467     Object[] alAndColsel = tree.seqData.getAlignmentAndColumnSelection(gc);
468
469     if (alAndColsel != null && alAndColsel[0] != null)
470     {
471       // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
472
473       Alignment al = new Alignment((SequenceI[]) alAndColsel[0]);
474       Alignment dataset = (av != null && av.getAlignment() != null) ? av
475               .getAlignment().getDataset() : null;
476       if (dataset != null)
477       {
478         al.setDataset(dataset);
479       }
480
481       if (true)
482       {
483         // make a new frame!
484         AlignFrame af = new AlignFrame(al,
485                 (ColumnSelection) alAndColsel[1], AlignFrame.DEFAULT_WIDTH,
486                 AlignFrame.DEFAULT_HEIGHT);
487
488         // >>>This is a fix for the moment, until a better solution is
489         // found!!<<<
490         // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
491
492         // af.addSortByOrderMenuItem(ServiceName + " Ordering",
493         // msaorder);
494
495         Desktop.addInternalFrame(af, MessageManager.formatMessage(
496                 "label.original_data_for_params", new String[]
497                 { this.title }), AlignFrame.DEFAULT_WIDTH,
498                 AlignFrame.DEFAULT_HEIGHT);
499       }
500     }
501   }
502
503   /**
504    * DOCUMENT ME!
505    * 
506    * @param e
507    *          DOCUMENT ME!
508    */
509   public void fitToWindow_actionPerformed(ActionEvent e)
510   {
511     treeCanvas.fitToWindow = fitToWindow.isSelected();
512     repaint();
513   }
514
515   /**
516    * sort the associated alignment view by the current tree.
517    * 
518    * @param e
519    */
520   public void sortByTree_actionPerformed(ActionEvent e)
521   {
522
523     if (treeCanvas.applyToAllViews)
524     {
525       final ArrayList<CommandI> commands = new ArrayList<CommandI>();
526       for (AlignmentPanel ap : PaintRefresher.getAssociatedPanels(av
527               .getSequenceSetId()))
528       {
529         commands.add(sortAlignmentIn(ap.av.getAlignPanel()));
530       }
531       av.getAlignPanel().alignFrame.addHistoryItem(new CommandI()
532       {
533
534         @Override
535         public void undoCommand(AlignmentI[] views)
536         {
537           for (CommandI tsort : commands)
538           {
539             tsort.undoCommand(views);
540           }
541         }
542
543         @Override
544         public int getSize()
545         {
546           return commands.size();
547         }
548
549         @Override
550         public String getDescription()
551         {
552           return "Tree Sort (many views)";
553         }
554
555         @Override
556         public void doCommand(AlignmentI[] views)
557         {
558
559           for (CommandI tsort : commands)
560           {
561             tsort.doCommand(views);
562           }
563         }
564       });
565       for (AlignmentPanel ap : PaintRefresher.getAssociatedPanels(av
566               .getSequenceSetId()))
567       {
568         // ensure all the alignFrames refresh their GI after adding an undo item
569         ap.alignFrame.updateEditMenuBar();
570       }
571     }
572     else
573     {
574       treeCanvas.ap.alignFrame
575               .addHistoryItem(sortAlignmentIn(treeCanvas.ap));
576     }
577
578   }
579
580   public CommandI sortAlignmentIn(AlignmentPanel ap)
581   {
582     AlignViewport av = ap.av;
583     SequenceI[] oldOrder = av.getAlignment().getSequencesArray();
584     AlignmentSorter.sortByTree(av.getAlignment(), tree);
585     CommandI undo;
586     undo = new OrderCommand("Tree Sort", oldOrder, av.getAlignment());
587
588     ap.paintAlignment(true);
589     return undo;
590   }
591
592   /**
593    * DOCUMENT ME!
594    * 
595    * @param e
596    *          DOCUMENT ME!
597    */
598   public void font_actionPerformed(ActionEvent e)
599   {
600     if (treeCanvas == null)
601     {
602       return;
603     }
604
605     new FontChooser(this);
606   }
607
608   public Font getTreeFont()
609   {
610     return treeCanvas.font;
611   }
612
613   public void setTreeFont(Font font)
614   {
615     if (treeCanvas != null)
616     {
617       treeCanvas.setFont(font);
618     }
619   }
620
621   /**
622    * DOCUMENT ME!
623    * 
624    * @param e
625    *          DOCUMENT ME!
626    */
627   public void distanceMenu_actionPerformed(ActionEvent e)
628   {
629     treeCanvas.setShowDistances(distanceMenu.isSelected());
630   }
631
632   /**
633    * DOCUMENT ME!
634    * 
635    * @param e
636    *          DOCUMENT ME!
637    */
638   public void bootstrapMenu_actionPerformed(ActionEvent e)
639   {
640     treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());
641   }
642
643   /**
644    * DOCUMENT ME!
645    * 
646    * @param e
647    *          DOCUMENT ME!
648    */
649   public void placeholdersMenu_actionPerformed(ActionEvent e)
650   {
651     treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());
652   }
653
654   /**
655    * DOCUMENT ME!
656    * 
657    * @param e
658    *          DOCUMENT ME!
659    */
660   public void epsTree_actionPerformed(ActionEvent e)
661   {
662     boolean accurateText = true;
663
664     String renderStyle = jalview.bin.Cache.getDefault("EPS_RENDERING",
665             "Prompt each time");
666
667     // If we need to prompt, and if the GUI is visible then
668     // Prompt for EPS rendering style
669     if (renderStyle.equalsIgnoreCase("Prompt each time")
670             && !(System.getProperty("java.awt.headless") != null && System
671                     .getProperty("java.awt.headless").equals("true")))
672     {
673       EPSOptions eps = new EPSOptions();
674       renderStyle = eps.getValue();
675
676       if (renderStyle == null || eps.cancelled)
677       {
678         return;
679       }
680
681     }
682
683     if (renderStyle.equalsIgnoreCase("text"))
684     {
685       accurateText = false;
686     }
687
688     int width = treeCanvas.getWidth();
689     int height = treeCanvas.getHeight();
690
691     try
692     {
693       jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
694               jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
695               { "eps" }, new String[]
696               { "Encapsulated Postscript" }, "Encapsulated Postscript");
697       chooser.setFileView(new jalview.io.JalviewFileView());
698       chooser.setDialogTitle(MessageManager.getString("label.create_eps_from_tree"));
699       chooser.setToolTipText(MessageManager.getString("action.save"));
700
701       int value = chooser.showSaveDialog(this);
702
703       if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)
704       {
705         return;
706       }
707
708       jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
709               .getSelectedFile().getParent());
710
711       FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
712       EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width, height);
713
714       pg.setAccurateTextMode(accurateText);
715
716       treeCanvas.draw(pg, width, height);
717
718       pg.flush();
719       pg.close();
720     } catch (Exception ex)
721     {
722       ex.printStackTrace();
723     }
724   }
725
726   /**
727    * DOCUMENT ME!
728    * 
729    * @param e
730    *          DOCUMENT ME!
731    */
732   public void pngTree_actionPerformed(ActionEvent e)
733   {
734     int width = treeCanvas.getWidth();
735     int height = treeCanvas.getHeight();
736
737     try
738     {
739       jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
740               jalview.bin.Cache.getProperty("LAST_DIRECTORY"), new String[]
741               { "png" }, new String[]
742               { "Portable network graphics" }, "Portable network graphics");
743
744       chooser.setFileView(new jalview.io.JalviewFileView());
745       chooser.setDialogTitle(MessageManager.getString("label.create_png_from_tree"));
746       chooser.setToolTipText(MessageManager.getString("action.save"));
747
748       int value = chooser.showSaveDialog(this);
749
750       if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)
751       {
752         return;
753       }
754
755       jalview.bin.Cache.setProperty("LAST_DIRECTORY", chooser
756               .getSelectedFile().getParent());
757
758       FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
759
760       BufferedImage bi = new BufferedImage(width, height,
761               BufferedImage.TYPE_INT_RGB);
762       Graphics png = bi.getGraphics();
763
764       treeCanvas.draw(png, width, height);
765
766       ImageIO.write(bi, "png", out);
767       out.close();
768     } catch (Exception ex)
769     {
770       ex.printStackTrace();
771     }
772   }
773
774   /**
775    * change node labels to the annotation referred to by labelClass TODO:
776    * promote to a datamodel modification that can be undone TODO: make argument
777    * one case of a generic transformation function ie { undoStep = apply(Tree,
778    * TransformFunction)};
779    * 
780    * @param labelClass
781    */
782   public void changeNames(final String labelClass)
783   {
784     tree.applyToNodes(new NodeTransformI()
785     {
786
787       public void transform(BinaryNode node)
788       {
789         if (node instanceof SequenceNode
790                 && !((SequenceNode) node).isPlaceholder()
791                 && !((SequenceNode) node).isDummy())
792         {
793           String newname = null;
794           SequenceI sq = (SequenceI) ((SequenceNode) node).element();
795           if (sq != null)
796           {
797             // search dbrefs, features and annotation
798             DBRefEntry[] refs = jalview.util.DBRefUtils.selectRefs(
799                     sq.getDBRef(), new String[]
800                     { labelClass.toUpperCase() });
801             if (refs != null)
802             {
803               for (int i = 0; i < refs.length; i++)
804               {
805                 if (newname == null)
806                 {
807                   newname = new String(refs[i].getAccessionId());
808                 }
809                 else
810                 {
811                   newname = newname + "; " + refs[i].getAccessionId();
812                 }
813               }
814             }
815             if (newname == null)
816             {
817               SequenceFeature sf[] = sq.getSequenceFeatures();
818               for (int i = 0; sf != null && i < sf.length; i++)
819               {
820                 if (sf[i].getType().equals(labelClass))
821                 {
822                   if (newname == null)
823                   {
824                     newname = new String(sf[i].getDescription());
825                   }
826                   else
827                   {
828                     newname = newname + "; " + sf[i].getDescription();
829                   }
830                 }
831               }
832             }
833           }
834           if (newname != null)
835           {
836             String oldname = ((SequenceNode) node).getName();
837             // TODO : save in the undo object for this modification.
838             ((SequenceNode) node).setName(newname);
839           }
840         }
841       }
842     });
843   }
844 }