JAL-3400 include sequence name in View | Show Chain menu
[jalview.git] / src / jalview / gui / StructureViewerBase.java
index 72b0bcc..853ecc1 100644 (file)
@@ -20,6 +20,7 @@
  */
 package jalview.gui;
 
+import jalview.api.AlignViewportI;
 import jalview.api.AlignmentViewPanel;
 import jalview.bin.Cache;
 import jalview.datamodel.Alignment;
@@ -52,6 +53,7 @@ import java.io.FileReader;
 import java.io.IOException;
 import java.io.PrintWriter;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.Vector;
 
@@ -90,13 +92,13 @@ public abstract class StructureViewerBase extends GStructureViewer
   /**
    * list of alignment panels to use for superposition
    */
-  protected Vector<AlignmentPanel> _alignwith = new Vector<>();
+  protected Vector<AlignmentViewPanel> _alignwith = new Vector<>();
 
   /**
    * list of alignment panels that are used for colouring structures by aligned
    * sequences
    */
-  protected Vector<AlignmentPanel> _colourwith = new Vector<>();
+  protected Vector<AlignmentViewPanel> _colourwith = new Vector<>();
 
   private String viewId = null;
 
@@ -165,9 +167,10 @@ public abstract class StructureViewerBase extends GStructureViewer
     return (_alignwith != null) && _alignwith.contains(ap2);
   }
 
-  public boolean isUsedforcolourby(AlignmentPanel ap2)
+  @Override
+  public boolean isUsedforcolourby(AlignmentViewPanel avp)
   {
-    return (_colourwith != null) && _colourwith.contains(ap2);
+    return (_colourwith != null) && _colourwith.contains(avp);
   }
 
   /**
@@ -513,6 +516,10 @@ public abstract class StructureViewerBase extends GStructureViewer
     {
       return;
     }
+
+    /*
+     * add the 'All' menu item
+     */
     JMenuItem menuItem = new JMenuItem(
             MessageManager.getString("label.all"));
     menuItem.addActionListener(new ActionListener()
@@ -532,12 +539,29 @@ public abstract class StructureViewerBase extends GStructureViewer
         allChainsSelected = false;
       }
     });
-
     chainMenu.add(menuItem);
 
+    /*
+     * add a menu item for each structure and chain
+     */
+    Collections.sort(chainNames);
+    String lastSeqName = "";
     for (String chain : chainNames)
     {
-      menuItem = new JCheckBoxMenuItem(chain, true);
+      String seqName = getSequenceNameForChain(chain);
+      int nameLength = seqName.length();
+      if (nameLength > 16)
+      {
+        seqName = seqName.substring(0, 8) + "..."
+                + seqName.substring(nameLength - 8, nameLength);
+      }
+      String text = chain;
+      if (!lastSeqName.equals(seqName))
+      {
+        text = text + " " + seqName;
+      }
+      lastSeqName = seqName;
+      menuItem = new JCheckBoxMenuItem(text, true);
       menuItem.addItemListener(new ItemListener()
       {
         @Override
@@ -554,7 +578,25 @@ public abstract class StructureViewerBase extends GStructureViewer
     }
   }
 
-  abstract void showSelectedChains();
+  /**
+   * Answers the name of the sequence mapped to the given chain (formatted as
+   * pdbId:chainId, e.g. 1A70:A). Answers null if no mapped sequence is found. If
+   * more than one sequence is matched, just answers the name of the first one
+   * found.
+   * 
+   * @param chain
+   * @return
+   */
+  private String getSequenceNameForChain(String chain)
+  {
+    String[] tokens = chain.split(":");
+    String pdbId = tokens[0];
+    String chainId = tokens[1];
+    List<StructureMapping> mappings = getBinding().getSsm()
+            .getMappingForChain(pdbId, chainId);
+    return mappings.isEmpty() ? null
+            : mappings.get(0).getSequence().getName();
+  }
 
   /**
    * Action on selecting one of Jalview's registered colour schemes
@@ -564,7 +606,8 @@ public abstract class StructureViewerBase extends GStructureViewer
   {
     AlignmentI al = getAlignmentPanel().av.getAlignment();
     ColourSchemeI cs = ColourSchemes.getInstance()
-            .getColourScheme(colourSchemeName, al, null);
+            .getColourScheme(colourSchemeName, getAlignmentPanel().av, al,
+                    null);
     getBinding().setJalviewColourScheme(cs);
   }
 
@@ -708,6 +751,36 @@ public abstract class StructureViewerBase extends GStructureViewer
             });
     viewMenu.add(seqColourBy);
 
+    showAlignmentOnly = new JCheckBoxMenuItem(
+            MessageManager.getString("label.show_alignment_only"));
+    showAlignmentOnly.addActionListener(new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        hideHiddenRegions.setEnabled(showAlignmentOnly.isSelected());
+        getBinding().setShowAlignmentOnly(showAlignmentOnly.isSelected());
+        getBinding().showStructures(getAlignmentPanel().getAlignViewport(),
+                true);
+      }
+    });
+    viewMenu.add(showAlignmentOnly);
+
+    hideHiddenRegions = new JCheckBoxMenuItem(
+            MessageManager.getString("label.hide_hidden_regions"));
+    hideHiddenRegions.setEnabled(false);
+    hideHiddenRegions.addActionListener(new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        getBinding().setHideHiddenRegions(hideHiddenRegions.isSelected());
+        getBinding().showStructures(getAlignmentPanel().getAlignViewport(),
+                false);
+      }
+    });
+    viewMenu.add(hideHiddenRegions);
+
     final ItemListener handler = new ItemListener()
     {
       @Override
@@ -746,12 +819,6 @@ public abstract class StructureViewerBase extends GStructureViewer
     buildColourMenu();
   }
 
-  @Override
-  public void setJalviewColourScheme(ColourSchemeI cs)
-  {
-    getBinding().setJalviewColourScheme(cs);
-  }
-
   /**
    * Sends commands to the structure viewer to superimpose structures based on
    * currently associated alignments. May optionally return an error message for
@@ -783,11 +850,12 @@ public abstract class StructureViewerBase extends GStructureViewer
       int[] alm = new int[_alignwith.size()];
       int a = 0;
 
-      for (AlignmentPanel alignPanel : _alignwith)
+      for (AlignmentViewPanel alignPanel : _alignwith)
       {
-        als[a] = alignPanel.av.getAlignment();
+        AlignViewportI av = alignPanel.getAlignViewport();
+        als[a] = av.getAlignment();
         alm[a] = -1;
-        alc[a++] = alignPanel.av.getAlignment().getHiddenColumns();
+        alc[a++] = av.getAlignment().getHiddenColumns();
       }
       reply = getBinding().superposeStructures(als, alm, alc);
       if (reply != null)
@@ -799,9 +867,10 @@ public abstract class StructureViewerBase extends GStructureViewer
     } catch (Exception e)
     {
       StringBuffer sp = new StringBuffer();
-      for (AlignmentPanel alignPanel : _alignwith)
+      for (AlignmentViewPanel avp : _alignwith)
       {
-        sp.append("'" + alignPanel.alignFrame.getTitle() + "' ");
+        sp.append(
+                "'" + ((AlignmentPanel) avp).alignFrame.getTitle() + "' ");
       }
       Cache.log.info("Couldn't align structures with the " + sp.toString()
               + "associated alignment panels.", e);
@@ -865,9 +934,9 @@ public abstract class StructureViewerBase extends GStructureViewer
         }
       }
       // Set the colour using the current view for the associated alignframe
-      for (AlignmentPanel alignPanel : _colourwith)
+      for (AlignmentViewPanel avp : _colourwith)
       {
-        binding.colourBySequence(alignPanel);
+        binding.updateStructureColours(avp);
       }
       seqColoursApplied = true;
     }
@@ -1040,4 +1109,21 @@ public abstract class StructureViewerBase extends GStructureViewer
     toFront();
   }
 
+  @Override
+  public abstract AAStructureBindingModel getBinding();
+
+  /**
+   * Show only the selected chain(s) in the viewer
+   */
+  protected void showSelectedChains()
+  {
+    setSelectedChains();
+  
+    /*
+     * refresh display without resizing - easier to see what changed
+     */
+    getBinding().showStructures(getAlignmentPanel().getAlignViewport(),
+            false);
+  }
+
 }