src/jalview/appletgui/TreePanel.java

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