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