JAL-845 further code/tests/refactoring
[jalview.git] / src / jalview / gui / AlignViewport.java
index 98cae4c..676d180 100644 (file)
@@ -1,19 +1,22 @@
 /*
- * 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.8.2)
+ * Copyright (C) 2014 The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * 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.
- * 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
  * 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/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 /*
  * Jalview - A Sequence Alignment Editor and Viewer
  */
 package jalview.gui;
 
-import java.util.*;
-
-import java.awt.*;
-
-import jalview.analysis.*;
-import jalview.api.StructureSelectionManagerProvider;
-
-import jalview.bin.*;
-
-import jalview.datamodel.*;
-
-import jalview.schemes.*;
+import jalview.analysis.AlignmentUtils;
+import jalview.analysis.AlignmentUtils.MappingResult;
+import jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
+import jalview.analysis.NJTree;
+import jalview.api.AlignViewportI;
+import jalview.bin.Cache;
+import jalview.commands.CommandI;
+import jalview.datamodel.Alignment;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.PDBEntry;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.schemes.ColourSchemeProperty;
+import jalview.schemes.UserColourScheme;
+import jalview.structure.CommandListener;
 import jalview.structure.SelectionSource;
 import jalview.structure.StructureSelectionManager;
 import jalview.structure.VamsasSource;
+import jalview.util.MessageManager;
+import jalview.util.StringUtils;
+import jalview.viewmodel.AlignmentViewport;
+import jalview.ws.params.AutoCalcSetting;
+
+import java.awt.Color;
+import java.awt.Container;
+import java.awt.Font;
+import java.awt.Rectangle;
+import java.util.ArrayDeque;
+import java.util.ArrayList;
+import java.util.Deque;
+import java.util.Hashtable;
+import java.util.Set;
+import java.util.Vector;
+
+import javax.swing.JInternalFrame;
+import javax.swing.JOptionPane;
 
 /**
  * DOCUMENT ME!
@@ -57,10 +83,9 @@ import jalview.structure.VamsasSource;
  * @author $author$
  * @version $Revision: 1.141 $
  */
-public class AlignViewport implements SelectionSource, VamsasSource
+public class AlignViewport extends AlignmentViewport implements
+        SelectionSource, VamsasSource, AlignViewportI, CommandListener
 {
-  private static final int RIGHT_JUSTIFY = 1;
-
   int startRes;
 
   int endRes;
@@ -85,15 +110,7 @@ public class AlignViewport implements SelectionSource, VamsasSource
 
   boolean showAnnotation = true;
 
-  boolean colourAppliesToAllGroups = true;
-
-  ColourSchemeI globalColourScheme = null;
-
-  boolean conservationColourSelected = false;
-
-  boolean abovePIDThreshold = false;
-
-  SequenceGroup selectionGroup;
+  SequenceAnnotationOrder sortAnnotationsBy = null;
 
   int charHeight;
 
@@ -107,14 +124,6 @@ public class AlignViewport implements SelectionSource, VamsasSource
 
   boolean seqNameItalics;
 
-  AlignmentI alignment;
-
-  ColumnSelection colSel = new ColumnSelection();
-
-  int threshold;
-
-  int increment;
-
   NJTree currentTree = null;
 
   boolean scaleAboveWrapped = false;
@@ -123,10 +132,6 @@ public class AlignViewport implements SelectionSource, VamsasSource
 
   boolean scaleRightWrapped = true;
 
-  boolean hasHiddenColumns = false;
-
-  boolean hasHiddenRows = false;
-
   boolean showHiddenMarkers = true;
 
   boolean cursorMode = false;
@@ -137,56 +142,17 @@ public class AlignViewport implements SelectionSource, VamsasSource
    */
   Hashtable featuresDisplayed = null;
 
-  /** DOCUMENT ME!! */
-  public Hashtable[] hconsensus;
-  
-  public Hashtable[] hStrucConsensus;
-  
-  AlignmentAnnotation consensus;
-  
-  AlignmentAnnotation strucConsensus;
-
-  AlignmentAnnotation conservation;
-
-  AlignmentAnnotation quality;
-
-  AlignmentAnnotation[] groupConsensus;
-
-  AlignmentAnnotation[] groupConservation;
-
-  boolean autoCalculateConsensus = true;
-  
-  boolean autoCalculateStrucConsensus = true;
-
-
-  /** DOCUMENT ME!! */
-  public int ConsPercGaps = 25; // JBPNote : This should be a scalable property!
-
-  // JBPNote Prolly only need this in the applet version.
-  private java.beans.PropertyChangeSupport changeSupport = new java.beans.PropertyChangeSupport(
-          this);
-
-  boolean ignoreGapsInConsensusCalculation = false;
-
-  boolean isDataset = false;
-
   boolean antiAlias = false;
 
-  boolean padGaps = false;
-
   Rectangle explodedPosition;
 
   String viewName;
 
-  String sequenceSetID;
-
   boolean gatherViewsHere = false;
 
-  Stack historyList = new Stack();
+  private Deque<CommandI> historyList = new ArrayDeque<CommandI>();
 
-  Stack redoList = new Stack();
-
-  Hashtable sequenceColours;
+  private Deque<CommandI> redoList = new ArrayDeque<CommandI>();
 
   int thresholdTextColour = 0;
 
@@ -196,10 +162,6 @@ public class AlignViewport implements SelectionSource, VamsasSource
 
   boolean rightAlignIds = false;
 
-  Hashtable hiddenRepSequences;
-
-  boolean sortByTree;
-
   /**
    * Creates a new AlignViewport object.
    * 
@@ -341,7 +303,7 @@ public class AlignViewport implements SelectionSource, VamsasSource
     centreColumnLabels = Cache.getDefault("CENTRE_COLUMN_LABELS", false);
     autoCalculateConsensus = Cache.getDefault("AUTO_CALC_CONSENSUS", true);
 
-    padGaps = Cache.getDefault("PAD_GAPS", true);
+    setPadGaps(Cache.getDefault("PAD_GAPS", true));
     shownpfeats = Cache.getDefault("SHOW_NPFEATS_TOOLTIP", true);
     showdbrefs = Cache.getDefault("SHOW_DBREFS_TOOLTIP", true);
 
@@ -373,53 +335,20 @@ public class AlignViewport implements SelectionSource, VamsasSource
     {
       if (!alignment.isNucleotide())
       {
-        conservation = new AlignmentAnnotation("Conservation",
-                "Conservation of total alignment less than " + ConsPercGaps
-                        + "% gaps", new Annotation[1], 0f, 11f,
-                AlignmentAnnotation.BAR_GRAPH);
-        conservation.hasText = true;
-        conservation.autoCalculated = true;
-
-        if (Cache.getDefault("SHOW_CONSERVATION", true))
-        {
-          alignment.addAnnotation(conservation);
-        }
-
-        if (Cache.getDefault("SHOW_QUALITY", true))
-        {
-          quality = new AlignmentAnnotation("Quality",
-                  "Alignment Quality based on Blosum62 scores",
-                  new Annotation[1], 0f, 11f, AlignmentAnnotation.BAR_GRAPH);
-          quality.hasText = true;
-          quality.autoCalculated = true;
-
-          alignment.addAnnotation(quality);
-        }
+        showConservation = Cache.getDefault("SHOW_CONSERVATION", true);
+        showQuality = Cache.getDefault("SHOW_QUALITY", true);
         showGroupConservation = Cache.getDefault("SHOW_GROUP_CONSERVATION",
                 false);
-
-        {
-
-        }
       }
       showConsensusHistogram = Cache.getDefault("SHOW_CONSENSUS_HISTOGRAM",
               true);
       showSequenceLogo = Cache.getDefault("SHOW_CONSENSUS_LOGO", false);
+      normaliseSequenceLogo = Cache.getDefault("NORMALISE_CONSENSUS_LOGO",
+              false);
       showGroupConsensus = Cache.getDefault("SHOW_GROUP_CONSENSUS", false);
-      // TODO: add menu option action that nulls or creates consensus object
-      // depending on if the user wants to see the annotation or not in a
-      // specific alignment
-      consensus = new AlignmentAnnotation("Consensus", "PID",
-              new Annotation[1], 0f, 100f, AlignmentAnnotation.BAR_GRAPH);
-      consensus.hasText = true;
-      consensus.autoCalculated = true;
-
-      if (Cache.getDefault("SHOW_IDENTITY", true))
-      {
-        alignment.addAnnotation(consensus);
-      }
+      showConsensus = Cache.getDefault("SHOW_IDENTITY", true);
     }
-
+    initAutoAnnotation();
     if (jalview.bin.Cache.getProperty("DEFAULT_COLOUR") != null)
     {
       globalColourScheme = ColourSchemeProperty.getColour(alignment,
@@ -438,12 +367,15 @@ public class AlignViewport implements SelectionSource, VamsasSource
       }
     }
 
-    wrapAlignment = jalview.bin.Cache.getDefault("WRAP_ALIGNMENT", false);
-    showUnconserved = jalview.bin.Cache.getDefault("SHOW_UNCONSERVED",
-            false);
-    sortByTree = jalview.bin.Cache.getDefault("SORT_BY_TREE", false);
-    followSelection = jalview.bin.Cache.getDefault("FOLLOW_SELECTIONS",
-            true);
+    wrapAlignment = Cache.getDefault("WRAP_ALIGNMENT", false);
+    showUnconserved = Cache.getDefault("SHOW_UNCONSERVED", false);
+    sortByTree = Cache.getDefault("SORT_BY_TREE", false);
+    followSelection = Cache.getDefault("FOLLOW_SELECTIONS", true);
+    sortAnnotationsBy = SequenceAnnotationOrder.valueOf(Cache.getDefault(
+            Preferences.SORT_ANNOTATIONS,
+            SequenceAnnotationOrder.NONE.name()));
+    showAutocalculatedAbove = Cache.getDefault(
+            Preferences.SHOW_AUTOCALC_ABOVE, false);
   }
 
   /**
@@ -462,26 +394,6 @@ public class AlignViewport implements SelectionSource, VamsasSource
     return showSequenceFeatures;
   }
 
-  ConservationThread conservationThread;
-
-  ConsensusThread consensusThread;
-  
-  StrucConsensusThread strucConsensusThread;
-
-  boolean consUpdateNeeded = false;
-
-  static boolean UPDATING_CONSENSUS = false;
-  
-  static boolean UPDATING_STRUC_CONSENSUS = false;
-
-  static boolean UPDATING_CONSERVATION = false;
-
-  boolean updatingConsensus = false;
-  
-  boolean updatingStrucConsensus = false;
-
-  boolean updatingConservation = false;
-
   /**
    * centre columnar annotation labels in displayed alignment annotation TODO:
    * add to jalviewXML and annotation display settings
@@ -492,240 +404,7 @@ public class AlignViewport implements SelectionSource, VamsasSource
 
   private boolean shownpfeats;
 
-  /**
-   * trigger update of conservation annotation
-   */
-  public void updateConservation(final AlignmentPanel ap)
-  {
-    // see note in mantis : issue number 8585
-    if (alignment.isNucleotide() || conservation == null
-            || !autoCalculateConsensus)
-    {
-      return;
-    }
-
-    conservationThread = new ConservationThread(this, ap);
-    conservationThread.start();
-  }
-
-  /**
-   * trigger update of consensus annotation
-   */
-  public void updateConsensus(final AlignmentPanel ap)
-  {
-    // see note in mantis : issue number 8585
-    if (consensus == null || !autoCalculateConsensus)
-    {
-      return;
-    }
-    consensusThread = new ConsensusThread(ap);
-    consensusThread.start();
-  }
-
-  class ConsensusThread extends Thread
-  {
-    AlignmentPanel ap;
-
-    public ConsensusThread(AlignmentPanel ap)
-    {
-      this.ap = ap;
-    }
-
-    public void run()
-    {
-      updatingConsensus = true;
-      while (UPDATING_CONSENSUS)
-      {
-        try
-        {
-          if (ap != null)
-          {
-            ap.paintAlignment(false);
-          }
-
-          Thread.sleep(200);
-        } catch (Exception ex)
-        {
-          ex.printStackTrace();
-        }
-      }
-
-      UPDATING_CONSENSUS = true;
-
-      try
-      {
-        int aWidth = (alignment != null) ? alignment.getWidth() : -1; // null
-        // pointer
-        // possibility
-        // here.
-        if (aWidth <= 0)
-        {
-          updatingConsensus = false;
-          UPDATING_CONSENSUS = false;
-          return;
-        }
-
-        consensus.annotations = null;
-        consensus.annotations = new Annotation[aWidth];
-
-        hconsensus = new Hashtable[aWidth];
-        AAFrequency.calculate(alignment.getSequencesArray(), 0,
-                alignment.getWidth(), hconsensus, true);
-        updateAnnotation(true);
-        if (globalColourScheme != null)
-        {
-          globalColourScheme.setConsensus(hconsensus);
-        }
-
-      } catch (OutOfMemoryError error)
-      {
-        alignment.deleteAnnotation(consensus);
-
-        consensus = null;
-        hconsensus = null;
-        new OOMWarning("calculating consensus", error);
-      }
-      UPDATING_CONSENSUS = false;
-      updatingConsensus = false;
-
-      if (ap != null)
-      {
-        ap.paintAlignment(true);
-      }
-    }
-
-    /**
-     * update the consensus annotation from the sequence profile data using
-     * current visualization settings.
-     */
-    public void updateAnnotation()
-    {
-      updateAnnotation(false);
-    }
-
-    protected void updateAnnotation(boolean immediate)
-    {
-      // TODO: make calls thread-safe, so if another thread calls this method,
-      // it will either return or wait until one calculation is finished.
-      if (immediate
-              || (!updatingConsensus && consensus != null && hconsensus != null))
-      {
-        AAFrequency.completeConsensus(consensus, hconsensus, 0,
-                hconsensus.length, ignoreGapsInConsensusCalculation,
-                showSequenceLogo);
-      }
-    }
-  }
-  
-  //--------START Structure Conservation
-  public void updateStrucConsensus(final AlignmentPanel ap)
-  {
-    // see note in mantis : issue number 8585
-    if (strucConsensus == null || !autoCalculateStrucConsensus)
-    {
-      return;
-    }
-    strucConsensusThread = new StrucConsensusThread(ap);
-    strucConsensusThread.start();
-  }
-
-  class StrucConsensusThread extends Thread
-  {
-    AlignmentPanel ap;
-
-    public StrucConsensusThread(AlignmentPanel ap)
-    {
-      this.ap = ap;
-    }
-
-    public void run()
-    {
-      updatingStrucConsensus = true;
-      while (UPDATING_STRUC_CONSENSUS)
-      {
-        try
-        {
-          if (ap != null)
-          {
-            ap.paintAlignment(false);
-          }
-
-          Thread.sleep(200);
-        } catch (Exception ex)
-        {
-          ex.printStackTrace();
-        }
-      }
-
-      UPDATING_STRUC_CONSENSUS = true;
-
-      try
-      {
-        int aWidth = (alignment != null) ? alignment.getWidth() : -1; // null
-        // pointer
-        // possibility
-        // here.
-        if (aWidth <= 0)
-        {
-          updatingStrucConsensus = false;
-          UPDATING_STRUC_CONSENSUS = false;
-          return;
-        }
-
-        strucConsensus.annotations = null;
-        strucConsensus.annotations = new Annotation[aWidth];
-
-        hStrucConsensus = new Hashtable[aWidth];
-        AlignmentAnnotation rna = ap.av.getAlignment().getAlignmentAnnotation()[0];
-        StructureFrequency.calculate(alignment.getSequencesArray(), 0,
-                alignment.getWidth(), hStrucConsensus, true, rna);
-        //TODO AlignmentAnnotation rnaStruc!!!
-        updateAnnotation(true);
-        if (globalColourScheme != null)
-        {
-          globalColourScheme.setConsensus(hStrucConsensus);
-        }
-
-      } catch (OutOfMemoryError error)
-      {
-        alignment.deleteAnnotation(consensus);
-
-        strucConsensus = null;
-        hStrucConsensus = null;
-        new OOMWarning("calculating structure consensus", error);
-      }
-      UPDATING_STRUC_CONSENSUS = false;
-      updatingStrucConsensus = false;
-
-      if (ap != null)
-      {
-        ap.paintAlignment(true);
-      }
-    }
-
-    /**
-     * update the consensus annotation from the sequence profile data using
-     * current visualization settings.
-     */
-    public void updateAnnotation()
-    {
-      updateAnnotation(false);
-    }
-
-    protected void updateAnnotation(boolean immediate)
-    {
-      // TODO: make calls thread-safe, so if another thread calls this method,
-      // it will either return or wait until one calculation is finished.
-      if (immediate
-              || (!updatingConsensus && consensus != null && hconsensus != null))
-      {
-        StructureFrequency.completeConsensus(strucConsensus, hStrucConsensus, 0,
-                hStrucConsensus.length, ignoreGapsInConsensusCalculation,
-                showSequenceLogo);
-      }
-    }
-  }
-  //--------END   Structure Conservation
+  // --------END Structure Conservation
 
   /**
    * get the consensus sequence as displayed under the PID consensus annotation
@@ -766,66 +445,6 @@ public class AlignViewport implements SelectionSource, VamsasSource
   }
 
   /**
-   * 
-   * 
-   * @return null or the currently selected sequence region
-   */
-  public SequenceGroup getSelectionGroup()
-  {
-    return selectionGroup;
-  }
-
-  /**
-   * Set the selection group for this window.
-   * 
-   * @param sg - group holding references to sequences in this alignment view
-   *          
-   */
-  public void setSelectionGroup(SequenceGroup sg)
-  {
-    selectionGroup = sg;
-  }
-
-  /**
-   * GUI state
-   * @return true if conservation based shading is enabled
-   */
-  public boolean getConservationSelected()
-  {
-    return conservationColourSelected;
-  }
-
-  /**
-   * GUI state
-   * @param b
-   *          enable conservation based shading
-   */
-  public void setConservationSelected(boolean b)
-  {
-    conservationColourSelected = b;
-  }
-
-  /**
-   * GUI state
-   * @return true if percent identity threshold is applied to shading
-   */
-  public boolean getAbovePIDThreshold()
-  {
-    return abovePIDThreshold;
-  }
-
-  /**
-   * GUI state
-   * 
-   * 
-   * @param b indicate if percent identity threshold is applied to shading
-   */
-  public void setAbovePIDThreshold(boolean b)
-  {
-    abovePIDThreshold = b;
-  }
-
-  /**
    * DOCUMENT ME!
    * 
    * @return DOCUMENT ME!
@@ -858,27 +477,6 @@ public class AlignViewport implements SelectionSource, VamsasSource
   /**
    * DOCUMENT ME!
    * 
-   * @param cs
-   *          DOCUMENT ME!
-   */
-  public void setGlobalColourScheme(ColourSchemeI cs)
-  {
-    globalColourScheme = cs;
-  }
-
-  /**
-   * DOCUMENT ME!
-   * 
-   * @return DOCUMENT ME!
-   */
-  public ColourSchemeI getGlobalColourScheme()
-  {
-    return globalColourScheme;
-  }
-
-  /**
-   * DOCUMENT ME!
-   * 
    * @param res
    *          DOCUMENT ME!
    */
@@ -1063,14 +661,14 @@ public class AlignViewport implements SelectionSource, VamsasSource
   {
     if (alignment != null && alignment.getCodonFrames() != null)
     {
-      StructureSelectionManager.getStructureSelectionManager(Desktop.instance)
-              .removeMappings(alignment.getCodonFrames());
+      StructureSelectionManager.getStructureSelectionManager(
+              Desktop.instance).removeMappings(alignment.getCodonFrames());
     }
     this.alignment = align;
-    if (alignment.getCodonFrames() != null)
+    if (alignment != null && alignment.getCodonFrames() != null)
     {
-      StructureSelectionManager.getStructureSelectionManager(Desktop.instance).addMappings(
-              alignment.getCodonFrames());
+      StructureSelectionManager.getStructureSelectionManager(
+              Desktop.instance).addMappings(alignment.getCodonFrames());
     }
   }
 
@@ -1196,33 +794,22 @@ public class AlignViewport implements SelectionSource, VamsasSource
   /**
    * DOCUMENT ME!
    * 
-   * @param thresh
-   *          DOCUMENT ME!
-   */
-  public void setThreshold(int thresh)
-  {
-    threshold = thresh;
-  }
-
-  /**
-   * DOCUMENT ME!
-   * 
    * @return DOCUMENT ME!
    */
-  public int getThreshold()
+  public ColumnSelection getColumnSelection()
   {
-    return threshold;
+    return colSel;
   }
 
   /**
    * DOCUMENT ME!
    * 
-   * @param inc
+   * @param tree
    *          DOCUMENT ME!
    */
-  public void setIncrement(int inc)
+  public void setCurrentTree(NJTree tree)
   {
-    increment = inc;
+    currentTree = tree;
   }
 
   /**
@@ -1230,9 +817,9 @@ public class AlignViewport implements SelectionSource, VamsasSource
    * 
    * @return DOCUMENT ME!
    */
-  public int getIncrement()
+  public NJTree getCurrentTree()
   {
-    return increment;
+    return currentTree;
   }
 
   /**
@@ -1240,20 +827,20 @@ public class AlignViewport implements SelectionSource, VamsasSource
    * 
    * @return DOCUMENT ME!
    */
-  public ColumnSelection getColumnSelection()
+  public boolean getShowJVSuffix()
   {
-    return colSel;
+    return showJVSuffix;
   }
 
   /**
    * DOCUMENT ME!
    * 
-   * @param tree
+   * @param b
    *          DOCUMENT ME!
    */
-  public void setCurrentTree(NJTree tree)
+  public void setShowJVSuffix(boolean b)
   {
-    currentTree = tree;
+    showJVSuffix = b;
   }
 
   /**
@@ -1261,9 +848,9 @@ public class AlignViewport implements SelectionSource, VamsasSource
    * 
    * @return DOCUMENT ME!
    */
-  public NJTree getCurrentTree()
+  public boolean getShowAnnotation()
   {
-    return currentTree;
+    return showAnnotation;
   }
 
   /**
@@ -1272,9 +859,9 @@ public class AlignViewport implements SelectionSource, VamsasSource
    * @param b
    *          DOCUMENT ME!
    */
-  public void setColourAppliesToAllGroups(boolean b)
+  public void setShowAnnotation(boolean b)
   {
-    colourAppliesToAllGroups = b;
+    showAnnotation = b;
   }
 
   /**
@@ -1282,9 +869,9 @@ public class AlignViewport implements SelectionSource, VamsasSource
    * 
    * @return DOCUMENT ME!
    */
-  public boolean getColourAppliesToAllGroups()
+  public boolean getScaleAboveWrapped()
   {
-    return colourAppliesToAllGroups;
+    return scaleAboveWrapped;
   }
 
   /**
@@ -1292,67 +879,15 @@ public class AlignViewport implements SelectionSource, VamsasSource
    * 
    * @return DOCUMENT ME!
    */
-  public boolean getShowJVSuffix()
+  public boolean getScaleLeftWrapped()
   {
-    return showJVSuffix;
+    return scaleLeftWrapped;
   }
 
   /**
    * DOCUMENT ME!
    * 
-   * @param b
-   *          DOCUMENT ME!
-   */
-  public void setShowJVSuffix(boolean b)
-  {
-    showJVSuffix = b;
-  }
-
-  /**
-   * DOCUMENT ME!
-   * 
-   * @return DOCUMENT ME!
-   */
-  public boolean getShowAnnotation()
-  {
-    return showAnnotation;
-  }
-
-  /**
-   * DOCUMENT ME!
-   * 
-   * @param b
-   *          DOCUMENT ME!
-   */
-  public void setShowAnnotation(boolean b)
-  {
-    showAnnotation = b;
-  }
-
-  /**
-   * DOCUMENT ME!
-   * 
-   * @return DOCUMENT ME!
-   */
-  public boolean getScaleAboveWrapped()
-  {
-    return scaleAboveWrapped;
-  }
-
-  /**
-   * DOCUMENT ME!
-   * 
-   * @return DOCUMENT ME!
-   */
-  public boolean getScaleLeftWrapped()
-  {
-    return scaleLeftWrapped;
-  }
-
-  /**
-   * DOCUMENT ME!
-   * 
-   * @return DOCUMENT ME!
+   * @return DOCUMENT ME!
    */
   public boolean getScaleRightWrapped()
   {
@@ -1384,572 +919,32 @@ public class AlignViewport implements SelectionSource, VamsasSource
   /**
    * DOCUMENT ME!
    * 
-   * @param b
-   *          DOCUMENT ME!
-   */
-  public void setScaleRightWrapped(boolean b)
-  {
-    scaleRightWrapped = b;
-  }
-
-  /**
-   * Property change listener for changes in alignment
-   * 
-   * @param listener
-   *          DOCUMENT ME!
-   */
-  public void addPropertyChangeListener(
-          java.beans.PropertyChangeListener listener)
-  {
-    changeSupport.addPropertyChangeListener(listener);
-  }
-
-  /**
-   * DOCUMENT ME!
-   * 
-   * @param listener
-   *          DOCUMENT ME!
-   */
-  public void removePropertyChangeListener(
-          java.beans.PropertyChangeListener listener)
-  {
-    changeSupport.removePropertyChangeListener(listener);
-  }
-
-  /**
-   * Property change listener for changes in alignment
-   * 
-   * @param prop
-   *          DOCUMENT ME!
-   * @param oldvalue
-   *          DOCUMENT ME!
-   * @param newvalue
-   *          DOCUMENT ME!
-   */
-  public void firePropertyChange(String prop, Object oldvalue,
-          Object newvalue)
-  {
-    changeSupport.firePropertyChange(prop, oldvalue, newvalue);
-  }
-
-  public void setIgnoreGapsConsensus(boolean b, AlignmentPanel ap)
-  {
-    ignoreGapsInConsensusCalculation = b;
-    updateConsensus(ap);
-    if (globalColourScheme != null)
-    {
-      globalColourScheme.setThreshold(globalColourScheme.getThreshold(),
-              ignoreGapsInConsensusCalculation);
-    }
-  }
-
-  public boolean getIgnoreGapsConsensus()
-  {
-    return ignoreGapsInConsensusCalculation;
-  }
-
-  public void setDataset(boolean b)
-  {
-    isDataset = b;
-  }
-
-  public boolean isDataset()
-  {
-    return isDataset;
-  }
-
-  public void hideSelectedColumns()
-  {
-    if (colSel.size() < 1)
-    {
-      return;
-    }
-
-    colSel.hideSelectedColumns();
-    setSelectionGroup(null);
-
-    hasHiddenColumns = true;
-  }
-
-  public void hideColumns(int start, int end)
-  {
-    if (start == end)
-    {
-      colSel.hideColumns(start);
-    }
-    else
-    {
-      colSel.hideColumns(start, end);
-    }
-
-    hasHiddenColumns = true;
-  }
-
-  public void hideRepSequences(SequenceI repSequence, SequenceGroup sg)
-  {
-    int sSize = sg.getSize();
-    if (sSize < 2)
-    {
-      return;
-    }
-
-    if (hiddenRepSequences == null)
-    {
-      hiddenRepSequences = new Hashtable();
-    }
-
-    hiddenRepSequences.put(repSequence, sg);
-
-    // Hide all sequences except the repSequence
-    SequenceI[] seqs = new SequenceI[sSize - 1];
-    int index = 0;
-    for (int i = 0; i < sSize; i++)
-    {
-      if (sg.getSequenceAt(i) != repSequence)
-      {
-        if (index == sSize - 1)
-        {
-          return;
-        }
-
-        seqs[index++] = sg.getSequenceAt(i);
-      }
-    }
-    sg.setSeqrep(repSequence);
-    sg.setHidereps(true);
-    hideSequence(seqs);
-
-  }
-
-  public void hideAllSelectedSeqs()
-  {
-    if (selectionGroup == null || selectionGroup.getSize() < 1)
-    {
-      return;
-    }
-
-    SequenceI[] seqs = selectionGroup.getSequencesInOrder(alignment);
-
-    hideSequence(seqs);
-
-    setSelectionGroup(null);
-  }
-
-  public void hideSequence(SequenceI[] seq)
-  {
-    if (seq != null)
-    {
-      for (int i = 0; i < seq.length; i++)
-      {
-        alignment.getHiddenSequences().hideSequence(seq[i]);
-      }
-      hasHiddenRows = true;
-      firePropertyChange("alignment", null, alignment.getSequences());
-    }
-  }
-
-  public void showSequence(int index)
-  {
-    Vector tmp = alignment.getHiddenSequences().showSequence(index,
-            hiddenRepSequences);
-    if (tmp.size() > 0)
-    {
-      if (selectionGroup == null)
-      {
-        selectionGroup = new SequenceGroup();
-        selectionGroup.setEndRes(alignment.getWidth() - 1);
-      }
-
-      for (int t = 0; t < tmp.size(); t++)
-      {
-        selectionGroup.addSequence((SequenceI) tmp.elementAt(t), false);
-      }
-      firePropertyChange("alignment", null, alignment.getSequences());
-      sendSelection();
-    }
-
-    if (alignment.getHiddenSequences().getSize() < 1)
-    {
-      hasHiddenRows = false;
-    }
-  }
-
-  public void showColumn(int col)
-  {
-    colSel.revealHiddenColumns(col);
-    if (colSel.getHiddenColumns() == null)
-    {
-      hasHiddenColumns = false;
-    }
-  }
-
-  public void showAllHiddenColumns()
-  {
-    colSel.revealAllHiddenColumns();
-    hasHiddenColumns = false;
-  }
-
-  public void showAllHiddenSeqs()
-  {
-    if (alignment.getHiddenSequences().getSize() > 0)
-    {
-      if (selectionGroup == null)
-      {
-        selectionGroup = new SequenceGroup();
-        selectionGroup.setEndRes(alignment.getWidth() - 1);
-      }
-      Vector tmp = alignment.getHiddenSequences().showAll(
-              hiddenRepSequences);
-      for (int t = 0; t < tmp.size(); t++)
-      {
-        selectionGroup.addSequence((SequenceI) tmp.elementAt(t), false);
-      }
-      firePropertyChange("alignment", null, alignment.getSequences());
-      sendSelection();
-      hasHiddenRows = false;
-      hiddenRepSequences = null;
-    }
-  }
-
-  public void invertColumnSelection()
-  {
-    colSel.invertColumnSelection(0, alignment.getWidth());
-  }
-
-  public int adjustForHiddenSeqs(int alignmentIndex)
-  {
-    return alignment.getHiddenSequences().adjustForHiddenSeqs(
-            alignmentIndex);
-  }
-
-  /**
-   * This method returns an array of new SequenceI objects derived from the
-   * whole alignment or just the current selection with start and end points
-   * adjusted
-   * 
-   * @note if you need references to the actual SequenceI objects in the
-   *       alignment or currently selected then use getSequenceSelection()
-   * @return selection as new sequenceI objects
-   */
-  public SequenceI[] getSelectionAsNewSequence()
-  {
-    SequenceI[] sequences;
-
-    if (selectionGroup == null)
-    {
-      sequences = alignment.getSequencesArray();
-      AlignmentAnnotation[] annots = alignment.getAlignmentAnnotation();
-      for (int i = 0; i < sequences.length; i++)
-      {
-        sequences[i] = new Sequence(sequences[i], annots); // construct new
-        // sequence with
-        // subset of visible
-        // annotation
-      }
-    }
-    else
-    {
-      sequences = selectionGroup.getSelectionAsNewSequences(alignment);
-    }
-
-    return sequences;
-  }
-
-  /**
-   * get the currently selected sequence objects or all the sequences in the
-   * alignment.
-   * 
-   * @return array of references to sequence objects
-   */
-  public SequenceI[] getSequenceSelection()
-  {
-    SequenceI[] sequences = null;
-    if (selectionGroup != null)
-    {
-      sequences = selectionGroup.getSequencesInOrder(alignment);
-    }
-    if (sequences == null)
-    {
-      sequences = alignment.getSequencesArray();
-    }
-    return sequences;
-  }
-
-  /**
-   * This method returns the visible alignment as text, as seen on the GUI, ie
-   * if columns are hidden they will not be returned in the result. Use this for
-   * calculating trees, PCA, redundancy etc on views which contain hidden
-   * columns.
-   * 
-   * @return String[]
-   */
-  public jalview.datamodel.CigarArray getViewAsCigars(
-          boolean selectedRegionOnly)
-  {
-    return new jalview.datamodel.CigarArray(alignment, (hasHiddenColumns ? colSel : null), (selectedRegionOnly ? selectionGroup : null));
-  }
-
-  /**
-   * return a compact representation of the current alignment selection to pass
-   * to an analysis function
-   * 
-   * @param selectedOnly
-   *          boolean true to just return the selected view
-   * @return AlignmentView
-   */
-  public jalview.datamodel.AlignmentView getAlignmentView(boolean selectedOnly)
-  {
-    return getAlignmentView(selectedOnly, false);
-  }
-  
-  /**
-   * return a compact representation of the current alignment selection to pass
-   * to an analysis function
-   * 
-   * @param selectedOnly
-   *          boolean true to just return the selected view
-   * @param markGroups
-   *          boolean true to annotate the alignment view with groups on the alignment (and intersecting with selected region if selectedOnly is true) 
-   * @return AlignmentView
-   */
-  public jalview.datamodel.AlignmentView getAlignmentView(boolean selectedOnly, boolean markGroups)
-  {
-    return new AlignmentView(alignment, colSel, selectionGroup, hasHiddenColumns, selectedOnly, markGroups);
-  }
-
-  /**
-   * This method returns the visible alignment as text, as seen on the GUI, ie
-   * if columns are hidden they will not be returned in the result. Use this for
-   * calculating trees, PCA, redundancy etc on views which contain hidden
-   * columns.
-   * 
-   * @return String[]
-   */
-  public String[] getViewAsString(boolean selectedRegionOnly)
-  {
-    String[] selection = null;
-    SequenceI[] seqs = null;
-    int i, iSize;
-    int start = 0, end = 0;
-    if (selectedRegionOnly && selectionGroup != null)
-    {
-      iSize = selectionGroup.getSize();
-      seqs = selectionGroup.getSequencesInOrder(alignment);
-      start = selectionGroup.getStartRes();
-      end = selectionGroup.getEndRes() + 1;
-    }
-    else
-    {
-      iSize = alignment.getHeight();
-      seqs = alignment.getSequencesArray();
-      end = alignment.getWidth();
-    }
-
-    selection = new String[iSize];
-    if (hasHiddenColumns)
-    {
-      selection = colSel.getVisibleSequenceStrings(start, end, seqs);
-    }
-    else
-    {
-      for (i = 0; i < iSize; i++)
-      {
-        selection[i] = seqs[i].getSequenceAsString(start, end);
-      }
-
-    }
-    return selection;
-  }
-
-  public int[][] getVisibleRegionBoundaries(int min, int max)
-  {
-    Vector regions = new Vector();
-    int start = min;
-    int end = max;
-
-    do
-    {
-      if (hasHiddenColumns)
-      {
-        if (start == 0)
-        {
-          start = colSel.adjustForHiddenColumns(start);
-        }
-
-        end = colSel.getHiddenBoundaryRight(start);
-        if (start == end)
-        {
-          end = max;
-        }
-        if (end > max)
-        {
-          end = max;
-        }
-      }
-
-      regions.addElement(new int[]
-      { start, end });
-
-      if (hasHiddenColumns)
-      {
-        start = colSel.adjustForHiddenColumns(end);
-        start = colSel.getHiddenBoundaryLeft(start) + 1;
-      }
-    } while (end < max);
-
-    int[][] startEnd = new int[regions.size()][2];
-
-    regions.copyInto(startEnd);
-
-    return startEnd;
-
-  }
-
-  public boolean getShowHiddenMarkers()
-  {
-    return showHiddenMarkers;
-  }
-
-  public void setShowHiddenMarkers(boolean show)
-  {
-    showHiddenMarkers = show;
-  }
-
-  public String getSequenceSetId()
-  {
-    if (sequenceSetID == null)
-    {
-      sequenceSetID = alignment.hashCode() + "";
-    }
-
-    return sequenceSetID;
-  }
-
-  /**
-   * unique viewId for synchronizing state with stored Jalview Project
-   * 
-   */
-  private String viewId = null;
-
-  public String getViewId()
-  {
-    if (viewId == null)
-    {
-      viewId = this.getSequenceSetId() + "." + this.hashCode() + "";
-    }
-    return viewId;
-  }
-
-  public void alignmentChanged(AlignmentPanel ap)
-  {
-    if (padGaps)
-    {
-      alignment.padGaps();
-    }
-    if (hconsensus != null && autoCalculateConsensus)
-    {
-      updateConservation(ap);
-    }
-    if (autoCalculateConsensus)
-    {
-      updateConsensus(ap);
-    }
-    
-    if(autoCalculateStrucConsensus)
-    {
-       updateStrucConsensus(ap);
-    }
-
-    // Reset endRes of groups if beyond alignment width
-    int alWidth = alignment.getWidth();
-    Vector groups = alignment.getGroups();
-    if (groups != null)
-    {
-      for (int i = 0; i < groups.size(); i++)
-      {
-        SequenceGroup sg = (SequenceGroup) groups.elementAt(i);
-        if (sg.getEndRes() > alWidth)
-        {
-          sg.setEndRes(alWidth - 1);
-        }
-      }
-    }
-
-    if (selectionGroup != null && selectionGroup.getEndRes() > alWidth)
-    {
-      selectionGroup.setEndRes(alWidth - 1);
-    }
-
-    resetAllColourSchemes();
-
-    // alignment.adjustSequenceAnnotations();
+   * @param b
+   *          DOCUMENT ME!
+   */
+  public void setScaleRightWrapped(boolean b)
+  {
+    scaleRightWrapped = b;
   }
 
-  void resetAllColourSchemes()
+  public void setDataset(boolean b)
   {
-    ColourSchemeI cs = globalColourScheme;
-    if (cs != null)
-    {
-      if (cs instanceof ClustalxColourScheme)
-      {
-        ((ClustalxColourScheme) cs).resetClustalX(alignment.getSequences(),
-                alignment.getWidth());
-      }
-
-      cs.setConsensus(hconsensus);
-      if (cs.conservationApplied())
-      {
-        Alignment al = (Alignment) alignment;
-        Conservation c = new Conservation("All",
-                ResidueProperties.propHash, 3, al.getSequences(), 0,
-                al.getWidth() - 1);
-        c.calculate();
-        c.verdict(false, ConsPercGaps);
-
-        cs.setConservation(c);
-      }
-    }
-
-    int s, sSize = alignment.getGroups().size();
-    for (s = 0; s < sSize; s++)
-    {
-      SequenceGroup sg = (SequenceGroup) alignment.getGroups().elementAt(s);
-      if (sg.cs != null && sg.cs instanceof ClustalxColourScheme)
-      {
-        ((ClustalxColourScheme) sg.cs).resetClustalX(
-                sg.getSequences(hiddenRepSequences), sg.getWidth());
-      }
-      sg.recalcConservation();
-    }
+    isDataset = b;
   }
 
-  public Color getSequenceColour(SequenceI seq)
+  public boolean isDataset()
   {
-    if (sequenceColours == null || !sequenceColours.containsKey(seq))
-    {
-      return Color.white;
-    }
-    else
-    {
-      return (Color) sequenceColours.get(seq);
-    }
+    return isDataset;
   }
 
-  public void setSequenceColour(SequenceI seq, Color col)
+  public boolean getShowHiddenMarkers()
   {
-    if (sequenceColours == null)
-    {
-      sequenceColours = new Hashtable();
-    }
+    return showHiddenMarkers;
+  }
 
-    if (col == null)
-    {
-      sequenceColours.remove(seq);
-    }
-    else
-    {
-      sequenceColours.put(seq, col);
-    }
+  public void setShowHiddenMarkers(boolean show)
+  {
+    showHiddenMarkers = show;
   }
 
   /**
@@ -1984,9 +979,12 @@ public class AlignViewport implements SelectionSource, VamsasSource
    */
   public long[] getUndoRedoHash()
   {
+    // TODO: JAL-1126
     if (historyList == null || redoList == null)
+    {
       return new long[]
       { -1, -1 };
+    }
     return new long[]
     { historyList.hashCode(), this.redoList.hashCode() };
   }
@@ -2032,27 +1030,6 @@ public class AlignViewport implements SelectionSource, VamsasSource
     centreColumnLabels = centrecolumnlabels;
   }
 
-  public void updateSequenceIdColours()
-  {
-    Vector groups = alignment.getGroups();
-    if (sequenceColours == null)
-    {
-      sequenceColours = new Hashtable();
-    }
-    for (int ig = 0, igSize = groups.size(); ig < igSize; ig++)
-    {
-      SequenceGroup sg = (SequenceGroup) groups.elementAt(ig);
-      if (sg.idColour != null)
-      {
-        Vector sqs = sg.getSequences(hiddenRepSequences);
-        for (int s = 0, sSize = sqs.size(); s < sSize; s++)
-        {
-          sequenceColours.put(sqs.elementAt(s), sg.idColour);
-        }
-      }
-    }
-  }
-
   /**
    * enable or disable the display of Database Cross References in the sequence
    * ID tooltip
@@ -2135,46 +1112,11 @@ public class AlignViewport implements SelectionSource, VamsasSource
     return followSelection;
   }
 
-  private long sgrouphash = -1, colselhash = -1;
-
   boolean showSeqFeaturesHeight;
 
   /**
-   * checks current SelectionGroup against record of last hash value, and
-   * updates record.
-   * @param b update the record of last hash value
-   * 
-   * @return true if SelectionGroup changed since last call (when b is true)
-   */
-  boolean isSelectionGroupChanged(boolean b)
-  {
-    int hc = (selectionGroup == null || selectionGroup.getSize()==0) ? -1 : selectionGroup.hashCode();
-    if (hc!=-1 && hc != sgrouphash)
-    {
-      if (b) {sgrouphash = hc;}
-      return true;
-    }
-    return false;
-  }
-
-  /**
-   * checks current colsel against record of last hash value, and optionally updates
-   * record.
-
-   * @param b update the record of last hash value
-   * @return true if colsel changed since last call (when b is true)
+   * Send the current selection to be broadcast to any selection listeners.
    */
-  boolean isColSelChanged(boolean b)
-  {
-    int hc = (colSel == null || colSel.size()==0) ? -1 : colSel.hashCode();
-    if (hc!=-1 && hc != colselhash)
-    {
-      if (b) {colselhash = hc;}
-      return true;
-    }
-    return false;
-  }
-
   public void sendSelection()
   {
     jalview.structure.StructureSelectionManager
@@ -2193,18 +1135,6 @@ public class AlignViewport implements SelectionSource, VamsasSource
     return showSeqFeaturesHeight;
   }
 
-  boolean showUnconserved = false;
-
-  public boolean getShowUnconserved()
-  {
-    return showUnconserved;
-  }
-
-  public void setShowUnconserved(boolean showunconserved)
-  {
-    showUnconserved = showunconserved;
-  }
-
   /**
    * return the alignPanel containing the given viewport. Use this to get the
    * components currently handling the given viewport.
@@ -2217,7 +1147,6 @@ public class AlignViewport implements SelectionSource, VamsasSource
   {
     AlignmentPanel[] aps = PaintRefresher.getAssociatedPanels(this
             .getSequenceSetId());
-    AlignmentPanel ap = null;
     for (int p = 0; aps != null && p < aps.length; p++)
     {
       if (aps[p].av == this)
@@ -2239,174 +1168,442 @@ public class AlignViewport implements SelectionSource, VamsasSource
   }
 
   /**
-   * should conservation rows be shown for groups
+   * synthesize a column selection if none exists so it covers the given
+   * selection group. if wholewidth is false, no column selection is made if the
+   * selection group covers the whole alignment width.
+   * 
+   * @param sg
+   * @param wholewidth
    */
-  boolean showGroupConservation = false;
+  public void expandColSelection(SequenceGroup sg, boolean wholewidth)
+  {
+    int sgs, sge;
+    if (sg != null
+            && (sgs = sg.getStartRes()) >= 0
+            && sg.getStartRes() <= (sge = sg.getEndRes())
+            && (colSel == null || colSel.getSelected() == null || colSel
+                    .getSelected().size() == 0))
+    {
+      if (!wholewidth && alignment.getWidth() == (1 + sge - sgs))
+      {
+        // do nothing
+        return;
+      }
+      if (colSel == null)
+      {
+        colSel = new ColumnSelection();
+      }
+      for (int cspos = sg.getStartRes(); cspos <= sg.getEndRes(); cspos++)
+      {
+        colSel.addElement(cspos);
+      }
+    }
+  }
 
-  /**
-   * should consensus rows be shown for groups
-   */
-  boolean showGroupConsensus = false;
+  public StructureSelectionManager getStructureSelectionManager()
+  {
+    return StructureSelectionManager
+            .getStructureSelectionManager(Desktop.instance);
+  }
 
   /**
-   * should consensus profile be rendered by default
+   * 
+   * @param pdbEntries
+   * @return a series of SequenceI arrays, one for each PDBEntry, listing which
+   *         sequence in the alignment holds a reference to it
    */
-  public boolean showSequenceLogo = false;
+  public SequenceI[][] collateForPDB(PDBEntry[] pdbEntries)
+  {
+    ArrayList<SequenceI[]> seqvectors = new ArrayList<SequenceI[]>();
+    for (PDBEntry pdb : pdbEntries)
+    {
+      ArrayList<SequenceI> seqs = new ArrayList<SequenceI>();
+      for (int i = 0; i < alignment.getHeight(); i++)
+      {
+        Vector pdbs = alignment.getSequenceAt(i).getDatasetSequence()
+                .getPDBId();
+        if (pdbs == null)
+        {
+          continue;
+        }
+        SequenceI sq;
+        for (int p = 0; p < pdbs.size(); p++)
+        {
+          PDBEntry p1 = (PDBEntry) pdbs.elementAt(p);
+          if (p1.getId().equals(pdb.getId()))
+          {
+            if (!seqs.contains(sq = alignment.getSequenceAt(i)))
+            {
+              seqs.add(sq);
+            }
 
-  /**
-   * should consensus histograms be rendered by default
-   */
-  public boolean showConsensusHistogram = true;
+            continue;
+          }
+        }
+      }
+      seqvectors.add(seqs.toArray(new SequenceI[seqs.size()]));
+    }
+    return seqvectors.toArray(new SequenceI[seqvectors.size()][]);
+  }
 
-  /**
-   * @return the showConsensusProfile
-   */
-  public boolean isShowSequenceLogo()
+  public boolean isNormaliseSequenceLogo()
   {
-    return showSequenceLogo;
+    return normaliseSequenceLogo;
+  }
+
+  public void setNormaliseSequenceLogo(boolean state)
+  {
+    normaliseSequenceLogo = state;
   }
 
   /**
-   * @param showSequenceLogo
-   *          the new value
+   * 
+   * @return true if alignment characters should be displayed
    */
-  public void setShowSequenceLogo(boolean showSequenceLogo)
+  public boolean isValidCharWidth()
+  {
+    return validCharWidth;
+  }
+
+  private Hashtable<String, AutoCalcSetting> calcIdParams = new Hashtable<String, AutoCalcSetting>();
+
+  private boolean showAutocalculatedAbove;
+
+  public AutoCalcSetting getCalcIdSettingsFor(String calcId)
+  {
+    return calcIdParams.get(calcId);
+  }
+
+  public void setCalcIdSettingsFor(String calcId, AutoCalcSetting settings,
+          boolean needsUpdate)
   {
-    if (showSequenceLogo != this.showSequenceLogo)
+    calcIdParams.put(calcId, settings);
+    // TODO: create a restart list to trigger any calculations that need to be
+    // restarted after load
+    // calculator.getRegisteredWorkersOfClass(settings.getWorkerClass())
+    if (needsUpdate)
     {
-      // TODO: decouple settings setting from calculation when refactoring
-      // annotation update method from alignframe to viewport
-      this.showSequenceLogo = showSequenceLogo;
-      if (consensusThread != null)
-      {
-        consensusThread.updateAnnotation();
-      }
+      Cache.log.debug("trigger update for " + calcId);
     }
-    this.showSequenceLogo = showSequenceLogo;
   }
 
-  /**
-   * @param showConsensusHistogram
-   *          the showConsensusHistogram to set
-   */
-  public void setShowConsensusHistogram(boolean showConsensusHistogram)
+  protected SequenceAnnotationOrder getSortAnnotationsBy()
   {
-    this.showConsensusHistogram = showConsensusHistogram;
+    return sortAnnotationsBy;
   }
 
-  /**
-   * @return the showGroupConservation
-   */
-  public boolean isShowGroupConservation()
+  protected void setSortAnnotationsBy(SequenceAnnotationOrder sortAnnotationsBy)
   {
-    return showGroupConservation;
+    this.sortAnnotationsBy = sortAnnotationsBy;
   }
 
-  /**
-   * @param showGroupConservation
-   *          the showGroupConservation to set
-   */
-  public void setShowGroupConservation(boolean showGroupConservation)
+  protected boolean isShowAutocalculatedAbove()
   {
-    this.showGroupConservation = showGroupConservation;
+    return showAutocalculatedAbove;
+  }
+
+  protected void setShowAutocalculatedAbove(boolean showAutocalculatedAbove)
+  {
+    this.showAutocalculatedAbove = showAutocalculatedAbove;
   }
 
   /**
-   * @return the showGroupConsensus
+   * Method called when another alignment's edit (or possibly other) command is
+   * broadcast to here.
+   *
+   * To allow for sequence mappings (e.g. protein to cDNA), we have to first
+   * 'unwind' the command on the source sequences (in simulation, not in fact),
+   * and then for each edit in turn:
+   * <ul>
+   * <li>compute the equivalent edit on the mapped sequences</li>
+   * <li>apply the mapped edit</li>
+   * <li>'apply' the source edit to the working copy of the source sequences</li>
+   * </ul>
+   * 
+   * @param command
+   * @param undo
+   * @param ssm
    */
-  public boolean isShowGroupConsensus()
+  @Override
+  public void mirrorCommand(CommandI command, boolean undo,
+          StructureSelectionManager ssm, VamsasSource source)
   {
-    return showGroupConsensus;
+    /*
+     * ...work in progress... do nothing unless we are a 'complement' of the
+     * source May replace this with direct calls not via SSM.
+     */
+    if (source instanceof AlignViewportI
+            && ((AlignViewportI) source).getCodingComplement() == this)
+    {
+      // ok to continue;
+    }
+    else
+    {
+      return;
+    }
+
+    CommandI mappedCommand = ssm.mapCommand(command, undo, getAlignment(),
+            getGapCharacter());
+    if (mappedCommand != null)
+    {
+      AlignmentI[] views = getAlignPanel().alignFrame.getViewAlignments();
+      mappedCommand.doCommand(views);
+      getAlignPanel().alignmentChanged();
+    }
+  }
+
+  @Override
+  public VamsasSource getVamsasSource()
+  {
+    return this;
   }
 
   /**
-   * @param showGroupConsensus
-   *          the showGroupConsensus to set
+   * Add one command to the command history list.
+   * 
+   * @param command
    */
-  public void setShowGroupConsensus(boolean showGroupConsensus)
+  public void addToHistoryList(CommandI command)
+  {
+    if (this.historyList != null)
+    {
+      this.historyList.push(command);
+      broadcastCommand(command, false);
+    }
+  }
+
+  protected void broadcastCommand(CommandI command, boolean undo)
   {
-    this.showGroupConsensus = showGroupConsensus;
+    getStructureSelectionManager().commandPerformed(command, undo, getVamsasSource());
   }
 
   /**
+   * Add one command to the command redo list.
    * 
-   * @return flag to indicate if the consensus histogram should be rendered by
-   *         default
+   * @param command
    */
-  public boolean isShowConsensusHistogram()
+  public void addToRedoList(CommandI command)
   {
-    return this.showConsensusHistogram;
+    if (this.redoList != null)
+    {
+      this.redoList.push(command);
+    }
+    broadcastCommand(command, true);
   }
 
   /**
-   * synthesize a column selection if none exists so it covers the given
-   * selection group. if wholewidth is false, no column selection is made if the
-   * selection group covers the whole alignment width.
-   * 
-   * @param sg
-   * @param wholewidth
+   * Clear the command redo list.
    */
-  public void expandColSelection(SequenceGroup sg, boolean wholewidth)
+  public void clearRedoList()
   {
-    int sgs, sge;
-    if (sg != null
-            && (sgs = sg.getStartRes()) >= 0
-            && sg.getStartRes() <= (sge = sg.getEndRes())
-            && (colSel == null || colSel.getSelected() == null || colSel
-                    .getSelected().size() == 0))
+    if (this.redoList != null)
     {
-      if (!wholewidth && alignment.getWidth() == (1 + sge - sgs))
-      {
-        // do nothing
-        return;
-      }
-      if (colSel == null)
-      {
-        colSel = new ColumnSelection();
-      }
-      for (int cspos = sg.getStartRes(); cspos <= sg.getEndRes(); cspos++)
-      {
-        colSel.addElement(cspos);
-      }
+      this.redoList.clear();
     }
   }
 
-  public StructureSelectionManager getStructureSelectionManager()
+  public void setHistoryList(Deque<CommandI> list)
   {
-    return StructureSelectionManager.getStructureSelectionManager(Desktop.instance);
+    this.historyList = list;
+  }
+
+  public Deque<CommandI> getHistoryList()
+  {
+    return this.historyList;
+  }
+
+  public void setRedoList(Deque<CommandI> list)
+  {
+    this.redoList = list;
+  }
+
+  public Deque<CommandI> getRedoList()
+  {
+    return this.redoList;
   }
 
   /**
+   * Add the sequences from the given alignment to this viewport. Optionally,
+   * may give the user the option to open a new frame, or split panel, with cDNA
+   * and protein linked.
    * 
-   * @param pdbEntries
-   * @return a series of SequenceI arrays, one for each PDBEntry, listing which sequence in the alignment holds a reference to it
+   * @param al
+   * @param title
    */
-  public SequenceI[][] collateForPDB(PDBEntry[] pdbEntries)
+  public void addAlignment(AlignmentI al, String title)
   {
-    ArrayList<SequenceI[]> seqvectors = new ArrayList<SequenceI[]>();
-    for (PDBEntry pdb: pdbEntries) {
-    ArrayList<SequenceI> seqs = new ArrayList<SequenceI>();
-    for (int i = 0; i < alignment.getHeight(); i++)
+    // TODO: promote to AlignViewportI? applet CutAndPasteTransfer is different
+
+    // refactored from FileLoader / CutAndPasteTransfer / SequenceFetcher with
+    // this comment:
+    // TODO: create undo object for this JAL-1101
+
+    /*
+     * If one alignment is protein and one nucleotide, with at least one
+     * sequence name in common, offer to open a linked alignment.
+     */
+    if (getAlignment().isNucleotide() != al.isNucleotide())
     {
-      Vector pdbs = alignment.getSequenceAt(i)
-              .getDatasetSequence().getPDBId();
-      if (pdbs == null)
-        continue;
-      SequenceI sq;
-      for (int p = 0; p < pdbs.size(); p++)
+      final Set<String> sequenceNames = getAlignment().getSequenceNames();
+      sequenceNames.retainAll(al.getSequenceNames());
+      if (!sequenceNames.isEmpty()) // at least one sequence name in both
       {
-        PDBEntry p1 = (PDBEntry) pdbs.elementAt(p);
-        if (p1.getId().equals(pdb.getId()))
+        if (openLinkedAlignment(al, title))
         {
-          if (!seqs.contains(sq=alignment.getSequenceAt(i)))
-            seqs.add(sq);
-
-          continue;
+          return;
         }
       }
     }
-    seqvectors.add(seqs.toArray(new SequenceI[seqs.size()]));
+
+    for (int i = 0; i < al.getHeight(); i++)
+    {
+      getAlignment().addSequence(al.getSequenceAt(i));
     }
-    return seqvectors.toArray(new SequenceI[seqvectors.size()][]);
+    // TODO this call was done by SequenceFetcher but not FileLoader or
+    // CutAndPasteTransfer. Is it needed?
+    setEndSeq(getAlignment().getHeight());
+    firePropertyChange("alignment", null, getAlignment().getSequences());
+  }
+
+  /**
+   * Show a dialog with the option to open and link (cDNA <-> protein) as a new
+   * alignment. Returns true if the new alignment was opened, false if not,
+   * because the user declined the offer.
+   * 
+   * @param title
+   */
+  protected boolean openLinkedAlignment(AlignmentI al, String title)
+  {
+    String[] options = new String[]
+    { MessageManager.getString("action.no"),
+        MessageManager.getString("label.split_window"),
+        MessageManager.getString("label.new_window"), };
+    final String question = JvSwingUtils.wrapTooltip(true,
+            MessageManager.getString("label.open_linked_alignment?"));
+    int response = JOptionPane.showOptionDialog(Desktop.desktop, question,
+            MessageManager.getString("label.open_linked_alignment"),
+            JOptionPane.DEFAULT_OPTION, JOptionPane.PLAIN_MESSAGE, null,
+            options, options[0]);
+
+    if (response != 1 && response != 2)
+    {
+      return false;
+    }
+    final boolean openSplitPane = (response == 1);
+    final boolean openInNewWindow = (response == 2);
+
+    /*
+     * Create the AlignFrame first (which creates the new alignment's datasets),
+     * before attempting sequence mapping.
+     */
+    AlignFrame newAlignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
+            AlignFrame.DEFAULT_HEIGHT);
+    newAlignFrame.setTitle(title);
+
+    /*
+     * Identify protein and dna alignments. Make a copy of this one if opening
+     * in a new split pane.
+     */
+    AlignmentI thisAlignment = openSplitPane ? new Alignment(getAlignment())
+            : getAlignment();
+    final AlignmentI protein = al.isNucleotide() ? thisAlignment : al;
+    final AlignmentI cdna = al.isNucleotide() ? al : thisAlignment;
+
+    newAlignFrame.statusBar.setText(MessageManager.formatMessage(
+            "label.successfully_loaded_file", new Object[]
+            { title }));
+
+    // TODO if we want this (e.g. to enable reload of the alignment from file),
+    // we will need to add parameters to the stack.
+    // if (!protocol.equals(AppletFormatAdapter.PASTE))
+    // {
+    // alignFrame.setFileName(file, format);
+    // }
+
+    if (openInNewWindow)
+    {
+      Desktop.addInternalFrame(newAlignFrame, title,
+              AlignFrame.DEFAULT_WIDTH,
+              AlignFrame.DEFAULT_HEIGHT);
+    }
+
+    /*
+     * Try to find mappings for at least one sequence.
+     */
+    MappingResult mapped = AlignmentUtils.mapProteinToCdna(protein, cdna);
+    final StructureSelectionManager ssm = StructureSelectionManager
+            .getStructureSelectionManager(Desktop.instance);
+    if (mapped == MappingResult.Mapped)
+    {
+
+      /*
+       * Register the mappings (held on the protein alignment) with the
+       * StructureSelectionManager (for mouseover linking).
+       */
+      ssm.addMappings(protein.getCodonFrames());
+    }
+    else
+    {
+
+      /*
+       * No mapping possible - warn the user, but leave window open.
+       */
+      final String msg = JvSwingUtils.wrapTooltip(true,
+              MessageManager.getString("label.mapping_failed"));
+      JOptionPane.showInternalMessageDialog(Desktop.desktop, msg,
+              MessageManager.getString("label.no_mappings"),
+              JOptionPane.WARNING_MESSAGE);
+    }
+
+    try
+    {
+      newAlignFrame.setMaximum(jalview.bin.Cache.getDefault(
+              "SHOW_FULLSCREEN",
+              false));
+    } catch (java.beans.PropertyVetoException ex)
+    {
+    }
+
+    if (openSplitPane)
+    {
+      /*
+       * Open in split pane. DNA sequence above, protein below.
+       */
+      AlignFrame copyMe = new AlignFrame(thisAlignment,
+              AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
+      copyMe.setTitle(getAlignPanel().alignFrame.getTitle());
+      final AlignFrame proteinFrame = al.isNucleotide() ? copyMe
+              : newAlignFrame;
+      final AlignFrame cdnaFrame = al.isNucleotide() ? newAlignFrame
+              : copyMe;
+
+      cdnaFrame.setVisible(true);
+      proteinFrame.setVisible(true);
+      String proteinShortName = StringUtils.getLastToken(
+              proteinFrame.getTitle(), "/");
+      String dnaShortName = StringUtils.getLastToken(cdnaFrame.getTitle(),
+              "/");
+      String linkedTitle = MessageManager.formatMessage(
+              "label.linked_view_title", dnaShortName, proteinShortName);
+      JInternalFrame splitFrame = new SplitFrame(cdnaFrame, proteinFrame);
+      Desktop.addInternalFrame(splitFrame, linkedTitle,
+              AlignFrame.DEFAULT_WIDTH,
+              AlignFrame.DEFAULT_HEIGHT);
+
+      /*
+       * Set the frames to listen for each other's edit and sort commands.
+       */
+      ssm.addCommandListener(cdnaFrame.getViewport());
+      ssm.addCommandListener(proteinFrame.getViewport());
+
+      /*
+       * 'Coding complement' (dna/protein) views will mirror each others' edits,
+       * selections, sorting etc as decided from time to time by the relevant
+       * authorities.
+       */
+      proteinFrame.getViewport().setCodingComplement(cdnaFrame.getViewport());
+    }
+
+    return true;
   }
 }