Conservation colour scheme is no more
[jalview.git] / src / jalview / gui / AlignFrame.java
index ad350cc..fc59062 100755 (executable)
  * GNU General Public License for more details.\r
  *\r
  * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
+ * along with this program; if not, write to the Free Softwarechang\r
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  */\r
 package jalview.gui;\r
 \r
 import java.beans.*;\r
+import java.io.*;\r
 import java.util.*;\r
 \r
 import java.awt.*;\r
@@ -35,18 +36,34 @@ import jalview.jbgui.*;
 import jalview.schemes.*;\r
 import jalview.ws.*;\r
 \r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
 public class AlignFrame\r
     extends GAlignFrame\r
 {\r
+  /** DOCUMENT ME!! */\r
   public static final int NEW_WINDOW_WIDTH = 700;\r
+\r
+  /** DOCUMENT ME!! */\r
   public static final int NEW_WINDOW_HEIGHT = 500;\r
   final AlignmentPanel alignPanel;\r
   final AlignViewport viewport;\r
-  public String currentFileFormat = "Jalview";\r
+\r
+  /** DOCUMENT ME!! */\r
+  public String currentFileFormat = null;\r
   Stack historyList = new Stack();\r
   Stack redoList = new Stack();\r
   private int treeCount = 0;\r
 \r
+  /**\r
+   * Creates a new AlignFrame object.\r
+   *\r
+   * @param al DOCUMENT ME!\r
+   */\r
   public AlignFrame(AlignmentI al)\r
   {\r
     viewport = new AlignViewport(al);\r
@@ -74,8 +91,113 @@ public class AlignFrame
         });\r
       }\r
     });\r
+    addServiceListeners();\r
+  }\r
+\r
+  /* Set up intrinsic listeners for dynamically generated GUI bits. */\r
+  private void addServiceListeners()\r
+  {\r
+\r
+    final AlignFrame thisFrame = this;\r
+    final java.beans.PropertyChangeListener thisListener;\r
+    // Do this once to get current state\r
+    thisFrame.BuildWebServiceMenu();\r
+    Desktop.discoverer.addPropertyChangeListener(\r
+        thisListener = new java.beans.PropertyChangeListener()\r
+    {\r
+      public void propertyChange(PropertyChangeEvent evt)\r
+      {\r
+        // System.out.println("Discoverer property change.");\r
+        if (evt.getPropertyName().equals("services"))\r
+        {\r
+          // System.out.println("Rebuilding web service menu");\r
+          thisFrame.BuildWebServiceMenu();\r
+        }\r
+      }\r
+    });\r
+    addInternalFrameListener(new javax.swing.event.\r
+                             InternalFrameAdapter()\r
+    {\r
+      public void internalFrameClosed(\r
+          javax.swing.event.InternalFrameEvent evt)\r
+      {\r
+        // System.out.println("deregistering discoverer listener");\r
+        Desktop.discoverer.removePropertyChangeListener(thisListener);\r
+      }\r
+      ;\r
+    });\r
+\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param String DOCUMENT ME!\r
+   */\r
+\r
+  public void parseGroupsFile(String file)\r
+  {\r
+    try\r
+    {\r
+      BufferedReader in = new BufferedReader(new FileReader(file));\r
+      SequenceI seq = null;\r
+      String line, text, token;\r
+      UserColourScheme ucs;\r
+      int index, start, end;\r
+      StringTokenizer st;\r
+      SequenceGroup sg;\r
+      while ( (line = in.readLine()) != null)\r
+      {\r
+        st = new StringTokenizer(line, "\t");\r
+        if (st.countTokens() != 6)\r
+        {\r
+          System.out.println("Groups file " + file +\r
+                             " is invalid. Read help file.");\r
+          System.exit(1);\r
+        }\r
+\r
+        while (st.hasMoreElements())\r
+        {\r
+          text = st.nextToken();\r
+          token = st.nextToken();\r
+          if (!token.equals("ID_NOT_SPECIFIED"))\r
+          {\r
+            index = viewport.alignment.findIndex(viewport.alignment.findName(\r
+                token));\r
+            st.nextToken();\r
+          }\r
+          else\r
+          {\r
+            index = Integer.parseInt(st.nextToken());\r
+          }\r
+\r
+          start = Integer.parseInt(st.nextToken());\r
+          end = Integer.parseInt(st.nextToken());\r
+          ucs = new UserColourScheme(st.nextToken());\r
+\r
+          seq = viewport.alignment.getSequenceAt(index);\r
+          start = seq.findIndex(start) - 1;\r
+          end = seq.findIndex(end) - 1;\r
+\r
+          sg = new SequenceGroup(text, ucs, true, true, false, start, end);\r
+          sg.addSequence(seq, true);\r
+\r
+          viewport.alignment.addGroup(sg);\r
+        }\r
+      }\r
+\r
+    }\r
+    catch (Exception ex)\r
+    {\r
+      System.out.println("Error parsing groups file: " + ex);\r
+    }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void saveAlignmentMenu_actionPerformed(ActionEvent e)\r
   {\r
     JalviewFileChooser chooser = new JalviewFileChooser(jalview.bin.Cache.\r
@@ -104,43 +226,61 @@ public class AlignFrame
       jalview.bin.Cache.setProperty("DEFAULT_FILE_FORMAT",\r
                                     currentFileFormat);\r
 \r
-      if (currentFileFormat.equals("Jalview"))\r
-      {\r
-        String shortName = title;\r
+      String choice = chooser.getSelectedFile().getPath();\r
+      jalview.bin.Cache.setProperty("LAST_DIRECTORY", choice);\r
 \r
-        if (shortName.indexOf(java.io.File.separatorChar) > -1)\r
-        {\r
-          shortName = shortName.substring(shortName.lastIndexOf(\r
-              java.io.File.separatorChar) + 1);\r
-        }\r
+      saveAlignment(choice, currentFileFormat);\r
+    }\r
+  }\r
 \r
-        String choice = chooser.getSelectedFile().getPath();\r
-        Jalview2XML.SaveAlignment(this, choice, shortName);\r
+  public boolean saveAlignment(String file, String format)\r
+  {\r
+    if (format.equalsIgnoreCase("Jalview"))\r
+    {\r
+      String shortName = title;\r
 \r
-        // USE Jalview2XML to save this file\r
-        return;\r
+      if (shortName.indexOf(java.io.File.separatorChar) > -1)\r
+      {\r
+        shortName = shortName.substring(shortName.lastIndexOf(\r
+            java.io.File.separatorChar) + 1);\r
       }\r
 \r
-      String choice = chooser.getSelectedFile().getPath();\r
-      jalview.bin.Cache.setProperty("LAST_DIRECTORY", choice);\r
+      Jalview2XML.SaveAlignment(this, file, shortName);\r
 \r
-      String output = FormatAdapter.formatSequences(currentFileFormat,\r
-          viewport.getAlignment().getSequences());\r
+      // USE Jalview2XML to save this file\r
+      return true;\r
+    }\r
+    else\r
+    {\r
+      String output = FormatAdapter.formatSequences(format,\r
+          viewport.getAlignment().\r
+          getSequences());\r
+      if (output == null)\r
+      {\r
+        return false;\r
+      }\r
 \r
       try\r
       {\r
-        java.io.PrintWriter out = new java.io.PrintWriter(new java.io.\r
-            FileWriter(\r
-                choice));\r
+        java.io.PrintWriter out = new java.io.PrintWriter(\r
+            new java.io.FileWriter(file));\r
         out.println(output);\r
         out.close();\r
+        return true;\r
       }\r
       catch (Exception ex)\r
       {\r
+        ex.printStackTrace();\r
       }\r
     }\r
+    return false;\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void outputText_actionPerformed(ActionEvent e)\r
   {\r
     CutAndPasteTransfer cap = new CutAndPasteTransfer();\r
@@ -152,21 +292,46 @@ public class AlignFrame
                                               getSequences()));\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void htmlMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     new HTMLOutput(viewport);\r
   }\r
 \r
-  protected void createPNG_actionPerformed(ActionEvent e)\r
+  public void createImageMap(File file, String image)\r
+  {\r
+    alignPanel.makePNGImageMap(file, image);\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
+  public void createPNG(File f)\r
   {\r
-    alignPanel.makePNG();\r
+    alignPanel.makePNG(f);\r
   }\r
 \r
-  protected void epsFile_actionPerformed(ActionEvent e)\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
+  public void createEPS(File f)\r
   {\r
-    alignPanel.makeEPS();\r
+    alignPanel.makeEPS(f);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void printMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     //Putting in a thread avoids Swing painting problems\r
@@ -174,6 +339,11 @@ public class AlignFrame
     thread.start();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void closeMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     try\r
@@ -185,6 +355,9 @@ public class AlignFrame
     }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   */\r
   void updateEditMenuBar()\r
   {\r
     if (historyList.size() > 0)\r
@@ -214,12 +387,22 @@ public class AlignFrame
     }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param hi DOCUMENT ME!\r
+   */\r
   public void addHistoryItem(HistoryItem hi)\r
   {\r
     historyList.push(hi);\r
     updateEditMenuBar();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void undoMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     HistoryItem hi = (HistoryItem) historyList.pop();\r
@@ -228,6 +411,11 @@ public class AlignFrame
     restoreHistoryItem(hi);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void redoMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     HistoryItem hi = (HistoryItem) redoList.pop();\r
@@ -287,6 +475,11 @@ public class AlignFrame
                                 viewport.getAlignment().getSequences());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param up DOCUMENT ME!\r
+   */\r
   public void moveSelectedSequences(boolean up)\r
   {\r
     SequenceGroup sg = viewport.getSelectionGroup();\r
@@ -344,6 +537,11 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void copy_actionPerformed(ActionEvent e)\r
   {\r
     if (viewport.getSelectionGroup() == null)\r
@@ -365,7 +563,8 @@ public class AlignFrame
       orderedSeqs.put(index + "", seq);\r
     }\r
 \r
-    int index = 0;\r
+    int index = 0, startRes, endRes;\r
+    char ch;\r
 \r
     for (int i = 0; i < sg.getSize(); i++)\r
     {\r
@@ -385,22 +584,53 @@ public class AlignFrame
           index++;\r
         }\r
       }\r
+      //FIND START RES\r
+      //Returns residue following index if gap\r
+      startRes = seq.findPosition(sg.getStartRes());\r
+\r
+      //FIND END RES\r
+      //Need to find the residue preceeding index if gap\r
+      endRes = 0;\r
+\r
+      for (int j = 0; j < sg.getEndRes() + 1 && j < seq.getLength(); j++)\r
+      {\r
+        ch = seq.getCharAt(j);\r
+        if (!jalview.util.Comparison.isGap( (ch)))\r
+        {\r
+          endRes++;\r
+        }\r
+      }\r
+\r
+      if (endRes > 0)\r
+      {\r
+        endRes += seq.getStart() - 1;\r
+      }\r
 \r
       buffer.append(seq.getName() + "\t" +\r
-                    seq.findPosition(sg.getStartRes()) + "\t" +\r
-                    seq.findPosition(sg.getEndRes()) + "\t" +\r
-                    sg.getSequenceAt(i).getSequence(sg.getStartRes(),\r
-          sg.getEndRes() + 1) + "\n");\r
+                    startRes + "\t" +\r
+                    endRes + "\t" +\r
+                    seq.getSequence(sg.getStartRes(),\r
+                                    sg.getEndRes() + 1) + "\n");\r
     }\r
 \r
     c.setContents(new StringSelection(buffer.toString()), null);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void pasteNew_actionPerformed(ActionEvent e)\r
   {\r
     paste(true);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void pasteThis_actionPerformed(ActionEvent e)\r
   {\r
     addHistoryItem(new HistoryItem("Paste Sequences", viewport.alignment,\r
@@ -408,6 +638,11 @@ public class AlignFrame
     paste(false);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param newAlignment DOCUMENT ME!\r
+   */\r
   void paste(boolean newAlignment)\r
   {\r
     try\r
@@ -480,12 +715,22 @@ public class AlignFrame
     // could be anything being pasted in here\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void cut_actionPerformed(ActionEvent e)\r
   {\r
     copy_actionPerformed(null);\r
     delete_actionPerformed(null);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void delete_actionPerformed(ActionEvent e)\r
   {\r
     boolean seqsdeleted = false;\r
@@ -499,6 +744,11 @@ public class AlignFrame
                                    HistoryItem.HIDE));\r
 \r
     SequenceGroup sg = viewport.getSelectionGroup();\r
+    boolean allSequences = false;\r
+    if (sg.sequences.size() == viewport.alignment.getHeight())\r
+    {\r
+      allSequences = true;\r
+    }\r
 \r
     for (int i = 0; i < sg.sequences.size(); i++)\r
     {\r
@@ -506,6 +756,13 @@ public class AlignFrame
       int index = viewport.getAlignment().findIndex(seq);\r
       seq.deleteChars(sg.getStartRes(), sg.getEndRes() + 1);\r
 \r
+      // If the cut affects all sequences, remove highlighted columns\r
+      if (allSequences)\r
+      {\r
+        viewport.getColumnSelection().removeElements(sg.getStartRes(),\r
+            sg.getEndRes() + 1);\r
+      }\r
+\r
       if (seq.getSequence().length() < 1)\r
       {\r
         seqsdeleted = true;\r
@@ -544,6 +801,11 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void deleteGroups_actionPerformed(ActionEvent e)\r
   {\r
     viewport.alignment.deleteAllGroups();\r
@@ -551,6 +813,11 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void selectAllSequenceMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     SequenceGroup sg = new SequenceGroup();\r
@@ -561,32 +828,55 @@ public class AlignFrame
       sg.addSequence(viewport.getAlignment().getSequenceAt(i), false);\r
     }\r
 \r
-    sg.setEndRes(viewport.alignment.getWidth());\r
+    sg.setEndRes(viewport.alignment.getWidth() - 1);\r
     viewport.setSelectionGroup(sg);\r
-    PaintRefresher.Refresh(null);\r
+    PaintRefresher.Refresh(null, viewport.alignment);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void deselectAllSequenceMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setSelectionGroup(null);\r
     viewport.getColumnSelection().clear();\r
     viewport.setSelectionGroup(null);\r
-    PaintRefresher.Refresh(null);\r
+    alignPanel.annotationPanel.activeRes = null;\r
+    PaintRefresher.Refresh(null, viewport.alignment);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void invertSequenceMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     SequenceGroup sg = viewport.getSelectionGroup();\r
 \r
+    if (sg == null)\r
+    {\r
+      selectAllSequenceMenuItem_actionPerformed(null);\r
+\r
+      return;\r
+    }\r
+\r
     for (int i = 0; i < viewport.getAlignment().getSequences().size();\r
          i++)\r
     {\r
       sg.addOrRemove(viewport.getAlignment().getSequenceAt(i), false);\r
     }\r
 \r
-    PaintRefresher.Refresh(null);\r
+    PaintRefresher.Refresh(null, viewport.alignment);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void remove2LeftMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     ColumnSelection colSel = viewport.getColumnSelection();\r
@@ -621,6 +911,11 @@ public class AlignFrame
     }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void remove2RightMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     ColumnSelection colSel = viewport.getColumnSelection();\r
@@ -654,6 +949,11 @@ public class AlignFrame
     }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void removeGappedColumnMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     addHistoryItem(new HistoryItem("Remove Gapped Columns",\r
@@ -665,6 +965,11 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void removeAllGapsMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     addHistoryItem(new HistoryItem("Remove Gaps", viewport.alignment,\r
@@ -673,13 +978,32 @@ public class AlignFrame
     SequenceI current;\r
     int jSize;\r
 \r
-    for (int i = 0; i < viewport.getAlignment().getSequences().size();\r
-         i++)\r
+    Vector seqs = null;\r
+\r
+    int start = 0;\r
+    int end = viewport.alignment.getWidth();\r
+\r
+    if (viewport.getSelectionGroup() != null\r
+        && viewport.getSelectionGroup().sequences != null\r
+        && viewport.getSelectionGroup().sequences.size() > 0)\r
     {\r
-      current = viewport.getAlignment().getSequenceAt(i);\r
+      seqs = viewport.getSelectionGroup().sequences;\r
+      start = viewport.getSelectionGroup().getStartRes();\r
+      end = viewport.getSelectionGroup().getEndRes();\r
+    }\r
+    else\r
+    {\r
+      seqs = viewport.alignment.getSequences();\r
+    }\r
+\r
+    for (int i = 0; i < seqs.size(); i++)\r
+    {\r
+      current = (SequenceI) seqs.elementAt(i);\r
       jSize = current.getLength();\r
 \r
-      for (int j = 0; j < jSize; j++)\r
+      int j = start;\r
+\r
+      do\r
       {\r
         if (jalview.util.Comparison.isGap(current.getCharAt(j)))\r
         {\r
@@ -687,7 +1011,9 @@ public class AlignFrame
           j--;\r
           jSize--;\r
         }\r
+        j++;\r
       }\r
+      while (j < end && j < jSize);\r
     }\r
 \r
     viewport.updateConservation();\r
@@ -695,13 +1021,18 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void padGapsMenuitem_actionPerformed(ActionEvent e)\r
   {\r
     addHistoryItem(new HistoryItem("Pad Gaps", viewport.alignment,\r
                                    HistoryItem.HIDE));\r
 \r
     SequenceI current;\r
-    int Width = viewport.getAlignment().getWidth() - 1;\r
+    int Width = viewport.getAlignment().getWidth();\r
 \r
     for (int i = 0; i < viewport.getAlignment().getSequences().size();\r
          i++)\r
@@ -710,7 +1041,7 @@ public class AlignFrame
 \r
       if (current.getLength() < Width)\r
       {\r
-        current.insertCharAt(Width, viewport.getGapCharacter());\r
+        current.insertCharAt(Width - 1, viewport.getGapCharacter());\r
       }\r
     }\r
 \r
@@ -719,6 +1050,11 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void findMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     JInternalFrame frame = new JInternalFrame();\r
@@ -728,11 +1064,21 @@ public class AlignFrame
     frame.setLayer(JLayeredPane.PALETTE_LAYER);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void font_actionPerformed(ActionEvent e)\r
   {\r
     FontChooser fc = new FontChooser(alignPanel);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void fullSeqId_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setShowFullId(fullSeqId.isSelected());\r
@@ -741,12 +1087,22 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void colourTextMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setColourText(colourTextMenuItem.isSelected());\r
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void wrapMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setWrapAlignment(wrapMenuItem.isSelected());\r
@@ -757,42 +1113,77 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void scaleAbove_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setScaleAboveWrapped(scaleAbove.isSelected());\r
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void scaleLeft_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setScaleLeftWrapped(scaleLeft.isSelected());\r
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void scaleRight_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setScaleRightWrapped(scaleRight.isSelected());\r
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void viewBoxesMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setShowBoxes(viewBoxesMenuItem.isSelected());\r
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void viewTextMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setShowText(viewTextMenuItem.isSelected());\r
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void renderGapsMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setRenderGaps(renderGapsMenuItem.isSelected());\r
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param evt DOCUMENT ME!\r
+   */\r
   public void sequenceFeatures_actionPerformed(ActionEvent evt)\r
   {\r
     viewport.showSequenceFeatures(sequenceFeatures.isSelected());\r
@@ -809,6 +1200,11 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void annotationPanelMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     if (annotationPanelMenuItem.isSelected() &&\r
@@ -823,6 +1219,11 @@ public class AlignFrame
     alignPanel.setAnnotationVisible(annotationPanelMenuItem.isSelected());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void overviewMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     if (alignPanel.overviewPanel != null)\r
@@ -850,124 +1251,170 @@ public class AlignFrame
     alignPanel.setOverviewPanel(overview);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void noColourmenuItem_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(null);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void clustalColour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new ClustalxColourScheme(\r
         viewport.alignment.getSequences(), viewport.alignment.getWidth()));\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void zappoColour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new ZappoColourScheme());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void taylorColour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new TaylorColourScheme());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void hydrophobicityColour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new HydrophobicColourScheme());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void helixColour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new HelixColourScheme());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void strandColour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new StrandColourScheme());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void turnColour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new TurnColourScheme());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void buriedColour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new BuriedColourScheme());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void nucleotideColour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new NucleotideColourScheme());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void applyToAllGroups_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setColourAppliesToAllGroups(applyToAllGroups.isSelected());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param cs DOCUMENT ME!\r
+   */\r
   void changeColour(ColourSchemeI cs)\r
   {\r
     int threshold = 0;\r
 \r
-    if (viewport.getAbovePIDThreshold())\r
+    if(cs!=null)\r
     {\r
-      threshold = SliderPanel.setPIDSliderSource(alignPanel, cs,\r
-                                                 "Background");\r
-\r
-      if (cs instanceof ResidueColourScheme)\r
+      if (viewport.getAbovePIDThreshold())\r
       {\r
-        ( (ResidueColourScheme) cs).setThreshold(threshold);\r
+        threshold = SliderPanel.setPIDSliderSource(alignPanel, cs,\r
+                                                   "Background");\r
+\r
+        cs.setThreshold(threshold,\r
+                        viewport.getIgnoreGapsConsensus());\r
+\r
+        viewport.setGlobalColourScheme(cs);\r
       }\r
-      else if (cs instanceof ScoreColourScheme)\r
+      else\r
       {\r
-        ( (ScoreColourScheme) cs).setThreshold(threshold);\r
+        cs.setThreshold(0, viewport.getIgnoreGapsConsensus());\r
       }\r
 \r
-      viewport.setGlobalColourScheme(cs);\r
-    }\r
-    else if (cs instanceof ResidueColourScheme)\r
-    {\r
-      ( (ResidueColourScheme) cs).setThreshold(0);\r
-    }\r
-    else if (cs instanceof ScoreColourScheme)\r
-    {\r
-      ( (ScoreColourScheme) cs).setThreshold(0);\r
-    }\r
-\r
-    if (viewport.getConservationSelected())\r
-    {\r
-      ConservationColourScheme ccs = null;\r
-\r
-      Alignment al = (Alignment) viewport.alignment;\r
-      Conservation c = new Conservation("All",\r
-                                        ResidueProperties.propHash, 3,\r
-                                        al.getSequences(), 0,\r
-                                        al.getWidth() - 1);\r
+      if (viewport.getConservationSelected())\r
+      {\r
 \r
-      c.calculate();\r
-      c.verdict(false, viewport.ConsPercGaps);\r
+        Alignment al = (Alignment) viewport.alignment;\r
+        Conservation c = new Conservation("All",\r
+                                          ResidueProperties.propHash, 3,\r
+                                          al.getSequences(), 0,\r
+                                          al.getWidth() - 1);\r
 \r
-      ccs = new ConservationColourScheme(c, cs);\r
+        c.calculate();\r
+        c.verdict(false, viewport.ConsPercGaps);\r
 \r
-      // MUST NOTIFY THE COLOURSCHEME OF CONSENSUS!\r
-      ccs.setConsensus(viewport.vconsensus);\r
-      viewport.setGlobalColourScheme(ccs);\r
+        cs.setConservation(c);\r
 \r
-      ccs.inc = SliderPanel.setConservationSlider(alignPanel, ccs,\r
-                                                  "Background");\r
-    }\r
-    else\r
-    {\r
-      // MUST NOTIFY THE COLOURSCHEME OF CONSENSUS!\r
-      if (cs != null)\r
+        cs.setConservationInc(SliderPanel.setConservationSlider(alignPanel, cs,\r
+            "Background"));\r
+      }\r
+      else\r
       {\r
-        cs.setConsensus(viewport.vconsensus);\r
+        cs.setConservation(null);\r
       }\r
 \r
-      viewport.setGlobalColourScheme(cs);\r
+      cs.setConsensus(viewport.vconsensus);\r
     }\r
 \r
+    viewport.setGlobalColourScheme(cs);\r
+\r
     if (viewport.getColourAppliesToAllGroups())\r
     {\r
       Vector groups = viewport.alignment.getGroups();\r
@@ -979,8 +1426,10 @@ public class AlignFrame
         if (cs == null)\r
         {\r
           sg.cs = null;\r
+          continue;\r
         }\r
-        else if (cs instanceof ClustalxColourScheme)\r
+\r
+        if (cs instanceof ClustalxColourScheme)\r
         {\r
           sg.cs = new ClustalxColourScheme(sg.sequences, sg.getWidth());\r
         }\r
@@ -1001,18 +1450,15 @@ public class AlignFrame
 \r
         if (viewport.getAbovePIDThreshold())\r
         {\r
-          if (sg.cs instanceof ResidueColourScheme)\r
-          {\r
-            ( (ResidueColourScheme) sg.cs).setThreshold(threshold);\r
-          }\r
-          else if (sg.cs instanceof ScoreColourScheme)\r
-          {\r
-            ( (ScoreColourScheme) sg.cs).setThreshold(threshold);\r
-          }\r
+         sg.cs.setThreshold(threshold,\r
+                viewport.getIgnoreGapsConsensus());\r
 \r
           sg.cs.setConsensus(AAFrequency.calculate(sg.sequences, 0,\r
               sg.getWidth()));\r
         }\r
+        else\r
+          sg.cs.setThreshold(0, viewport.getIgnoreGapsConsensus());\r
+\r
 \r
         if (viewport.getConservationSelected())\r
         {\r
@@ -1022,21 +1468,10 @@ public class AlignFrame
                                             viewport.alignment.getWidth() - 1);\r
           c.calculate();\r
           c.verdict(false, viewport.ConsPercGaps);\r
-\r
-          ConservationColourScheme ccs = new ConservationColourScheme(c,\r
-              sg.cs);\r
-\r
-          // MUST NOTIFY THE COLOURSCHEME OF CONSENSUS!\r
-          ccs.setConsensus(AAFrequency.calculate(sg.sequences, 0,\r
-                                                 sg.getWidth()));\r
-          sg.cs = ccs;\r
-        }\r
-        else if (cs != null)\r
-        {\r
-          // MUST NOTIFY THE COLOURSCHEME OF CONSENSUS!\r
-          sg.cs.setConsensus(AAFrequency.calculate(sg.sequences, 0,\r
-              sg.getWidth()));\r
+          sg.cs.setConservation(c);\r
         }\r
+        else\r
+          sg.cs.setConservation(null);\r
       }\r
     }\r
 \r
@@ -1048,9 +1483,14 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void modifyPID_actionPerformed(ActionEvent e)\r
   {\r
-    if (viewport.getAbovePIDThreshold())\r
+    if (viewport.getAbovePIDThreshold() && viewport.globalColourScheme!=null)\r
     {\r
       SliderPanel.setPIDSliderSource(alignPanel,\r
                                      viewport.getGlobalColourScheme(),\r
@@ -1059,9 +1499,14 @@ public class AlignFrame
     }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void modifyConservation_actionPerformed(ActionEvent e)\r
   {\r
-    if (viewport.getConservationSelected())\r
+    if (viewport.getConservationSelected() && viewport.globalColourScheme!=null)\r
     {\r
       SliderPanel.setConservationSlider(alignPanel,\r
                                         viewport.globalColourScheme,\r
@@ -1070,6 +1515,11 @@ public class AlignFrame
     }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void conservationMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setConservationSelected(conservationMenuItem.isSelected());\r
@@ -1077,20 +1527,16 @@ public class AlignFrame
     viewport.setAbovePIDThreshold(false);\r
     abovePIDThreshold.setSelected(false);\r
 \r
-    ColourSchemeI cs = viewport.getGlobalColourScheme();\r
-\r
-    if (cs instanceof ConservationColourScheme)\r
-    {\r
-      changeColour( ( (ConservationColourScheme) cs).cs);\r
-    }\r
-    else\r
-    {\r
-      changeColour(cs);\r
-    }\r
+    changeColour(viewport.getGlobalColourScheme());\r
 \r
     modifyConservation_actionPerformed(null);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void abovePIDThreshold_actionPerformed(ActionEvent e)\r
   {\r
     viewport.setAbovePIDThreshold(abovePIDThreshold.isSelected());\r
@@ -1100,33 +1546,122 @@ public class AlignFrame
 \r
     ColourSchemeI cs = viewport.getGlobalColourScheme();\r
 \r
-    if (cs instanceof ConservationColourScheme)\r
+    changeColour(viewport.getGlobalColourScheme());\r
+\r
+    modifyPID_actionPerformed(null);\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
+  public void userDefinedColour_actionPerformed(ActionEvent e)\r
+  {\r
+    if (e.getActionCommand().equals("User Defined..."))\r
     {\r
-      changeColour( ( (ConservationColourScheme) cs).cs);\r
+      new UserDefinedColours(alignPanel, null);\r
     }\r
     else\r
     {\r
-      changeColour(cs);\r
-    }\r
+      UserColourScheme udc = (UserColourScheme) UserDefinedColours.\r
+          getUserColourSchemes().get(e.getActionCommand());\r
 \r
-    modifyPID_actionPerformed(null);\r
+      changeColour(udc);\r
+    }\r
   }\r
 \r
-  public void userDefinedColour_actionPerformed(ActionEvent e)\r
+  public void updateUserColourMenu()\r
   {\r
-    new UserDefinedColours(alignPanel, null);\r
+\r
+    Component[] menuItems = colourMenu.getMenuComponents();\r
+    int i, iSize = menuItems.length;\r
+    for (i = 0; i < iSize; i++)\r
+    {\r
+      if (menuItems[i].getName() != null &&\r
+          menuItems[i].getName().equals("USER_DEFINED"))\r
+      {\r
+        colourMenu.remove(menuItems[i]);\r
+        iSize--;\r
+      }\r
+    }\r
+    if (jalview.gui.UserDefinedColours.getUserColourSchemes() != null)\r
+    {\r
+      java.util.Enumeration userColours = jalview.gui.UserDefinedColours.\r
+          getUserColourSchemes().keys();\r
+\r
+      while (userColours.hasMoreElements())\r
+      {\r
+        final JRadioButtonMenuItem radioItem = new JRadioButtonMenuItem(userColours.\r
+            nextElement().toString());\r
+        radioItem.setName("USER_DEFINED");\r
+        radioItem.addMouseListener(new MouseAdapter()\r
+            {\r
+              public void mousePressed(MouseEvent evt)\r
+              {\r
+                if(evt.isControlDown() || SwingUtilities.isRightMouseButton(evt))\r
+                {\r
+                  radioItem.removeActionListener(radioItem.getActionListeners()[0]);\r
+\r
+                  int option = JOptionPane.showInternalConfirmDialog(jalview.gui.Desktop.desktop,\r
+                      "Remove from default list?",\r
+                      "Remove user defined colour",\r
+                      JOptionPane.YES_NO_OPTION);\r
+                  if(option == JOptionPane.YES_OPTION)\r
+                  {\r
+                    jalview.gui.UserDefinedColours.removeColourFromDefaults(radioItem.getText());\r
+                    colourMenu.remove(radioItem);\r
+                  }\r
+                  else\r
+                    radioItem.addActionListener(new ActionListener()\r
+                    {\r
+                      public void actionPerformed(ActionEvent evt)\r
+                      {\r
+                        userDefinedColour_actionPerformed(evt);\r
+                      }\r
+                    });\r
+                }\r
+              }\r
+            });\r
+        radioItem.addActionListener(new ActionListener()\r
+        {\r
+          public void actionPerformed(ActionEvent evt)\r
+          {\r
+            userDefinedColour_actionPerformed(evt);\r
+          }\r
+        });\r
+\r
+        colourMenu.insert(radioItem, 15);\r
+        colours.add(radioItem);\r
+      }\r
+    }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void PIDColour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new PIDColourScheme());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void BLOSUM62Colour_actionPerformed(ActionEvent e)\r
   {\r
     changeColour(new Blosum62ColourScheme());\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void sortPairwiseMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     addHistoryItem(new HistoryItem("Pairwise Sort", viewport.alignment,\r
@@ -1136,6 +1671,11 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void sortIDMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     addHistoryItem(new HistoryItem("ID Sort", viewport.alignment,\r
@@ -1144,16 +1684,25 @@ public class AlignFrame
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void sortGroupMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     addHistoryItem(new HistoryItem("Group Sort", viewport.alignment,\r
                                    HistoryItem.SORT));\r
 \r
-    //  AlignmentSorter.sortByGroup(viewport.getAlignment());\r
-    AlignmentSorter.sortGroups(viewport.getAlignment());\r
+    AlignmentSorter.sortByGroup(viewport.getAlignment());\r
     alignPanel.repaint();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void removeRedundancyMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     RedundancyPanel sp = new RedundancyPanel(alignPanel, this);\r
@@ -1163,6 +1712,11 @@ public class AlignFrame
                              100, false);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void pairwiseAlignmentMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     if ( (viewport.getSelectionGroup() == null) ||\r
@@ -1181,6 +1735,11 @@ public class AlignFrame
     }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void PCAMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     if ( ( (viewport.getSelectionGroup() != null) &&\r
@@ -1214,26 +1773,53 @@ public class AlignFrame
     }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void averageDistanceTreeMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     NewTreePanel("AV", "PID", "Average distance tree using PID");\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   public void neighbourTreeMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     NewTreePanel("NJ", "PID", "Neighbour joining tree using PID");\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void njTreeBlosumMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     NewTreePanel("NJ", "BL", "Neighbour joining tree using BLOSUM62");\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void avTreeBlosumMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     NewTreePanel("AV", "BL", "Average distance tree using BLOSUM62");\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param type DOCUMENT ME!\r
+   * @param pwType DOCUMENT ME!\r
+   * @param title DOCUMENT ME!\r
+   */\r
   void NewTreePanel(String type, String pwType, String title)\r
   {\r
     final TreePanel tp;\r
@@ -1293,6 +1879,12 @@ public class AlignFrame
     Desktop.addInternalFrame(tp, title + " from " + this.title, 600, 500);\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param title DOCUMENT ME!\r
+   * @param order DOCUMENT ME!\r
+   */\r
   public void addSortByOrderMenuItem(String title, final AlignmentOrder order)\r
   {\r
     final JMenuItem item = new JMenuItem("by " + title);\r
@@ -1311,6 +1903,15 @@ public class AlignFrame
     });\r
   }\r
 \r
+  /**\r
+   * Maintain the Order by->Displayed Tree menu.\r
+   * Creates a new menu item for a TreePanel with an appropriate\r
+   * <code>jalview.analysis.AlignmentSorter</code> call. Listeners are added\r
+   * to remove the menu item when the treePanel is closed, and adjust\r
+   * the tree leaf to sequence mapping when the alignment is modified.\r
+   * @param treePanel Displayed tree window.\r
+   * @param title SortBy menu item title.\r
+   */\r
   void addTreeMenuItem(final TreePanel treePanel, String title)\r
   {\r
     final JMenuItem item = new JMenuItem(title);\r
@@ -1364,9 +1965,13 @@ public class AlignFrame
     });\r
   }\r
 \r
-  public void clustalAlignMenuItem_actionPerformed(ActionEvent e)\r
+  /**\r
+   * Work out whether the whole set of sequences\r
+   * or just the selected set will be submitted for multiple alignment.\r
+   *\r
+   */\r
+  private SequenceI[] gatherSequencesForAlignment()\r
   {\r
-    // TODO:resolve which menu item was actually selected\r
     // Now, check we have enough sequences\r
     SequenceI[] msa = null;\r
 \r
@@ -1397,56 +2002,16 @@ public class AlignFrame
         }\r
       }\r
     }\r
-\r
-    if (msa != null)\r
-    {\r
-      jalview.ws.MsaWSClient ct = new jalview.ws.MsaWSClient("ClustalWS",\r
-          title, msa, false, true);\r
-    }\r
+    return msa;\r
   }\r
 \r
-  public void ClustalRealign_actionPerformed(ActionEvent e)\r
-  {\r
-    // TODO:resolve which menu item was actually selected\r
-    // Now, check we have enough sequences\r
-    SequenceI[] msa = null;\r
-\r
-    if ( (viewport.getSelectionGroup() != null) &&\r
-        (viewport.getSelectionGroup().getSize() > 1))\r
-    {\r
-      // JBPNote UGLY! To prettify, make SequenceGroup and Alignment conform to some common interface!\r
-      SequenceGroup seqs = viewport.getSelectionGroup();\r
-      int sz;\r
-      msa = new SequenceI[sz = seqs.getSize()];\r
-\r
-      for (int i = 0; i < sz; i++)\r
-      {\r
-        msa[i] = (SequenceI) seqs.getSequenceAt(i);\r
-      }\r
-    }\r
-    else\r
-    {\r
-      Vector seqs = viewport.getAlignment().getSequences();\r
-\r
-      if (seqs.size() > 1)\r
-      {\r
-        msa = new SequenceI[seqs.size()];\r
-\r
-        for (int i = 0; i < seqs.size(); i++)\r
-        {\r
-          msa[i] = (SequenceI) seqs.elementAt(i);\r
-        }\r
-      }\r
-    }\r
-\r
-    if (msa != null)\r
-    {\r
-      jalview.ws.MsaWSClient ct = new jalview.ws.MsaWSClient("ClustalWS",\r
-          title, msa, true, true);\r
-    }\r
-  }\r
-\r
-  protected void jpred_actionPerformed(ActionEvent e)\r
+  /**\r
+   * Decides what is submitted to a secondary structure prediction service,\r
+   * the currently selected sequence, or the currently selected alignment\r
+   * (where the first sequence in the set is the one that the prediction\r
+   * will be for).\r
+   */\r
+  SequenceI[] gatherSeqOrMsaForSecStrPrediction()\r
   {\r
     SequenceI seq = null;\r
     SequenceI[] msa = null;\r
@@ -1490,63 +2055,26 @@ public class AlignFrame
         }\r
       }\r
     }\r
-\r
     if (msa != null)\r
     {\r
-      JPredClient ct = new JPredClient(title, msa);\r
-    }\r
-    else if (seq != null)\r
-    {\r
-      JPredClient ct = new JPredClient(title, seq);\r
+      return msa;\r
     }\r
     else\r
     {\r
-      System.err.print(\r
-          "JALVIEW ERROR! - Unexpected JPred selection state!\n");\r
-    }\r
-  }\r
-\r
-  protected void msaAlignMenuItem_actionPerformed(ActionEvent e)\r
-  {\r
-    // TODO:resolve which menu item was actually selected\r
-    // Now, check we have enough sequences\r
-    SequenceI[] msa = null;\r
-\r
-    if ( (viewport.getSelectionGroup() != null) &&\r
-        (viewport.getSelectionGroup().getSize() > 1))\r
-    {\r
-      // JBPNote UGLY! To prettify, make SequenceGroup and Alignment conform to some common interface!\r
-      SequenceGroup seqs = viewport.getSelectionGroup();\r
-      int sz;\r
-      msa = new SequenceI[sz = seqs.getSize()];\r
-\r
-      for (int i = 0; i < sz; i++)\r
+      if (seq != null)\r
       {\r
-        msa[i] = (SequenceI) seqs.getSequenceAt(i);\r
-      }\r
-    }\r
-    else\r
-    {\r
-      Vector seqs = viewport.getAlignment().getSequences();\r
-\r
-      if (seqs.size() > 1)\r
-      {\r
-        msa = new SequenceI[seqs.size()];\r
-\r
-        for (int i = 0; i < seqs.size(); i++)\r
-        {\r
-          msa[i] = (SequenceI) seqs.elementAt(i);\r
-        }\r
+        return new SequenceI[]\r
+            {\r
+            seq};\r
       }\r
     }\r
-\r
-    if (msa != null)\r
-    {\r
-      MsaWSClient ct = new jalview.ws.MsaWSClient("MuscleWS", title, msa,\r
-                                                  false, true);\r
-    }\r
+    return null;\r
   }\r
-\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param e DOCUMENT ME!\r
+   */\r
   protected void LoadtreeMenuItem_actionPerformed(ActionEvent e)\r
   {\r
     // Pick the tree file\r
@@ -1568,7 +2096,7 @@ public class AlignFrame
       {\r
         jalview.io.NewickFile fin = new jalview.io.NewickFile(choice,\r
             "File");\r
-        viewport.setCurrentTree( ShowNewickTree(fin, choice).getTree() );\r
+        viewport.setCurrentTree(ShowNewickTree(fin, choice).getTree());\r
       }\r
       catch (Exception ex)\r
       {\r
@@ -1581,18 +2109,28 @@ public class AlignFrame
     }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param nf DOCUMENT ME!\r
+   * @param title DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
   public TreePanel ShowNewickTree(NewickFile nf, String title)\r
   {\r
     TreePanel tp = null;\r
+\r
     try\r
     {\r
       nf.parse();\r
+\r
       if (nf.getTree() != null)\r
       {\r
         tp = new TreePanel(viewport,\r
-                                     viewport.getAlignment().getSequences(), nf,\r
-                                     "FromFile",\r
-                                     title);\r
+                           viewport.getAlignment().getSequences(), nf,\r
+                           "FromFile",\r
+                           title);\r
         Desktop.addInternalFrame(tp, title, 600, 500);\r
         addTreeMenuItem(tp, title);\r
       }\r
@@ -1601,6 +2139,7 @@ public class AlignFrame
     {\r
       ex.printStackTrace();\r
     }\r
+\r
     return tp;\r
   }\r
 \r
@@ -1626,4 +2165,111 @@ public class AlignFrame
       }\r
     }\r
   }\r
+\r
+  /**\r
+   * Generates menu items and listener event actions for web service clients\r
+   *\r
+   */\r
+  public void BuildWebServiceMenu()\r
+  {\r
+    if ( (Desktop.discoverer.services != null)\r
+        && (Desktop.discoverer.services.size() > 0))\r
+    {\r
+      Vector msaws = (Vector) Desktop.discoverer.services.get("MsaWS");\r
+      Vector secstrpr = (Vector) Desktop.discoverer.services.get("SecStrPred");\r
+      Vector wsmenu = new Vector();\r
+      if (msaws != null)\r
+      {\r
+        // Add any Multiple Sequence Alignment Services\r
+        final JMenu msawsmenu = new JMenu("Alignment");\r
+        for (int i = 0, j = msaws.size(); i < j; i++)\r
+        {\r
+          final ext.vamsas.ServiceHandle sh = (ext.vamsas.ServiceHandle) msaws.\r
+              get(i);\r
+          final JMenuItem method = new JMenuItem(sh.getName());\r
+          method.addActionListener(new ActionListener()\r
+          {\r
+            public void actionPerformed(ActionEvent e)\r
+            {\r
+              SequenceI[] msa = gatherSequencesForAlignment();\r
+              MsaWSClient ct = new jalview.ws.MsaWSClient(sh, title, msa,\r
+                  false, true);\r
+\r
+            }\r
+\r
+          });\r
+          msawsmenu.add(method);\r
+          // Deal with services that we know accept partial alignments.\r
+          if (sh.getName().indexOf("lustal") > -1)\r
+          {\r
+            // We know that ClustalWS can accept partial alignments for refinement.\r
+            final JMenuItem methodR = new JMenuItem(sh.getName()+" Realign");\r
+            methodR.addActionListener(new ActionListener()\r
+            {\r
+              public void actionPerformed(ActionEvent e)\r
+              {\r
+                SequenceI[] msa = gatherSequencesForAlignment();\r
+                MsaWSClient ct = new jalview.ws.MsaWSClient(sh, title, msa,\r
+                    true, true);\r
+\r
+              }\r
+\r
+            });\r
+            msawsmenu.add(methodR);\r
+\r
+          }\r
+        }\r
+        wsmenu.add(msawsmenu);\r
+      }\r
+      if (secstrpr != null)\r
+      {\r
+        // Add any secondary structure prediction services\r
+        final JMenu secstrmenu = new JMenu("Secondary Structure Prediction");\r
+        for (int i = 0, j = secstrpr.size(); i < j; i++)\r
+        {\r
+          final ext.vamsas.ServiceHandle sh = (ext.vamsas.ServiceHandle)\r
+              secstrpr.get(i);\r
+          final JMenuItem method = new JMenuItem(sh.getName());\r
+          method.addActionListener(new ActionListener()\r
+          {\r
+            public void actionPerformed(ActionEvent e)\r
+            {\r
+              SequenceI[] msa = gatherSeqOrMsaForSecStrPrediction();\r
+              if (msa.length == 1)\r
+              {\r
+                // Single Sequence prediction\r
+                jalview.ws.JPredClient ct = new jalview.ws.JPredClient(sh,\r
+                    title, msa[0]);\r
+              }\r
+              else\r
+              {\r
+                if (msa.length > 1)\r
+                {\r
+                  // Single Sequence prediction\r
+                  jalview.ws.JPredClient ct = new jalview.ws.JPredClient(sh,\r
+                      title, msa);\r
+                }\r
+              }\r
+            }\r
+          });\r
+          secstrmenu.add(method);\r
+        }\r
+        wsmenu.add(secstrmenu);\r
+      }\r
+      this.webService.removeAll();\r
+      for (int i = 0, j = wsmenu.size(); i < j; i++)\r
+      {\r
+        webService.add( (JMenu) wsmenu.get(i));\r
+      }\r
+    }\r
+    else\r
+    {\r
+      this.webService.removeAll();\r
+      this.webService.add(this.webServiceNoServices);\r
+    }\r
+    // TODO: add in rediscovery function\r
+    // TODO: reduce code redundancy.\r
+    // TODO: group services by location as well as function.\r
+  }\r
+\r
 }\r