3253-omnibus save
[jalview.git] / src / jalview / gui / AlignViewport.java
index cc533ce..954cfcc 100644 (file)
@@ -47,6 +47,7 @@ import jalview.schemes.UserColourScheme;
 import jalview.structure.SelectionSource;
 import jalview.structure.StructureSelectionManager;
 import jalview.structure.VamsasSource;
+import jalview.util.ColorUtils;
 import jalview.util.MessageManager;
 import jalview.viewmodel.AlignmentViewport;
 import jalview.ws.params.AutoCalcSetting;
@@ -56,6 +57,7 @@ import java.awt.Dimension;
 import java.awt.Font;
 import java.awt.FontMetrics;
 import java.awt.Rectangle;
+import java.util.ArrayList;
 import java.util.Hashtable;
 import java.util.Iterator;
 import java.util.List;
@@ -77,9 +79,9 @@ public class AlignViewport extends AlignmentViewport
 
   boolean antiAlias = false;
 
-  private Rectangle explodedGeometry;
+  private Rectangle explodedGeometry = null;
 
-  private String viewName;
+  private String viewName = null;
 
   /*
    * Flag set true on the view that should 'gather' multiple views of the same
@@ -206,24 +208,29 @@ public class AlignViewport extends AlignmentViewport
    */
   private void applyViewProperties()
   {
-    antiAlias = Cache.getDefault("ANTI_ALIAS", 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);
-
-    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));
+         // BH! using final static strings here because we also use these in 
+         // JS version startup api
+         // BH was false
+    antiAlias = Cache.getDefault(Preferences.ANTI_ALIAS, true);
+
+    viewStyle.setShowJVSuffix(
+            Cache.getDefault(Preferences.SHOW_JVSUFFIX, true));
+    setShowAnnotation(Cache.getDefault(Preferences.SHOW_ANNOTATIONS, true));
+
+    setRightAlignIds(Cache.getDefault(Preferences.RIGHT_ALIGN_IDS, false));
+    setCentreColumnLabels(Cache.getDefault(Preferences.CENTRE_COLUMN_LABELS, false));
+    autoCalculateConsensusAndConservation = Cache.getDefault(Preferences.AUTO_CALC_CONSENSUS, true);
+
+    setPadGaps(Cache.getDefault(Preferences.PAD_GAPS, true));
+    setShowNPFeats(Cache.getDefault(Preferences.SHOW_NPFEATS_TOOLTIP, true));
+    setShowDBRefs(Cache.getDefault(Preferences.SHOW_DBREFS_TOOLTIP, true));
+    viewStyle.setSeqNameItalics(Cache.getDefault(Preferences.ID_ITALICS, true));
+    viewStyle.setWrapAlignment(
+            Cache.getDefault(Preferences.WRAP_ALIGNMENT, false));
     viewStyle.setShowUnconserved(
-            Cache.getDefault("SHOW_UNCONSERVED", false));
-    sortByTree = Cache.getDefault("SORT_BY_TREE", false);
-    followSelection = Cache.getDefault("FOLLOW_SELECTIONS", true);
+            Cache.getDefault(Preferences.SHOW_UNCONSERVED, false));
+    sortByTree = Cache.getDefault(Preferences.SORT_BY_TREE, false);
+    followSelection = Cache.getDefault(Preferences.FOLLOW_SELECTIONS, true);
     sortAnnotationsBy = SequenceAnnotationOrder
             .valueOf(Cache.getDefault(Preferences.SORT_ANNOTATIONS,
                     SequenceAnnotationOrder.NONE.name()));
@@ -237,9 +244,10 @@ public class AlignViewport extends AlignmentViewport
   {
     applyViewProperties();
 
-    String fontName = Cache.getDefault("FONT_NAME", "SansSerif");
-    String fontStyle = Cache.getDefault("FONT_STYLE", Font.PLAIN + "");
-    String fontSize = Cache.getDefault("FONT_SIZE", "10");
+    String fontName = Cache.getDefault(Preferences.FONT_NAME, "SansSerif");
+    String fontStyle = Cache.getDefault(Preferences.FONT_STYLE,
+            Font.PLAIN + "");
+    String fontSize = Cache.getDefault(Preferences.FONT_SIZE, "10");
 
     int style = 0;
 
@@ -255,7 +263,8 @@ public class AlignViewport extends AlignmentViewport
     setFont(new Font(fontName, style, Integer.parseInt(fontSize)), true);
 
     alignment
-            .setGapCharacter(Cache.getDefault("GAP_SYMBOL", "-").charAt(0));
+            .setGapCharacter(Cache.getDefault(Preferences.GAP_SYMBOL, "-")
+                    .charAt(0));
 
     // We must set conservation and consensus before setting colour,
     // as Blosum and Clustal require this to be done
@@ -263,18 +272,22 @@ public class AlignViewport extends AlignmentViewport
     {
       if (!alignment.isNucleotide())
       {
-        showConservation = Cache.getDefault("SHOW_CONSERVATION", true);
-        showQuality = Cache.getDefault("SHOW_QUALITY", true);
-        showGroupConservation = Cache.getDefault("SHOW_GROUP_CONSERVATION",
-                false);
+        showConservation = Cache.getDefault(Preferences.SHOW_CONSERVATION,
+                true);
+        showQuality = Cache.getDefault(Preferences.SHOW_QUALITY, true);
+        showGroupConservation = Cache
+                .getDefault(Preferences.SHOW_GROUP_CONSERVATION, false);
       }
-      showConsensusHistogram = Cache.getDefault("SHOW_CONSENSUS_HISTOGRAM",
-              true);
-      showSequenceLogo = Cache.getDefault("SHOW_CONSENSUS_LOGO", false);
-      normaliseSequenceLogo = Cache.getDefault("NORMALISE_CONSENSUS_LOGO",
+      showConsensusHistogram = Cache
+              .getDefault(Preferences.SHOW_CONSENSUS_HISTOGRAM, true);
+      showSequenceLogo = Cache.getDefault(Preferences.SHOW_CONSENSUS_LOGO,
               false);
-      showGroupConsensus = Cache.getDefault("SHOW_GROUP_CONSENSUS", false);
-      showConsensus = Cache.getDefault("SHOW_IDENTITY", true);
+
+      normaliseSequenceLogo = Cache
+              .getDefault(Preferences.NORMALISE_CONSENSUS_LOGO, false);
+      showGroupConsensus = Cache
+              .getDefault(Preferences.SHOW_GROUP_CONSENSUS, false);
+      showConsensus = Cache.getDefault(Preferences.SHOW_IDENTITY, true);
 
       showOccupancy = Cache.getDefault(Preferences.SHOW_OCCUPANCY, true);
     }
@@ -290,7 +303,7 @@ public class AlignViewport extends AlignmentViewport
               ResidueColourScheme.NONE);
     }
     ColourSchemeI colourScheme = ColourSchemeProperty
-            .getColourScheme(alignment, schemeName);
+            .getColourScheme(this, alignment, schemeName);
     residueShading = new ResidueShader(colourScheme);
 
     if (colourScheme instanceof UserColourScheme)
@@ -304,6 +317,7 @@ public class AlignViewport extends AlignmentViewport
     {
       residueShading.setConsensus(hconsensus);
     }
+    setColourAppliesToAllGroups(true);
   }
 
   boolean validCharWidth;
@@ -382,9 +396,8 @@ public class AlignViewport extends AlignmentViewport
      */
     if (align != null)
     {
-      StructureSelectionManager ssm = StructureSelectionManager
-              .getStructureSelectionManager(Desktop.instance);
-      ssm.registerMappings(align.getCodonFrames());
+      Desktop.getStructureSelectionManager()
+              .registerMappings(align.getCodonFrames());
     }
 
     /*
@@ -404,8 +417,8 @@ public class AlignViewport extends AlignmentViewport
       List<AlignedCodonFrame> mappings = al.getCodonFrames();
       if (mappings != null)
       {
-        StructureSelectionManager ssm = StructureSelectionManager
-                .getStructureSelectionManager(Desktop.instance);
+        StructureSelectionManager ssm = Desktop
+                .getStructureSelectionManager();
         for (AlignedCodonFrame acf : mappings)
         {
           if (noReferencesTo(acf))
@@ -530,12 +543,10 @@ public class AlignViewport extends AlignmentViewport
   @Override
   public void sendSelection()
   {
-    jalview.structure.StructureSelectionManager
-            .getStructureSelectionManager(Desktop.instance)
-            .sendSelection(new SequenceGroup(getSelectionGroup()),
-                    new ColumnSelection(getColumnSelection()),
-                    new HiddenColumns(getAlignment().getHiddenColumns()),
-                    this);
+    Desktop.getStructureSelectionManager().sendSelection(
+            new SequenceGroup(getSelectionGroup()),
+            new ColumnSelection(getColumnSelection()),
+            new HiddenColumns(getAlignment().getHiddenColumns()), this);
   }
 
   /**
@@ -576,8 +587,7 @@ public class AlignViewport extends AlignmentViewport
   @Override
   public StructureSelectionManager getStructureSelectionManager()
   {
-    return StructureSelectionManager
-            .getStructureSelectionManager(Desktop.instance);
+    return Desktop.getStructureSelectionManager();
   }
 
   @Override
@@ -707,16 +717,20 @@ public class AlignViewport extends AlignmentViewport
     {
       if (AlignmentUtils.isMappable(toAdd, getAlignment()))
       {
-        if (openLinkedAlignment(toAdd, title))
-        {
-          return;
-        }
+        openLinkedAlignment(toAdd, title);
+        return;
       }
     }
+    addDataToAlignment(toAdd);
+  }
 
-    /*
-     * No mappings, or offer declined - add sequences to this alignment
-     */
+  /**
+   * adds sequences to this alignment
+   * 
+   * @param toAdd
+   */
+  void addDataToAlignment(AlignmentI toAdd)
+  {
     // TODO: JAL-407 regardless of above - identical sequences (based on ID and
     // provenance) should share the same dataset sequence
 
@@ -738,10 +752,16 @@ public class AlignViewport extends AlignmentViewport
       }
     }
 
-    ranges.setEndSeq(getAlignment().getHeight());
+    ranges.setEndSeq(getAlignment().getHeight() - 1); // BH 2019.04.18
     firePropertyChange("alignment", null, getAlignment().getSequences());
   }
 
+  public final static int NO_SPLIT = 0;
+
+  public final static int SPLIT_FRAME = 1;
+
+  public final static int NEW_WINDOW = 2;
+
   /**
    * 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
@@ -751,33 +771,69 @@ public class AlignViewport extends AlignmentViewport
    * @param al
    * @param title
    */
-  protected boolean openLinkedAlignment(AlignmentI al, String title)
+  protected void 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_split_window?"));
-    int response = JvOptionPane.showOptionDialog(Desktop.desktop, question,
+
+    /*
+     * options No, Split Window, New Window correspond to
+     * dialog responses 0, 1, 2 (even though JOptionPane shows them
+     * in reverse order)
+     */
+    JvOptionPane dialog = JvOptionPane
+            .newOptionDialog(Desktop.getDesktopPane())
+            .setResponseHandler(NO_SPLIT, new Runnable()
+            {
+              @Override
+              public void run()
+              {
+                addDataToAlignment(al);
+              }
+            }).setResponseHandler(SPLIT_FRAME, new Runnable()
+            {
+              @Override
+              public void run()
+              {
+                openLinkedAlignmentAs(getAlignPanel().alignFrame,
+                        new Alignment(getAlignment()), al, title,
+                        SPLIT_FRAME);
+              }
+            }).setResponseHandler(NEW_WINDOW, new Runnable()
+            {
+              @Override
+              public void run()
+              {
+                openLinkedAlignmentAs(null, getAlignment(), al, title,
+                        NEW_WINDOW);
+              }
+            });
+    dialog.showDialog(question,
             MessageManager.getString("label.open_split_window"),
             JvOptionPane.DEFAULT_OPTION, JvOptionPane.PLAIN_MESSAGE, null,
             options, options[0]);
+  }
 
-    if (response != 1 && response != 2)
-    {
-      return false;
-    }
-    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();
+  /**
+   * Open a split frame or a new window
+   * 
+   * @param al
+   * @param title
+   * @param mode
+   *          SPLIT_FRAME or NEW_WINDOW
+   */
+  public static void openLinkedAlignmentAs(AlignFrame thisFrame,
+          AlignmentI thisAlignment, AlignmentI al, String title, int mode)
+  {
+     // BH: thisAlignment is already a copy if mode == SPLIT_FRAME
+     // Identify protein and dna alignments. Make a copy of this one if opening
+     // in a new split pane.
+     
     AlignmentI protein = al.isNucleotide() ? thisAlignment : al;
-    final AlignmentI cdna = al.isNucleotide() ? al : thisAlignment;
+    AlignmentI cdna = al.isNucleotide() ? al : thisAlignment;
 
     /*
      * Map sequences. At least one should get mapped as we have already passed
@@ -795,7 +851,7 @@ public class AlignViewport extends AlignmentViewport
     AlignFrame newAlignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
             AlignFrame.DEFAULT_HEIGHT);
     newAlignFrame.setTitle(title);
-    newAlignFrame.statusBar.setText(MessageManager
+    newAlignFrame.setStatus(MessageManager
             .formatMessage("label.successfully_loaded_file", new Object[]
             { title }));
 
@@ -806,7 +862,7 @@ public class AlignViewport extends AlignmentViewport
     // alignFrame.setFileName(file, format);
     // }
 
-    if (openInNewWindow)
+    if (mode == NEW_WINDOW)
     {
       Desktop.addInternalFrame(newAlignFrame, title,
               AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
@@ -814,19 +870,16 @@ public class AlignViewport extends AlignmentViewport
 
     try
     {
-      newAlignFrame.setMaximum(
-              jalview.bin.Cache.getDefault("SHOW_FULLSCREEN", false));
+      newAlignFrame.setMaximum(Cache.getDefault(Preferences.SHOW_FULLSCREEN, false));
     } catch (java.beans.PropertyVetoException ex)
     {
     }
 
-    if (openSplitPane)
+    if (mode == SPLIT_FRAME)
     {
       al.alignAs(thisAlignment);
-      protein = openSplitFrame(newAlignFrame, thisAlignment);
+      openSplitFrame(thisFrame, newAlignFrame, thisAlignment);
     }
-
-    return true;
   }
 
   /**
@@ -839,8 +892,8 @@ public class AlignViewport extends AlignmentViewport
    *          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)
+  static protected AlignmentI openSplitFrame(AlignFrame thisFrame,
+          AlignFrame newAlignFrame, AlignmentI complement)
   {
     /*
      * Make a new frame with a copy of the alignment we are adding to. If this
@@ -849,7 +902,7 @@ public class AlignViewport extends AlignmentViewport
      */
     AlignFrame copyMe = new AlignFrame(complement, AlignFrame.DEFAULT_WIDTH,
             AlignFrame.DEFAULT_HEIGHT);
-    copyMe.setTitle(getAlignPanel().alignFrame.getTitle());
+    copyMe.setTitle(thisFrame.getTitle());
 
     AlignmentI al = newAlignFrame.viewport.getAlignment();
     final AlignFrame proteinFrame = al.isNucleotide() ? copyMe
@@ -888,10 +941,9 @@ public class AlignViewport extends AlignmentViewport
     if (ap != null)
     {
       // modify GUI elements to reflect geometry change
-      Dimension idw = getAlignPanel().getIdPanel().getIdCanvas()
-              .getPreferredSize();
+      Dimension idw = ap.getIdPanel().getIdCanvas().getPreferredSize();
       idw.width = i;
-      getAlignPanel().getIdPanel().getIdCanvas().setPreferredSize(idw);
+      ap.getIdPanel().getIdCanvas().setPreferredSize(idw);
     }
   }
 
@@ -980,6 +1032,35 @@ public class AlignViewport extends AlignmentViewport
   @Override
   public void applyFeaturesStyle(FeatureSettingsModelI featureSettings)
   {
+    transferFeaturesStyles(featureSettings, false);
+  }
+
+  /**
+   * Applies the supplied feature settings descriptor to currently known features.
+   * This supports an 'initial configuration' of feature colouring based on a
+   * preset or user favourite. This may then be modified in the usual way using
+   * the Feature Settings dialogue.
+   * 
+   * @param featureSettings
+   */
+  @Override
+  public void mergeFeaturesStyle(FeatureSettingsModelI featureSettings)
+  {
+    transferFeaturesStyles(featureSettings, true);
+  }
+
+  /**
+   * when mergeOnly is set, then group and feature visibility or feature colours
+   * are not modified for features and groups already known to the feature
+   * renderer. Feature ordering is always adjusted, and transparency is always set
+   * regardless.
+   * 
+   * @param featureSettings
+   * @param mergeOnly
+   */
+  private void transferFeaturesStyles(FeatureSettingsModelI featureSettings,
+          boolean mergeOnly)
+  {
     if (featureSettings == null)
     {
       return;
@@ -987,12 +1068,24 @@ public class AlignViewport extends AlignmentViewport
 
     FeatureRenderer fr = getAlignPanel().getSeqPanel().seqCanvas
             .getFeatureRenderer();
+    List<String> origRenderOrder = new ArrayList<>(),
+            origGroups = new ArrayList<>();
+    // preserve original render order - allows differentiation between user configured colours and autogenerated ones
+    origRenderOrder.addAll(fr.getRenderOrder());
+    origGroups.addAll(fr.getFeatureGroups());
+
     fr.findAllFeatures(true);
     List<String> renderOrder = fr.getRenderOrder();
     FeaturesDisplayedI displayed = fr.getFeaturesDisplayed();
+    if (!mergeOnly)
+    {
+      // only clear displayed features if we are merging
     displayed.clear();
+    }
     // TODO this clears displayed.featuresRegistered - do we care?
-
+    //
+    // JAL-3330 - JBP - yes we do - calling applyFeatureStyle to a view where
+    // feature visibility has already been configured is not very friendly
     /*
      * set feature colour if specified by feature settings
      * set visibility of all features
@@ -1001,6 +1094,16 @@ public class AlignViewport extends AlignmentViewport
     {
       FeatureColourI preferredColour = featureSettings
               .getFeatureColour(type);
+      FeatureColourI origColour = fr.getFeatureStyle(type);
+      if (!mergeOnly || (!origRenderOrder.contains(type)
+              || origColour == null
+              || (!origColour.isGraduatedColour()
+                      && origColour.getColour() != null
+                      && origColour.getColour().equals(
+                              ColorUtils.createColourFromName(type)))))
+      {
+        // if we are merging, only update if there wasn't already a colour defined for
+        // this type
       if (preferredColour != null)
       {
         fr.setColour(type, preferredColour);
@@ -1010,13 +1113,19 @@ public class AlignViewport extends AlignmentViewport
         displayed.setVisible(type);
       }
     }
+    }
 
     /*
      * set visibility of feature groups
      */
     for (String group : fr.getFeatureGroups())
     {
-      fr.setGroupVisibility(group, featureSettings.isGroupDisplayed(group));
+      if (!mergeOnly || !origGroups.contains(group))
+      {
+        // when merging, display groups only if the aren't already marked as not visible
+        fr.setGroupVisibility(group,
+                featureSettings.isGroupDisplayed(group));
+      }
     }
 
     /*