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