src/jalview/appletgui/TreePanel.java

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