Don't parse input id, leave it as it is
[jalview.git] / src / jalview / gui / TreePanel.java
index c458638..bd619a3 100755 (executable)
+/*\r
+ * Jalview - A Sequence Alignment Editor and Viewer\r
+ * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ *\r
+ * This program is free software; you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License\r
+ * as published by the Free Software Foundation; either version 2\r
+ * of the License, or (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with this program; if not, write to the Free Software\r
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+ */\r
 package jalview.gui;\r
 \r
-import jalview.datamodel.*;\r
 import jalview.analysis.*;\r
-import jalview.jbgui.GTreePanel;\r
+\r
+import jalview.datamodel.*;\r
+\r
 import jalview.io.*;\r
+\r
+import jalview.jbgui.*;\r
+\r
+\r
+import java.awt.*;\r
 import java.awt.event.*;\r
-import java.util.*;\r
+\r
 import java.io.*;\r
-import jalview.util.*;\r
-import javax.swing.*;\r
-import java.awt.print.*;\r
-import java.awt.*;\r
-import java.awt.image.*;\r
-import org.jibble.epsgraphics.*;\r
-import javax.imageio.*;\r
 \r
+import java.util.*;\r
 \r
+import java.beans.PropertyChangeEvent;\r
 \r
 \r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
 public class TreePanel extends GTreePanel\r
 {\r
-  SequenceI[] seq;\r
-  String type;\r
-  String pwtype;\r
-  AlignViewport av;\r
-  int start;\r
-  int end;\r
-  TreeCanvas treeCanvas;\r
-  NJTree tree;\r
-\r
-  public NJTree getTree()\r
-  {\r
-    return tree;\r
-  }\r
-\r
-  public TreePanel(AlignViewport av, Vector seqVector, String type, String pwtype, int s, int e)\r
-  {\r
-    super();\r
-\r
-    this.type = type;\r
-    this.pwtype = pwtype;\r
+    SequenceI[] seq;\r
+    String type;\r
+    String pwtype;\r
+    int start;\r
+    int end;\r
+    TreeCanvas treeCanvas;\r
+    NJTree tree;\r
+\r
+    /**\r
+     * Creates a new TreePanel object.\r
+     *\r
+     * @param av DOCUMENT ME!\r
+     * @param seqVector DOCUMENT ME!\r
+     * @param type DOCUMENT ME!\r
+     * @param pwtype DOCUMENT ME!\r
+     * @param s DOCUMENT ME!\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public TreePanel(AlignViewport av, Vector seqVector, String type,\r
+                     String pwtype, int s, int e)\r
+    {\r
+      super();\r
+      initTreePanel(av, seqVector, type, pwtype, s, e, null);\r
 \r
-    start = s;\r
-    end = e;\r
+      // We know this tree has distances. JBPNote TODO: prolly should add this as a userdefined default\r
+      showDistances(true);\r
+    }\r
 \r
-    String longestName = "";\r
-    seq = new Sequence [seqVector.size()];\r
-    for (int i=0;i < seqVector.size();i++)\r
+    /**\r
+     * Creates a new TreePanel object.\r
+     *\r
+     * @param av DOCUMENT ME!\r
+     * @param seqVector DOCUMENT ME!\r
+     * @param newtree DOCUMENT ME!\r
+     * @param type DOCUMENT ME!\r
+     * @param pwtype DOCUMENT ME!\r
+     */\r
+    public TreePanel(AlignViewport av, Vector seqVector, NewickFile newtree,\r
+                     String type, String pwtype)\r
     {\r
-      seq[i] = (Sequence) seqVector.elementAt(i);\r
-      if(seq[i].getName().length()>longestName.length())\r
-        longestName = seq[i].getName();\r
+      super();\r
+      initTreePanel(av, seqVector, type, pwtype, 0, seqVector.size(), newtree);\r
     }\r
 \r
-    tree = new NJTree(seq, type, pwtype, start, end);\r
-\r
-    treeCanvas = new TreeCanvas(av, tree, scrollPane, longestName);\r
+    public AlignmentI getAlignment()\r
+    {\r
+      return treeCanvas.av.getAlignment();\r
+    }\r
 \r
-    tree.reCount(tree.getTopNode());\r
-    tree.findHeight(tree.getTopNode());\r
-    scrollPane.setViewportView(treeCanvas);\r
 \r
-  }\r
-  public TreePanel(AlignViewport av, Vector seqVector, NewickFile newtree,\r
-                   String type, String pwtype)\r
+    void initTreePanel(AlignViewport av, Vector seqVector, String type,\r
+                       String pwtype, int s, int e, NewickFile newTree)\r
     {\r
-      super();\r
-      // These are probably only  arbitrary strings reflecting source of tree\r
+\r
       this.type = type;\r
       this.pwtype = pwtype;\r
 \r
-      start = 0;\r
-      end = seqVector.size();\r
+      start = s;\r
+      end = e;\r
 \r
-      String longestName = "";\r
-      seq = new Sequence [seqVector.size()];\r
-      for (int i=0;i < seqVector.size();i++)\r
-      {\r
-        seq[i] = (Sequence) seqVector.elementAt(i);\r
-        if(seq[i].getName().length()>longestName.length())\r
-          longestName = seq[i].getName();\r
-      }\r
-      // This constructor matches sequence names to treenodes and sets up the tree layouts.\r
-      tree = new NJTree(seq, newtree);\r
+      seq = new Sequence[seqVector.size()];\r
+      seqVector.toArray(seq);\r
 \r
-      tree.reCount(tree.getTopNode());\r
-      tree.findHeight(tree.getTopNode());\r
 \r
-      treeCanvas = new TreeCanvas(av, tree, scrollPane, longestName);\r
-      treeCanvas.setShowBootstrap(newtree.HasBootstrap());\r
-      treeCanvas.setShowDistances(newtree.HasDistances());\r
+      treeCanvas = new TreeCanvas(av, scrollPane);\r
       scrollPane.setViewportView(treeCanvas);\r
 \r
-    }\r
+      av.addPropertyChangeListener(new java.beans.PropertyChangeListener()\r
+      {\r
+        public void propertyChange(PropertyChangeEvent evt)\r
+        {\r
+          if (evt.getPropertyName().equals("alignment"))\r
+          {\r
+            if(tree==null)\r
+              System.out.println("tree is null");\r
+            if(evt.getNewValue()==null)\r
+              System.out.println("new value is null");\r
+\r
+            tree.UpdatePlaceHolders( (Vector) evt.getNewValue());\r
+\r
+            repaint();\r
+          }\r
+        }\r
+      });\r
+\r
+\r
+      TreeLoader tl = new TreeLoader(newTree);\r
+      tl.start();\r
 \r
-    public String getText(String format)\r
-    {\r
-      return null;\r
     }\r
 \r
-    public void saveAsNewick_actionPerformed(ActionEvent e)\r
+    class TreeLoader extends Thread\r
     {\r
+      NewickFile newtree;\r
 \r
-  JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.\r
-        getProperty("LAST_DIRECTORY"));\r
-    chooser.setFileView(new JalviewFileView());\r
-    chooser.setDialogTitle("Save tree as newick file");\r
-    chooser.setToolTipText("Save");\r
-    int value = chooser.showSaveDialog(null);\r
-    if (value == JalviewFileChooser.APPROVE_OPTION) {\r
-      String choice =  chooser.getSelectedFile().getPath();\r
-      jalview.bin.Cache.setProperty("LAST_DIRECTORY",  chooser.getSelectedFile().getParent());\r
-      try{\r
-        jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());\r
-        String output = fout.print(false,true); // distances only\r
-        java.io.PrintWriter out = new java.io.PrintWriter( new java.io.FileWriter( choice )  );\r
-        out.println(output);\r
-        out.close();\r
-      }\r
-      catch (Exception ex) {\r
-        ex.printStackTrace();\r
+      public TreeLoader(NewickFile newtree)\r
+      {\r
+        this.newtree = newtree;\r
+        if (newtree != null)\r
+        {\r
+          // Must be outside run(), as Jalview2XML tries to\r
+          // update distance/bootstrap visibility at the same time\r
+          showBootstrap(newtree.HasBootstrap());\r
+          showDistances(newtree.HasDistances());\r
+          showPlaceholders(true);\r
+        }\r
       }\r
-    }\r
-  }\r
 \r
-  protected void printMenu_actionPerformed(ActionEvent e)\r
-  {\r
+      public void run()\r
+      {\r
+        if(newtree!=null)\r
+          tree = new NJTree(seq, newtree);\r
+        else\r
+          tree = new NJTree(seq, type, pwtype, start, end);\r
 \r
-    //Putting in a thread avoids Swing painting problems\r
-    treeCanvas.startPrinting();\r
-  }\r
+        tree.reCount(tree.getTopNode());\r
+        tree.findHeight(tree.getTopNode());\r
+        treeCanvas.setTree(tree);\r
 \r
-  protected void fitToWindow_actionPerformed(ActionEvent e)\r
-  {\r
-    treeCanvas.fitToWindow = fitToWindow.isSelected();\r
-    repaint();\r
-  }\r
+        treeCanvas.repaint();\r
+      }\r
 \r
+    }\r
 \r
-  protected void fontSize_actionPerformed(ActionEvent e)\r
-  {\r
-    if( treeCanvas==null )\r
-     return;\r
+    public void showDistances(boolean b)\r
+    {\r
+      treeCanvas.setShowDistances(b);\r
+      distanceMenu.setSelected(b);\r
+    }\r
 \r
-   String size = fontSize.getText().substring( fontSize.getText().indexOf("-")+1);\r
+    public void showBootstrap(boolean b)\r
+    {\r
+      treeCanvas.setShowBootstrap(b);\r
+      bootstrapMenu.setSelected(b);\r
+    }\r
 \r
-   Object selection = JOptionPane.showInternalInputDialog(Desktop.desktop,\r
-                               "Select font size",\r
-                               "Font size",\r
-                               JOptionPane.QUESTION_MESSAGE,\r
-                               null, new String[]{"1","2","4","6","8","10","12","14","16","18","20"}\r
-                               ,"Font Size - "+size);\r
-   if(selection!=null)\r
-   {\r
-     fontSize.setText("Font Size - " + selection);\r
+    public void showPlaceholders(boolean b)\r
+    {\r
+      placeholdersMenu.setState(b);\r
+      treeCanvas.setMarkPlaceholders(b);\r
+    }\r
 \r
-     int i = Integer.parseInt(selection.toString());\r
-     treeCanvas.setFontSize(i);\r
-   }\r
-    scrollPane.setViewportView(treeCanvas);\r
 \r
-  }\r
 \r
-  protected void distanceMenu_actionPerformed(ActionEvent e)\r
-  {\r
-    treeCanvas.setShowDistances(distanceMenu.isSelected());\r
-  }\r
 \r
-  protected void bootstrapMenu_actionPerformed(ActionEvent e)\r
-  {\r
-    treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());\r
-  }\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public NJTree getTree()\r
+    {\r
+        return tree;\r
+    }\r
 \r
 \r
-  protected void epsTree_actionPerformed(ActionEvent e)\r
-  {\r
-    int width = treeCanvas.getWidth(), height=treeCanvas.getHeight();\r
-    try\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void textbox_actionPerformed(ActionEvent e)\r
     {\r
-      jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(jalview.bin.Cache.getProperty(\r
-          "LAST_DIRECTORY"),\r
-              new String[]{"eps"},\r
-              new String[]{"Encapsulated Postscript"},\r
-              "Encapsulated Postscript");\r
-      chooser.setFileView(new jalview.io.JalviewFileView());\r
-      chooser.setDialogTitle("Create EPS file from tree");\r
-      chooser.setToolTipText("Save");\r
+        CutAndPasteTransfer cap = new CutAndPasteTransfer();\r
+\r
+        StringBuffer buffer = new StringBuffer();\r
+\r
+        if (type.equals("AV"))\r
+        {\r
+            buffer.append("Average distance tree using ");\r
+        }\r
+        else\r
+        {\r
+            buffer.append("Neighbour joining tree using ");\r
+        }\r
+\r
+        if (pwtype.equals("BL"))\r
+        {\r
+            buffer.append("BLOSUM62");\r
+        }\r
+        else\r
+        {\r
+            buffer.append("PID");\r
+        }\r
+\r
+        Desktop.addInternalFrame(cap, buffer.toString(), 500, 100);\r
 \r
-      int value = chooser.showSaveDialog(this);\r
-      if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)\r
-        return;\r
+        jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());\r
+        cap.setText(fout.print(false, true));\r
+    }\r
 \r
-      jalview.bin.Cache.setProperty("LAST_DIRECTORY",chooser.getSelectedFile().getParent());\r
-      FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());\r
-      EpsGraphics2D pg = new EpsGraphics2D("Tree", out, 0, 0, width, height);\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void saveAsNewick_actionPerformed(ActionEvent e)\r
+    {\r
+        JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.getProperty(\r
+                    "LAST_DIRECTORY"));\r
+        chooser.setFileView(new JalviewFileView());\r
+        chooser.setDialogTitle("Save tree as newick file");\r
+        chooser.setToolTipText("Save");\r
+\r
+        int value = chooser.showSaveDialog(null);\r
+\r
+        if (value == JalviewFileChooser.APPROVE_OPTION)\r
+        {\r
+            String choice = chooser.getSelectedFile().getPath();\r
+            jalview.bin.Cache.setProperty("LAST_DIRECTORY",\r
+                chooser.getSelectedFile().getParent());\r
+\r
+            try\r
+            {\r
+                jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());\r
+                String output = fout.print(false, true); // distances only\r
+                java.io.PrintWriter out = new java.io.PrintWriter(new java.io.FileWriter(\r
+                            choice));\r
+                out.println(output);\r
+                out.close();\r
+            }\r
+            catch (Exception ex)\r
+            {\r
+                ex.printStackTrace();\r
+            }\r
+        }\r
+    }\r
 \r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void printMenu_actionPerformed(ActionEvent e)\r
+    {\r
+        //Putting in a thread avoids Swing painting problems\r
+        treeCanvas.startPrinting();\r
+    }\r
 \r
-      treeCanvas.draw(pg, width, height);\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void fitToWindow_actionPerformed(ActionEvent e)\r
+    {\r
+        treeCanvas.fitToWindow = fitToWindow.isSelected();\r
+        repaint();\r
+    }\r
 \r
-        pg.flush();\r
-        pg.close();\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void font_actionPerformed(ActionEvent e)\r
+    {\r
+        if (treeCanvas == null)\r
+        {\r
+            return;\r
+        }\r
+\r
+        new FontChooser(this);\r
     }\r
-    catch (Exception ex)\r
+\r
+    public Font getTreeFont()\r
     {\r
-      ex.printStackTrace();\r
+        return treeCanvas.font;\r
     }\r
-  }\r
 \r
-  protected void pngTree_actionPerformed(ActionEvent e)\r
- {\r
-  int width = treeCanvas.getWidth(), height = treeCanvas.getHeight();\r
-    try\r
+    public void setTreeFont(Font font)\r
     {\r
-      jalview.io.JalviewFileChooser chooser = new jalview.io.JalviewFileChooser(\r
-          jalview.bin.Cache.getProperty("LAST_DIRECTORY"),\r
-          new String[] {"png"},\r
-          new String[] {"Portable network graphics"},\r
-          "Portable network graphics");\r
+      if(treeCanvas!=null)\r
+      treeCanvas.setFont(font);\r
+    }\r
 \r
-      chooser.setFileView(new jalview.io.JalviewFileView());\r
-      chooser.setDialogTitle("Create PNG image from tree");\r
-      chooser.setToolTipText("Save");\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void distanceMenu_actionPerformed(ActionEvent e)\r
+    {\r
+        treeCanvas.setShowDistances(distanceMenu.isSelected());\r
+    }\r
 \r
-      int value = chooser.showSaveDialog(this);\r
-      if (value != jalview.io.JalviewFileChooser.APPROVE_OPTION)\r
-        return;\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void bootstrapMenu_actionPerformed(ActionEvent e)\r
+    {\r
+        treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());\r
+    }\r
 \r
-      jalview.bin.Cache.setProperty("LAST_DIRECTORY",chooser.getSelectedFile().getParent());\r
-      FileOutputStream out = new FileOutputStream(chooser.getSelectedFile());\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void placeholdersMenu_actionPerformed(ActionEvent e)\r
+    {\r
+        treeCanvas.setMarkPlaceholders(placeholdersMenu.isSelected());\r
+    }\r
 \r
-      BufferedImage bi = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);\r
-      Graphics png = bi.getGraphics();\r
 \r
-      treeCanvas.draw(png, width, height);\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void epsTree_actionPerformed(ActionEvent e)\r
+    {\r
+      makeTreeImage(jalview.util.ImageMaker.EPS);\r
+    }\r
 \r
-        ImageIO.write(bi, "png", out);\r
-        out.close();\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void pngTree_actionPerformed(ActionEvent e)\r
+    {\r
+       makeTreeImage(jalview.util.ImageMaker.PNG);\r
     }\r
-    catch (Exception ex)\r
+\r
+    void makeTreeImage(int type)\r
     {\r
-      ex.printStackTrace();\r
+      int width = treeCanvas.getWidth();\r
+      int height = treeCanvas.getHeight();\r
+\r
+      jalview.util.ImageMaker im;\r
+\r
+      if(type == jalview.util.ImageMaker.PNG)\r
+        im = new jalview.util.ImageMaker(this,\r
+                                         jalview.util.ImageMaker.PNG,\r
+                                         "Make PNG image from tree",\r
+                                         width, height,\r
+                                         null, null);\r
+        else\r
+          im = new jalview.util.ImageMaker(this,\r
+                                 jalview.util.ImageMaker.EPS,\r
+                                 "Make EPS file from tree",\r
+                                 width, height,\r
+                                 null, this.getTitle());\r
+\r
+      if(im.getGraphics()!=null)\r
+      {\r
+        treeCanvas.draw(im.getGraphics(), width, height);\r
+        im.writeImage();\r
+      }\r
     }\r
-  }\r
 \r
 }\r