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()
 326                 .getScoreModel(scoreModelName,
 327                         treeCanvas.getAssociatedPanel());
 328         TreeBuilder njtree = treeType.equals(TreeBuilder.NEIGHBOUR_JOINING)
 329                 ? new NJTree(av, sm, similarityParams)
 330                 : new AverageDistanceTree(av, sm, similarityParams);
 331         tree = new TreeModel(njtree);
 332         showDistances(true);
 333       }
 334
 335       tree.reCount(tree.getTopNode());
 336       tree.findHeight(tree.getTopNode());
 337       treeCanvas.setTree(tree);
 338       treeCanvas.repaint();
 339       av.setCurrentTree(tree);
 340       if (av.getSortByTree())
 341       {
 342         sortByTree_actionPerformed();
 343       }
 344     }
 345   }
 346
 347   public void showDistances(boolean b)
 348   {
 349     treeCanvas.setShowDistances(b);
 350     distanceMenu.setSelected(b);
 351   }
 352
 353   public void showBootstrap(boolean b)
 354   {
 355     treeCanvas.setShowBootstrap(b);
 356     bootstrapMenu.setSelected(b);
 357   }
 358
 359   public void showPlaceholders(boolean b)
 360   {
 361     placeholdersMenu.setState(b);
 362     treeCanvas.setMarkPlaceholders(b);
 363   }
 364
 365   /**
 366    * DOCUMENT ME!
 367    *
 368    * @return DOCUMENT ME!
 369    */
 370   public TreeModel getTree()
 371   {
 372     return tree;
 373   }
 374
 375   /**
 376    * DOCUMENT ME!
 377    *
 378    * @param e
 379    *          DOCUMENT ME!
 380    */
 381   @Override
 382   public void textbox_actionPerformed(ActionEvent e)
 383   {
 384     CutAndPasteTransfer cap = new CutAndPasteTransfer();
 385
 386     String newTitle = getPanelTitle();
 387
 388     NewickFile fout = new NewickFile(tree.getTopNode());
 389     try
 390     {
 391       cap.setText(fout.print(tree.hasBootstrap(), tree.hasDistances(),
 392               tree.hasRootDistance()));
 393       Desktop.addInternalFrame(cap, newTitle, 500, 100);
 394     } catch (OutOfMemoryError oom)
 395     {
 396       new OOMWarning("generating newick tree file", oom);
 397       cap.dispose();
 398     }
 399
 400   }
 401
 402   /**
 403    * DOCUMENT ME!
 404    *
 405    * @param e
 406    *          DOCUMENT ME!
 407    */
 408   @Override
 409   public void saveAsNewick_actionPerformed(ActionEvent e)
 410   {
 411     // TODO: JAL-3048 save newick file for Jalview-JS
 412     JalviewFileChooser chooser = new JalviewFileChooser(
 413             Cache.getProperty("LAST_DIRECTORY"));
 414     chooser.setFileView(new JalviewFileView());
 415     chooser.setDialogTitle(
 416             MessageManager.getString("label.save_tree_as_newick"));
 417     chooser.setToolTipText(MessageManager.getString("action.save"));
 418
 419     int value = chooser.showSaveDialog(null);
 420
 421     if (value == JalviewFileChooser.APPROVE_OPTION)
 422     {
 423       String choice = chooser.getSelectedFile().getPath();
 424       Cache.setProperty("LAST_DIRECTORY",
 425               chooser.getSelectedFile().getParent());
 426
 427       try
 428       {
 429         jalview.io.NewickFile fout = new jalview.io.NewickFile(
 430                 tree.getTopNode());
 431         String output = fout.print(tree.hasBootstrap(), tree.hasDistances(),
 432                 tree.hasRootDistance());
 433         java.io.PrintWriter out = new java.io.PrintWriter(
 434                 new java.io.FileWriter(choice));
 435         out.println(output);
 436         out.close();
 437       } catch (Exception ex)
 438       {
 439         ex.printStackTrace();
 440       }
 441     }
 442   }
 443
 444   /**
 445    * DOCUMENT ME!
 446    *
 447    * @param e
 448    *          DOCUMENT ME!
 449    */
 450   @Override
 451   public void printMenu_actionPerformed(ActionEvent e)
 452   {
 453     // Putting in a thread avoids Swing painting problems
 454     treeCanvas.startPrinting();
 455   }
 456
 457   @Override
 458   public void originalSeqData_actionPerformed(ActionEvent e)
 459   {
 460     AlignmentView originalData = tree.getOriginalData();
 461     if (originalData == null)
 462     {
 463       Console.info(
 464               "Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
 465       return;
 466     }
 467     // decide if av alignment is sufficiently different to original data to
 468     // warrant a new window to be created
 469     // create new alignmnt window with hidden regions (unhiding hidden regions
 470     // yields unaligned seqs)
 471     // or create a selection box around columns in alignment view
 472     // test Alignment(SeqCigar[])
 473     char gc = '-';
 474     try
 475     {
 476       // we try to get the associated view's gap character
 477       // but this may fail if the view was closed...
 478       gc = av.getGapCharacter();
 479
 480     } catch (Exception ex)
 481     {
 482     }
 483
 484     Object[] alAndColsel = originalData.getAlignmentAndHiddenColumns(gc);
 485
 486     if (alAndColsel != null && alAndColsel[0] != null)
 487     {
 488       // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
 489
 490       AlignmentI al = new Alignment((SequenceI[]) alAndColsel[0]);
 491       AlignmentI dataset = (av != null && av.getAlignment() != null)
 492               ? av.getAlignment().getDataset()
 493               : null;
 494       if (dataset != null)
 495       {
 496         al.setDataset(dataset);
 497       }
 498
 499       if (true)
 500       {
 501         // make a new frame!
 502         AlignFrame af = new AlignFrame(al, (HiddenColumns) alAndColsel[1],
 503                 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 504
 505         // >>>This is a fix for the moment, until a better solution is
 506         // found!!<<<
 507         // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
 508
 509         // af.addSortByOrderMenuItem(ServiceName + " Ordering",
 510         // msaorder);
 511
 512         Desktop.addInternalFrame(af, MessageManager.formatMessage(
 513                 "label.original_data_for_params", new Object[]
 514                 { this.title }), AlignFrame.DEFAULT_WIDTH,
 515                 AlignFrame.DEFAULT_HEIGHT);
 516       }
 517     }
 518   }
 519
 520   /**
 521    * DOCUMENT ME!
 522    *
 523    * @param e
 524    *          DOCUMENT ME!
 525    */
 526   @Override
 527   public void fitToWindow_actionPerformed(ActionEvent e)
 528   {
 529     treeCanvas.fitToWindow = fitToWindow.isSelected();
 530     repaint();
 531   }
 532
 533   /**
 534    * sort the associated alignment view by the current tree.
 535    *
 536    * @param e
 537    */
 538   @Override
 539   public void sortByTree_actionPerformed()
 540   {
 541
 542     if (treeCanvas.applyToAllViews)
 543     {
 544       final ArrayList<CommandI> commands = new ArrayList<>();
 545       for (AlignmentPanel ap : PaintRefresher
 546               .getAssociatedPanels(av.getSequenceSetId()))
 547       {
 548         commands.add(sortAlignmentIn(ap.av.getAlignPanel()));
 549       }
 550       av.getAlignPanel().alignFrame.addHistoryItem(new CommandI()
 551       {
 552
 553         @Override
 554         public void undoCommand(AlignmentI[] views)
 555         {
 556           for (CommandI tsort : commands)
 557           {
 558             tsort.undoCommand(views);
 559           }
 560         }
 561
 562         @Override
 563         public int getSize()
 564         {
 565           return commands.size();
 566         }
 567
 568         @Override
 569         public String getDescription()
 570         {
 571           return "Tree Sort (many views)";
 572         }
 573
 574         @Override
 575         public void doCommand(AlignmentI[] views)
 576         {
 577
 578           for (CommandI tsort : commands)
 579           {
 580             tsort.doCommand(views);
 581           }
 582         }
 583       });
 584       for (AlignmentPanel ap : PaintRefresher
 585               .getAssociatedPanels(av.getSequenceSetId()))
 586       {
 587         // ensure all the alignFrames refresh their GI after adding an undo item
 588         ap.alignFrame.updateEditMenuBar();
 589       }
 590     }
 591     else
 592     {
 593       treeCanvas.getAssociatedPanel().alignFrame
 594               .addHistoryItem(
 595                       sortAlignmentIn(treeCanvas.getAssociatedPanel()));
 596     }
 597
 598   }
 599
 600   public CommandI sortAlignmentIn(AlignmentPanel ap)
 601   {
 602     // TODO: move to alignment view controller
 603     AlignmentViewport viewport = ap.av;
 604     SequenceI[] oldOrder = viewport.getAlignment().getSequencesArray();
 605     AlignmentSorter.sortByTree(viewport.getAlignment(), tree);
 606     CommandI undo;
 607     undo = new OrderCommand("Tree Sort", oldOrder, viewport.getAlignment());
 608
 609     ap.paintAlignment(true, false);
 610     return undo;
 611   }
 612
 613   /**
 614    * DOCUMENT ME!
 615    *
 616    * @param e
 617    *          DOCUMENT ME!
 618    */
 619   @Override
 620   public void font_actionPerformed(ActionEvent e)
 621   {
 622     if (treeCanvas == null)
 623     {
 624       return;
 625     }
 626
 627     new FontChooser(this);
 628   }
 629
 630   public Font getTreeFont()
 631   {
 632     return treeCanvas.font;
 633   }
 634
 635   public void setTreeFont(Font f)
 636   {
 637     if (treeCanvas != null)
 638     {
 639       treeCanvas.setFont(f);
 640     }
 641   }
 642
 643   /**
 644    * DOCUMENT ME!
 645    *
 646    * @param e
 647    *          DOCUMENT ME!
 648    */
 649   @Override
 650   public void distanceMenu_actionPerformed(ActionEvent e)
 651   {
 652     treeCanvas.setShowDistances(distanceMenu.isSelected());
 653   }
 654
 655   /**
 656    * DOCUMENT ME!
 657    *
 658    * @param e
 659    *          DOCUMENT ME!
 660    */
 661   @Override
 662   public void bootstrapMenu_actionPerformed(ActionEvent e)
 663   {
 664     treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());
 665   }
 666
 667   /**
 668    * DOCUMENT ME!
 669    *
 670    * @param e
 671    *          DOCUMENT ME!
 672    */
 673   @Override
 674   public void placeholdersMenu_actionPerformed(ActionEvent e)
 675   {
 676     treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());
 677   }
 678
 679   /**
 680    * Outputs the Tree in image format (currently EPS or PNG). The user is
 681    * prompted for the file to save to, and for EPS (unless a preference is
 682    * already set) for the choice of Text or Lineart for character rendering.
 683    */
 684   @Override
 685   public void writeTreeImage(TYPE imageFormat)
 686   {
 687     int width = treeCanvas.getWidth();
 688     int height = treeCanvas.getHeight();
 689     ImageWriterI writer = new ImageWriterI()
 690     {
 691       @Override
 692       public void exportImage(Graphics g) throws Exception
 693       {
 694         treeCanvas.draw(g, width, height);
 695       }
 696     };
 697     String tree = MessageManager.getString("label.tree");
 698     ImageExporter exporter = new ImageExporter(writer, null, imageFormat,
 699             tree);
 700     exporter.doExport(null, this, width, height, tree.toLowerCase(Locale.ROOT));
 701   }
 702
 703   /**
 704    * change node labels to the annotation referred to by labelClass TODO:
 705    * promote to a datamodel modification that can be undone TODO: make argument
 706    * one case of a generic transformation function ie { undoStep = apply(Tree,
 707    * TransformFunction)};
 708    *
 709    * @param labelClass
 710    */
 711   public void changeNames(final String labelClass)
 712   {
 713     tree.applyToNodes(new NodeTransformI()
 714     {
 715
 716       @Override
 717       public void transform(BinaryNode node)
 718       {
 719         if (node instanceof SequenceNode
 720                 && !((SequenceNode) node).isPlaceholder()
 721                 && !((SequenceNode) node).isDummy())
 722         {
 723           String newname = null;
 724           SequenceI sq = (SequenceI) ((SequenceNode) node).element();
 725           if (sq != null)
 726           {
 727             // search dbrefs, features and annotation
 728             List<DBRefEntry> refs = jalview.util.DBRefUtils
 729                     .selectRefs(sq.getDBRefs(), new String[]
 730                     { labelClass.toUpperCase(Locale.ROOT) });
 731             if (refs != null)
 732             {
 733               for (int i = 0, ni = refs.size(); i < ni; i++)
 734               {
 735                 if (newname == null)
 736                 {
 737                   newname = new String(refs.get(i).getAccessionId());
 738                 }
 739                 else
 740                 {
 741                   newname += "; " + refs.get(i).getAccessionId();
 742                 }
 743               }
 744             }
 745             if (newname == null)
 746             {
 747               List<SequenceFeature> features = sq.getFeatures()
 748                       .getPositionalFeatures(labelClass);
 749               for (SequenceFeature feature : features)
 750               {
 751                 if (newname == null)
 752                 {
 753                   newname = feature.getDescription();
 754                 }
 755                 else
 756                 {
 757                   newname = newname + "; " + feature.getDescription();
 758                 }
 759               }
 760             }
 761           }
 762           if (newname != null)
 763           {
 764             // String oldname = ((SequenceNode) node).getName();
 765             // TODO : save oldname in the undo object for this modification.
 766             ((SequenceNode) node).setName(newname);
 767           }
 768         }
 769       }
 770     });
 771   }
 772
 773   /**
 774    * Formats a localised title for the tree panel, like
 775    * <p>
 776    * Neighbour Joining Using BLOSUM62
 777    * <p>
 778    * For a tree loaded from file, just uses the file name
 779    *
 780    * @return
 781    */
 782   public String getPanelTitle()
 783   {
 784     if (treeTitle != null)
 785     {
 786       return treeTitle;
 787     }
 788
 789     /*
 790      * i18n description of Neighbour Joining or Average Distance method
 791      */
 792     String treecalcnm = MessageManager
 793             .getString("label.tree_calc_" + treeType.toLowerCase(Locale.ROOT));
 794
 795     /*
 796      * short score model name (long description can be too long)
 797      */
 798     String smn = scoreModelName;
 799
 800     /*
 801      * put them together as <method> Using <model>
 802      */
 803     final String ttl = MessageManager.formatMessage("label.calc_title",
 804             treecalcnm, smn);
 805     return ttl;
 806   }
 807
 808   /**
 809    * Builds an EPS image and writes it to the specified file.
 810    *
 811    * @param outFile
 812    * @param textOption
 813    *          true for Text character rendering, false for Lineart
 814    */
 815   protected void writeEpsFile(File outFile, boolean textOption)
 816   {
 817     try
 818     {
 819       int width = treeCanvas.getWidth();
 820       int height = treeCanvas.getHeight();
 821
 822       FileOutputStream out = new FileOutputStream(
 823               outFile);
 824       EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width,
 825               height);
 826       pg.setAccurateTextMode(!textOption);
 827       treeCanvas.draw(pg, width, height);
 828
 829       pg.flush();
 830       pg.close();
 831     } catch (Exception ex)
 832     {
 833       System.err.println("Error writing tree as EPS");
 834       ex.printStackTrace();
 835     }
 836   }
 837
 838   public AlignViewport getViewport()
 839   {
 840     return av;
 841   }
 842
 843   public void setViewport(AlignViewport av)
 844   {
 845     this.av = av;
 846   }
 847
 848   public TreeCanvas getTreeCanvas()
 849   {
 850     return treeCanvas;
 851   }
 852 }