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 \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 \r
  75         this.type = type;\r
  76         this.pwtype = pwtype;\r
  77 \r
  78         start = s;\r
  79         end = e;\r
  80 \r
  81         String longestName = "";\r
  82         seq = new Sequence[seqVector.size()];\r
  83 \r
  84         for (int i = 0; i < seqVector.size(); i++)\r
  85         {\r
  86             seq[i] = (Sequence) seqVector.elementAt(i);\r
  87 \r
  88             if (seq[i].getName().length() > longestName.length())\r
  89             {\r
  90                 longestName = seq[i].getName();\r
  91             }\r
  92         }\r
  93 \r
  94         tree = new NJTree(seq, type, pwtype, start, end);\r
  95 \r
  96         treeCanvas = new TreeCanvas(av, tree, scrollPane, longestName);\r
  97         treeCanvas.setShowDistances(true); // We know this tree has distances. JBPNote TODO: prolly should add this as a userdefined default\r
  98         setViewStateFromTreeCanvas(treeCanvas);\r
  99         tree.reCount(tree.getTopNode());\r
 100         tree.findHeight(tree.getTopNode());\r
 101         scrollPane.setViewportView(treeCanvas);\r
 102     }\r
 103 \r
 104     /**\r
 105      * Creates a new TreePanel object.\r
 106      *\r
 107      * @param av DOCUMENT ME!\r
 108      * @param seqVector DOCUMENT ME!\r
 109      * @param newtree DOCUMENT ME!\r
 110      * @param type DOCUMENT ME!\r
 111      * @param pwtype DOCUMENT ME!\r
 112      */\r
 113     public TreePanel(AlignViewport av, Vector seqVector, NewickFile newtree,\r
 114         String type, String pwtype)\r
 115     {\r
 116         super();\r
 117 \r
 118         // These are probably only  arbitrary strings reflecting source of tree\r
 119         this.type = type;\r
 120         this.pwtype = pwtype;\r
 121 \r
 122         start = 0;\r
 123         end = seqVector.size();\r
 124 \r
 125         String longestName = "";\r
 126         seq = new Sequence[seqVector.size()];\r
 127 \r
 128         for (int i = 0; i < seqVector.size(); i++)\r
 129         {\r
 130             seq[i] = (Sequence) seqVector.elementAt(i);\r
 131         }\r
 132 \r
 133         // This constructor matches sequence names to treenodes and sets up the tree layouts.\r
 134         tree = new NJTree(seq, newtree);\r
 135 \r
 136         // Now have to calculate longest name based on the leaves\r
 137         Vector leaves = tree.findLeaves(tree.getTopNode(), new Vector());\r
 138         boolean has_placeholders = false;\r
 139 \r
 140         for (int i = 0; i < leaves.size(); i++)\r
 141         {\r
 142             SequenceNode lf = (SequenceNode) leaves.elementAt(i);\r
 143 \r
 144             if (lf.isPlaceholder())\r
 145             {\r
 146                 has_placeholders = true;\r
 147             }\r
 148 \r
 149             if (longestName.length() < ((Sequence) lf.element()).getName()\r
 150                                             .length())\r
 151             {\r
 152                 longestName = TreeCanvas.PLACEHOLDER +\r
 153                     ((Sequence) lf.element()).getName();\r
 154             }\r
 155         }\r
 156 \r
 157         tree.reCount(tree.getTopNode());\r
 158         tree.findHeight(tree.getTopNode());\r
 159 \r
 160         treeCanvas = new TreeCanvas(av, tree, scrollPane, longestName);\r
 161         treeCanvas.setShowBootstrap(newtree.HasBootstrap());\r
 162         treeCanvas.setShowDistances(newtree.HasDistances());\r
 163         scrollPane.setViewportView(treeCanvas);\r
 164         treeCanvas.setMarkPlaceholders(has_placeholders);\r
 165         setViewStateFromTreeCanvas(treeCanvas);\r
 166 \r
 167         // JBPNote TODO: preference for always marking placeholders in new associated tree\r
 168     }\r
 169 \r
 170     /**\r
 171      * DOCUMENT ME!\r
 172      *\r
 173      * @return DOCUMENT ME!\r
 174      */\r
 175     public NJTree getTree()\r
 176     {\r
 177         return tree;\r
 178     }\r
 179 \r
 180     /**\r
 181      * DOCUMENT ME!\r
 182      *\r
 183      * @param tree DOCUMENT ME!\r
 184      */\r
 185     private void setViewStateFromTreeCanvas(TreeCanvas tree)\r
 186     {\r
 187         // update view menu state from treeCanvas render state\r
 188         distanceMenu.setSelected(tree.showDistances);\r
 189         bootstrapMenu.setSelected(tree.showBootstrap);\r
 190         placeholdersMenu.setSelected(tree.markPlaceholders);\r
 191     }\r
 192 \r
 193     /**\r
 194      * DOCUMENT ME!\r
 195      *\r
 196      * @param tree DOCUMENT ME!\r
 197      */\r
 198     private void setTreeCanvasFromViewState(TreeCanvas tree)\r
 199     {\r
 200         // update view menu state from treeCanvas render state\r
 201         tree.showDistances = distanceMenu.isSelected();\r
 202         tree.showBootstrap = bootstrapMenu.isSelected();\r
 203         tree.markPlaceholders = placeholdersMenu.isSelected();\r
 204     }\r
 205 \r
 206     /**\r
 207      * DOCUMENT ME!\r
 208      *\r
 209      * @param e DOCUMENT ME!\r
 210      */\r
 211     public void textbox_actionPerformed(ActionEvent e)\r
 212     {\r
 213         CutAndPasteTransfer cap = new CutAndPasteTransfer();\r
 214 \r
 215         StringBuffer buffer = new StringBuffer();\r
 216 \r
 217         if (type.equals("AV"))\r
 218         {\r
 219             buffer.append("Average distance tree using ");\r
 220         }\r
 221         else\r
 222         {\r
 223             buffer.append("Neighbour joining tree using ");\r
 224         }\r
 225 \r
 226         if (pwtype.equals("BL"))\r
 227         {\r
 228             buffer.append("BLOSUM62");\r
 229         }\r
 230         else\r
 231         {\r
 232             buffer.append("PID");\r
 233         }\r
 234 \r
 235         Desktop.addInternalFrame(cap, buffer.toString(), 500, 100);\r
 236 \r
 237         jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());\r
 238         cap.setText(fout.print(false, true));\r
 239     }\r
 240 \r
 241     /**\r
 242      * DOCUMENT ME!\r
 243      *\r
 244      * @param e DOCUMENT ME!\r
 245      */\r
 246     public void saveAsNewick_actionPerformed(ActionEvent e)\r
 247     {\r
 248         JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.getProperty(\r
 249                     "LAST_DIRECTORY"));\r
 250         chooser.setFileView(new JalviewFileView());\r
 251         chooser.setDialogTitle("Save tree as newick file");\r
 252         chooser.setToolTipText("Save");\r
 253 \r
 254         int value = chooser.showSaveDialog(null);\r
 255 \r
 256         if (value == JalviewFileChooser.APPROVE_OPTION)\r
 257         {\r
 258             String choice = chooser.getSelectedFile().getPath();\r
 259             jalview.bin.Cache.setProperty("LAST_DIRECTORY",\r
 260                 chooser.getSelectedFile().getParent());\r
 261 \r
 262             try\r
 263             {\r
 264                 jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());\r
 265                 String output = fout.print(false, true); // distances only\r
 266                 java.io.PrintWriter out = new java.io.PrintWriter(new java.io.FileWriter(\r
 267                             choice));\r
 268                 out.println(output);\r
 269                 out.close();\r
 270             }\r
 271             catch (Exception ex)\r
 272             {\r
 273                 ex.printStackTrace();\r
 274             }\r
 275         }\r
 276     }\r
 277 \r
 278     /**\r
 279      * DOCUMENT ME!\r
 280      *\r
 281      * @param e DOCUMENT ME!\r
 282      */\r
 283     public void printMenu_actionPerformed(ActionEvent e)\r
 284     {\r
 285         //Putting in a thread avoids Swing painting problems\r
 286         treeCanvas.startPrinting();\r
 287     }\r
 288 \r
 289     /**\r
 290      * DOCUMENT ME!\r
 291      *\r
 292      * @param e DOCUMENT ME!\r
 293      */\r
 294     public void fitToWindow_actionPerformed(ActionEvent e)\r
 295     {\r
 296         treeCanvas.fitToWindow = fitToWindow.isSelected();\r
 297         repaint();\r
 298     }\r
 299 \r
 300     /**\r
 301      * DOCUMENT ME!\r
 302      *\r
 303      * @param e DOCUMENT ME!\r
 304      */\r
 305     public void fontSize_actionPerformed(ActionEvent e)\r
 306     {\r
 307         if (treeCanvas == null)\r
 308         {\r
 309             return;\r
 310         }\r
 311 \r
 312         String size = fontSize.getText().substring(fontSize.getText().indexOf("-") +\r
 313                 1);\r
 314 \r
 315         Object selection = JOptionPane.showInternalInputDialog(Desktop.desktop,\r
 316                 "Select font size", "Font size", JOptionPane.QUESTION_MESSAGE,\r
 317                 null,\r
 318                 new String[]\r
 319                 {\r
 320                     "1", "2", "4", "6", "8", "10", "12", "14", "16", "18", "20"\r
 321                 }, "Font Size - " + size);\r
 322 \r
 323         if (selection != null)\r
 324         {\r
 325             fontSize.setText("Font Size - " + selection);\r
 326 \r
 327             int i = Integer.parseInt(selection.toString());\r
 328             treeCanvas.setFontSize(i);\r
 329         }\r
 330 \r
 331         scrollPane.setViewportView(treeCanvas);\r
 332     }\r
 333 \r
 334     /**\r
 335      * DOCUMENT ME!\r
 336      *\r
 337      * @param e DOCUMENT ME!\r
 338      */\r
 339     public void distanceMenu_actionPerformed(ActionEvent e)\r
 340     {\r
 341         treeCanvas.setShowDistances(distanceMenu.isSelected());\r
 342     }\r
 343 \r
 344     /**\r
 345      * DOCUMENT ME!\r
 346      *\r
 347      * @param e DOCUMENT ME!\r
 348      */\r
 349     public void bootstrapMenu_actionPerformed(ActionEvent e)\r
 350     {\r
 351         treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());\r
 352     }\r
 353 \r
 354     /**\r
 355      * DOCUMENT ME!\r
 356      *\r
 357      * @param e DOCUMENT ME!\r
 358      */\r
 359     public void placeholdersMenu_actionPerformed(ActionEvent e)\r
 360     {\r
 361         treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());\r
 362     }\r
 363 \r
 364     /**\r
 365      * DOCUMENT ME!\r
 366      *\r
 367      * @param e DOCUMENT ME!\r
 368      */\r
 369     public void epsTree_actionPerformed(ActionEvent e)\r
 370     {\r
 371         int width = treeCanvas.getWidth();\r
 372         int height = treeCanvas.getHeight();\r
 373 \r
 374         try\r
 375         {\r
 376             jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(jalview.bin.Cache.getProperty(\r
 377                         "LAST_DIRECTORY"), new String[] { "eps" },\r
 378                     new String[] { "Encapsulated Postscript" },\r
 379                     "Encapsulated Postscript");\r
 380             chooser.setFileView(new jalview.io.JalviewFileView());\r
 381             chooser.setDialogTitle("Create EPS file from tree");\r
 382             chooser.setToolTipText("Save");\r
 383 \r
 384             int value = chooser.showSaveDialog(this);\r
 385 \r
 386             if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)\r
 387             {\r
 388                 return;\r
 389             }\r
 390 \r
 391             jalview.bin.Cache.setProperty("LAST_DIRECTORY",\r
 392                 chooser.getSelectedFile().getParent());\r
 393 \r
 394             FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());\r
 395             EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width,\r
 396                     height);\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