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