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