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