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