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