src/jalview/appletgui/TreePanel.java

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