src/jalview/appletgui/TreePanel.java

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