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