src/jalview/gui/TreePanel.java

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