src/jalview/appletgui/TreePanel.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
   3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.appletgui;
  19
  20 import java.awt.*;
  21 import java.awt.event.*;
  22 import java.util.Hashtable;
  23
  24 import jalview.analysis.*;
  25 import jalview.datamodel.*;
  26 import jalview.io.*;
  27
  28 public class TreePanel extends EmbmenuFrame implements ActionListener,
  29         ItemListener
  30 {
  31   SequenceI[] seq;
  32
  33   String type;
  34
  35   String pwtype;
  36
  37   int start;
  38
  39   int end;
  40
  41   TreeCanvas treeCanvas;
  42
  43   NJTree tree;
  44
  45   AlignViewport av;
  46
  47   public NJTree getTree()
  48   {
  49     return tree;
  50   }
  51
  52   /**
  53    * Creates a new TreePanel object.
  54    *
  55    * @param av
  56    *          DOCUMENT ME!
  57    * @param seqVector
  58    *          DOCUMENT ME!
  59    * @param type
  60    *          DOCUMENT ME!
  61    * @param pwtype
  62    *          DOCUMENT ME!
  63    * @param s
  64    *          DOCUMENT ME!
  65    * @param e
  66    *          DOCUMENT ME!
  67    */
  68   public TreePanel(AlignViewport av, String type, String pwtype)
  69   {
  70     try
  71     {
  72       jbInit();
  73       this.setMenuBar(jMenuBar1);
  74     } catch (Exception ex)
  75     {
  76       ex.printStackTrace();
  77     }
  78
  79     initTreePanel(av, type, pwtype, null);
  80   }
  81
  82   /**
  83    * Creates a new TreePanel object.
  84    *
  85    * @param av
  86    *          DOCUMENT ME!
  87    * @param seqVector
  88    *          DOCUMENT ME!
  89    * @param newtree
  90    *          DOCUMENT ME!
  91    * @param type
  92    *          DOCUMENT ME!
  93    * @param pwtype
  94    *          DOCUMENT ME!
  95    */
  96   public TreePanel(AlignViewport av, String type, String pwtype,
  97           NewickFile newtree)
  98   {
  99     try
 100     {
 101       jbInit();
 102       this.setMenuBar(jMenuBar1);
 103     } catch (Exception e)
 104     {
 105       e.printStackTrace();
 106     }
 107
 108     initTreePanel(av, type, pwtype, newtree);
 109   }
 110
 111   void initTreePanel(AlignViewport av, String type, String pwtype,
 112           NewickFile newTree)
 113   {
 114
 115     this.av = av;
 116     this.type = type;
 117     this.pwtype = pwtype;
 118
 119     treeCanvas = new TreeCanvas(av, scrollPane);
 120     TreeLoader tl = new TreeLoader(newTree);
 121     tl.start();
 122     embedMenuIfNeeded(treeCanvas);
 123     scrollPane.add(treeCanvas, BorderLayout.CENTER);
 124   }
 125
 126   void showOriginalData()
 127   {
 128     // decide if av alignment is sufficiently different to original data to
 129     // warrant a new window to be created
 130     // create new alignmnt window with hidden regions (unhiding hidden regions
 131     // yields unaligned seqs)
 132     // or create a selection box around columns in alignment view
 133     // test Alignment(SeqCigar[])
 134     if (tree.seqData != null)
 135     {
 136       char gc = '-';
 137       try
 138       {
 139         // we try to get the associated view's gap character
 140         // but this may fail if the view was closed...
 141         gc = av.getGapCharacter();
 142       } catch (Exception ex)
 143       {
 144       }
 145       ;
 146       Object[] alAndColsel = tree.seqData
 147               .getAlignmentAndColumnSelection(gc);
 148
 149       if (alAndColsel != null && alAndColsel[0] != null)
 150       {
 151         Alignment al = new Alignment((SequenceI[]) alAndColsel[0]);
 152         AlignFrame af = new AlignFrame(al, av.applet,
 153                 "Original Data for Tree", false);
 154
 155         af.viewport.setHiddenColumns((ColumnSelection) alAndColsel[1]);
 156       }
 157     }
 158     else
 159     {
 160       System.out.println("Original Tree Data not available");
 161     }
 162   }
 163
 164   class TreeLoader extends Thread
 165   {
 166     NewickFile newtree;
 167
 168     jalview.datamodel.AlignmentView odata = null;
 169
 170     public TreeLoader(NewickFile newtree)
 171     {
 172       this.newtree = newtree;
 173     }
 174
 175     public void run()
 176     {
 177       if (newtree != null)
 178       {
 179         if (odata == null)
 180         {
 181           tree = new NJTree(av.alignment.getSequencesArray(), newtree);
 182         }
 183         else
 184         {
 185           tree = new NJTree(av.alignment.getSequencesArray(), odata,
 186                   newtree);
 187         }
 188
 189       }
 190       else
 191       {
 192         int start, end;
 193         SequenceI[] seqs;
 194         AlignmentView seqStrings = av.getAlignmentView(av
 195                 .getSelectionGroup() != null);
 196         if (av.getSelectionGroup() == null)
 197         {
 198           start = 0;
 199           end = av.alignment.getWidth();
 200           seqs = av.alignment.getSequencesArray();
 201         }
 202         else
 203         {
 204           start = av.getSelectionGroup().getStartRes();
 205           end = av.getSelectionGroup().getEndRes() + 1;
 206           seqs = av.getSelectionGroup().getSequencesInOrder(av.alignment);
 207         }
 208
 209         tree = new NJTree(seqs, seqStrings, type, pwtype, start, end);
 210       }
 211
 212       tree.reCount(tree.getTopNode());
 213       tree.findHeight(tree.getTopNode());
 214       treeCanvas.setTree(tree);
 215       if (newtree != null)
 216       {
 217         // Set default view, paying lip service to any overriding tree view
 218         // parameter settings
 219         boolean showDist = newtree.HasDistances()
 220                 && av.applet.getDefaultParameter("showTreeDistances",
 221                         newtree.HasDistances());
 222         boolean showBoots = newtree.HasBootstrap()
 223                 && av.applet.getDefaultParameter("showTreeBootstraps",
 224                         newtree.HasBootstrap());
 225         distanceMenu.setState(showDist);
 226         bootstrapMenu.setState(showBoots);
 227         treeCanvas.setShowBootstrap(showBoots);
 228         treeCanvas.setShowDistances(showDist);
 229         treeCanvas.setMarkPlaceholders(av.applet.getDefaultParameter(
 230                 "showUnlinkedTreeNodes", false));
 231       }
 232
 233       treeCanvas.repaint();
 234
 235       av.setCurrentTree(tree);
 236
 237     }
 238   }
 239
 240   public void actionPerformed(ActionEvent evt)
 241   {
 242     if (evt.getSource() == newickOutput)
 243     {
 244       newickOutput_actionPerformed();
 245     }
 246     else if (evt.getSource() == fontSize)
 247     {
 248       fontSize_actionPerformed();
 249     }
 250     else if (evt.getSource() == inputData)
 251     {
 252       showOriginalData();
 253     }
 254   }
 255
 256   public void itemStateChanged(ItemEvent evt)
 257   {
 258     if (evt.getSource() == fitToWindow)
 259     {
 260       treeCanvas.fitToWindow = fitToWindow.getState();
 261     }
 262
 263     else if (evt.getSource() == distanceMenu)
 264     {
 265       treeCanvas.setShowDistances(distanceMenu.getState());
 266     }
 267
 268     else if (evt.getSource() == bootstrapMenu)
 269     {
 270       treeCanvas.setShowBootstrap(bootstrapMenu.getState());
 271     }
 272
 273     else if (evt.getSource() == placeholdersMenu)
 274     {
 275       treeCanvas.setMarkPlaceholders(placeholdersMenu.getState());
 276     }
 277
 278     treeCanvas.repaint();
 279   }
 280
 281   public void newickOutput_actionPerformed()
 282   {
 283     jalview.io.NewickFile fout = new jalview.io.NewickFile(tree
 284             .getTopNode());
 285     String output = fout.print(false, true);
 286     CutAndPasteTransfer cap = new CutAndPasteTransfer(false, null);
 287     cap.setText(output);
 288     java.awt.Frame frame = new java.awt.Frame();
 289     frame.add(cap);
 290     jalview.bin.JalviewLite.addFrame(frame, type + " " + pwtype, 500, 100);
 291   }
 292
 293   public java.awt.Font getTreeFont()
 294   {
 295     return treeCanvas.font;
 296   }
 297
 298   public void setTreeFont(java.awt.Font font)
 299   {
 300     treeCanvas.font = font;
 301     treeCanvas.repaint();
 302   }
 303
 304   protected void fontSize_actionPerformed()
 305   {
 306     if (treeCanvas == null)
 307     {
 308       return;
 309     }
 310
 311     new FontChooser(this);
 312   }
 313
 314   BorderLayout borderLayout1 = new BorderLayout();
 315
 316   protected ScrollPane scrollPane = new ScrollPane();
 317
 318   MenuBar jMenuBar1 = new MenuBar();
 319
 320   Menu jMenu2 = new Menu();
 321
 322   protected MenuItem fontSize = new MenuItem();
 323
 324   protected CheckboxMenuItem bootstrapMenu = new CheckboxMenuItem();
 325
 326   protected CheckboxMenuItem distanceMenu = new CheckboxMenuItem();
 327
 328   protected CheckboxMenuItem placeholdersMenu = new CheckboxMenuItem();
 329
 330   protected CheckboxMenuItem fitToWindow = new CheckboxMenuItem();
 331
 332   Menu fileMenu = new Menu();
 333
 334   MenuItem newickOutput = new MenuItem();
 335
 336   MenuItem inputData = new MenuItem();
 337
 338   private void jbInit() throws Exception
 339   {
 340     setLayout(borderLayout1);
 341     this.setBackground(Color.white);
 342     this.setFont(new java.awt.Font("Verdana", 0, 12));
 343     jMenu2.setLabel("View");
 344     fontSize.setLabel("Font...");
 345     fontSize.addActionListener(this);
 346     bootstrapMenu.setLabel("Show Bootstrap Values");
 347     bootstrapMenu.addItemListener(this);
 348     distanceMenu.setLabel("Show Distances");
 349     distanceMenu.addItemListener(this);
 350     placeholdersMenu.setLabel("Mark Unassociated Leaves");
 351     placeholdersMenu.addItemListener(this);
 352     fitToWindow.setState(true);
 353     fitToWindow.setLabel("Fit To Window");
 354     fitToWindow.addItemListener(this);
 355     fileMenu.setLabel("File");
 356     newickOutput.setLabel("Newick Format");
 357     newickOutput.addActionListener(this);
 358     inputData.setLabel("Input Data...");
 359
 360     add(scrollPane, BorderLayout.CENTER);
 361     jMenuBar1.add(fileMenu);
 362     jMenuBar1.add(jMenu2);
 363     jMenu2.add(fitToWindow);
 364     jMenu2.add(fontSize);
 365     jMenu2.add(distanceMenu);
 366     jMenu2.add(bootstrapMenu);
 367     jMenu2.add(placeholdersMenu);
 368     fileMenu.add(newickOutput);
 369     fileMenu.add(inputData);
 370     inputData.addActionListener(this);
 371   }
 372
 373 }