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.awt.Font;
  24 import java.awt.Graphics;
  25 import java.awt.event.ActionEvent;
  26 import java.awt.event.ActionListener;
  27 import java.beans.PropertyChangeEvent;
  28 import java.beans.PropertyChangeListener;
  29 import java.io.File;
  30 import java.io.FileOutputStream;
  31 import java.util.ArrayList;
  32 import java.util.List;
  33 import java.util.Locale;
  34
  35 import javax.swing.ButtonGroup;
  36 import javax.swing.JMenuItem;
  37 import javax.swing.JRadioButtonMenuItem;
  38 import javax.swing.event.InternalFrameAdapter;
  39 import javax.swing.event.InternalFrameEvent;
  40
  41 import org.jibble.epsgraphics.EpsGraphics2D;
  42
  43 import jalview.analysis.AlignmentSorter;
  44 import jalview.analysis.AverageDistanceTree;
  45 import jalview.analysis.NJTree;
  46 import jalview.analysis.TreeBuilder;
  47 import jalview.analysis.TreeModel;
  48 import jalview.analysis.scoremodels.ScoreModels;
  49 import jalview.api.analysis.ScoreModelI;
  50 import jalview.api.analysis.SimilarityParamsI;
  51 import jalview.bin.Cache;
  52 import jalview.bin.Console;
  53 import jalview.commands.CommandI;
  54 import jalview.commands.OrderCommand;
  55 import jalview.datamodel.Alignment;
  56 import jalview.datamodel.AlignmentI;
  57 import jalview.datamodel.AlignmentView;
  58 import jalview.datamodel.BinaryNode;
  59 import jalview.datamodel.DBRefEntry;
  60 import jalview.datamodel.HiddenColumns;
  61 import jalview.datamodel.NodeTransformI;
  62 import jalview.datamodel.SequenceFeature;
  63 import jalview.datamodel.SequenceI;
  64 import jalview.datamodel.SequenceNode;
  65 import jalview.gui.ImageExporter.ImageWriterI;
  66 import jalview.io.JalviewFileChooser;
  67 import jalview.io.JalviewFileView;
  68 import jalview.io.NewickFile;
  69 import jalview.jbgui.GTreePanel;
  70 import jalview.util.ImageMaker.TYPE;
  71 import jalview.util.MessageManager;
  72 import jalview.viewmodel.AlignmentViewport;
  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.setFrameIcon(null);
 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.setFrameIcon(null);
 122     this.treeTitle = theTitle;
 123     initTreePanel(alignPanel, null, null, newtree, inputData);
 124   }
 125
 126   public AlignmentI getAlignment()
 127   {
 128     return getTreeCanvas().getViewport().getAlignment();
 129   }
 130
 131   public AlignmentViewport getViewPort()
 132   {
 133     // @Mungo - Why don't we return our own viewport ???
 134     return getTreeCanvas().getViewport();
 135   }
 136
 137   void initTreePanel(AlignmentPanel ap, String type, String modelName,
 138           NewickFile newTree, AlignmentView inputData)
 139   {
 140
 141     av = ap.av;
 142     this.treeType = type;
 143     this.scoreModelName = modelName;
 144
 145     treeCanvas = new TreeCanvas(this, ap, scrollPane);
 146     scrollPane.setViewportView(treeCanvas);
 147
 148     PaintRefresher.Register(this, ap.av.getSequenceSetId());
 149
 150     buildAssociatedViewMenu();
 151
 152     final PropertyChangeListener listener = addAlignmentListener();
 153
 154     /*
 155      * remove listener when window is closed, so that this
 156      * panel can be garbage collected
 157      */
 158     addInternalFrameListener(new InternalFrameAdapter()
 159     {
 160       @Override
 161       public void internalFrameClosed(InternalFrameEvent evt)
 162       {
 163         if (av != null)
 164         {
 165           av.removePropertyChangeListener(listener);
 166         }
 167         releaseReferences();
 168       }
 169     });
 170
 171     TreeLoader tl = new TreeLoader(newTree, inputData);
 172     tl.start();
 173
 174   }
 175
 176   /**
 177    * Ensure any potentially large object references are nulled
 178    */
 179   public void releaseReferences()
 180   {
 181     this.tree = null;
 182     this.treeCanvas.tree = null;
 183     this.treeCanvas.nodeHash = null;
 184     this.treeCanvas.nameHash = null;
 185   }
 186
 187   /**
 188    * @return
 189    */
 190   protected PropertyChangeListener addAlignmentListener()
 191   {
 192     final PropertyChangeListener listener = new PropertyChangeListener()
 193     {
 194       @Override
 195       public void propertyChange(PropertyChangeEvent evt)
 196       {
 197         if (evt.getPropertyName().equals("alignment"))
 198         {
 199           if (tree == null)
 200           {
 201             System.out.println("tree is null");
 202             // TODO: deal with case when a change event is received whilst a
 203             // tree is still being calculated - should save reference for
 204             // processing message later.
 205             return;
 206           }
 207           if (evt.getNewValue() == null)
 208           {
 209             System.out.println(
 210                     "new alignment sequences vector value is null");
 211           }
 212
 213           tree.updatePlaceHolders((List<SequenceI>) evt.getNewValue());
 214           treeCanvas.nameHash.clear(); // reset the mapping between canvas
 215           // rectangles and leafnodes
 216           repaint();
 217         }
 218       }
 219     };
 220     av.addPropertyChangeListener(listener);
 221     return listener;
 222   }
 223
 224   @Override
 225   public void viewMenu_menuSelected()
 226   {
 227     buildAssociatedViewMenu();
 228   }
 229
 230   void buildAssociatedViewMenu()
 231   {
 232     AlignmentPanel[] aps = PaintRefresher
 233             .getAssociatedPanels(av.getSequenceSetId());
 234     if (aps.length == 1 && getTreeCanvas().getAssociatedPanel() == aps[0])
 235     {
 236       associateLeavesMenu.setVisible(false);
 237       return;
 238     }
 239
 240     associateLeavesMenu.setVisible(true);
 241
 242     if ((viewMenu
 243             .getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
 244     {
 245       viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
 246     }
 247
 248     associateLeavesMenu.removeAll();
 249
 250     JRadioButtonMenuItem item;
 251     ButtonGroup buttonGroup = new ButtonGroup();
 252     int i, iSize = aps.length;
 253     final TreePanel thisTreePanel = this;
 254     for (i = 0; i < iSize; i++)
 255     {
 256       final AlignmentPanel ap = aps[i];
 257       item = new JRadioButtonMenuItem(ap.av.getViewName(),
 258               ap == treeCanvas.getAssociatedPanel());
 259       buttonGroup.add(item);
 260       item.addActionListener(new ActionListener()
 261       {
 262         @Override
 263         public void actionPerformed(ActionEvent evt)
 264         {
 265           treeCanvas.applyToAllViews = false;
 266           treeCanvas.setAssociatedPanel(ap);
 267           treeCanvas.setViewport(ap.av);
 268           PaintRefresher.Register(thisTreePanel, ap.av.getSequenceSetId());
 269         }
 270       });
 271
 272       associateLeavesMenu.add(item);
 273     }
 274
 275     final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem(
 276             MessageManager.getString("label.all_views"));
 277     buttonGroup.add(itemf);
 278     itemf.setSelected(treeCanvas.applyToAllViews);
 279     itemf.addActionListener(new ActionListener()
 280     {
 281       @Override
 282       public void actionPerformed(ActionEvent evt)
 283       {
 284         treeCanvas.applyToAllViews = itemf.isSelected();
 285       }
 286     });
 287     associateLeavesMenu.add(itemf);
 288
 289   }
 290
 291   class TreeLoader extends Thread
 292   {
 293     private NewickFile newtree;
 294
 295     private AlignmentView odata = null;
 296
 297     public TreeLoader(NewickFile newickFile, AlignmentView inputData)
 298     {
 299       this.newtree = newickFile;
 300       this.odata = inputData;
 301
 302       if (newickFile != null)
 303       {
 304         // Must be outside run(), as Jalview2XML tries to
 305         // update distance/bootstrap visibility at the same time
 306         showBootstrap(newickFile.HasBootstrap());
 307         showDistances(newickFile.HasDistances());
 308       }
 309     }
 310
 311     @Override
 312     public void run()
 313     {
 314
 315       if (newtree != null)
 316       {
 317         tree = new TreeModel(av.getAlignment().getSequencesArray(), odata,
 318                 newtree);
 319         if (tree.getOriginalData() == null)
 320         {
 321           originalSeqData.setVisible(false);
 322         }
 323       }
 324       else
 325       {
 326         ScoreModelI sm = ScoreModels.getInstance().getScoreModel(
 327                 scoreModelName, 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.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,
 700             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.getString(
 793             "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(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 }