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.bin.Console;
  35 import jalview.commands.CommandI;
  36 import jalview.commands.OrderCommand;
  37 import jalview.datamodel.Alignment;
  38 import jalview.datamodel.AlignmentI;
  39 import jalview.datamodel.AlignmentView;
  40 import jalview.datamodel.BinaryNode;
  41 import jalview.datamodel.DBRefEntry;
  42 import jalview.datamodel.HiddenColumns;
  43 import jalview.datamodel.NodeTransformI;
  44 import jalview.datamodel.SequenceFeature;
  45 import jalview.datamodel.SequenceI;
  46 import jalview.datamodel.SequenceNode;
  47 import jalview.gui.ImageExporter.ImageWriterI;
  48 import jalview.io.JalviewFileChooser;
  49 import jalview.io.JalviewFileView;
  50 import jalview.io.NewickFile;
  51 import jalview.jbgui.GTreePanel;
  52 import jalview.util.ImageMaker.TYPE;
  53 import jalview.util.MessageManager;
  54 import jalview.viewmodel.AlignmentViewport;
  55
  56 import java.awt.Font;
  57 import java.awt.Graphics;
  58 import java.awt.event.ActionEvent;
  59 import java.awt.event.ActionListener;
  60 import java.beans.PropertyChangeEvent;
  61 import java.beans.PropertyChangeListener;
  62 import java.io.File;
  63 import java.io.FileOutputStream;
  64 import java.util.ArrayList;
  65 import java.util.List;
  66
  67 import javax.swing.ButtonGroup;
  68 import javax.swing.JMenuItem;
  69 import javax.swing.JRadioButtonMenuItem;
  70 import javax.swing.event.InternalFrameAdapter;
  71 import javax.swing.event.InternalFrameEvent;
  72
  73 import org.jibble.epsgraphics.EpsGraphics2D;
  74
  75 /**
  76  * DOCUMENT ME!
  77  *
  78  * @author $author$
  79  * @version $Revision$
  80  */
  81 public class TreePanel extends GTreePanel
  82 {
  83   String treeType;
  84
  85   String scoreModelName; // if tree computed
  86
  87   String treeTitle; // if tree loaded
  88
  89   SimilarityParamsI similarityParams;
  90
  91   private TreeCanvas treeCanvas;
  92
  93   TreeModel tree;
  94
  95   private AlignViewport av;
  96
  97   /**
  98    * Creates a new TreePanel object.
  99    *
 100    * @param ap
 101    * @param type
 102    * @param modelName
 103    * @param options
 104    */
 105   public TreePanel(AlignmentPanel ap, String type, String modelName,
 106           SimilarityParamsI options)
 107   {
 108     super();
 109     this.similarityParams = options;
 110     initTreePanel(ap, type, modelName, null, null);
 111
 112     // We know this tree has distances. JBPNote TODO: prolly should add this as
 113     // a userdefined default
 114     // showDistances(true);
 115   }
 116
 117   public TreePanel(AlignmentPanel alignPanel, NewickFile newtree,
 118           String theTitle, AlignmentView inputData)
 119   {
 120     super();
 121     this.treeTitle = theTitle;
 122     initTreePanel(alignPanel, null, null, newtree, inputData);
 123   }
 124
 125   public AlignmentI getAlignment()
 126   {
 127     return getTreeCanvas().getViewport().getAlignment();
 128   }
 129
 130   public AlignmentViewport getViewPort()
 131   {
 132     // @Mungo - Why don't we return our own viewport ???
 133     return getTreeCanvas().getViewport();
 134   }
 135
 136   void initTreePanel(AlignmentPanel ap, String type, String modelName,
 137           NewickFile newTree, AlignmentView inputData)
 138   {
 139
 140     av = ap.av;
 141     this.treeType = type;
 142     this.scoreModelName = modelName;
 143
 144     treeCanvas = new TreeCanvas(this, ap, scrollPane);
 145     scrollPane.setViewportView(treeCanvas);
 146
 147     PaintRefresher.Register(this, ap.av.getSequenceSetId());
 148
 149     buildAssociatedViewMenu();
 150
 151     final PropertyChangeListener listener = addAlignmentListener();
 152
 153     /*
 154      * remove listener when window is closed, so that this
 155      * panel can be garbage collected
 156      */
 157     addInternalFrameListener(new InternalFrameAdapter()
 158     {
 159       @Override
 160       public void internalFrameClosed(InternalFrameEvent evt)
 161       {
 162         if (av != null)
 163         {
 164           av.removePropertyChangeListener(listener);
 165         }
 166         releaseReferences();
 167       }
 168     });
 169
 170     TreeLoader tl = new TreeLoader(newTree, inputData);
 171     tl.start();
 172
 173   }
 174
 175   /**
 176    * Ensure any potentially large object references are nulled
 177    */
 178   public void releaseReferences()
 179   {
 180     this.tree = null;
 181     this.treeCanvas.tree = null;
 182     this.treeCanvas.nodeHash = null;
 183     this.treeCanvas.nameHash = null;
 184   }
 185
 186   /**
 187    * @return
 188    */
 189   protected PropertyChangeListener addAlignmentListener()
 190   {
 191     final PropertyChangeListener listener = new PropertyChangeListener()
 192     {
 193       @Override
 194       public void propertyChange(PropertyChangeEvent evt)
 195       {
 196         if (evt.getPropertyName().equals("alignment"))
 197         {
 198           if (tree == null)
 199           {
 200             System.out.println("tree is null");
 201             // TODO: deal with case when a change event is received whilst a
 202             // tree is still being calculated - should save reference for
 203             // processing message later.
 204             return;
 205           }
 206           if (evt.getNewValue() == null)
 207           {
 208             System.out.println(
 209                     "new alignment sequences vector value is null");
 210           }
 211
 212           tree.updatePlaceHolders((List<SequenceI>) evt.getNewValue());
 213           treeCanvas.nameHash.clear(); // reset the mapping between canvas
 214           // rectangles and leafnodes
 215           repaint();
 216         }
 217       }
 218     };
 219     av.addPropertyChangeListener(listener);
 220     return listener;
 221   }
 222
 223   @Override
 224   public void viewMenu_menuSelected()
 225   {
 226     buildAssociatedViewMenu();
 227   }
 228
 229   void buildAssociatedViewMenu()
 230   {
 231     AlignmentPanel[] aps = PaintRefresher
 232             .getAssociatedPanels(av.getSequenceSetId());
 233     if (aps.length == 1 && getTreeCanvas().getAssociatedPanel() == aps[0])
 234     {
 235       associateLeavesMenu.setVisible(false);
 236       return;
 237     }
 238
 239     associateLeavesMenu.setVisible(true);
 240
 241     if ((viewMenu
 242             .getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
 243     {
 244       viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
 245     }
 246
 247     associateLeavesMenu.removeAll();
 248
 249     JRadioButtonMenuItem item;
 250     ButtonGroup buttonGroup = new ButtonGroup();
 251     int i, iSize = aps.length;
 252     final TreePanel thisTreePanel = this;
 253     for (i = 0; i < iSize; i++)
 254     {
 255       final AlignmentPanel ap = aps[i];
 256       item = new JRadioButtonMenuItem(ap.av.getViewName(),
 257               ap == treeCanvas.getAssociatedPanel());
 258       buttonGroup.add(item);
 259       item.addActionListener(new ActionListener()
 260       {
 261         @Override
 262         public void actionPerformed(ActionEvent evt)
 263         {
 264           treeCanvas.applyToAllViews = false;
 265           treeCanvas.setAssociatedPanel(ap);
 266           treeCanvas.setViewport(ap.av);
 267           PaintRefresher.Register(thisTreePanel, ap.av.getSequenceSetId());
 268         }
 269       });
 270
 271       associateLeavesMenu.add(item);
 272     }
 273
 274     final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem(
 275             MessageManager.getString("label.all_views"));
 276     buttonGroup.add(itemf);
 277     itemf.setSelected(treeCanvas.applyToAllViews);
 278     itemf.addActionListener(new ActionListener()
 279     {
 280       @Override
 281       public void actionPerformed(ActionEvent evt)
 282       {
 283         treeCanvas.applyToAllViews = itemf.isSelected();
 284       }
 285     });
 286     associateLeavesMenu.add(itemf);
 287
 288   }
 289
 290   class TreeLoader extends Thread
 291   {
 292     private NewickFile newtree;
 293
 294     private AlignmentView odata = null;
 295
 296     public TreeLoader(NewickFile newickFile, AlignmentView inputData)
 297     {
 298       this.newtree = newickFile;
 299       this.odata = inputData;
 300
 301       if (newickFile != null)
 302       {
 303         // Must be outside run(), as Jalview2XML tries to
 304         // update distance/bootstrap visibility at the same time
 305         showBootstrap(newickFile.HasBootstrap());
 306         showDistances(newickFile.HasDistances());
 307       }
 308     }
 309
 310     @Override
 311     public void run()
 312     {
 313
 314       if (newtree != null)
 315       {
 316         tree = new TreeModel(av.getAlignment().getSequencesArray(), odata,
 317                 newtree);
 318         if (tree.getOriginalData() == null)
 319         {
 320           originalSeqData.setVisible(false);
 321         }
 322       }
 323       else
 324       {
 325         ScoreModelI sm = ScoreModels.getInstance().getScoreModel(
 326                 scoreModelName, 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       Console.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.addHistoryItem(
 593               sortAlignmentIn(treeCanvas.getAssociatedPanel()));
 594     }
 595
 596   }
 597
 598   public CommandI sortAlignmentIn(AlignmentPanel ap)
 599   {
 600     // TODO: move to alignment view controller
 601     AlignmentViewport viewport = ap.av;
 602     SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
 603     AlignmentSorter.sortByTree(viewport.getAlignment(), tree);
 604     CommandI undo;
 605     undo = new OrderCommand("Tree Sort", oldOrder, viewport.getAlignment());
 606
 607     ap.paintAlignment(true, false);
 608     return undo;
 609   }
 610
 611   /**
 612    * DOCUMENT ME!
 613    *
 614    * @param e
 615    *          DOCUMENT ME!
 616    */
 617   @Override
 618   public void font_actionPerformed(ActionEvent e)
 619   {
 620     if (treeCanvas == null)
 621     {
 622       return;
 623     }
 624
 625     new FontChooser(this);
 626   }
 627
 628   public Font getTreeFont()
 629   {
 630     return treeCanvas.font;
 631   }
 632
 633   public void setTreeFont(Font f)
 634   {
 635     if (treeCanvas != null)
 636     {
 637       treeCanvas.setFont(f);
 638     }
 639   }
 640
 641   /**
 642    * DOCUMENT ME!
 643    *
 644    * @param e
 645    *          DOCUMENT ME!
 646    */
 647   @Override
 648   public void distanceMenu_actionPerformed(ActionEvent e)
 649   {
 650     treeCanvas.setShowDistances(distanceMenu.isSelected());
 651   }
 652
 653   /**
 654    * DOCUMENT ME!
 655    *
 656    * @param e
 657    *          DOCUMENT ME!
 658    */
 659   @Override
 660   public void bootstrapMenu_actionPerformed(ActionEvent e)
 661   {
 662     treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());
 663   }
 664
 665   /**
 666    * DOCUMENT ME!
 667    *
 668    * @param e
 669    *          DOCUMENT ME!
 670    */
 671   @Override
 672   public void placeholdersMenu_actionPerformed(ActionEvent e)
 673   {
 674     treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());
 675   }
 676
 677   /**
 678    * Outputs the Tree in image format (currently EPS or PNG). The user is
 679    * prompted for the file to save to, and for EPS (unless a preference is
 680    * already set) for the choice of Text or Lineart for character rendering.
 681    */
 682   @Override
 683   public void writeTreeImage(TYPE imageFormat)
 684   {
 685     int width = treeCanvas.getWidth();
 686     int height = treeCanvas.getHeight();
 687     ImageWriterI writer = new ImageWriterI()
 688     {
 689       @Override
 690       public void exportImage(Graphics g) throws Exception
 691       {
 692         treeCanvas.draw(g, width, height);
 693       }
 694     };
 695     String tree = MessageManager.getString("label.tree");
 696     ImageExporter exporter = new ImageExporter(writer, null, imageFormat,
 697             tree);
 698     exporter.doExport(null, this, width, height,
 699             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.getString(
 792             "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(outFile);
 822       EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width,
 823               height);
 824       pg.setAccurateTextMode(!textOption);
 825       treeCanvas.draw(pg, width, height);
 826
 827       pg.flush();
 828       pg.close();
 829     } catch (Exception ex)
 830     {
 831       System.err.println("Error writing tree as EPS");
 832       ex.printStackTrace();
 833     }
 834   }
 835
 836   public AlignViewport getViewport()
 837   {
 838     return av;
 839   }
 840
 841   public void setViewport(AlignViewport av)
 842   {
 843     this.av = av;
 844   }
 845
 846   public TreeCanvas getTreeCanvas()
 847   {
 848     return treeCanvas;
 849   }
 850 }