src/jalview/gui/TreePanel.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
   3  * Copyright (C) 2008 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18  */
  19 package jalview.gui;
  20
  21 import java.beans.*;
  22 import java.io.*;
  23 import java.util.*;
  24 import javax.imageio.*;
  25
  26 import java.awt.*;
  27 import java.awt.event.*;
  28 import java.awt.image.*;
  29 import javax.swing.*;
  30
  31 import org.jibble.epsgraphics.*;
  32 import jalview.analysis.*;
  33 import jalview.datamodel.*;
  34 import jalview.io.*;
  35 import jalview.jbgui.*;
  36
  37 /**
  38  * DOCUMENT ME!
  39  *
  40  * @author $author$
  41  * @version $Revision$
  42  */
  43 public class TreePanel
  44     extends GTreePanel
  45 {
  46   String type;
  47   String pwtype;
  48   TreeCanvas treeCanvas;
  49   NJTree tree;
  50   AlignViewport av;
  51
  52   /**
  53    * Creates a new TreePanel object.
  54    *
  55    * @param av DOCUMENT ME!
  56    * @param seqVector DOCUMENT ME!
  57    * @param type DOCUMENT ME!
  58    * @param pwtype DOCUMENT ME!
  59    * @param s DOCUMENT ME!
  60    * @param e DOCUMENT ME!
  61    */
  62   public TreePanel(AlignmentPanel ap, String type, String pwtype)
  63   {
  64     super();
  65     initTreePanel(ap, type, pwtype, null, null);
  66
  67     // We know this tree has distances. JBPNote TODO: prolly should add this as a userdefined default
  68     // showDistances(true);
  69   }
  70
  71   /**
  72    * Creates a new TreePanel object.
  73    *
  74    * @param av DOCUMENT ME!
  75    * @param seqVector DOCUMENT ME!
  76    * @param newtree DOCUMENT ME!
  77    * @param type DOCUMENT ME!
  78    * @param pwtype DOCUMENT ME!
  79    */
  80   public TreePanel(AlignmentPanel ap,
  81                    String type,
  82                    String pwtype,
  83                    NewickFile newtree)
  84   {
  85     super();
  86     initTreePanel(ap, type, pwtype, newtree, null);
  87   }
  88
  89   public TreePanel(AlignmentPanel av,
  90                    String type,
  91                    String pwtype,
  92                    NewickFile newtree, AlignmentView inputData)
  93   {
  94     super();
  95     initTreePanel(av, type, pwtype, newtree, inputData);
  96   }
  97
  98   public AlignmentI getAlignment()
  99   {
 100     return treeCanvas.av.getAlignment();
 101   }
 102
 103   public AlignViewport getViewPort()
 104   {
 105     return treeCanvas.av;
 106   }
 107
 108   void initTreePanel(AlignmentPanel ap, String type, String pwtype,
 109                      NewickFile newTree, AlignmentView inputData)
 110   {
 111
 112     av = ap.av;
 113     this.type = type;
 114     this.pwtype = pwtype;
 115
 116     treeCanvas = new TreeCanvas(this, ap, scrollPane);
 117     scrollPane.setViewportView(treeCanvas);
 118
 119     PaintRefresher.Register(this, ap.av.getSequenceSetId());
 120
 121     buildAssociatedViewMenu();
 122
 123     av.addPropertyChangeListener(new java.beans.PropertyChangeListener()
 124     {
 125       public void propertyChange(PropertyChangeEvent evt)
 126       {
 127         if (evt.getPropertyName().equals("alignment"))
 128         {
 129           if (tree == null)
 130           {
 131             System.out.println("tree is null");
 132           }
 133           if (evt.getNewValue() == null)
 134           {
 135             System.out.println("new alignment sequences vector value is null");
 136           }
 137
 138           tree.UpdatePlaceHolders( (Vector) evt.getNewValue());
 139           treeCanvas.nameHash.clear(); // reset the mapping between canvas rectangles and leafnodes
 140           repaint();
 141         }
 142       }
 143     });
 144
 145     TreeLoader tl = new TreeLoader(newTree);
 146     if (inputData != null)
 147     {
 148       tl.odata = inputData;
 149     }
 150     tl.start();
 151
 152   }
 153
 154   public void viewMenu_menuSelected()
 155   {
 156     buildAssociatedViewMenu();
 157   }
 158
 159   void buildAssociatedViewMenu()
 160   {
 161     AlignmentPanel[] aps = PaintRefresher.getAssociatedPanels(av.
 162         getSequenceSetId());
 163     if (aps.length == 1 && treeCanvas.ap == aps[0])
 164     {
 165       associateLeavesMenu.setVisible(false);
 166       return;
 167     }
 168
 169     associateLeavesMenu.setVisible(true);
 170
 171     if ( (viewMenu.getItem(viewMenu.getItemCount() - 2) instanceof JMenuItem))
 172     {
 173       viewMenu.insertSeparator(viewMenu.getItemCount() - 1);
 174     }
 175
 176     associateLeavesMenu.removeAll();
 177
 178     JRadioButtonMenuItem item;
 179     ButtonGroup buttonGroup = new ButtonGroup();
 180     int i, iSize = aps.length;
 181     final TreePanel thisTreePanel = this;
 182     for (i = 0; i < iSize; i++)
 183     {
 184       final AlignmentPanel ap = aps[i];
 185       item = new JRadioButtonMenuItem(ap.av.viewName, ap == treeCanvas.ap);
 186       buttonGroup.add(item);
 187       item.addActionListener(new ActionListener()
 188       {
 189         public void actionPerformed(ActionEvent evt)
 190         {
 191           treeCanvas.applyToAllViews = false;
 192           treeCanvas.ap = ap;
 193           treeCanvas.av = ap.av;
 194           PaintRefresher.Register(thisTreePanel, ap.av.getSequenceSetId());
 195         }
 196       });
 197
 198       associateLeavesMenu.add(item);
 199     }
 200
 201     final JRadioButtonMenuItem itemf = new JRadioButtonMenuItem("All Views");
 202     buttonGroup.add(itemf);
 203     itemf.setSelected(treeCanvas.applyToAllViews);
 204     itemf.addActionListener(new ActionListener()
 205     {
 206       public void actionPerformed(ActionEvent evt)
 207       {
 208         treeCanvas.applyToAllViews = itemf.isSelected();
 209       }
 210     });
 211     associateLeavesMenu.add(itemf);
 212
 213   }
 214
 215   class TreeLoader
 216       extends Thread
 217   {
 218     NewickFile newtree;
 219     jalview.datamodel.AlignmentView odata = null;
 220     public TreeLoader(NewickFile newtree)
 221     {
 222       this.newtree = newtree;
 223       if (newtree != null)
 224       {
 225         // Must be outside run(), as Jalview2XML tries to
 226         // update distance/bootstrap visibility at the same time
 227         showBootstrap(newtree.HasBootstrap());
 228         showDistances(newtree.HasDistances());
 229       }
 230     }
 231
 232     public void run()
 233     {
 234
 235       if (newtree != null)
 236       {
 237         if (odata == null)
 238         {
 239           tree = new NJTree(av.alignment.getSequencesArray(),
 240                             newtree);
 241         }
 242         else
 243         {
 244           tree = new NJTree(av.alignment.getSequencesArray(), odata, newtree);
 245         }
 246         if (!tree.hasOriginalSequenceData())
 247         {
 248           allowOriginalSeqData(false);
 249         }
 250       }
 251       else
 252       {
 253         int start, end;
 254         SequenceI[] seqs;
 255         AlignmentView seqStrings = av.getAlignmentView(av.getSelectionGroup() != null);
 256         if (av.getSelectionGroup() == null)
 257         {
 258           start = 0;
 259           end = av.alignment.getWidth();
 260           seqs = av.alignment.getSequencesArray();
 261         }
 262         else
 263         {
 264           start = av.getSelectionGroup().getStartRes();
 265           end = av.getSelectionGroup().getEndRes() + 1;
 266           seqs = av.getSelectionGroup().getSequencesInOrder(av.alignment);
 267         }
 268
 269         tree = new NJTree(seqs, seqStrings, type, pwtype, start, end);
 270         showDistances(true);
 271       }
 272
 273       tree.reCount(tree.getTopNode());
 274       tree.findHeight(tree.getTopNode());
 275       treeCanvas.setTree(tree);
 276       treeCanvas.repaint();
 277       av.setCurrentTree(tree);
 278
 279     }
 280   }
 281
 282   public void showDistances(boolean b)
 283   {
 284     treeCanvas.setShowDistances(b);
 285     distanceMenu.setSelected(b);
 286   }
 287
 288   public void showBootstrap(boolean b)
 289   {
 290     treeCanvas.setShowBootstrap(b);
 291     bootstrapMenu.setSelected(b);
 292   }
 293
 294   public void showPlaceholders(boolean b)
 295   {
 296     placeholdersMenu.setState(b);
 297     treeCanvas.setMarkPlaceholders(b);
 298   }
 299
 300   private void allowOriginalSeqData(boolean b)
 301   {
 302     originalSeqData.setVisible(b);
 303   }
 304
 305   /**
 306    * DOCUMENT ME!
 307    *
 308    * @return DOCUMENT ME!
 309    */
 310   public NJTree getTree()
 311   {
 312     return tree;
 313   }
 314
 315   /**
 316    * DOCUMENT ME!
 317    *
 318    * @param e DOCUMENT ME!
 319    */
 320   public void textbox_actionPerformed(ActionEvent e)
 321   {
 322     CutAndPasteTransfer cap = new CutAndPasteTransfer();
 323
 324     StringBuffer buffer = new StringBuffer();
 325
 326     if (type.equals("AV"))
 327     {
 328       buffer.append("Average distance tree using ");
 329     }
 330     else
 331     {
 332       buffer.append("Neighbour joining tree using ");
 333     }
 334
 335     if (pwtype.equals("BL"))
 336     {
 337       buffer.append("BLOSUM62");
 338     }
 339     else
 340     {
 341       buffer.append("PID");
 342     }
 343
 344     Desktop.addInternalFrame(cap, buffer.toString(), 500, 100);
 345
 346     jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());
 347     cap.setText(fout.print(tree.isHasBootstrap(), tree.isHasDistances(),
 348                            tree.isHasRootDistance()));
 349   }
 350
 351   /**
 352    * DOCUMENT ME!
 353    *
 354    * @param e DOCUMENT ME!
 355    */
 356   public void saveAsNewick_actionPerformed(ActionEvent e)
 357   {
 358     JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.
 359         getProperty(
 360             "LAST_DIRECTORY"));
 361     chooser.setFileView(new JalviewFileView());
 362     chooser.setDialogTitle("Save tree as newick file");
 363     chooser.setToolTipText("Save");
 364
 365     int value = chooser.showSaveDialog(null);
 366
 367     if (value == JalviewFileChooser.APPROVE_OPTION)
 368     {
 369       String choice = chooser.getSelectedFile().getPath();
 370       jalview.bin.Cache.setProperty("LAST_DIRECTORY",
 371                                     chooser.getSelectedFile().getParent());
 372
 373       try
 374       {
 375         jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());
 376         String output = fout.print(tree.isHasBootstrap(), tree.isHasDistances(),
 377                                    tree.isHasRootDistance());
 378         java.io.PrintWriter out = new java.io.PrintWriter(new java.io.
 379             FileWriter(
 380                 choice));
 381         out.println(output);
 382         out.close();
 383       }
 384       catch (Exception ex)
 385       {
 386         ex.printStackTrace();
 387       }
 388     }
 389   }
 390
 391   /**
 392    * DOCUMENT ME!
 393    *
 394    * @param e DOCUMENT ME!
 395    */
 396   public void printMenu_actionPerformed(ActionEvent e)
 397   {
 398     //Putting in a thread avoids Swing painting problems
 399     treeCanvas.startPrinting();
 400   }
 401
 402   public void originalSeqData_actionPerformed(ActionEvent e)
 403   {
 404     if (!tree.hasOriginalSequenceData())
 405     {
 406       jalview.bin.Cache.log.info("Unexpected call to originalSeqData_actionPerformed - should have hidden this menu action.");
 407       return;
 408     }
 409     // decide if av alignment is sufficiently different to original data to warrant a new window to be created
 410     // create new alignmnt window with hidden regions (unhiding hidden regions yields unaligned seqs)
 411     // or create a selection box around columns in alignment view
 412     // test Alignment(SeqCigar[])
 413     char gc = '-';
 414     try {
 415       // we try to get the associated view's gap character
 416       // but this may fail if the view was closed...
 417       gc = av.
 418       getGapCharacter();
 419
 420     } catch (Exception ex) {};
 421     Object[] alAndColsel = tree.seqData.getAlignmentAndColumnSelection(gc);
 422
 423     if (alAndColsel != null && alAndColsel[0] != null)
 424     {
 425       // AlignmentOrder origorder = new AlignmentOrder(alAndColsel[0]);
 426
 427       Alignment al = new Alignment( (SequenceI[]) alAndColsel[0]);
 428       Alignment dataset = (av!=null && av.getAlignment()!=null) ? av.getAlignment().getDataset() : null;
 429       if (dataset != null)
 430       {
 431         al.setDataset(dataset);
 432       }
 433
 434       if (true)
 435       {
 436         // make a new frame!
 437         AlignFrame af = new AlignFrame(al, (ColumnSelection) alAndColsel[1],
 438                                        AlignFrame.DEFAULT_WIDTH,
 439                                        AlignFrame.DEFAULT_HEIGHT
 440             );
 441
 442         //>>>This is a fix for the moment, until a better solution is found!!<<<
 443         // af.getFeatureRenderer().transferSettings(alignFrame.getFeatureRenderer());
 444
 445         //           af.addSortByOrderMenuItem(ServiceName + " Ordering",
 446         //                                     msaorder);
 447
 448         Desktop.addInternalFrame(af, "Original Data for " + this.title,
 449                                  AlignFrame.DEFAULT_WIDTH,
 450                                  AlignFrame.DEFAULT_HEIGHT);
 451       }
 452     }
 453   }
 454
 455   /**
 456    * DOCUMENT ME!
 457    *
 458    * @param e DOCUMENT ME!
 459    */
 460   public void fitToWindow_actionPerformed(ActionEvent e)
 461   {
 462     treeCanvas.fitToWindow = fitToWindow.isSelected();
 463     repaint();
 464   }
 465
 466   /**
 467    * DOCUMENT ME!
 468    *
 469    * @param e DOCUMENT ME!
 470    */
 471   public void font_actionPerformed(ActionEvent e)
 472   {
 473     if (treeCanvas == null)
 474     {
 475       return;
 476     }
 477
 478     new FontChooser(this);
 479   }
 480
 481   public Font getTreeFont()
 482   {
 483     return treeCanvas.font;
 484   }
 485
 486   public void setTreeFont(Font font)
 487   {
 488     if (treeCanvas != null)
 489     {
 490       treeCanvas.setFont(font);
 491     }
 492   }
 493
 494   /**
 495    * DOCUMENT ME!
 496    *
 497    * @param e DOCUMENT ME!
 498    */
 499   public void distanceMenu_actionPerformed(ActionEvent e)
 500   {
 501     treeCanvas.setShowDistances(distanceMenu.isSelected());
 502   }
 503
 504   /**
 505    * DOCUMENT ME!
 506    *
 507    * @param e DOCUMENT ME!
 508    */
 509   public void bootstrapMenu_actionPerformed(ActionEvent e)
 510   {
 511     treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());
 512   }
 513
 514   /**
 515    * DOCUMENT ME!
 516    *
 517    * @param e DOCUMENT ME!
 518    */
 519   public void placeholdersMenu_actionPerformed(ActionEvent e)
 520   {
 521     treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());
 522   }
 523
 524   /**
 525    * DOCUMENT ME!
 526    *
 527    * @param e DOCUMENT ME!
 528    */
 529   public void epsTree_actionPerformed(ActionEvent e)
 530   {
 531     boolean accurateText = true;
 532
 533     String renderStyle = jalview.bin.Cache.getDefault("EPS_RENDERING",
 534         "Prompt each time");
 535
 536     // If we need to prompt, and if the GUI is visible then
 537     // Prompt for EPS rendering style
 538     if (renderStyle.equalsIgnoreCase("Prompt each time")
 539         && !
 540         (System.getProperty("java.awt.headless") != null
 541          && System.getProperty("java.awt.headless").equals("true")))
 542     {
 543       EPSOptions eps = new EPSOptions();
 544       renderStyle = eps.getValue();
 545
 546       if (renderStyle == null || eps.cancelled)
 547       {
 548         return;
 549       }
 550
 551     }
 552
 553     if (renderStyle.equalsIgnoreCase("text"))
 554     {
 555       accurateText = false;
 556     }
 557
 558     int width = treeCanvas.getWidth();
 559     int height = treeCanvas.getHeight();
 560
 561     try
 562     {
 563       jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
 564           jalview.bin.Cache.getProperty(
 565               "LAST_DIRECTORY"), new String[]
 566           {"eps"},
 567           new String[]
 568           {"Encapsulated Postscript"},
 569           "Encapsulated Postscript");
 570       chooser.setFileView(new jalview.io.JalviewFileView());
 571       chooser.setDialogTitle("Create EPS file from tree");
 572       chooser.setToolTipText("Save");
 573
 574       int value = chooser.showSaveDialog(this);
 575
 576       if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)
 577       {
 578         return;
 579       }
 580
 581       jalview.bin.Cache.setProperty("LAST_DIRECTORY",
 582                                     chooser.getSelectedFile().getParent());
 583
 584       FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
 585       EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width,
 586                                            height);
 587
 588       pg.setAccurateTextMode(accurateText);
 589
 590       treeCanvas.draw(pg, width, height);
 591
 592       pg.flush();
 593       pg.close();
 594     }
 595     catch (Exception ex)
 596     {
 597       ex.printStackTrace();
 598     }
 599   }
 600
 601   /**
 602    * DOCUMENT ME!
 603    *
 604    * @param e DOCUMENT ME!
 605    */
 606   public void pngTree_actionPerformed(ActionEvent e)
 607   {
 608     int width = treeCanvas.getWidth();
 609     int height = treeCanvas.getHeight();
 610
 611     try
 612     {
 613       jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(
 614           jalview.bin.Cache.getProperty(
 615               "LAST_DIRECTORY"), new String[]
 616           {"png"},
 617           new String[]
 618           {"Portable network graphics"},
 619           "Portable network graphics");
 620
 621       chooser.setFileView(new jalview.io.JalviewFileView());
 622       chooser.setDialogTitle("Create PNG image from tree");
 623       chooser.setToolTipText("Save");
 624
 625       int value = chooser.showSaveDialog(this);
 626
 627       if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)
 628       {
 629         return;
 630       }
 631
 632       jalview.bin.Cache.setProperty("LAST_DIRECTORY",
 633                                     chooser.getSelectedFile().getParent());
 634
 635       FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());
 636
 637       BufferedImage bi = new BufferedImage(width, height,
 638                                            BufferedImage.TYPE_INT_RGB);
 639       Graphics png = bi.getGraphics();
 640
 641       treeCanvas.draw(png, width, height);
 642
 643       ImageIO.write(bi, "png", out);
 644       out.close();
 645     }
 646     catch (Exception ex)
 647     {
 648       ex.printStackTrace();
 649     }
 650   }
 651 }