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