src/jalview/appletgui/TreePanel.java

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