JAL-1114 - refactor methods handling Vectors and Hashtables to Lists and Maps, and...
[jalview.git] / src / jalview / appletgui / APopupMenu.java
index 2bacd70..acdae46 100755 (executable)
@@ -1,20 +1,19 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
- * Copyright (C) 2008 AM Waterhouse, J Procter, 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 program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
  * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  * 
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  */
 package jalview.appletgui;
 
@@ -113,6 +112,11 @@ public class APopupMenu extends java.awt.PopupMenu implements
 
   MenuItem revealAll = new MenuItem();
 
+  MenuItem revealSeq = new MenuItem();
+  /**
+   * index of sequence to be revealed
+   */
+  int revealSeq_index=-1;
   Menu menu1 = new Menu();
 
   public APopupMenu(AlignmentPanel apanel, final Sequence seq, Vector links)
@@ -148,12 +152,12 @@ public class APopupMenu extends java.awt.PopupMenu implements
 
     if (sg != null && sg.getSize() > 0)
     {
-      editGroupName.setLabel(sg.getName());
+      editGroupName.setLabel("Name: "+sg.getName());
       showText.setState(sg.getDisplayText());
       showColourText.setState(sg.getColourText());
       showBoxes.setState(sg.getDisplayBoxes());
-      displayNonconserved.setState(sg.getShowunconserved());
-      if (!ap.av.alignment.getGroups().contains(sg))
+      displayNonconserved.setState(sg.getShowNonconserved());
+      if (!ap.av.getAlignment().getGroups().contains(sg))
       {
         groupMenu.remove(unGroupMenuItem);
       }
@@ -179,19 +183,19 @@ public class APopupMenu extends java.awt.PopupMenu implements
           continue;
         }
         final String target = urlLink.getTarget(); // link.substring(0,
-                                                    // link.indexOf("|"));
+        // link.indexOf("|"));
         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[]
-          { target });
+          DBRefEntry[] dbr = jalview.util.DBRefUtils.selectRefs(
+                  seq.getDBRef(), new String[]
+                  { target });
           // collect id string too
           String id = seq.getName();
           String descr = seq.getDescription();
-          if (descr!=null && descr.length()<1)
+          if (descr != null && descr.length() < 1)
           {
             descr = null;
           }
@@ -230,8 +234,9 @@ public class APopupMenu extends java.awt.PopupMenu implements
             }
             // addshowLink(linkMenu, target, url_pref + id + url_suff);
           }
-          // Now construct URLs from description but only try to do it for regex URL links
-          if (descr != null && urlLink.getRegexReplace()!=null)
+          // Now construct URLs from description but only try to do it for regex
+          // URL links
+          if (descr != null && urlLink.getRegexReplace() != null)
           {
             // create link for this URL from description only if regex matches
             String[] urls = urlLink.makeUrls(descr, true);
@@ -252,11 +257,12 @@ public class APopupMenu extends java.awt.PopupMenu implements
          * final String url;
          * 
          * if (link.indexOf("$SEQUENCE_ID$") > -1) { // Substitute SEQUENCE_ID
-         * string and any matching database reference accessions String url_pref =
-         * link.substring(link.indexOf("|") + 1, link.indexOf("$SEQUENCE_ID$"));
+         * string and any matching database reference accessions String url_pref
+         * = link.substring(link.indexOf("|") + 1,
+         * link.indexOf("$SEQUENCE_ID$"));
          * 
          * String url_suff = link.substring(link.indexOf("$SEQUENCE_ID$") + 13);
-         *  // collect matching db-refs DBRefEntry[] dbr =
+         * // collect matching db-refs DBRefEntry[] dbr =
          * jalview.util.DBRefUtils.selectRefs(seq.getDBRef(), new
          * String[]{target}); // collect id string too String id =
          * seq.getName(); if (id.indexOf("|") > -1) { id =
@@ -271,16 +277,19 @@ public class APopupMenu extends java.awt.PopupMenu implements
          * link.substring(link.lastIndexOf("|")+1)); }
          */
       }
-
-      if (seq != null)
+      if (linkMenu.getItemCount() > 0)
       {
-        seqMenu.add(linkMenu);
-      }
-      else
-      {
-        add(linkMenu);
+        if (seq != null)
+        {
+          seqMenu.add(linkMenu);
+        }
+        else
+        {
+          add(linkMenu);
+        }
       }
     }
+    // TODO: add group link menu entry here
     if (seq != null)
     {
       seqMenu.setLabel(seq.getName());
@@ -291,9 +300,20 @@ public class APopupMenu extends java.awt.PopupMenu implements
       remove(seqMenu);
     }
 
-    if (!ap.av.hasHiddenRows)
+    if (!ap.av.hasHiddenRows())
     {
       remove(revealAll);
+      remove(revealSeq);
+    } else {
+      final int index = ap.av.getAlignment().findIndex(seq);
+
+      if (ap.av.adjustForHiddenSeqs(index)
+              - ap.av.adjustForHiddenSeqs(index - 1) > 1)
+      {
+        revealSeq_index=index;
+      } else {
+        remove(revealSeq);
+      }
     }
   }
 
@@ -301,10 +321,10 @@ public class APopupMenu extends java.awt.PopupMenu implements
    * add a show URL menu item to the given linkMenu
    * 
    * @param linkMenu
-   * @param target -
-   *                menu label string
-   * @param url -
-   *                url to open
+   * @param target
+   *          - menu label string
+   * @param url
+   *          - url to open
    */
   private void addshowLink(Menu linkMenu, final String target,
           final String url)
@@ -316,12 +336,12 @@ public class APopupMenu extends java.awt.PopupMenu implements
    * add a show URL menu item to the given linkMenu
    * 
    * @param linkMenu
-   * @param target -
-   *                URL target window
-   * @param label -
-   *                menu label string
-   * @param url -
-   *                url to open
+   * @param target
+   *          - URL target window
+   * @param label
+   *          - menu label string
+   * @param url
+   *          - url to open
    */
   private void addshowLink(Menu linkMenu, final String target,
           final String label, final String url)
@@ -442,6 +462,10 @@ public class APopupMenu extends java.awt.PopupMenu implements
     {
       hideSequences(true);
     }
+    else if (source == revealSeq)
+    {
+      ap.av.showSequence(revealSeq_index);
+    }
     else if (source == revealAll)
     {
       ap.av.showAllHiddenSeqs();
@@ -488,9 +512,9 @@ public class APopupMenu extends java.awt.PopupMenu implements
         {
           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);
 
@@ -505,44 +529,8 @@ public class APopupMenu extends java.awt.PopupMenu implements
       Vector regions = new Vector();
       if (sg != null)
       {
-        int start = sg.getStartRes();
-        int end = sg.getEndRes() + 1;
-
-        do
-        {
-          if (ap.av.hasHiddenColumns)
-          {
-            if (start == 0)
-            {
-              start = ap.av.colSel.adjustForHiddenColumns(start);
-            }
-
-            end = ap.av.colSel.getHiddenBoundaryRight(start);
-            if (start == end)
-            {
-              end = sg.getEndRes() + 1;
-            }
-            if (end > sg.getEndRes())
-            {
-              end = sg.getEndRes() + 1;
-            }
-          }
-
-          regions.addElement(new int[]
-          { start, end });
-
-          if (ap.av.hasHiddenColumns)
-          {
-            start = ap.av.colSel.adjustForHiddenColumns(end);
-            start = ap.av.colSel.getHiddenBoundaryLeft(start) + 1;
-          }
-        } while (end < sg.getEndRes());
-
-        int[][] startEnd = new int[regions.size()][2];
-        for (int i = 0; i < regions.size(); i++)
-        {
-          startEnd[i] = (int[]) regions.elementAt(i);
-        }
+        int[][] startEnd = ap.av.getVisibleRegionBoundaries(sg.getStartRes(),
+                sg.getEndRes() + 1);
 
         String description;
         int caseChange;
@@ -564,7 +552,7 @@ public class APopupMenu extends java.awt.PopupMenu implements
         }
 
         ChangeCaseCommand caseCommand = new ChangeCaseCommand(description,
-                sg.getSequencesAsArray(ap.av.hiddenRepSequences), startEnd,
+                sg.getSequencesAsArray(ap.av.getHiddenRepSequences()), startEnd,
                 caseChange);
 
         ap.alignFrame.addHistoryItem(caseCommand);
@@ -582,18 +570,28 @@ public class APopupMenu extends java.awt.PopupMenu implements
         return;
       }
 
-      int gSize = sg.getSize();
-      SequenceI[] seqs = new SequenceI[gSize];
-      SequenceFeature[] features = new SequenceFeature[gSize];
+      int rsize = 0, gSize = sg.getSize();
+      SequenceI[] rseqs, seqs = new SequenceI[gSize];
+      SequenceFeature[] tfeatures, features = new SequenceFeature[gSize];
 
       for (int i = 0; i < gSize; i++)
       {
-        seqs[i] = sg.getSequenceAt(i);
         int start = sg.getSequenceAt(i).findPosition(sg.getStartRes());
         int end = sg.findEndRes(sg.getSequenceAt(i));
-        features[i] = new SequenceFeature(null, null, null, start, end,
-                "Jalview");
+        if (start <= end)
+        {
+          seqs[rsize] = sg.getSequenceAt(i);
+          features[rsize] = new SequenceFeature(null, null, null, start,
+                  end, "Jalview");
+          rsize++;
+        }
       }
+      rseqs = new SequenceI[rsize];
+      tfeatures = new SequenceFeature[rsize];
+      System.arraycopy(seqs, 0, rseqs, 0, rsize);
+      System.arraycopy(features, 0, tfeatures, 0, rsize);
+      features = tfeatures;
+      seqs = rseqs;
 
       if (ap.seqPanel.seqCanvas.getFeatureRenderer().amendFeatures(seqs,
               features, true, ap))
@@ -616,19 +614,22 @@ public class APopupMenu extends java.awt.PopupMenu implements
 
     Frame frame = new Frame();
     frame.add(cap);
-    jalview.bin.JalviewLite.addFrame(frame, "Selection output - "
-            + e.getActionCommand(), 600, 500);
+    jalview.bin.JalviewLite.addFrame(frame,
+            "Selection output - " + e.getActionCommand(), 600, 500);
+    // JBPNote: getSelectionAsNewSequence behaviour has changed - this method now returns a full copy of sequence data
+    // TODO consider using getSequenceSelection instead here
 
-    cap.setText(new jalview.io.AppletFormatAdapter().formatSequences(e
-            .getActionCommand(), new Alignment(ap.av
-            .getSelectionAsNewSequence()), ap.av.showJVSuffix));
+    cap.setText(new jalview.io.AppletFormatAdapter().formatSequences(
+            e.getActionCommand(),
+            new Alignment(ap.av.getSelectionAsNewSequence()),
+            ap.av.showJVSuffix));
 
   }
 
   void editName()
   {
-    EditNameDialog dialog = new EditNameDialog(seq.getName(), seq
-            .getDescription(), "       Sequence Name",
+    EditNameDialog dialog = new EditNameDialog(seq.getName(),
+            seq.getDescription(), "       Sequence Name",
             "Sequence Description", ap.alignFrame,
             "Edit Sequence Name / Description", 500, 100, true);
 
@@ -661,7 +662,7 @@ public class APopupMenu extends java.awt.PopupMenu implements
       cap.setPDBImport(seq);
       Frame frame = new Frame();
       frame.add(cap);
-      jalview.bin.JalviewLite.addFrame(frame, "Paste PDB file ", 400, 300);
+      jalview.bin.JalviewLite.addFrame(frame, "Paste PDB file for sequence "+seq.getName(), 400, 300);
     }
   }
 
@@ -697,10 +698,12 @@ public class APopupMenu extends java.awt.PopupMenu implements
     hideSeqs.setLabel("Hide Sequences");
     repGroup.setLabel("Represent Group with");
     revealAll.setLabel("Reveal All");
+    revealSeq.setLabel("Reveal Sequences");
     menu1.setLabel("Group");
     add(groupMenu);
     this.add(seqMenu);
     this.add(hideSeqs);
+    this.add(revealSeq);
     this.add(revealAll);
     groupMenu.add(editGroupName);
     groupMenu.add(editMenu);
@@ -768,7 +771,10 @@ public class APopupMenu extends java.awt.PopupMenu implements
     toLower.addActionListener(this);
     editMenu.add(toggleCase);
     seqMenu.add(sequenceName);
-    seqMenu.add(pdb);
+    if (!ap.av.applet.useXtrnalSviewer)
+    {
+      seqMenu.add(pdb);
+    }
     seqMenu.add(repGroup);
     menu1.add(unGroupMenuItem);
     menu1.add(colourMenu);
@@ -781,6 +787,7 @@ public class APopupMenu extends java.awt.PopupMenu implements
     hideSeqs.addActionListener(this);
     repGroup.addActionListener(this);
     revealAll.addActionListener(this);
+    revealSeq.addActionListener(this);
   }
 
   void refresh()
@@ -791,9 +798,8 @@ public class APopupMenu extends java.awt.PopupMenu implements
   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();
   }
 
@@ -855,9 +861,9 @@ public class APopupMenu extends java.awt.PopupMenu implements
 
     if (abovePIDColour.getState())
     {
-      sg.cs.setConsensus(AAFrequency.calculate(sg
-              .getSequences(ap.av.hiddenRepSequences), 0, ap.av.alignment
-              .getWidth()));
+      sg.cs.setConsensus(AAFrequency.calculate(
+              sg.getSequences(ap.av.getHiddenRepSequences()), 0,
+              ap.av.getAlignment().getWidth()));
       int threshold = SliderPanel.setPIDSliderSource(ap, sg.cs, getGroup()
               .getName());
 
@@ -885,9 +891,9 @@ public class APopupMenu extends java.awt.PopupMenu implements
   {
     SequenceGroup sg = getGroup();
     sg.cs = new PIDColourScheme();
-    sg.cs.setConsensus(AAFrequency.calculate(sg
-            .getSequences(ap.av.hiddenRepSequences), 0, ap.av.alignment
-            .getWidth()));
+    sg.cs.setConsensus(AAFrequency.calculate(
+            sg.getSequences(ap.av.getHiddenRepSequences()), 0,
+            ap.av.getAlignment().getWidth()));
     refresh();
   }
 
@@ -897,9 +903,9 @@ public class APopupMenu extends java.awt.PopupMenu implements
 
     sg.cs = new Blosum62ColourScheme();
 
-    sg.cs.setConsensus(AAFrequency.calculate(sg
-            .getSequences(ap.av.hiddenRepSequences), 0, ap.av.alignment
-            .getWidth()));
+    sg.cs.setConsensus(AAFrequency.calculate(
+            sg.getSequences(ap.av.getHiddenRepSequences()), 0,
+            ap.av.getAlignment().getWidth()));
 
     refresh();
   }
@@ -921,16 +927,11 @@ public class APopupMenu extends java.awt.PopupMenu implements
     if (conservationMenuItem.getState())
     {
 
-      Conservation c = new Conservation("Group",
-              ResidueProperties.propHash, 3, sg
-                      .getSequences(ap.av.hiddenRepSequences), 0,
-              ap.av.alignment.getWidth());
-
-      c.calculate();
-      c.verdict(false, ap.av.ConsPercGaps);
-
-      sg.cs.setConservation(c);
-
+      sg.cs.setConservation(Conservation.calculateConservation("Group",
+              ResidueProperties.propHash, 3,
+              sg.getSequences(ap.av.getHiddenRepSequences()), 0,
+              ap.av.getAlignment().getWidth(),
+              false, ap.av.getConsPercGaps(),false));
       SliderPanel.setConservationSlider(ap, sg.cs, sg.getName());
       SliderPanel.showConservationSlider();
     }
@@ -950,7 +951,7 @@ public class APopupMenu extends java.awt.PopupMenu implements
     // 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;
@@ -959,7 +960,7 @@ public class APopupMenu extends java.awt.PopupMenu implements
   void unGroupMenuItem_actionPerformed()
   {
     SequenceGroup sg = ap.av.getSelectionGroup();
-    ap.av.alignment.deleteGroup(sg);
+    ap.av.getAlignment().deleteGroup(sg);
     ap.av.setSelectionGroup(null);
     ap.paintAlignment(true);
   }
@@ -978,7 +979,7 @@ public class APopupMenu extends java.awt.PopupMenu implements
 
   public void showNonconserved_itemStateChanged()
   {
-    getGroup().setShowunconserved(this.displayNonconserved.getState());
+    getGroup().setShowNonconserved(this.displayNonconserved.getState());
     refresh();
   }
 
@@ -1019,6 +1020,7 @@ public class APopupMenu extends java.awt.PopupMenu implements
     }
 
     ap.av.hideSequence(hseqs);
+    ap.av.sendSelection();
   }
 
 }