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