JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob
[jalview.git] / src / jalview / gui / AlignViewport.java
old mode 100755 (executable)
new mode 100644 (file)
index fa458a6..8a95015
@@ -1,4 +1,24 @@
 /*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 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.
+ *  
+ * 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/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
+/*
  * Jalview - A Sequence Alignment Editor and Viewer
  * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
  *
  */
 package jalview.gui;
 
-import java.util.*;
-
-import java.awt.*;
-
-import jalview.analysis.*;
-import jalview.bin.*;
-import jalview.datamodel.*;
-import jalview.schemes.*;
+import jalview.analysis.AlignmentUtils;
+import jalview.analysis.AnnotationSorter.SequenceAnnotationOrder;
+import jalview.analysis.NJTree;
+import jalview.api.AlignViewportI;
+import jalview.api.AlignmentViewPanel;
+import jalview.api.ViewStyleI;
+import jalview.bin.Cache;
+import jalview.commands.CommandI;
+import jalview.datamodel.AlignedCodonFrame;
+import jalview.datamodel.Alignment;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.PDBEntry;
+import jalview.datamodel.SearchResults;
+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.viewmodel.AlignmentViewport;
+import jalview.ws.params.AutoCalcSetting;
+
+import java.awt.Container;
+import java.awt.Dimension;
+import java.awt.Font;
+import java.awt.Rectangle;
+import java.util.ArrayList;
+import java.util.Hashtable;
+import java.util.List;
+import java.util.Set;
+import java.util.Vector;
+
+import javax.swing.JInternalFrame;
+import javax.swing.JOptionPane;
 
 /**
  * DOCUMENT ME!
- *
+ * 
  * @author $author$
- * @version $Revision$
+ * @version $Revision: 1.141 $
  */
-public class AlignViewport
+public class AlignViewport extends AlignmentViewport implements
+        SelectionSource, CommandListener
 {
-  int startRes;
-  int endRes;
-  int startSeq;
-  int endSeq;
-  boolean showJVSuffix = true;
-  boolean showText = true;
-  boolean showColourText = false;
-  boolean showBoxes = true;
-  boolean wrapAlignment = false;
-  boolean renderGaps = true;
-  boolean showSequenceFeatures = false;
-  boolean showAnnotation = true;
-  boolean colourAppliesToAllGroups = true;
-  ColourSchemeI globalColourScheme = null;
-  boolean conservationColourSelected = false;
-  boolean abovePIDThreshold = false;
-  SequenceGroup selectionGroup;
-  int charHeight;
-  int charWidth;
-  boolean validCharWidth;
-  int wrappedWidth;
   Font font;
-  boolean seqNameItalics;
-  AlignmentI alignment;
-  ColumnSelection colSel = new ColumnSelection();
-  int threshold;
-  int increment;
+
   NJTree currentTree = null;
-  boolean scaleAboveWrapped = false;
-  boolean scaleLeftWrapped = true;
-  boolean scaleRightWrapped = true;
-  boolean hasHiddenColumns = false;
-  boolean hasHiddenRows = false;
-  boolean showHiddenMarkers = true;
 
   boolean cursorMode = false;
 
-  // The following vector holds the features which are
-  // currently visible, in the correct order or rendering
-  Hashtable featuresDisplayed = null;
-
-  /** DOCUMENT ME!! */
-  public Hashtable[] hconsensus;
-  AlignmentAnnotation consensus;
-  AlignmentAnnotation conservation;
-  AlignmentAnnotation quality;
-  boolean autoCalculateConsensus = 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;
+  private Rectangle explodedGeometry;
 
   String viewName;
 
-  String sequenceSetID;
-
-  boolean gatherViewsHere = false;
-
-  Stack historyList = new Stack();
-  Stack redoList = new Stack();
-
-  Hashtable sequenceColours;
-
-  int thresholdTextColour = 0;
-  Color textColour = Color.black;
-  Color textColour2 = Color.white;
-
-  boolean rightAlignIds = false;
+  /*
+   * Flag set true on the view that should 'gather' multiple views of the same
+   * sequence set id when a project is reloaded. Set false on all views when
+   * they are 'exploded' into separate windows. Set true on the current view
+   * when 'Gather' is performed, and also on the first tab when the first new
+   * view is created.
+   */
+  private boolean gatherViewsHere = false;
 
-  Hashtable hiddenRepSequences;
+  private AnnotationColumnChooser annotationColumnSelectionState;
 
   /**
    * Creates a new AlignViewport object.
-   *
-   * @param al DOCUMENT ME!
+   * 
+   * @param al
+   *          alignment to view
    */
   public AlignViewport(AlignmentI al)
   {
@@ -131,48 +123,144 @@ public class AlignViewport
   }
 
   /**
+   * Create a new AlignViewport object with a specific sequence set ID
+   * 
+   * @param al
+   * @param seqsetid
+   *          (may be null - but potential for ambiguous constructor exception)
+   */
+  public AlignViewport(AlignmentI al, String seqsetid)
+  {
+    this(al, seqsetid, null);
+  }
+
+  public AlignViewport(AlignmentI al, String seqsetid, String viewid)
+  {
+    sequenceSetID = seqsetid;
+    viewId = viewid;
+    // TODO remove these once 2.4.VAMSAS release finished
+    if (Cache.log != null && Cache.log.isDebugEnabled() && seqsetid != null)
+    {
+      Cache.log.debug("Setting viewport's sequence set id : "
+              + sequenceSetID);
+    }
+    if (Cache.log != null && Cache.log.isDebugEnabled() && viewId != null)
+    {
+      Cache.log.debug("Setting viewport's view id : " + viewId);
+    }
+    setAlignment(al);
+    init();
+  }
+
+  /**
    * Create a new AlignViewport with hidden regions
-   * @param al AlignmentI
-   * @param hiddenColumns ColumnSelection
+   * 
+   * @param al
+   *          AlignmentI
+   * @param hiddenColumns
+   *          ColumnSelection
    */
   public AlignViewport(AlignmentI al, ColumnSelection hiddenColumns)
   {
     setAlignment(al);
     if (hiddenColumns != null)
     {
-      this.colSel = hiddenColumns;
-      if (hiddenColumns.getHiddenColumns() != null)
-      {
-        hasHiddenColumns = true;
-      }
+      colSel = hiddenColumns;
     }
     init();
   }
 
-  void init()
+  /**
+   * New viewport with hidden columns and an existing sequence set id
+   * 
+   * @param al
+   * @param hiddenColumns
+   * @param seqsetid
+   *          (may be null)
+   */
+  public AlignViewport(AlignmentI al, ColumnSelection hiddenColumns,
+          String seqsetid)
   {
-    this.startRes = 0;
-    this.endRes = alignment.getWidth() - 1;
-    this.startSeq = 0;
-    this.endSeq = alignment.getHeight() - 1;
+    this(al, hiddenColumns, seqsetid, null);
+  }
 
-    antiAlias = Cache.getDefault("ANTI_ALIAS", false);
+  /**
+   * New viewport with hidden columns and an existing sequence set id and viewid
+   * 
+   * @param al
+   * @param hiddenColumns
+   * @param seqsetid
+   *          (may be null)
+   * @param viewid
+   *          (may be null)
+   */
+  public AlignViewport(AlignmentI al, ColumnSelection hiddenColumns,
+          String seqsetid, String viewid)
+  {
+    sequenceSetID = seqsetid;
+    viewId = viewid;
+    // TODO remove these once 2.4.VAMSAS release finished
+    if (Cache.log != null && Cache.log.isDebugEnabled() && seqsetid != null)
+    {
+      Cache.log.debug("Setting viewport's sequence set id : "
+              + sequenceSetID);
+    }
+    if (Cache.log != null && Cache.log.isDebugEnabled() && viewId != null)
+    {
+      Cache.log.debug("Setting viewport's view id : " + viewId);
+    }
+    setAlignment(al);
+    if (hiddenColumns != null)
+    {
+      colSel = hiddenColumns;
+    }
+    init();
+  }
 
-    showJVSuffix = Cache.getDefault("SHOW_JVSUFFIX", true);
-    showAnnotation = Cache.getDefault("SHOW_ANNOTATIONS", true);
+  /**
+   * Apply any settings saved in user preferences
+   */
+  private void applyViewProperties()
+  {
+    antiAlias = Cache.getDefault("ANTI_ALIAS", false);
 
-    rightAlignIds = Cache.getDefault("RIGHT_ALIGN_IDS", false);
+    viewStyle.setShowJVSuffix(Cache.getDefault("SHOW_JVSUFFIX", true));
+    setShowAnnotation(Cache.getDefault("SHOW_ANNOTATIONS", true));
 
+    setRightAlignIds(Cache.getDefault("RIGHT_ALIGN_IDS", false));
+    setCentreColumnLabels(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));
+    setShowNPFeats(Cache.getDefault("SHOW_NPFEATS_TOOLTIP", true));
+    setShowDBRefs(Cache.getDefault("SHOW_DBREFS_TOOLTIP", true));
+    viewStyle.setSeqNameItalics(Cache.getDefault("ID_ITALICS", true));
+    viewStyle.setWrapAlignment(Cache.getDefault("WRAP_ALIGNMENT", false));
+    viewStyle.setShowUnconserved(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);
+    viewStyle.setScaleProteinAsCdna(Cache.getDefault(
+            Preferences.SCALE_PROTEIN_TO_CDNA, true));
+  }
+
+  void init()
+  {
+    this.startRes = 0;
+    this.endRes = alignment.getWidth() - 1;
+    this.startSeq = 0;
+    this.endSeq = alignment.getHeight() - 1;
+    applyViewProperties();
 
     String fontName = Cache.getDefault("FONT_NAME", "SansSerif");
     String fontStyle = Cache.getDefault("FONT_STYLE", Font.PLAIN + "");
     String fontSize = Cache.getDefault("FONT_SIZE", "10");
 
-    seqNameItalics = Cache.getDefault("ID_ITALICS", true);
-
     int style = 0;
 
     if (fontStyle.equals("bold"))
@@ -184,9 +272,10 @@ public class AlignViewport
       style = 2;
     }
 
-    setFont(new Font(fontName, style, Integer.parseInt(fontSize)));
+    setFont(new Font(fontName, style, Integer.parseInt(fontSize)), true);
 
-    alignment.setGapCharacter(Cache.getDefault("GAP_SYMBOL", "-").charAt(0));
+    alignment
+            .setGapCharacter(Cache.getDefault("GAP_SYMBOL", "-").charAt(0));
 
     // We must set conservation and consensus before setting colour,
     // as Blosum and Clustal require this to be done
@@ -194,57 +283,38 @@ public class AlignViewport
     {
       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);
-        }
-      }
-
-      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);
+        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);
+      showConsensus = Cache.getDefault("SHOW_IDENTITY", true);
     }
-
-    if (jalview.bin.Cache.getProperty("DEFAULT_COLOUR") != null)
+    initAutoAnnotation();
+    String colourProperty = alignment.isNucleotide() ? Preferences.DEFAULT_COLOUR_NUC
+            : Preferences.DEFAULT_COLOUR_PROT;
+    String propertyValue = Cache.getProperty(colourProperty);
+    if (propertyValue == null)
+    {
+      // fall back on this property for backwards compatibility
+      propertyValue = Cache.getProperty(Preferences.DEFAULT_COLOUR);
+    }
+    if (propertyValue != null)
     {
       globalColourScheme = ColourSchemeProperty.getColour(alignment,
-          jalview.bin.Cache.getProperty("DEFAULT_COLOUR"));
+              propertyValue);
 
       if (globalColourScheme instanceof UserColourScheme)
       {
         globalColourScheme = UserDefinedColours.loadDefaultColours();
-        ( (UserColourScheme) globalColourScheme).setThreshold(0,
-            getIgnoreGapsConsensus());
+        ((UserColourScheme) globalColourScheme).setThreshold(0,
+                isIgnoreGapsConsensus());
       }
 
       if (globalColourScheme != null)
@@ -252,338 +322,12 @@ public class AlignViewport
         globalColourScheme.setConsensus(hconsensus);
       }
     }
-
-    wrapAlignment = jalview.bin.Cache.getDefault("WRAP_ALIGNMENT", false);
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param b DOCUMENT ME!
-   */
-  public void setShowSequenceFeatures(boolean b)
-  {
-    showSequenceFeatures = b;
-  }
-
-  public boolean getShowSequenceFeatures()
-  {
-    return showSequenceFeatures;
-  }
-
-  class ConservationThread
-      extends Thread
-  {
-    AlignmentPanel ap;
-    public ConservationThread(AlignmentPanel ap)
-    {
-      this.ap = ap;
-    }
-
-    public void run()
-    {
-      try
-      {
-        updatingConservation = true;
-
-        while (UPDATING_CONSERVATION)
-        {
-          try
-          {
-            if (ap != null)
-            {
-              ap.paintAlignment(true);
-            }
-            Thread.sleep(200);
-          }
-          catch (Exception ex)
-          {
-            ex.printStackTrace();
-          }
-        }
-
-        UPDATING_CONSERVATION = true;
-
-        int alWidth = alignment.getWidth();
-        if (alWidth < 0)
-        {
-          return;
-        }
-
-        Conservation cons = new jalview.analysis.Conservation("All",
-            jalview.schemes.ResidueProperties.propHash, 3,
-            alignment.getSequences(), 0, alWidth - 1);
-
-        cons.calculate();
-        cons.verdict(false, ConsPercGaps);
-
-        if (quality != null)
-        {
-          cons.findQuality();
-        }
-
-        char[] sequence = cons.getConsSequence().getSequence();
-        float minR;
-        float minG;
-        float minB;
-        float maxR;
-        float maxG;
-        float maxB;
-        minR = 0.3f;
-        minG = 0.0f;
-        minB = 0f;
-        maxR = 1.0f - minR;
-        maxG = 0.9f - minG;
-        maxB = 0f - minB; // scalable range for colouring both Conservation and Quality
-
-        float min = 0f;
-        float max = 11f;
-        float qmin = 0f;
-        float qmax = 0f;
-
-        char c;
-
-        conservation.annotations = new Annotation[alWidth];
-
-        if (quality != null)
-        {
-          quality.graphMax = cons.qualityRange[1].floatValue();
-          quality.annotations = new Annotation[alWidth];
-          qmin = cons.qualityRange[0].floatValue();
-          qmax = cons.qualityRange[1].floatValue();
-        }
-
-        for (int i = 0; i < alWidth; i++)
-        {
-          float value = 0;
-
-          c = sequence[i];
-
-          if (Character.isDigit(c))
-          {
-            value = (int) (c - '0');
-          }
-          else if (c == '*')
-          {
-            value = 11;
-          }
-          else if (c == '+')
-          {
-            value = 10;
-          }
-
-          float vprop = value - min;
-          vprop /= max;
-          conservation.annotations[i] =
-              new Annotation(String.valueOf(c),
-                             String.valueOf(value), ' ', value,
-                             new Color(minR + (maxR * vprop),
-                                       minG + (maxG * vprop),
-                                       minB + (maxB * vprop)));
-
-          // Quality calc
-          if (quality != null)
-          {
-            value = ( (Double) cons.quality.get(i)).floatValue();
-            vprop = value - qmin;
-            vprop /= qmax;
-            quality.annotations[i] = new Annotation(" ", String.valueOf(value),
-                ' ',
-                value,
-                new Color(minR + (maxR * vprop),
-                          minG + (maxG * vprop),
-                          minB + (maxB * vprop)));
-          }
-        }
-      }
-      catch (OutOfMemoryError error)
-      {
-        javax.swing.SwingUtilities.invokeLater(new Runnable()
-        {
-
-          public void run()
-          {
-            javax.swing.JOptionPane.showInternalMessageDialog(Desktop.desktop,
-                "Out of memory calculating conservation!!"
-                +
-                "\nSee help files for increasing Java Virtual Machine memory."
-                , "Out of memory",
-                javax.swing.JOptionPane.WARNING_MESSAGE);
-          }
-        });
-
-        conservation = null;
-        quality = null;
-
-        System.out.println("Conservation calculation: " + error);
-        System.gc();
-
-      }
-
-      UPDATING_CONSERVATION = false;
-      updatingConservation = false;
-
-      if (ap != null)
-      {
-        ap.paintAlignment(true);
-      }
-
-    }
-  }
-
-  ConservationThread conservationThread;
-
-  ConsensusThread consensusThread;
-
-  boolean consUpdateNeeded = false;
-
-  static boolean UPDATING_CONSENSUS = false;
-
-  static boolean UPDATING_CONSERVATION = false;
-
-  boolean updatingConsensus = false;
-
-  boolean updatingConservation = false;
-
-  /**
-   * DOCUMENT ME!
-   */
-  public void updateConservation(final AlignmentPanel ap)
-  {
-    if (alignment.isNucleotide() || conservation == null)
-    {
-      return;
-    }
-
-    conservationThread = new ConservationThread(ap);
-    conservationThread.start();
-  }
-
-  /**
-   * DOCUMENT ME!
-   */
-  public void updateConsensus(final AlignmentPanel ap)
-  {
-    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(true);
-          }
-
-          Thread.sleep(200);
-        }
-        catch (Exception ex)
-        {
-          ex.printStackTrace();
-        }
-      }
-
-      UPDATING_CONSENSUS = true;
-
-      try
-      {
-        int aWidth = alignment.getWidth();
-        if (aWidth < 0)
-        {
-          return;
-        }
-
-        consensus.annotations = null;
-        consensus.annotations = new Annotation[aWidth];
-
-        hconsensus = new Hashtable[aWidth];
-        AAFrequency.calculate(alignment.getSequencesArray(),
-                              0,
-                              alignment.getWidth(),
-                              hconsensus);
-
-        for (int i = 0; i < aWidth; i++)
-        {
-          float value = 0;
-          if (ignoreGapsInConsensusCalculation)
-          {
-            value = ( (Float) hconsensus[i].get(AAFrequency.PID_NOGAPS)).
-                floatValue();
-          }
-          else
-          {
-            value = ( (Float) hconsensus[i].get(AAFrequency.PID_GAPS)).
-                floatValue();
-          }
-
-          String maxRes = hconsensus[i].get(AAFrequency.MAXRESIDUE).toString();
-          String mouseOver = hconsensus[i].get(AAFrequency.MAXRESIDUE) + " ";
-
-          if (maxRes.length() > 1)
-          {
-            mouseOver = "[" + maxRes + "] ";
-            maxRes = "+";
-          }
-
-          mouseOver += ( (int) value + "%");
-          consensus.annotations[i] = new Annotation(maxRes, mouseOver, ' ',
-              value);
-        }
-
-        if (globalColourScheme != null)
-        {
-          globalColourScheme.setConsensus(hconsensus);
-        }
-
-      }
-      catch (OutOfMemoryError error)
-      {
-        alignment.deleteAnnotation(consensus);
-
-        consensus = null;
-        hconsensus = null;
-        javax.swing.SwingUtilities.invokeLater(new Runnable()
-        {
-          public void run()
-          {
-            javax.swing.JOptionPane.showInternalMessageDialog(Desktop.desktop,
-                "Out of memory calculating consensus!!"
-                +
-                "\nSee help files for increasing Java Virtual Machine memory."
-                , "Out of memory",
-                javax.swing.JOptionPane.WARNING_MESSAGE);
-          }
-        });
-
-        System.out.println("Consensus calculation: " + error);
-        System.gc();
-      }
-      UPDATING_CONSENSUS = false;
-      updatingConsensus = false;
-
-      if (ap != null)
-      {
-        ap.paintAlignment(true);
-      }
-    }
   }
 
   /**
-   * get the consensus sequence as displayed under the PID consensus annotation row.
+   * get the consensus sequence as displayed under the PID consensus annotation
+   * row.
+   * 
    * @return consensus sequence as a new sequence object
    */
   public SequenceI getConsensusSeq()
@@ -613,1192 +357,754 @@ public class AlignViewport
     }
 
     SequenceI sq = new Sequence("Consensus", seqs.toString());
-    sq.setDescription("Percentage Identity Consensus " +
-                      ( (ignoreGapsInConsensusCalculation) ? " without gaps" :
-                       ""));
+    sq.setDescription("Percentage Identity Consensus "
+            + ((ignoreGapsInConsensusCalculation) ? " without gaps" : ""));
     return sq;
   }
 
+  boolean validCharWidth;
+
   /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
+   * update view settings with the given font. You may need to call
+   * alignPanel.fontChanged to update the layout geometry
+   * 
+   * @param setGrid
+   *          when true, charWidth/height is set according to font mentrics
    */
-  public SequenceGroup getSelectionGroup()
+  public void setFont(Font f, boolean setGrid)
   {
-    return selectionGroup;
+    font = f;
+
+    Container c = new Container();
+
+    java.awt.FontMetrics fm = c.getFontMetrics(font);
+    int w = viewStyle.getCharWidth(), ww = fm.charWidth('M'), h = viewStyle
+            .getCharHeight();
+    if (setGrid)
+    {
+      setCharHeight(fm.getHeight());
+      setCharWidth(ww);
+    }
+    viewStyle.setFontName(font.getName());
+    viewStyle.setFontStyle(font.getStyle());
+    viewStyle.setFontSize(font.getSize());
+
+    validCharWidth = true;
   }
 
-  /**
-   * DOCUMENT ME!
-   *
-   * @param sg DOCUMENT ME!
-   */
-  public void setSelectionGroup(SequenceGroup sg)
+  @Override
+  public void setViewStyle(ViewStyleI settingsForView)
   {
-    selectionGroup = sg;
+    super.setViewStyle(settingsForView);
+    setFont(new Font(viewStyle.getFontName(), viewStyle.getFontStyle(),
+            viewStyle.getFontSize()), false);
+
   }
 
   /**
    * DOCUMENT ME!
-   *
+   * 
    * @return DOCUMENT ME!
    */
-  public boolean getConservationSelected()
+  public Font getFont()
   {
-    return conservationColourSelected;
+    return font;
   }
 
   /**
    * DOCUMENT ME!
-   *
-   * @param b DOCUMENT ME!
+   * 
+   * @param align
+   *          DOCUMENT ME!
    */
-  public void setConservationSelected(boolean b)
+  public void setAlignment(AlignmentI align)
   {
-    conservationColourSelected = b;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public boolean getAbovePIDThreshold()
-  {
-    return abovePIDThreshold;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param b DOCUMENT ME!
-   */
-  public void setAbovePIDThreshold(boolean b)
-  {
-    abovePIDThreshold = b;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public int getStartRes()
-  {
-    return startRes;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public int getEndRes()
-  {
-    return endRes;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public int getStartSeq()
-  {
-    return startSeq;
-  }
-
-  /**
-   * 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!
-   */
-  public void setStartRes(int res)
-  {
-    this.startRes = res;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param seq DOCUMENT ME!
-   */
-  public void setStartSeq(int seq)
-  {
-    this.startSeq = seq;
+    replaceMappings(align);
+    this.alignment = align;
   }
 
   /**
-   * DOCUMENT ME!
-   *
-   * @param res DOCUMENT ME!
+   * Replace any codon mappings for this viewport with those for the given
+   * viewport
+   * 
+   * @param align
    */
-  public void setEndRes(int res)
+  public void replaceMappings(AlignmentI align)
   {
-    if (res > (alignment.getWidth() - 1))
-    {
-      // log.System.out.println(" Corrected res from " + res + " to maximum " + (alignment.getWidth()-1));
-      res = alignment.getWidth() - 1;
-    }
-
-    if (res < 0)
-    {
-      res = 0;
-    }
 
-    this.endRes = res;
-  }
+    /*
+     * Deregister current mappings (if any)
+     */
+    deregisterMappings();
 
-  /**
-   * DOCUMENT ME!
-   *
-   * @param seq DOCUMENT ME!
-   */
-  public void setEndSeq(int seq)
-  {
-    if (seq > alignment.getHeight())
+    /*
+     * Register new mappings (if any)
+     */
+    if (align != null)
     {
-      seq = alignment.getHeight();
+      StructureSelectionManager ssm = StructureSelectionManager
+              .getStructureSelectionManager(Desktop.instance);
+      ssm.registerMappings(align.getCodonFrames());
     }
 
-    if (seq < 0)
+    /*
+     * replace mappings on our alignment
+     */
+    if (alignment != null && align != null)
     {
-      seq = 0;
+      alignment.setCodonFrames(align.getCodonFrames());
     }
-
-    this.endSeq = seq;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public int getEndSeq()
-  {
-    return endSeq;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param f DOCUMENT ME!
-   */
-  public void setFont(Font f)
-  {
-    font = f;
-
-    Container c = new Container();
-
-    java.awt.FontMetrics fm = c.getFontMetrics(font);
-    setCharHeight(fm.getHeight());
-    setCharWidth(fm.charWidth('M'));
-    validCharWidth = true;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public Font getFont()
-  {
-    return font;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param w DOCUMENT ME!
-   */
-  public void setCharWidth(int w)
-  {
-    this.charWidth = w;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public int getCharWidth()
-  {
-    return charWidth;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param h DOCUMENT ME!
-   */
-  public void setCharHeight(int h)
-  {
-    this.charHeight = h;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public int getCharHeight()
-  {
-    return charHeight;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param w DOCUMENT ME!
-   */
-  public void setWrappedWidth(int w)
-  {
-    this.wrappedWidth = w;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public int getWrappedWidth()
-  {
-    return wrappedWidth;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public AlignmentI getAlignment()
-  {
-    return alignment;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param align DOCUMENT ME!
-   */
-  public void setAlignment(AlignmentI align)
-  {
-    this.alignment = align;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param state DOCUMENT ME!
-   */
-  public void setWrapAlignment(boolean state)
-  {
-    wrapAlignment = state;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param state DOCUMENT ME!
-   */
-  public void setShowText(boolean state)
-  {
-    showText = state;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param state DOCUMENT ME!
-   */
-  public void setRenderGaps(boolean state)
-  {
-    renderGaps = state;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public boolean getColourText()
-  {
-    return showColourText;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param state DOCUMENT ME!
-   */
-  public void setColourText(boolean state)
-  {
-    showColourText = state;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param state DOCUMENT ME!
-   */
-  public void setShowBoxes(boolean state)
-  {
-    showBoxes = state;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public boolean getWrapAlignment()
-  {
-    return wrapAlignment;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public boolean getShowText()
-  {
-    return showText;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public boolean getShowBoxes()
-  {
-    return showBoxes;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public char getGapCharacter()
-  {
-    return getAlignment().getGapCharacter();
   }
 
-  /**
-   * DOCUMENT ME!
-   *
-   * @param gap DOCUMENT ME!
-   */
-  public void setGapCharacter(char gap)
+  protected void deregisterMappings()
   {
-    if (getAlignment() != null)
+    AlignmentI al = getAlignment();
+    if (al != null)
     {
-      getAlignment().setGapCharacter(gap);
-    }
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param thresh DOCUMENT ME!
-   */
-  public void setThreshold(int thresh)
-  {
-    threshold = thresh;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public int getThreshold()
-  {
-    return threshold;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param inc DOCUMENT ME!
-   */
-  public void setIncrement(int inc)
-  {
-    increment = inc;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public int getIncrement()
-  {
-    return increment;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public ColumnSelection getColumnSelection()
-  {
-    return colSel;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param tree DOCUMENT ME!
-   */
-  public void setCurrentTree(NJTree tree)
-  {
-    currentTree = tree;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public NJTree getCurrentTree()
-  {
-    return currentTree;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @param b DOCUMENT ME!
-   */
-  public void setColourAppliesToAllGroups(boolean b)
-  {
-    colourAppliesToAllGroups = b;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public boolean getColourAppliesToAllGroups()
-  {
-    return colourAppliesToAllGroups;
-  }
-
-  /**
-   * DOCUMENT ME!
-   *
-   * @return DOCUMENT ME!
-   */
-  public boolean getShowJVSuffix()
-  {
-    return showJVSuffix;
-  }
-
-  /**
-   * 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;
+      Set<AlignedCodonFrame> mappings = al.getCodonFrames();
+      if (mappings != null)
+      {
+        StructureSelectionManager ssm = StructureSelectionManager
+                .getStructureSelectionManager(Desktop.instance);
+        for (AlignedCodonFrame acf : mappings)
+        {
+          if (noReferencesTo(acf))
+          {
+            ssm.deregisterMapping(acf);
+          }
+        }
+      }
+    }
   }
 
   /**
    * DOCUMENT ME!
-   *
+   * 
    * @return DOCUMENT ME!
    */
-  public boolean getScaleRightWrapped()
+  public char getGapCharacter()
   {
-    return scaleRightWrapped;
+    return getAlignment().getGapCharacter();
   }
 
   /**
    * DOCUMENT ME!
-   *
-   * @param b DOCUMENT ME!
+   * 
+   * @param gap
+   *          DOCUMENT ME!
    */
-  public void setScaleAboveWrapped(boolean b)
+  public void setGapCharacter(char gap)
   {
-    scaleAboveWrapped = b;
+    if (getAlignment() != null)
+    {
+      getAlignment().setGapCharacter(gap);
+    }
   }
 
   /**
    * DOCUMENT ME!
-   *
-   * @param b DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
    */
-  public void setScaleLeftWrapped(boolean b)
+  public ColumnSelection getColumnSelection()
   {
-    scaleLeftWrapped = b;
+    return colSel;
   }
 
   /**
    * DOCUMENT ME!
-   *
-   * @param b DOCUMENT ME!
-   */
-  public void setScaleRightWrapped(boolean b)
-  {
-    scaleRightWrapped = b;
-  }
-
-  /**
-   * Property change listener for changes in alignment
-   *
-   * @param listener DOCUMENT ME!
+   * 
+   * @param tree
+   *          DOCUMENT ME!
    */
-  public void addPropertyChangeListener(
-      java.beans.PropertyChangeListener listener)
+  public void setCurrentTree(NJTree tree)
   {
-    changeSupport.addPropertyChangeListener(listener);
+    currentTree = tree;
   }
 
   /**
    * DOCUMENT ME!
-   *
-   * @param listener DOCUMENT ME!
+   * 
+   * @return DOCUMENT ME!
    */
-  public void removePropertyChangeListener(
-      java.beans.PropertyChangeListener listener)
+  public NJTree getCurrentTree()
   {
-    changeSupport.removePropertyChangeListener(listener);
+    return currentTree;
   }
 
   /**
-   * Property change listener for changes in alignment
-   *
-   * @param prop DOCUMENT ME!
-   * @param oldvalue DOCUMENT ME!
-   * @param newvalue DOCUMENT ME!
+   * returns the visible column regions of the alignment
+   * 
+   * @param selectedRegionOnly
+   *          true to just return the contigs intersecting with the selected
+   *          area
+   * @return
    */
-  public void firePropertyChange(String prop, Object oldvalue, Object newvalue)
-  {
-    changeSupport.firePropertyChange(prop, oldvalue, newvalue);
-  }
-
-  public void setIgnoreGapsConsensus(boolean b, AlignmentPanel ap)
+  public int[] getViewAsVisibleContigs(boolean selectedRegionOnly)
   {
-    ignoreGapsInConsensusCalculation = b;
-    updateConsensus(ap);
-    if (globalColourScheme != null)
+    int[] viscontigs = null;
+    int start = 0, end = 0;
+    if (selectedRegionOnly && selectionGroup != null)
     {
-      globalColourScheme.setThreshold(globalColourScheme.getThreshold(),
-                                      ignoreGapsInConsensusCalculation);
+      start = selectionGroup.getStartRes();
+      end = selectionGroup.getEndRes() + 1;
     }
-  }
-
-  public boolean getIgnoreGapsConsensus()
-  {
-    return ignoreGapsInConsensusCalculation;
-  }
-
-  public void setDataset(boolean b)
-  {
-    isDataset = b;
-  }
-
-  public boolean isDataset()
-  {
-    return isDataset;
-  }
-
-  public void hideSelectedColumns()
-  {
-    if (colSel.size() < 1)
+    else
     {
-      return;
+      end = alignment.getWidth();
     }
-
-    colSel.hideSelectedColumns();
-    setSelectionGroup(null);
-
-    hasHiddenColumns = true;
+    viscontigs = colSel.getVisibleContigs(start, end);
+    return viscontigs;
   }
 
-  public void hideColumns(int start, int end)
+  /**
+   * get hash of undo and redo list for the alignment
+   * 
+   * @return long[] { historyList.hashCode, redoList.hashCode };
+   */
+  public long[] getUndoRedoHash()
   {
-    if (start == end)
-    {
-      colSel.hideColumns(start);
-    }
-    else
+    // TODO: JAL-1126
+    if (historyList == null || redoList == null)
     {
-      colSel.hideColumns(start, end);
+      return new long[] { -1, -1 };
     }
-
-    hasHiddenColumns = true;
+    return new long[] { historyList.hashCode(), this.redoList.hashCode() };
   }
 
-  public void hideRepSequences(SequenceI repSequence, SequenceGroup sg)
+  /**
+   * test if a particular set of hashcodes are different to the hashcodes for
+   * the undo and redo list.
+   * 
+   * @param undoredo
+   *          the stored set of hashcodes as returned by getUndoRedoHash
+   * @return true if the hashcodes differ (ie the alignment has been edited) or
+   *         the stored hashcode array differs in size
+   */
+  public boolean isUndoRedoHashModified(long[] undoredo)
   {
-    int sSize = sg.getSize();
-    if (sSize < 2)
+    if (undoredo == null)
     {
-      return;
+      return true;
     }
-
-    if (hiddenRepSequences == null)
+    long[] cstate = getUndoRedoHash();
+    if (cstate.length != undoredo.length)
     {
-      hiddenRepSequences = new Hashtable();
+      return true;
     }
 
-    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++)
+    for (int i = 0; i < cstate.length; i++)
     {
-      if (sg.getSequenceAt(i) != repSequence)
+      if (cstate[i] != undoredo[i])
       {
-        if (index == sSize - 1)
-        {
-          return;
-        }
-
-        seqs[index++] = sg.getSequenceAt(i);
+        return true;
       }
     }
-
-    hideSequence(seqs);
-
+    return false;
   }
 
-  public void hideAllSelectedSeqs()
-  {
-    if (selectionGroup == null || selectionGroup.getSize()<1)
-    {
-      return;
-    }
-
-    SequenceI[] seqs = selectionGroup.getSequencesInOrder(alignment);
-
-    hideSequence(seqs);
+  public boolean followSelection = true;
 
-    setSelectionGroup(null);
+  /**
+   * @return true if view selection should always follow the selections
+   *         broadcast by other selection sources
+   */
+  public boolean getFollowSelection()
+  {
+    return followSelection;
   }
 
-  public void hideSequence(SequenceI[] seq)
+  /**
+   * Send the current selection to be broadcast to any selection listeners.
+   */
+  public void sendSelection()
   {
-    if (seq != null)
-    {
-      for (int i = 0; i < seq.length; i++)
-      {
-        alignment.getHiddenSequences().hideSequence(seq[i]);
-      }
-      hasHiddenRows = true;
-      firePropertyChange("alignment", null, alignment.getSequences());
-    }
+    jalview.structure.StructureSelectionManager
+            .getStructureSelectionManager(Desktop.instance).sendSelection(
+                    new SequenceGroup(getSelectionGroup()),
+                    new ColumnSelection(getColumnSelection()), this);
   }
 
-  public void showSequence(int index)
+  /**
+   * return the alignPanel containing the given viewport. Use this to get the
+   * components currently handling the given viewport.
+   * 
+   * @param av
+   * @return null or an alignPanel guaranteed to have non-null alignFrame
+   *         reference
+   */
+  public AlignmentPanel getAlignPanel()
   {
-    Vector tmp = alignment.getHiddenSequences().showSequence(index
-        , hiddenRepSequences);
-    if (tmp.size() > 0)
+    AlignmentPanel[] aps = PaintRefresher.getAssociatedPanels(this
+            .getSequenceSetId());
+    for (int p = 0; aps != null && p < aps.length; p++)
     {
-      if (selectionGroup == null)
-      {
-        selectionGroup = new SequenceGroup();
-        selectionGroup.setEndRes(alignment.getWidth() - 1);
-      }
-
-      for (int t = 0; t < tmp.size(); t++)
+      if (aps[p].av == this)
       {
-        selectionGroup.addSequence(
-            (SequenceI) tmp.elementAt(t), false
-            );
+        return aps[p];
       }
-      firePropertyChange("alignment", null, alignment.getSequences());
-    }
-
-    if (alignment.getHiddenSequences().getSize() < 1)
-    {
-      hasHiddenRows = false;
     }
+    return null;
   }
 
-  public void showColumn(int col)
+  public boolean getSortByTree()
   {
-    colSel.revealHiddenColumns(col);
-    if (colSel.getHiddenColumns() == null)
-    {
-      hasHiddenColumns = false;
-    }
+    return sortByTree;
   }
 
-  public void showAllHiddenColumns()
+  public void setSortByTree(boolean sort)
   {
-    colSel.revealAllHiddenColumns();
-    hasHiddenColumns = false;
+    sortByTree = sort;
   }
 
-  public void showAllHiddenSeqs()
+  /**
+   * 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
+   */
+  public void expandColSelection(SequenceGroup sg, boolean wholewidth)
   {
-    if (alignment.getHiddenSequences().getSize() > 0)
+    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 (selectionGroup == null)
+      if (!wholewidth && alignment.getWidth() == (1 + sge - sgs))
+      {
+        // do nothing
+        return;
+      }
+      if (colSel == null)
       {
-        selectionGroup = new SequenceGroup();
-        selectionGroup.setEndRes(alignment.getWidth() - 1);
+        colSel = new ColumnSelection();
       }
-      Vector tmp = alignment.getHiddenSequences().showAll(hiddenRepSequences);
-      for (int t = 0; t < tmp.size(); t++)
+      for (int cspos = sg.getStartRes(); cspos <= sg.getEndRes(); cspos++)
       {
-        selectionGroup.addSequence(
-            (SequenceI) tmp.elementAt(t), false
-            );
+        colSel.addElement(cspos);
       }
-      firePropertyChange("alignment", null, alignment.getSequences());
-      hasHiddenRows = false;
-      hiddenRepSequences = null;
     }
   }
 
-  public void invertColumnSelection()
+  /**
+   * Returns the (Desktop) instance of the StructureSelectionManager
+   */
+  @Override
+  public StructureSelectionManager getStructureSelectionManager()
+  {
+    return StructureSelectionManager
+            .getStructureSelectionManager(Desktop.instance);
+  }
+
+  /**
+   * 
+   * @param pdbEntries
+   * @return an array of SequenceI arrays, one for each PDBEntry, listing which
+   *         sequences in the alignment hold a reference to it
+   */
+  public SequenceI[][] collateForPDB(PDBEntry[] pdbEntries)
   {
-    for (int i = 0; i < alignment.getWidth(); i++)
+    List<SequenceI[]> seqvectors = new ArrayList<SequenceI[]>();
+    for (PDBEntry pdb : pdbEntries)
     {
-      if (colSel.contains(i))
-      {
-        colSel.removeElement(i);
-      }
-      else
+      List<SequenceI> seqs = new ArrayList<SequenceI>();
+      for (SequenceI sq : alignment.getSequences())
       {
-        if (!hasHiddenColumns || colSel.isVisible(i))
+        Vector<PDBEntry> pdbs = sq.getDatasetSequence().getAllPDBEntries();
+        if (pdbs == null)
+        {
+          continue;
+        }
+        for (PDBEntry p1 : pdbs)
         {
-          colSel.addElement(i);
+          if (p1.getId().equals(pdb.getId()))
+          {
+            if (!seqs.contains(sq))
+            {
+              seqs.add(sq);
+              continue;
+            }
+          }
         }
       }
+      seqvectors.add(seqs.toArray(new SequenceI[seqs.size()]));
     }
+    return seqvectors.toArray(new SequenceI[seqvectors.size()][]);
+  }
+
+  public boolean isNormaliseSequenceLogo()
+  {
+    return normaliseSequenceLogo;
   }
 
-  public int adjustForHiddenSeqs(int alignmentIndex)
+  public void setNormaliseSequenceLogo(boolean state)
   {
-    return alignment.getHiddenSequences().adjustForHiddenSeqs(alignmentIndex);
+    normaliseSequenceLogo = state;
   }
 
   /**
-   * This method returns the a new SequenceI [] with
-   * the selection sequence and start and end points adjusted
-   * @return String[]
+   * 
+   * @return true if alignment characters should be displayed
    */
-  public SequenceI[] getSelectionAsNewSequence()
+  public boolean isValidCharWidth()
   {
-    SequenceI[] sequences;
+    return validCharWidth;
+  }
 
-    if (selectionGroup == null)
-    {
-      sequences = alignment.getSequencesArray();
-    }
-    else
+  private Hashtable<String, AutoCalcSetting> calcIdParams = new Hashtable<String, AutoCalcSetting>();
+
+  public AutoCalcSetting getCalcIdSettingsFor(String calcId)
+  {
+    return calcIdParams.get(calcId);
+  }
+
+  public void setCalcIdSettingsFor(String calcId, AutoCalcSetting settings,
+          boolean needsUpdate)
+  {
+    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)
     {
-      sequences = selectionGroup.getSelectionAsNewSequences(alignment);
+      Cache.log.debug("trigger update for " + calcId);
     }
-
-    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)
-  {
-    CigarArray selection = null;
-    SequenceI[] seqs = null;
-    int i, iSize;
-    int start = 0, end = 0;
-    if (selectedRegionOnly && selectionGroup != null)
+   * 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
+   */
+  @Override
+  public void mirrorCommand(CommandI command, boolean undo,
+          StructureSelectionManager ssm, VamsasSource source)
+  {
+    /*
+     * 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)
     {
-      iSize = selectionGroup.getSize();
-      seqs = selectionGroup.getSequencesInOrder(alignment);
-      start = selectionGroup.getStartRes();
-      end = selectionGroup.getEndRes(); // inclusive for start and end in SeqCigar constructor
+      // ok to continue;
     }
     else
     {
-      iSize = alignment.getHeight();
-      seqs = alignment.getSequencesArray();
-      end = alignment.getWidth() - 1;
+      return;
     }
-    SeqCigar[] selseqs = new SeqCigar[iSize];
-    for (i = 0; i < iSize; i++)
+
+    CommandI mappedCommand = ssm.mapCommand(command, undo, getAlignment(),
+            getGapCharacter());
+    if (mappedCommand != null)
     {
-      selseqs[i] = new SeqCigar(seqs[i], start, end);
+      AlignmentI[] views = getAlignPanel().alignFrame.getViewAlignments();
+      mappedCommand.doCommand(views);
+      getAlignPanel().alignmentChanged();
     }
-    selection = new CigarArray(selseqs);
-    // now construct the CigarArray operations
-    if (hasHiddenColumns)
+  }
+
+  /**
+   * 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 al
+   * @param title
+   */
+  public void addAlignment(AlignmentI al, String title)
+  {
+    // TODO: promote to AlignViewportI? applet CutAndPasteTransfer is different
+
+    // JBPComment: title is a largely redundant parameter at the moment
+    // JBPComment: this really should be an 'insert/pre/append' controller
+    // JBPComment: but the DNA/Protein check makes it a bit more complex
+
+    // refactored from FileLoader / CutAndPasteTransfer / SequenceFetcher with
+    // this comment:
+    // TODO: create undo object for this JAL-1101
+
+    /*
+     * If any cDNA/protein mappings can be made between the alignments, offer to
+     * open a linked alignment with split frame option.
+     */
+    if (Cache.getDefault(Preferences.ENABLE_SPLIT_FRAME, true))
     {
-      Vector regions = colSel.getHiddenColumns();
-      int[] region;
-      int hideStart, hideEnd;
-      int last = start;
-      for (int j = 0; last < end & j < regions.size(); j++)
+      if (al.getDataset() == null)
       {
-        region = (int[]) regions.elementAt(j);
-        hideStart = region[0];
-        hideEnd = region[1];
-        // edit hidden regions to selection range
-        if (hideStart < last)
+        // need to create ds seqs
+        for (SequenceI sq : al.getSequences())
         {
-          if (hideEnd > last)
+          if (sq.getDatasetSequence() == null)
           {
-            hideStart = last;
+            sq.createDatasetSequence();
           }
-          else
-          {
-            continue;
-          }
-        }
-
-        if (hideStart > end)
-        {
-          break;
-        }
-
-        if (hideEnd > end)
-        {
-          hideEnd = end;
-        }
-
-        if (hideStart > hideEnd)
-        {
-          break;
-        }
-        /**
-         * form operations...
-         */
-        if (last < hideStart)
-        {
-          selection.addOperation(CigarArray.M, hideStart - last);
         }
-        selection.addOperation(CigarArray.D, 1 + hideEnd - hideStart);
-        last = hideEnd + 1;
       }
-      // Final match if necessary.
-      if (last < end)
+      if (AlignmentUtils.isMappable(al, getAlignment()))
       {
-        selection.addOperation(CigarArray.M, end - last + 1);
+        if (openLinkedAlignment(al, title))
+        {
+          return;
+        }
       }
     }
-    else
-    {
-      selection.addOperation(CigarArray.M, end - start + 1);
-    }
-    return selection;
-  }
 
-  /**
-   * 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
-   */
-  jalview.datamodel.AlignmentView getAlignmentView(boolean selectedOnly)
-  {
-    // JBPNote:
-    // this is here because the AlignmentView constructor modifies the CigarArray
-    // object. Refactoring of Cigar and alignment view representation should
-    // be done to remove redundancy.
-    CigarArray aligview = getViewAsCigars(selectedOnly);
-    if (aligview != null)
+    /*
+     * No mappings, or offer declined - add sequences to this alignment
+     */
+    // TODO: JAL-407 regardless of above - identical sequences (based on ID and
+    // provenance) should share the same dataset sequence
+
+    for (int i = 0; i < al.getHeight(); i++)
     {
-      return new AlignmentView(aligview,
-                               (selectedOnly && selectionGroup != null) ?
-                               selectionGroup.getStartRes() : 0);
+      getAlignment().addSequence(al.getSequenceAt(i));
     }
-    return null;
+
+    setEndSeq(getAlignment().getHeight());
+    firePropertyChange("alignment", null, getAlignment().getSequences());
   }
 
   /**
-   * 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[]
+   * Show a dialog with the option to open and link (cDNA <-> protein) as a new
+   * alignment, either as a standalone alignment or in a split frame. Returns
+   * true if the new alignment was opened, false if not, because the user
+   * declined the offer.
+   * 
+   * @param al
+   * @param title
    */
-  public String[] getViewAsString(boolean selectedRegionOnly)
+  protected boolean openLinkedAlignment(AlignmentI al, String title)
   {
-    String[] selection = null;
-    SequenceI[] seqs = null;
-    int i, iSize;
-    int start = 0, end = 0;
-    if (selectedRegionOnly && selectionGroup != null)
+    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_split_window?"));
+    int response = JOptionPane.showOptionDialog(Desktop.desktop, question,
+            MessageManager.getString("label.open_split_window"),
+            JOptionPane.DEFAULT_OPTION, JOptionPane.PLAIN_MESSAGE, null,
+            options, options[0]);
+
+    if (response != 1 && response != 2)
     {
-      iSize = selectionGroup.getSize();
-      seqs = selectionGroup.getSequencesInOrder(alignment);
-      start = selectionGroup.getStartRes();
-      end = selectionGroup.getEndRes() + 1;
+      return false;
     }
-    else
+    final boolean openSplitPane = (response == 1);
+    final boolean openInNewWindow = (response == 2);
+
+    /*
+     * 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();
+    AlignmentI protein = al.isNucleotide() ? thisAlignment : al;
+    final AlignmentI cdna = al.isNucleotide() ? al : thisAlignment;
+
+    /*
+     * Map sequences. At least one should get mapped as we have already passed
+     * the test for 'mappability'. Any mappings made will be added to the
+     * protein alignment. Note creating dataset sequences on the new alignment
+     * is a pre-requisite for building mappings.
+     */
+    al.setDataset(null);
+    AlignmentUtils.mapProteinToCdna(protein, cdna);
+
+    /*
+     * Create the AlignFrame for the added alignment. If it is protein, mappings
+     * are registered with StructureSelectionManager as a side-effect.
+     */
+    AlignFrame newAlignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
+            AlignFrame.DEFAULT_HEIGHT);
+    newAlignFrame.setTitle(title);
+    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)
     {
-      iSize = alignment.getHeight();
-      seqs = alignment.getSequencesArray();
-      end = alignment.getWidth();
+      Desktop.addInternalFrame(newAlignFrame, title,
+              AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
     }
 
-    selection = new String[iSize];
-    if (hasHiddenColumns)
+    try
     {
-      selection = colSel.getVisibleSequenceStrings(start, end, seqs);
-    }
-    else
+      newAlignFrame.setMaximum(jalview.bin.Cache.getDefault(
+              "SHOW_FULLSCREEN", false));
+    } catch (java.beans.PropertyVetoException ex)
     {
-      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 (openSplitPane)
     {
-      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;
-      }
+      al.alignAs(thisAlignment);
+      protein = openSplitFrame(newAlignFrame, thisAlignment);
     }
-    while (end < max);
 
-    int[][] startEnd = new int[regions.size()][2];
+    return true;
+  }
+
+  /**
+   * Helper method to open a new SplitFrame holding linked dna and protein
+   * alignments.
+   * 
+   * @param newAlignFrame
+   *          containing a new alignment to be shown
+   * @param complement
+   *          cdna/protein complement alignment to show in the other split half
+   * @return the protein alignment in the split frame
+   */
+  protected AlignmentI openSplitFrame(AlignFrame newAlignFrame,
+          AlignmentI complement)
+  {
+    /*
+     * Make a new frame with a copy of the alignment we are adding to. If this
+     * is protein, the mappings to cDNA will be registered with
+     * StructureSelectionManager as a side-effect.
+     */
+    AlignFrame copyMe = new AlignFrame(complement,
+            AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
+    copyMe.setTitle(getAlignPanel().alignFrame.getTitle());
 
-    regions.copyInto(startEnd);
+    AlignmentI al = newAlignFrame.viewport.getAlignment();
+    final AlignFrame proteinFrame = al.isNucleotide() ? copyMe
+            : newAlignFrame;
+    final AlignFrame cdnaFrame = al.isNucleotide() ? newAlignFrame : copyMe;
+    cdnaFrame.setVisible(true);
+    proteinFrame.setVisible(true);
+    String linkedTitle = MessageManager
+            .getString("label.linked_view_title");
 
-    return startEnd;
+    /*
+     * Open in split pane. DNA sequence above, protein below.
+     */
+    JInternalFrame splitFrame = new SplitFrame(cdnaFrame, proteinFrame);
+    Desktop.addInternalFrame(splitFrame, linkedTitle, -1, -1);
 
+    return proteinFrame.viewport.getAlignment();
   }
 
-  public boolean getShowHiddenMarkers()
+  public AnnotationColumnChooser getAnnotationColumnSelectionState()
   {
-    return showHiddenMarkers;
+    return annotationColumnSelectionState;
   }
 
-  public void setShowHiddenMarkers(boolean show)
+  public void setAnnotationColumnSelectionState(
+          AnnotationColumnChooser currentAnnotationColumnSelectionState)
   {
-    showHiddenMarkers = show;
+    this.annotationColumnSelectionState = currentAnnotationColumnSelectionState;
   }
 
-  public String getSequenceSetId()
+  @Override
+  public void setIdWidth(int i)
   {
-    if (sequenceSetID == null)
+    super.setIdWidth(i);
+    AlignmentPanel ap = getAlignPanel();
+    if (ap != null)
     {
-      sequenceSetID = alignment.hashCode() + "";
+      // modify GUI elements to reflect geometry change
+      Dimension idw = getAlignPanel().getIdPanel().getIdCanvas()
+              .getPreferredSize();
+      idw.width = i;
+      getAlignPanel().getIdPanel().getIdCanvas().setPreferredSize(idw);
     }
-
-    return sequenceSetID;
   }
 
-  public void alignmentChanged(AlignmentPanel ap)
+  public Rectangle getExplodedGeometry()
   {
-    if (padGaps)
-    {
-      alignment.padGaps();
-    }
-
-    if (hconsensus != null && autoCalculateConsensus)
-    {
-      updateConsensus(ap);
-      updateConservation(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();
+    return explodedGeometry;
   }
 
-  void resetAllColourSchemes()
+  public void setExplodedGeometry(Rectangle explodedPosition)
   {
-    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);
-      }
-    }
+    this.explodedGeometry = explodedPosition;
+  }
 
-    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();
-    }
+  public boolean isGatherViewsHere()
+  {
+    return gatherViewsHere;
   }
 
-  public Color getSequenceColour(SequenceI seq)
+  public void setGatherViewsHere(boolean gatherViewsHere)
   {
-    if (sequenceColours == null || !sequenceColours.containsKey(seq))
-    {
-      return Color.white;
-    }
-    else
-    {
-      return (Color) sequenceColours.get(seq);
-    }
+    this.gatherViewsHere = gatherViewsHere;
   }
 
-  public void setSequenceColour(SequenceI seq, Color col)
+  /**
+   * If this viewport has a (Protein/cDNA) complement, then scroll the
+   * complementary alignment to match this one.
+   */
+  public void scrollComplementaryAlignment()
   {
-    if (sequenceColours == null)
+    /*
+     * Populate a SearchResults object with the mapped location to scroll to. If
+     * there is no complement, or it is not following highlights, or no mapping
+     * is found, the result will be empty.
+     */
+    SearchResults sr = new SearchResults();
+    int verticalOffset = findComplementScrollTarget(sr);
+    if (!sr.isEmpty())
     {
-      sequenceColours = new Hashtable();
+      // TODO would like next line without cast but needs more refactoring...
+      final AlignmentPanel complementPanel = ((AlignViewport) getCodingComplement())
+              .getAlignPanel();
+      complementPanel.setFollowingComplementScroll(true);
+      complementPanel.scrollToCentre(sr, verticalOffset);
     }
+  }
 
-    if (col == null)
+  /**
+   * Answers true if no alignment holds a reference to the given mapping
+   * 
+   * @param acf
+   * @return
+   */
+  protected boolean noReferencesTo(AlignedCodonFrame acf)
+  {
+    AlignFrame[] frames = Desktop.getAlignFrames();
+    if (frames == null)
     {
-      sequenceColours.remove(seq);
+      return true;
     }
-    else
+    for (AlignFrame af : frames)
     {
-      sequenceColours.put(seq, col);
+      if (!af.isClosed())
+      {
+        for (AlignmentViewPanel ap : af.getAlignPanels())
+        {
+          AlignmentI al = ap.getAlignment();
+          if (al != null && al.getCodonFrames().contains(acf))
+          {
+            return false;
+          }
+        }
+      }
     }
+    return true;
   }
 
 }