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