src/jalview/gui/TreePanel.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer\r
   3  * Copyright (C) 2005 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     SequenceI[] seq;\r
  53     String type;\r
  54     String pwtype;\r
  55     int start;\r
  56     int end;\r
  57     TreeCanvas treeCanvas;\r
  58     NJTree tree;\r
  59 \r
  60     /**\r
  61      * Creates a new TreePanel object.\r
  62      *\r
  63      * @param av DOCUMENT ME!\r
  64      * @param seqVector DOCUMENT ME!\r
  65      * @param type DOCUMENT ME!\r
  66      * @param pwtype DOCUMENT ME!\r
  67      * @param s DOCUMENT ME!\r
  68      * @param e DOCUMENT ME!\r
  69      */\r
  70     public TreePanel(AlignViewport av, Vector seqVector, String type,\r
  71                      String pwtype, int s, int e)\r
  72     {\r
  73       super();\r
  74       initTreePanel(av, seqVector, type, pwtype, s, e, null);\r
  75 \r
  76       // We know this tree has distances. JBPNote TODO: prolly should add this as a userdefined default\r
  77       showDistances(true);\r
  78     }\r
  79 \r
  80     /**\r
  81      * Creates a new TreePanel object.\r
  82      *\r
  83      * @param av DOCUMENT ME!\r
  84      * @param seqVector DOCUMENT ME!\r
  85      * @param newtree DOCUMENT ME!\r
  86      * @param type DOCUMENT ME!\r
  87      * @param pwtype DOCUMENT ME!\r
  88      */\r
  89     public TreePanel(AlignViewport av, Vector seqVector, NewickFile newtree,\r
  90                      String type, String pwtype)\r
  91     {\r
  92       super();\r
  93       initTreePanel(av, seqVector, type, pwtype, 0, seqVector.size(), newtree);\r
  94     }\r
  95 \r
  96     public AlignmentI getAlignment()\r
  97     {\r
  98       return treeCanvas.av.getAlignment();\r
  99     }\r
 100 \r
 101 \r
 102     void initTreePanel(AlignViewport av, Vector seqVector, String type,\r
 103                        String pwtype, int s, int e, NewickFile newTree)\r
 104     {\r
 105 \r
 106       this.type = type;\r
 107       this.pwtype = pwtype;\r
 108 \r
 109       start = s;\r
 110       end = e;\r
 111 \r
 112       seq = new Sequence[seqVector.size()];\r
 113       seqVector.toArray(seq);\r
 114 \r
 115 \r
 116       treeCanvas = new TreeCanvas(av, scrollPane);\r
 117       scrollPane.setViewportView(treeCanvas);\r
 118 \r
 119       av.addPropertyChangeListener(new java.beans.PropertyChangeListener()\r
 120       {\r
 121         public void propertyChange(PropertyChangeEvent evt)\r
 122         {\r
 123           if (evt.getPropertyName().equals("alignment"))\r
 124           {\r
 125             if(tree==null)\r
 126               System.out.println("tree is null");\r
 127             if(evt.getNewValue()==null)\r
 128               System.out.println("new value is null");\r
 129 \r
 130             tree.UpdatePlaceHolders( (Vector) evt.getNewValue());\r
 131 \r
 132             repaint();\r
 133           }\r
 134         }\r
 135       });\r
 136 \r
 137 \r
 138       TreeLoader tl = new TreeLoader(newTree);\r
 139       tl.start();\r
 140 \r
 141     }\r
 142 \r
 143     class TreeLoader extends Thread\r
 144     {\r
 145       NewickFile newtree;\r
 146 \r
 147       public TreeLoader(NewickFile newtree)\r
 148       {\r
 149         this.newtree = newtree;\r
 150         if (newtree != null)\r
 151         {\r
 152           // Must be outside run(), as Jalview2XML tries to\r
 153           // update distance/bootstrap visibility at the same time\r
 154           showBootstrap(newtree.HasBootstrap());\r
 155           showDistances(newtree.HasDistances());\r
 156           showPlaceholders(true);\r
 157         }\r
 158       }\r
 159 \r
 160       public void run()\r
 161       {\r
 162         if(newtree!=null)\r
 163           tree = new NJTree(seq, newtree);\r
 164         else\r
 165           tree = new NJTree(seq, type, pwtype, start, end);\r
 166 \r
 167         tree.reCount(tree.getTopNode());\r
 168         tree.findHeight(tree.getTopNode());\r
 169         treeCanvas.setTree(tree);\r
 170 \r
 171         treeCanvas.repaint();\r
 172 \r
 173 \r
 174         fullid.setState(treeCanvas.av.showDBPrefix);\r
 175         if(!treeCanvas.av.showDBPrefix)\r
 176         {\r
 177           fullid_actionPerformed(null);\r
 178         }\r
 179       }\r
 180 \r
 181     }\r
 182 \r
 183     public void showDistances(boolean b)\r
 184     {\r
 185       treeCanvas.setShowDistances(b);\r
 186       distanceMenu.setSelected(b);\r
 187     }\r
 188 \r
 189     public void showBootstrap(boolean b)\r
 190     {\r
 191       treeCanvas.setShowBootstrap(b);\r
 192       bootstrapMenu.setSelected(b);\r
 193     }\r
 194 \r
 195     public void showPlaceholders(boolean b)\r
 196     {\r
 197       placeholdersMenu.setState(b);\r
 198       treeCanvas.setMarkPlaceholders(b);\r
 199     }\r
 200 \r
 201 \r
 202 \r
 203 \r
 204     /**\r
 205      * DOCUMENT ME!\r
 206      *\r
 207      * @return DOCUMENT ME!\r
 208      */\r
 209     public NJTree getTree()\r
 210     {\r
 211         return tree;\r
 212     }\r
 213 \r
 214 \r
 215     /**\r
 216      * DOCUMENT ME!\r
 217      *\r
 218      * @param e DOCUMENT ME!\r
 219      */\r
 220     public void textbox_actionPerformed(ActionEvent e)\r
 221     {\r
 222         CutAndPasteTransfer cap = new CutAndPasteTransfer();\r
 223 \r
 224         StringBuffer buffer = new StringBuffer();\r
 225 \r
 226         if (type.equals("AV"))\r
 227         {\r
 228             buffer.append("Average distance tree using ");\r
 229         }\r
 230         else\r
 231         {\r
 232             buffer.append("Neighbour joining tree using ");\r
 233         }\r
 234 \r
 235         if (pwtype.equals("BL"))\r
 236         {\r
 237             buffer.append("BLOSUM62");\r
 238         }\r
 239         else\r
 240         {\r
 241             buffer.append("PID");\r
 242         }\r
 243 \r
 244         Desktop.addInternalFrame(cap, buffer.toString(), 500, 100);\r
 245 \r
 246         jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());\r
 247         cap.setText(fout.print(false, true));\r
 248     }\r
 249 \r
 250     /**\r
 251      * DOCUMENT ME!\r
 252      *\r
 253      * @param e DOCUMENT ME!\r
 254      */\r
 255     public void saveAsNewick_actionPerformed(ActionEvent e)\r
 256     {\r
 257         JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.getProperty(\r
 258                     "LAST_DIRECTORY"));\r
 259         chooser.setFileView(new JalviewFileView());\r
 260         chooser.setDialogTitle("Save tree as newick file");\r
 261         chooser.setToolTipText("Save");\r
 262 \r
 263         int value = chooser.showSaveDialog(null);\r
 264 \r
 265         if (value == JalviewFileChooser.APPROVE_OPTION)\r
 266         {\r
 267             String choice = chooser.getSelectedFile().getPath();\r
 268             jalview.bin.Cache.setProperty("LAST_DIRECTORY",\r
 269                 chooser.getSelectedFile().getParent());\r
 270 \r
 271             try\r
 272             {\r
 273                 jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());\r
 274                 String output = fout.print(false, true); // distances only\r
 275                 java.io.PrintWriter out = new java.io.PrintWriter(new java.io.FileWriter(\r
 276                             choice));\r
 277                 out.println(output);\r
 278                 out.close();\r
 279             }\r
 280             catch (Exception ex)\r
 281             {\r
 282                 ex.printStackTrace();\r
 283             }\r
 284         }\r
 285     }\r
 286 \r
 287     /**\r
 288      * DOCUMENT ME!\r
 289      *\r
 290      * @param e DOCUMENT ME!\r
 291      */\r
 292     public void printMenu_actionPerformed(ActionEvent e)\r
 293     {\r
 294         //Putting in a thread avoids Swing painting problems\r
 295         treeCanvas.startPrinting();\r
 296     }\r
 297 \r
 298     /**\r
 299      * DOCUMENT ME!\r
 300      *\r
 301      * @param e DOCUMENT ME!\r
 302      */\r
 303     public void fitToWindow_actionPerformed(ActionEvent e)\r
 304     {\r
 305         treeCanvas.fitToWindow = fitToWindow.isSelected();\r
 306         repaint();\r
 307     }\r
 308 \r
 309     /**\r
 310      * DOCUMENT ME!\r
 311      *\r
 312      * @param e DOCUMENT ME!\r
 313      */\r
 314     public void font_actionPerformed(ActionEvent e)\r
 315     {\r
 316         if (treeCanvas == null)\r
 317         {\r
 318             return;\r
 319         }\r
 320 \r
 321         new FontChooser(this);\r
 322     }\r
 323 \r
 324     public Font getTreeFont()\r
 325     {\r
 326         return treeCanvas.font;\r
 327     }\r
 328 \r
 329     public void setTreeFont(Font font)\r
 330     {\r
 331       if(treeCanvas!=null)\r
 332       treeCanvas.setFont(font);\r
 333     }\r
 334 \r
 335     /**\r
 336      * DOCUMENT ME!\r
 337      *\r
 338      * @param e DOCUMENT ME!\r
 339      */\r
 340     public void distanceMenu_actionPerformed(ActionEvent e)\r
 341     {\r
 342         treeCanvas.setShowDistances(distanceMenu.isSelected());\r
 343     }\r
 344 \r
 345     /**\r
 346      * DOCUMENT ME!\r
 347      *\r
 348      * @param e DOCUMENT ME!\r
 349      */\r
 350     public void bootstrapMenu_actionPerformed(ActionEvent e)\r
 351     {\r
 352         treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());\r
 353     }\r
 354 \r
 355     /**\r
 356      * DOCUMENT ME!\r
 357      *\r
 358      * @param e DOCUMENT ME!\r
 359      */\r
 360     public void placeholdersMenu_actionPerformed(ActionEvent e)\r
 361     {\r
 362         treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());\r
 363     }\r
 364 \r
 365 \r
 366     public void fullid_actionPerformed(ActionEvent e)\r
 367     {\r
 368       tree.findHeight(tree.getTopNode());\r
 369 \r
 370       // Now have to calculate longest name based on the leaves\r
 371       Vector leaves = tree.findLeaves(tree.getTopNode(), new Vector());\r
 372 \r
 373       treeCanvas.longestName="";\r
 374       for (int i = 0; i < leaves.size(); i++)\r
 375       {\r
 376         SequenceNode lf = (SequenceNode) leaves.elementAt(i);\r
 377         Sequence seq = (Sequence) lf.element();\r
 378         lf.setName(seq.getDisplayId(fullid.getState(), false));\r
 379         if(lf.getName().length() > treeCanvas.longestName.length())\r
 380           treeCanvas.longestName = lf.getName();\r
 381       }\r
 382 \r
 383       treeCanvas.repaint();\r
 384     }\r
 385 \r
 386 \r
 387     /**\r
 388      * DOCUMENT ME!\r
 389      *\r
 390      * @param e DOCUMENT ME!\r
 391      */\r
 392     public void epsTree_actionPerformed(ActionEvent e)\r
 393     {\r
 394       boolean accurateText = true;\r
 395 \r
 396       String renderStyle = jalview.bin.Cache.getDefault("EPS_RENDERING",\r
 397           "Prompt each time");\r
 398 \r
 399     // If we need to prompt, and if the GUI is visible then\r
 400     // Prompt for EPS rendering style\r
 401       if (renderStyle.equalsIgnoreCase("Prompt each time")\r
 402           && !\r
 403           (System.getProperty("java.awt.headless") != null\r
 404            && System.getProperty("java.awt.headless").equals("true")))\r
 405       {\r
 406         EPSOptions eps = new EPSOptions();\r
 407         renderStyle = eps.getValue();\r
 408 \r
 409         if (renderStyle==null || eps.cancelled)\r
 410           return;\r
 411 \r
 412 \r
 413       }\r
 414 \r
 415       if (renderStyle.equalsIgnoreCase("text"))\r
 416       {\r
 417         accurateText = false;\r
 418       }\r
 419 \r
 420         int width = treeCanvas.getWidth();\r
 421         int height = treeCanvas.getHeight();\r
 422 \r
 423         try\r
 424         {\r
 425             jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(jalview.bin.Cache.getProperty(\r
 426                         "LAST_DIRECTORY"), new String[] { "eps" },\r
 427                     new String[] { "Encapsulated Postscript" },\r
 428                     "Encapsulated Postscript");\r
 429             chooser.setFileView(new jalview.io.JalviewFileView());\r
 430             chooser.setDialogTitle("Create EPS file from tree");\r
 431             chooser.setToolTipText("Save");\r
 432 \r
 433             int value = chooser.showSaveDialog(this);\r
 434 \r
 435             if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)\r
 436             {\r
 437                 return;\r
 438             }\r
 439 \r
 440             jalview.bin.Cache.setProperty("LAST_DIRECTORY",\r
 441                                           chooser.getSelectedFile().getParent());\r
 442 \r
 443             FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());\r
 444             EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width,\r
 445                                                  height);\r
 446 \r
 447             pg.setAccurateTextMode(accurateText);\r
 448 \r
 449             treeCanvas.draw(pg, width, height);\r
 450 \r
 451             pg.flush();\r
 452             pg.close();\r
 453         }\r
 454         catch (Exception ex)\r
 455         {\r
 456             ex.printStackTrace();\r
 457         }\r
 458     }\r
 459 \r
 460     /**\r
 461      * DOCUMENT ME!\r
 462      *\r
 463      * @param e DOCUMENT ME!\r
 464      */\r
 465     public void pngTree_actionPerformed(ActionEvent e)\r
 466     {\r
 467         int width = treeCanvas.getWidth();\r
 468         int height = treeCanvas.getHeight();\r
 469 \r
 470         try\r
 471         {\r
 472             jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(jalview.bin.Cache.getProperty(\r
 473                         "LAST_DIRECTORY"), new String[] { "png" },\r
 474                     new String[] { "Portable network graphics" },\r
 475                     "Portable network graphics");\r
 476 \r
 477             chooser.setFileView(new jalview.io.JalviewFileView());\r
 478             chooser.setDialogTitle("Create PNG image from tree");\r
 479             chooser.setToolTipText("Save");\r
 480 \r
 481             int value = chooser.showSaveDialog(this);\r
 482 \r
 483             if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)\r
 484             {\r
 485                 return;\r
 486             }\r
 487 \r
 488             jalview.bin.Cache.setProperty("LAST_DIRECTORY",\r
 489                 chooser.getSelectedFile().getParent());\r
 490 \r
 491             FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());\r
 492 \r
 493             BufferedImage bi = new BufferedImage(width, height,\r
 494                     BufferedImage.TYPE_INT_RGB);\r
 495             Graphics png = bi.getGraphics();\r
 496 \r
 497             treeCanvas.draw(png, width, height);\r
 498 \r
 499             ImageIO.write(bi, "png", out);\r
 500             out.close();\r
 501         }\r
 502         catch (Exception ex)\r
 503         {\r
 504             ex.printStackTrace();\r
 505         }\r
 506     }\r
 507 }\r