formatting
[jalview.git] / src / jalview / gui / PopupMenu.java
index f2f41a3..282378d 100644 (file)
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
  * 
  * This file is part of Jalview.
  * 
@@ -85,7 +85,11 @@ public class PopupMenu extends JPopupMenu
 
   JMenuItem sequenceName = new JMenuItem();
 
-  Sequence sequence;
+  JMenuItem sequenceDetails = new JMenuItem();
+
+  JMenuItem sequenceSelDetails = new JMenuItem();
+
+  SequenceI sequence;
 
   JMenuItem unGroupMenuItem = new JMenuItem();
 
@@ -162,8 +166,8 @@ public class PopupMenu extends JPopupMenu
    * @param links
    * @param groupLinks
    */
-  public PopupMenu(final AlignmentPanel ap, final Sequence seq,
-          final Vector links, final Vector groupLinks)
+  public PopupMenu(final AlignmentPanel ap, final SequenceI seq,
+          Vector links, Vector groupLinks)
   {
     // /////////////////////////////////////////////////////////
     // If this is activated from the sequence panel, the user may want to
@@ -215,11 +219,11 @@ public class PopupMenu extends JPopupMenu
       e.printStackTrace();
     }
 
+    JMenuItem menuItem;
     if (seq != null)
     {
       sequenceMenu.setText(sequence.getName());
 
-      JMenuItem menuItem;
       if (seq.getDatasetSequence().getPDBId() != null
               && seq.getDatasetSequence().getPDBId().size() > 0)
       {
@@ -257,30 +261,31 @@ public class PopupMenu extends JPopupMenu
       }
       else
       {
-        if (ap.av.alignment.isNucleotide() == false)
+        if (ap.av.getAlignment().isNucleotide() == false)
         {
           structureMenu.remove(viewStructureMenu);
         }
         // structureMenu.remove(colStructureMenu);
       }
 
-      if (ap.av.alignment.isNucleotide() == true)
+      if (ap.av.getAlignment().isNucleotide() == true)
       {
-        AlignmentAnnotation[] aa = ap.av.alignment.getAlignmentAnnotation();
+        AlignmentAnnotation[] aa = ap.av.getAlignment()
+                .getAlignmentAnnotation();
         for (int i = 0; i < aa.length; i++)
         {
           if (aa[i].getRNAStruc() != null)
           {
             final String rnastruc = aa[i].getRNAStruc();
-            
+            final String structureLine = aa[i].label;
             menuItem = new JMenuItem();
-            menuItem.setText("RNA structure - consensus");
+            menuItem.setText("2D RNA " + structureLine);
             menuItem.addActionListener(new java.awt.event.ActionListener()
             {
               public void actionPerformed(ActionEvent e)
               {
-                new AppVarna(seq.getSequenceAsString(), rnastruc, seq
-                        .getName(), ap);
+                new AppVarna(structureLine, seq, seq.getSequenceAsString(),
+                        rnastruc, seq.getName(), ap);
               }
             });
             viewStructureMenu.add(menuItem);
@@ -297,17 +302,18 @@ public class PopupMenu extends JPopupMenu
             if (seqAnno[i].getRNAStruc() != null)
             {
               final String rnastruc = seqAnno[i].getRNAStruc();
-              
-           // TODO: make rnastrucF a bit more nice
+
+              // TODO: make rnastrucF a bit more nice
               menuItem = new JMenuItem();
-              menuItem.setText("RNA structure - "+seq.getName());
+              menuItem.setText("2D RNA - " + seq.getName());
               menuItem.addActionListener(new java.awt.event.ActionListener()
               {
                 public void actionPerformed(ActionEvent e)
                 {
                   // TODO: VARNA does'nt print gaps in the sequence
-                  new AppVarna(seq.getSequenceAsString(), rnastruc, seq
-                          .getName(), ap);
+                  new AppVarna(seq.getName() + " structure", seq, seq
+                          .getSequenceAsString(), rnastruc, seq.getName(),
+                          ap);
                 }
               });
               viewStructureMenu.add(menuItem);
@@ -315,7 +321,6 @@ public class PopupMenu extends JPopupMenu
           }
         }
 
-        
       }
 
       menuItem = new JMenuItem("Hide Sequences");
@@ -342,9 +347,9 @@ public class PopupMenu extends JPopupMenu
         sequenceMenu.add(menuItem);
       }
 
-      if (ap.av.hasHiddenRows)
+      if (ap.av.hasHiddenRows())
       {
-        final int index = ap.av.alignment.findIndex(seq);
+        final int index = ap.av.getAlignment().findIndex(seq);
 
         if (ap.av.adjustForHiddenSeqs(index)
                 - ap.av.adjustForHiddenSeqs(index - 1) > 1)
@@ -363,7 +368,12 @@ public class PopupMenu extends JPopupMenu
           });
           add(menuItem);
         }
-
+      }
+    }
+    // for the case when no sequences are even visible
+    if (ap.av.hasHiddenRows())
+    {
+      {
         menuItem = new JMenuItem("Reveal All");
         menuItem.addActionListener(new ActionListener()
         {
@@ -384,7 +394,7 @@ public class PopupMenu extends JPopupMenu
 
     SequenceGroup sg = ap.av.getSelectionGroup();
 
-    if (sg != null)
+    if (sg != null && sg.getSize() > 0)
     {
       groupName.setText("Name: " + sg.getName());
       groupName.setText("Edit name and description of current group.");
@@ -461,6 +471,7 @@ public class PopupMenu extends JPopupMenu
       }
       // Add a 'show all structures' for the current selection
       Hashtable<String, PDBEntry> pdbe = new Hashtable<String, PDBEntry>();
+      SequenceI sqass = null;
       for (SequenceI sq : ap.av.getSequenceSelection())
       {
         Vector<PDBEntry> pes = (Vector<PDBEntry>) sq.getDatasetSequence()
@@ -470,6 +481,10 @@ public class PopupMenu extends JPopupMenu
           for (PDBEntry pe : pes)
           {
             pdbe.put(pe.getId(), pe);
+            if (sqass == null)
+            {
+              sqass = sq;
+            }
           }
         }
       }
@@ -478,10 +493,17 @@ public class PopupMenu extends JPopupMenu
         final PDBEntry[] pe = pdbe.values().toArray(
                 new PDBEntry[pdbe.size()]);
         final JMenuItem gpdbview;
-        structureMenu.add(gpdbview = new JMenuItem("View " + pdbe.size()
-                + " structures."));
-        gpdbview
-                .setToolTipText("Open a new Jmol view with all structures associated with the current selection and superimpose them using the alignment.");
+        if (pdbe.size() == 1)
+        {
+          structureMenu.add(gpdbview = new JMenuItem("View structure for "
+                  + sqass.getDisplayId(false)));
+        }
+        else
+        {
+          structureMenu.add(gpdbview = new JMenuItem("View all "
+                  + pdbe.size() + " structures."));
+        }
+        gpdbview.setToolTipText("Open a new Jmol view with all structures associated with the current selection and superimpose them using the alignment.");
         gpdbview.addActionListener(new ActionListener()
         {
 
@@ -499,7 +521,7 @@ public class PopupMenu extends JPopupMenu
       editMenu.setVisible(false);
     }
 
-    if (!ap.av.alignment.getGroups().contains(sg))
+    if (!ap.av.getAlignment().getGroups().contains(sg))
     {
       unGroupMenuItem.setVisible(false);
     }
@@ -535,13 +557,13 @@ public class PopupMenu extends JPopupMenu
           continue;
         }
         final String label = urlLink.getLabel();
-        if (urlLink.isDynamic())
+        if (seq != null && urlLink.isDynamic())
         {
 
           // collect matching db-refs
-          DBRefEntry[] dbr = jalview.util.DBRefUtils.selectRefs(seq
-                  .getDBRef(), new String[]
-          { urlLink.getTarget() });
+          DBRefEntry[] dbr = jalview.util.DBRefUtils.selectRefs(
+                  seq.getDBRef(), new String[]
+                  { urlLink.getTarget() });
           // collect id string too
           String id = seq.getName();
           String descr = seq.getDescription();
@@ -644,7 +666,7 @@ public class PopupMenu extends JPopupMenu
     JMenu[] linkMenus = new JMenu[]
     { null, new JMenu("IDS"), new JMenu("Sequences"),
         new JMenu("IDS and Sequences") }; // three types of url that might be
-    // created.
+                                          // created.
     SequenceI[] seqs = ap.av.getSelectionAsNewSequence();
     String[][] idandseqs = GroupUrlLink.formStrings(seqs);
     Hashtable commonDbrefs = new Hashtable();
@@ -692,7 +714,7 @@ public class PopupMenu extends JPopupMenu
     }
     // now create group links for all distinct ID/sequence sets.
     boolean addMenu = false; // indicates if there are any group links to give
-    // to user
+                             // to user
     for (int i = 0; i < groupLinks.size(); i++)
     {
       String link = groupLinks.elementAt(i).toString();
@@ -745,8 +767,8 @@ public class PopupMenu extends JPopupMenu
       Object[] urlset = null;
       try
       {
-        urlset = urlLink.makeUrlStubs(ids, seqstr, "FromJalview"
-                + System.currentTimeMillis(), false);
+        urlset = urlLink.makeUrlStubs(ids, seqstr,
+                "FromJalview" + System.currentTimeMillis(), false);
       } catch (UrlStringTooLongException e)
       {
       }
@@ -829,14 +851,14 @@ public class PopupMenu extends JPopupMenu
     JMenuItem item = new JMenuItem(label);
     item.setToolTipText("open URL (" + urlgenerator.getUrl_prefix()
             + "..) (" + urlgenerator.getNumberInvolved(urlstub) + " seqs)"); // TODO:
-    // put
-    // in
-    // info
-    // about
-    // what
-    // is
-    // being
-    // sent.
+                                                                             // put
+                                                                             // in
+                                                                             // info
+                                                                             // about
+                                                                             // what
+                                                                             // is
+                                                                             // being
+                                                                             // sent.
     item.addActionListener(new java.awt.event.ActionListener()
     {
       public void actionPerformed(ActionEvent e)
@@ -888,6 +910,23 @@ public class PopupMenu extends JPopupMenu
         sequenceName_actionPerformed();
       }
     });
+    sequenceDetails.setText("Sequence Details ...");
+    sequenceDetails.addActionListener(new java.awt.event.ActionListener()
+    {
+      public void actionPerformed(ActionEvent e)
+      {
+        sequenceDetails_actionPerformed();
+      }
+    });
+    sequenceSelDetails.setText("Sequence Details ...");
+    sequenceSelDetails
+            .addActionListener(new java.awt.event.ActionListener()
+            {
+              public void actionPerformed(ActionEvent e)
+              {
+                sequenceSelectionDetails_actionPerformed();
+              }
+            });
     PIDColour.setFocusPainted(false);
     unGroupMenuItem.setText("Remove Group");
     unGroupMenuItem.addActionListener(new java.awt.event.ActionListener()
@@ -1045,15 +1084,15 @@ public class PopupMenu extends JPopupMenu
         editSequence_actionPerformed(actionEvent);
       }
     });
+
     /*
      * annotationMenuItem.setText("By Annotation");
      * annotationMenuItem.addActionListener(new ActionListener() { public void
      * actionPerformed(ActionEvent actionEvent) {
      * annotationMenuItem_actionPerformed(actionEvent); } });
      */
-
+    groupMenu.add(sequenceSelDetails);
     add(groupMenu);
-
     add(sequenceMenu);
     this.add(structureMenu);
     groupMenu.add(editMenu);
@@ -1061,6 +1100,7 @@ public class PopupMenu extends JPopupMenu
     groupMenu.add(sequenceFeature);
     groupMenu.add(jMenu1);
     sequenceMenu.add(sequenceName);
+    sequenceMenu.add(sequenceDetails);
     colourMenu.add(textColour);
     colourMenu.add(noColourmenuItem);
     colourMenu.add(clustalColour);
@@ -1074,7 +1114,10 @@ public class PopupMenu extends JPopupMenu
     colourMenu.add(turnColour);
     colourMenu.add(buriedColour);
     colourMenu.add(nucleotideMenuItem);
-    colourMenu.add(purinePyrimidineColour);
+    if (ap.getAlignment().isNucleotide())
+    {
+      colourMenu.add(purinePyrimidineColour);
+    }
     // colourMenu.add(covariationColour);
     colourMenu.add(userDefinedColour);
 
@@ -1253,6 +1296,44 @@ public class PopupMenu extends JPopupMenu
             });
   }
 
+  protected void sequenceSelectionDetails_actionPerformed()
+  {
+    createSequenceDetailsReport(ap.av.getSequenceSelection());
+  }
+
+  protected void sequenceDetails_actionPerformed()
+  {
+    createSequenceDetailsReport(new SequenceI[]
+    { sequence });
+  }
+
+  public void createSequenceDetailsReport(SequenceI[] sequences)
+  {
+    CutAndPasteHtmlTransfer cap = new CutAndPasteHtmlTransfer();
+    StringBuffer contents = new StringBuffer();
+    for (SequenceI seq : sequences)
+    {
+      contents.append("<p><h2>Annotation for " + seq.getDisplayId(true)
+              + "</h2></p><p>");
+      new SequenceAnnotationReport(null)
+              .createSequenceAnnotationReport(
+                      contents,
+                      seq,
+                      true,
+                      true,
+                      false,
+                      (ap.seqPanel.seqCanvas.fr != null) ? ap.seqPanel.seqCanvas.fr.minmax
+                              : null);
+      contents.append("</p>");
+    }
+    cap.setText("<html>" + contents.toString() + "</html>");
+
+    Desktop.instance.addInternalFrame(cap, "Sequence Details for "
+            + (sequences.length == 1 ? sequences[0].getDisplayId(true)
+                    : "Selection"), 500, 400);
+
+  }
+
   protected void showNonconserved_actionPerformed()
   {
     getGroup().setShowNonconserved(displayNonconserved.isSelected());
@@ -1279,9 +1360,7 @@ public class PopupMenu extends JPopupMenu
   protected void clustalColour_actionPerformed()
   {
     SequenceGroup sg = getGroup();
-    sg.cs = new ClustalxColourScheme(sg
-            .getSequences(ap.av.hiddenRepSequences), ap.av.alignment
-            .getWidth());
+    sg.cs = new ClustalxColourScheme(sg, ap.av.getHiddenRepSequences());
     refresh();
   }
 
@@ -1407,9 +1486,9 @@ public class PopupMenu extends JPopupMenu
 
     if (abovePIDColour.isSelected())
     {
-      sg.cs.setConsensus(AAFrequency.calculate(sg
-              .getSequences(ap.av.hiddenRepSequences), sg.getStartRes(), sg
-              .getEndRes() + 1));
+      sg.cs.setConsensus(AAFrequency.calculate(
+              sg.getSequences(ap.av.getHiddenRepSequences()),
+              sg.getStartRes(), sg.getEndRes() + 1));
 
       int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup()
               .getName());
@@ -1461,9 +1540,9 @@ public class PopupMenu extends JPopupMenu
   {
     SequenceGroup sg = getGroup();
     sg.cs = new PIDColourScheme();
-    sg.cs.setConsensus(AAFrequency.calculate(sg
-            .getSequences(ap.av.hiddenRepSequences), sg.getStartRes(), sg
-            .getEndRes() + 1));
+    sg.cs.setConsensus(AAFrequency.calculate(
+            sg.getSequences(ap.av.getHiddenRepSequences()),
+            sg.getStartRes(), sg.getEndRes() + 1));
     refresh();
   }
 
@@ -1479,9 +1558,9 @@ public class PopupMenu extends JPopupMenu
 
     sg.cs = new Blosum62ColourScheme();
 
-    sg.cs.setConsensus(AAFrequency.calculate(sg
-            .getSequences(ap.av.hiddenRepSequences), sg.getStartRes(), sg
-            .getEndRes() + 1));
+    sg.cs.setConsensus(AAFrequency.calculate(
+            sg.getSequences(ap.av.getHiddenRepSequences()),
+            sg.getStartRes(), sg.getEndRes() + 1));
 
     refresh();
   }
@@ -1515,12 +1594,12 @@ public class PopupMenu extends JPopupMenu
     if (conservationMenuItem.isSelected())
     {
       Conservation c = new Conservation("Group",
-              ResidueProperties.propHash, 3, sg
-                      .getSequences(ap.av.hiddenRepSequences), sg
-                      .getStartRes(), sg.getEndRes() + 1);
+              ResidueProperties.propHash, 3, sg.getSequences(ap.av
+                      .getHiddenRepSequences()), sg.getStartRes(),
+              sg.getEndRes() + 1);
 
       c.calculate();
-      c.verdict(false, ap.av.ConsPercGaps);
+      c.verdict(false, ap.av.getConsPercGaps());
 
       sg.cs.setConservation(c);
 
@@ -1544,8 +1623,8 @@ public class PopupMenu extends JPopupMenu
       return;
     }
 
-    AnnotationColourGradient acg = new AnnotationColourGradient(sequence
-            .getAnnotation()[0], null,
+    AnnotationColourGradient acg = new AnnotationColourGradient(
+            sequence.getAnnotation()[0], null,
             AnnotationColourGradient.NO_THRESHOLD);
 
     acg.predefinedColours = true;
@@ -1564,9 +1643,10 @@ public class PopupMenu extends JPopupMenu
   {
 
     SequenceGroup sg = getGroup();
-    EditNameDialog dialog = new EditNameDialog(sg.getName(), sg
-            .getDescription(), "       Group Name ", "Group Description ",
-            "Edit Group Name/Description", ap.alignFrame);
+    EditNameDialog dialog = new EditNameDialog(sg.getName(),
+            sg.getDescription(), "       Group Name ",
+            "Group Description ", "Edit Group Name/Description",
+            ap.alignFrame);
 
     if (!dialog.accept)
     {
@@ -1589,7 +1669,7 @@ public class PopupMenu extends JPopupMenu
     // this method won't add a new group if it already exists
     if (sg != null)
     {
-      ap.av.alignment.addGroup(sg);
+      ap.av.getAlignment().addGroup(sg);
     }
 
     return sg;
@@ -1603,8 +1683,8 @@ public class PopupMenu extends JPopupMenu
    */
   void sequenceName_actionPerformed()
   {
-    EditNameDialog dialog = new EditNameDialog(sequence.getName(), sequence
-            .getDescription(), "       Sequence Name ",
+    EditNameDialog dialog = new EditNameDialog(sequence.getName(),
+            sequence.getDescription(), "       Sequence Name ",
             "Sequence Description ", "Edit Sequence Name/Description",
             ap.alignFrame);
 
@@ -1643,7 +1723,7 @@ public class PopupMenu extends JPopupMenu
   void unGroupMenuItem_actionPerformed()
   {
     SequenceGroup sg = ap.av.getSelectionGroup();
-    ap.av.alignment.deleteGroup(sg);
+    ap.av.getAlignment().deleteGroup(sg);
     ap.av.setSelectionGroup(null);
     refresh();
   }
@@ -1796,9 +1876,9 @@ public class PopupMenu extends JPopupMenu
         caseChange = ChangeCaseCommand.TO_LOWER;
       }
 
-      ChangeCaseCommand caseCommand = new ChangeCaseCommand(description, sg
-              .getSequencesAsArray(ap.av.hiddenRepSequences), startEnd,
-              caseChange);
+      ChangeCaseCommand caseCommand = new ChangeCaseCommand(description,
+              sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
+              startEnd, caseChange);
 
       ap.alignFrame.addHistoryItem(caseCommand);
 
@@ -1812,8 +1892,8 @@ public class PopupMenu extends JPopupMenu
   {
     CutAndPasteTransfer cap = new CutAndPasteTransfer();
     cap.setForInput(null);
-    Desktop.addInternalFrame(cap, "Alignment output - "
-            + e.getActionCommand(), 600, 500);
+    Desktop.addInternalFrame(cap,
+            "Alignment output - " + e.getActionCommand(), 600, 500);
 
     String[] omitHidden = null;
 
@@ -1824,7 +1904,8 @@ public class PopupMenu extends JPopupMenu
     ColumnSelection csel = new ColumnSelection(ap.av.getColumnSelection());
     omitHidden = ap.av.getViewAsString(true);
     Alignment oal = new Alignment(ap.av.getSequenceSelection());
-    AlignmentAnnotation[] nala = ap.av.alignment.getAlignmentAnnotation();
+    AlignmentAnnotation[] nala = ap.av.getAlignment()
+            .getAlignmentAnnotation();
     if (nala != null)
     {
       for (int i = 0; i < nala.length; i++)
@@ -1845,9 +1926,8 @@ public class PopupMenu extends JPopupMenu
     chooser.setFileView(new jalview.io.JalviewFileView());
     chooser.setDialogTitle("Select a PDB file for "
             + sequence.getDisplayId(false));
-    chooser
-            .setToolTipText("Load a PDB file and associate it with sequence '"
-                    + sequence.getDisplayId(false) + "'");
+    chooser.setToolTipText("Load a PDB file and associate it with sequence '"
+            + sequence.getDisplayId(false) + "'");
 
     int value = chooser.showOpenDialog(null);
 
@@ -1877,9 +1957,9 @@ public class PopupMenu extends JPopupMenu
   public void discoverPDB_actionPerformed()
   {
 
-    final SequenceI[] sequences = ((ap.av.selectionGroup == null) ? new Sequence[]
+    final SequenceI[] sequences = ((ap.av.getSelectionGroup() == null) ? new SequenceI[]
     { sequence }
-            : ap.av.selectionGroup.getSequencesInOrder(ap.av.alignment));
+            : ap.av.getSequenceSelection());
     Thread discpdb = new Thread(new Runnable()
     {
       public void run()
@@ -1948,10 +2028,10 @@ public class PopupMenu extends JPopupMenu
     AlignmentAnnotation an = new AlignmentAnnotation("Structure",
             "Coloured by " + pdbid, anots);
 
-    ap.av.alignment.addAnnotation(an);
+    ap.av.getAlignment().addAnnotation(an);
     an.createSequenceMapping(sequence, 0, true);
     // an.adjustForAlignment();
-    ap.av.alignment.setAnnotationIndex(an, 0);
+    ap.av.getAlignment().setAnnotationIndex(an, 0);
 
     ap.adjustAnnotationHeight();
 
@@ -1968,17 +2048,18 @@ public class PopupMenu extends JPopupMenu
       if (sequence == null)
         sequence = (Sequence) sg.getSequenceAt(0);
 
-      EditNameDialog dialog = new EditNameDialog(sequence
-              .getSequenceAsString(sg.getStartRes(), sg.getEndRes() + 1),
-              null, "Edit Sequence ", null, "Edit Sequence", ap.alignFrame);
+      EditNameDialog dialog = new EditNameDialog(
+              sequence.getSequenceAsString(sg.getStartRes(),
+                      sg.getEndRes() + 1), null, "Edit Sequence ", null,
+              "Edit Sequence", ap.alignFrame);
 
       if (dialog.accept)
       {
         EditCommand editCommand = new EditCommand("Edit Sequences",
                 EditCommand.REPLACE, dialog.getName().replace(' ',
-                        ap.av.getGapCharacter()), sg
-                        .getSequencesAsArray(ap.av.hiddenRepSequences), sg
-                        .getStartRes(), sg.getEndRes() + 1, ap.av.alignment);
+                        ap.av.getGapCharacter()),
+                sg.getSequencesAsArray(ap.av.getHiddenRepSequences()),
+                sg.getStartRes(), sg.getEndRes() + 1, ap.av.getAlignment());
 
         ap.alignFrame.addHistoryItem(editCommand);