Don't parse input id, leave it as it is
[jalview.git] / src / jalview / gui / TreePanel.java
index f723fdc..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
-import jalview.io.*;\r
-import java.awt.event.*;\r
-import java.util.*;\r
-import java.io.*;\r
-import jalview.util.*;\r
-import javax.swing.*;\r
-import java.awt.print.*;\r
-import java.awt.*;\r
-\r
 \r
+import jalview.datamodel.*;\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
+import jalview.io.*;\r
 \r
-  FileProperties       fp;\r
-  PostscriptProperties pp;\r
+import jalview.jbgui.*;\r
 \r
-  PrintWriter bw;\r
-  PrintStream ps;\r
-  boolean makeString = false;\r
-  StringBuffer out;\r
 \r
+import java.awt.*;\r
+import java.awt.event.*;\r
 \r
+import java.io.*;\r
 \r
-  public TreePanel(AlignViewport av, Vector seqVector, String type, String pwtype, int s, int e)\r
-  {\r
-    super();\r
+import java.util.*;\r
 \r
-    this.type = type;\r
-    this.pwtype = pwtype;\r
+import java.beans.PropertyChangeEvent;\r
 \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
+ * 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
+    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
-      seq[i] = (Sequence) seqVector.elementAt(i);\r
-      if(seq[i].getName().length()>longestName.length())\r
-        longestName = seq[i].getName();\r
-    }\r
-\r
-    tree = new NJTree(seq, type, pwtype, start, end);\r
-    av.setCurrentTree(tree);\r
-\r
-    propertiesInit();\r
-\r
-    treeCanvas = new TreeCanvas(av, tree, scrollPane, longestName);\r
-\r
-    tree.reCount(tree.getTopNode());\r
-    tree.findHeight(tree.getTopNode());\r
-    scrollPane.setViewportView(treeCanvas);\r
-\r
-  }\r
-\r
+      super();\r
+      initTreePanel(av, seqVector, type, pwtype, s, e, null);\r
 \r
-public void drawPostscript(PostscriptProperties pp) {\r
-  try {\r
-    int width = 0;\r
-    int height = 0;\r
-\r
-    printout("%!\n");\r
-\r
-    printout("/" + pp.font + " findfont\n");\r
-    printout(pp.fsize + " scalefont setfont\n");\r
-\r
-    int offx = pp.xoffset;\r
-    int offy = pp.yoffset;\r
-\r
-    if (pp.orientation == PostscriptProperties.PORTRAIT) {\r
-      width = PostscriptProperties.SHORTSIDE;\r
-      height = PostscriptProperties.LONGSIDE;\r
-    } else {\r
-      height = PostscriptProperties.SHORTSIDE;\r
-      width = PostscriptProperties.LONGSIDE;\r
-      printout(height + " 0 translate\n90 rotate\n");\r
+      // We know this tree has distances. JBPNote TODO: prolly should add this as a userdefined default\r
+      showDistances(true);\r
     }\r
-    float wscale = (float)(width*.8-offx*2)/tree.getMaxHeight();\r
-    SequenceNode top = tree.getTopNode();\r
 \r
-    if (top.count == 0) {\r
-        top.count = ((SequenceNode)top.left()).count + ((SequenceNode)top.right()).count ;\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
+      super();\r
+      initTreePanel(av, seqVector, type, pwtype, 0, seqVector.size(), newtree);\r
     }\r
 \r
-    float chunk = (float)(height-offy*2)/(((SequenceNode)top).count+1);\r
-\r
-    drawPostscriptNode(top,chunk,wscale,width,offx,offy);\r
-\r
-    printout("showpage\n");\r
-  } catch (java.io.IOException e) {\r
-    System.out.println("Exception " + e);\r
-  }\r
-}\r
+    public AlignmentI getAlignment()\r
+    {\r
+      return treeCanvas.av.getAlignment();\r
+    }\r
 \r
-public void drawPostscriptNode(SequenceNode node, float chunk, float scale, int width, int offx, int offy) throws java.io.IOException {\r
-  if (node == null) {\r
-    return;\r
-  }\r
 \r
-  if (node.left() == null && node.right() == null) {\r
-    // Drawing leaf node\r
+    void initTreePanel(AlignViewport av, Vector seqVector, String type,\r
+                       String pwtype, int s, int e, NewickFile newTree)\r
+    {\r
 \r
-    float height = node.height;\r
-    float dist = node.dist;\r
+      this.type = type;\r
+      this.pwtype = pwtype;\r
 \r
-    int xstart = (int)((height-dist)*scale) + offx;\r
-    int xend =   (int)(height*scale) + offx;\r
+      start = s;\r
+      end = e;\r
 \r
-    int ypos = (int)(node.ycount * chunk) + offy;\r
+      seq = new Sequence[seqVector.size()];\r
+      seqVector.toArray(seq);\r
 \r
-    // g.setColor(Color.black);\r
-    printout("\n" + new Format("%5.3f").form((double)node.color.getRed()/255) + " " +\r
-             new Format("%5.3f").form((double)node.color.getGreen()/255) + " " +\r
-             new Format("%5.3f").form((double)node.color.getBlue()/255) + " setrgbcolor\n");\r
 \r
-    // Draw horizontal line\r
-    //  g.drawLine(xstart,ypos,xend,ypos);\r
-    printout(xstart + " " + ypos + " moveto " + xend + " " + ypos + " lineto stroke \n");\r
+      treeCanvas = new TreeCanvas(av, scrollPane);\r
+      scrollPane.setViewportView(treeCanvas);\r
 \r
-    if (treeCanvas.showDistances && node.dist > 0) {\r
-      //       g.drawString(new Format("%5.2f").form(node.dist),xstart,ypos - 5);\r
-      printout("(" + new Format("%5.2f").form(node.dist) + ") " + xstart + " " + (ypos+5) + " moveto show\n");\r
-    }\r
-    //g.drawString((String)node.element(),xend+20,ypos);\r
-    printout("(" + (((SequenceI)node.element()).getName()) + ") " + (xend+20) + " " + (ypos) + " moveto show\n");\r
-  } else {\r
-    drawPostscriptNode((SequenceNode)node.left(),chunk,scale,width,offx,offy);\r
-    drawPostscriptNode((SequenceNode)node.right(),chunk,scale,width,offx,offy);\r
-\r
-\r
-    float height = node.height;\r
-    float dist = node.dist;\r
-\r
-    int xstart = (int)((height-dist)*scale) + offx;\r
-    int xend =   (int)(height*scale) + offx;\r
-    int ypos = (int)(node.ycount * chunk) + offy;\r
-\r
-    printout("\n" + new Format("%5.3f").form((double)node.color.getRed()/255) + " " +\r
-             new Format("%5.3f").form((double)node.color.getGreen()/255) + " " +\r
-             new Format("%5.3f").form((double)node.color.getBlue()/255) + " setrgbcolor\n");\r
-    //      g.setColor(Color.black);\r
-    //      bw.append("\nblack setrgbcolor\n");\r
-    // Draw horizontal line\r
-    //      g.drawLine(xstart,ypos,xend,ypos);\r
-    printout(xstart + " " + ypos + " moveto " + xend + " " + ypos + " lineto stroke\n");\r
-    int ystart = (int)(((SequenceNode)node.left()).ycount * chunk) + offy;\r
-    int yend = (int)(((SequenceNode)node.right()).ycount * chunk) + offy;\r
-\r
-    //      g.drawLine((int)(height*scale) + offx, ystart,\r
-    //          (int)(height*scale) + offx, yend);\r
-    printout\r
-    (((int)(height*scale) + offx) + " " + ystart + " moveto " +  ((int)(height*scale) + offx) + " " +\r
-     yend + " lineto stroke\n");\r
-    if (treeCanvas.showDistances && node.dist > 0) {\r
-      //       g.drawString(new Format("%5.2f").form(node.dist),xstart,ypos - 5);\r
-      printout("(" +new Format("%5.2f").form(node.dist) + ") " + (xstart) + " " + (ypos+5) + " moveto show\n");\r
-    }\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
-public void printout(String s) throws IOException {\r
-  if (bw != null) {\r
-    bw.write(s);\r
-  }\r
-  if (ps != null) {\r
-    ps.print(s);\r
-  }\r
-  if (makeString == true) {\r
-    out.append(s);\r
-  }\r
-}\r
+            tree.UpdatePlaceHolders( (Vector) evt.getNewValue());\r
 \r
+            repaint();\r
+          }\r
+        }\r
+      });\r
 \r
-public PostscriptProperties getPostscriptProperties() {\r
-  return pp;\r
-}\r
 \r
-public FileProperties getFileProperties() {\r
-  return fp;\r
-}\r
+      TreeLoader tl = new TreeLoader(newTree);\r
+      tl.start();\r
 \r
-public void setPostscriptProperties(PostscriptProperties pp) {\r
-  this.pp = pp;\r
-}\r
+    }\r
 \r
-public void setFileProperties(FileProperties fp) {\r
-  this.fp = fp;\r
-}\r
+    class TreeLoader extends Thread\r
+    {\r
+      NewickFile newtree;\r
 \r
-public String getText(String format) {\r
-  return null;\r
-}\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
-public void getPostscript(PrintWriter bw) {\r
-  this.bw = bw;\r
-  drawPostscript(pp);\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
-}\r
+        tree.reCount(tree.getTopNode());\r
+        tree.findHeight(tree.getTopNode());\r
+        treeCanvas.setTree(tree);\r
 \r
-public void getPostscript(PrintStream bw) {\r
-  this.ps = bw;\r
-  drawPostscript(pp);\r
-  bw.flush();\r
-}\r
+        treeCanvas.repaint();\r
+      }\r
 \r
-public StringBuffer getPostscript() {\r
-  makeString = true;\r
-  out = new StringBuffer();\r
-  drawPostscript(pp);\r
-  return out;\r
-}\r
+    }\r
 \r
-public void propertiesInit() {\r
-  this.pp = new PostscriptProperties();\r
-  this.fp = new FileProperties();\r
-}\r
+    public void showDistances(boolean b)\r
+    {\r
+      treeCanvas.setShowDistances(b);\r
+      distanceMenu.setSelected(b);\r
+    }\r
 \r
+    public void showBootstrap(boolean b)\r
+    {\r
+      treeCanvas.setShowBootstrap(b);\r
+      bootstrapMenu.setSelected(b);\r
+    }\r
 \r
-  public void saveButton_actionPerformed(ActionEvent e)\r
-  {\r
+    public void showPlaceholders(boolean b)\r
+    {\r
+      placeholdersMenu.setState(b);\r
+      treeCanvas.setMarkPlaceholders(b);\r
+    }\r
 \r
-    try{\r
-      JFileChooser chooser = new JFileChooser(jalview.bin.Cache.getProperty("LAST_DIRECTORY"));\r
-      chooser.setDialogTitle("Save Tree as postscript file");\r
-      chooser.setToolTipText("Save");\r
-      int value = chooser.showSaveDialog(this);\r
-      if (value == JFileChooser.APPROVE_OPTION)\r
-      {\r
-        String choice = chooser.getSelectedFile().getPath();\r
-        jalview.bin.Cache.setProperty("LAST_DIRECTORY", choice);\r
 \r
-        bw = new PrintWriter(new FileWriter(choice));\r
-        getPostscript(bw);\r
-        bw.close();\r
 \r
-      }\r
 \r
-    }catch(Exception ex){ex.printStackTrace();}\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public NJTree getTree()\r
+    {\r
+        return tree;\r
+    }\r
 \r
-  }\r
 \r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @param e DOCUMENT ME!\r
+     */\r
+    public void textbox_actionPerformed(ActionEvent e)\r
+    {\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
+        jalview.io.NewickFile fout = new jalview.io.NewickFile(tree.getTopNode());\r
+        cap.setText(fout.print(false, true));\r
+    }\r
 \r
-  protected void saveMenu_actionPerformed(ActionEvent e)\r
-  {\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
+    /**\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
-  protected void printMenu_actionPerformed(ActionEvent e)\r
-  {\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
-    //Putting in a thread avoids Swing painting problems\r
-    treeCanvas.startPrinting();\r
-  }\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
-  protected void fitToWindow_actionPerformed(ActionEvent e)\r
-  {\r
-    treeCanvas.fitToWindow = fitToWindow.isSelected();\r
-    repaint();\r
-  }\r
+        new FontChooser(this);\r
+    }\r
 \r
+    public Font getTreeFont()\r
+    {\r
+        return treeCanvas.font;\r
+    }\r
 \r
-  protected void fontSize_actionPerformed(ActionEvent e)\r
-  {\r
-    if( treeCanvas==null )\r
-     return;\r
+    public void setTreeFont(Font font)\r
+    {\r
+      if(treeCanvas!=null)\r
+      treeCanvas.setFont(font);\r
+    }\r
 \r
-   String size = fontSize.getText().substring( fontSize.getText().indexOf("-")+1);\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
-   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
+    /**\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
-     int i = Integer.parseInt(selection.toString());\r
-     treeCanvas.setFontSize(i);\r
-   }\r
-    scrollPane.setViewportView(treeCanvas);\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
-  }\r
 \r
-  protected void distanceMenu_actionPerformed(ActionEvent e)\r
-  {\r
-    treeCanvas.setShowDistances(distanceMenu.isSelected());\r
-  }\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
-  protected void bootstrapMenu_actionPerformed(ActionEvent e)\r
-  {\r
-    treeCanvas.setShowBootstrap(bootstrapMenu.isSelected());\r
-  }\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
 \r
+    void makeTreeImage(int type)\r
+    {\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