JAL-3148 SequenceRenderer, ResidueColourFinder overloads and
[jalview.git] / src / jalview / gui / StructureViewerBase.java
index e084417..05a163b 100644 (file)
@@ -37,6 +37,7 @@ import jalview.schemes.ColourSchemeI;
 import jalview.schemes.ColourSchemes;
 import jalview.structure.StructureMapping;
 import jalview.structures.models.AAStructureBindingModel;
+import jalview.structures.models.AAStructureBindingModel.ColourBy;
 import jalview.util.MessageManager;
 
 import java.awt.Color;
@@ -130,6 +131,26 @@ public abstract class StructureViewerBase extends GStructureViewer
   }
 
   /**
+   * @return true if added structures should be aligned to existing one(s)
+   */
+  @Override
+  public boolean isAlignAddedStructures()
+  {
+    return alignAddedStructures;
+  }
+
+  /**
+   * 
+   * @param true
+   *          if added structures should be aligned to existing one(s)
+   */
+  @Override
+  public void setAlignAddedStructures(boolean alignAdded)
+  {
+    alignAddedStructures = alignAdded;
+  }
+
+  /**
    * 
    * @param ap2
    * @return true if this Jmol instance is linked with the given alignPanel
@@ -139,15 +160,15 @@ public abstract class StructureViewerBase extends GStructureViewer
     return _aps.contains(ap2.av.getSequenceSetId());
   }
 
-  public boolean isUsedforaligment(AlignmentPanel ap2)
+  public boolean isUsedForAligment(AlignmentPanel ap2)
   {
 
     return (_alignwith != null) && _alignwith.contains(ap2);
   }
 
-  public boolean isUsedforcolourby(AlignmentPanel ap2)
+  public boolean isUsedForColourBy(Object o)
   {
-    return (_colourwith != null) && _colourwith.contains(ap2);
+    return (_colourwith != null) && _colourwith.contains(o);
   }
 
   /**
@@ -295,9 +316,10 @@ public abstract class StructureViewerBase extends GStructureViewer
           boolean enableColourBySeq)
   {
     useAlignmentPanelForColourbyseq(nap);
-    getBinding().setColourBySequence(enableColourBySeq);
     seqColour.setSelected(enableColourBySeq);
     viewerColour.setSelected(!enableColourBySeq);
+
+    getBinding().setColourBy(enableColourBySeq ? ColourBy.Sequence : ColourBy.Viewer);
   }
 
   public void useAlignmentPanelForColourbyseq(AlignmentPanel nap)
@@ -335,7 +357,7 @@ public abstract class StructureViewerBase extends GStructureViewer
    */
   protected void addStructure(final PDBEntry pdbentry,
           final SequenceI[] seqs, final String[] chains,
-          final boolean align, final IProgressIndicator alignFrame)
+          final IProgressIndicator alignFrame)
   {
     if (pdbentry.getFile() == null)
     {
@@ -359,7 +381,7 @@ public abstract class StructureViewerBase extends GStructureViewer
               }
             }
             // and call ourselves again.
-            addStructure(pdbentry, seqs, chains, align, alignFrame);
+            addStructure(pdbentry, seqs, chains, alignFrame);
           }
         }).start();
         return;
@@ -371,33 +393,11 @@ public abstract class StructureViewerBase extends GStructureViewer
             { seqs }, new String[][] { chains });
     addingStructures = true;
     _started = false;
-    alignAddedStructures = align;
     worker = new Thread(this);
     worker.start();
     return;
   }
 
-  /**
-   * Presents a dialog with the option to add an align a structure to an
-   * existing structure view
-   * 
-   * @param pdbId
-   * @param view
-   * @return YES, NO or CANCEL JvOptionPane code
-   */
-  protected int chooseAlignStructureToViewer(String pdbId,
-          StructureViewerBase view)
-  {
-    int option = JvOptionPane.showInternalConfirmDialog(Desktop.desktop,
-            MessageManager.formatMessage("label.add_pdbentry_to_view",
-                    new Object[]
-                    { pdbId, view.getTitle() }),
-            MessageManager
-                    .getString("label.align_to_existing_structure_view"),
-            JvOptionPane.YES_NO_CANCEL_OPTION);
-    return option;
-  }
-
   protected boolean hasPdbId(String pdbId)
   {
     return getBinding().hasPdbId(pdbId);
@@ -412,35 +412,23 @@ public abstract class StructureViewerBase extends GStructureViewer
     return Desktop.instance.getStructureViewers(alp, this.getClass());
   }
 
-
-  /**
-   * Check for any existing views involving this alignment and give user the
-   * option to add and align this molecule to one of them
-   * 
-   * @param pdbentry
-   * @param seq
-   * @param chains
-   * @param apanel
-   * @param pdbId
-   * @return true if user adds to a view, or cancels entirely, else false
-   */
   @Override
-  public boolean addToExistingViewer(PDBEntry pdbentry, SequenceI[] seq,
+  public void addToExistingViewer(PDBEntry pdbentry, SequenceI[] seq,
           String[] chains, final AlignmentViewPanel apanel, String pdbId)
   {
     /*
      * JAL-1742 exclude view with this structure already mapped (don't offer
-     * to align chain B to chain A of the same structure)
+     * to align chain B to chain A of the same structure); code may defend
+     * against this possibility before we reach here
      */
     if (hasPdbId(pdbId))
     {
-      return false;
+      return;
     }
-    AlignmentPanel ap = (AlignmentPanel) apanel; // Implementation error if this
+    AlignmentPanel alignPanel = (AlignmentPanel) apanel; // Implementation error if this
                                                  // cast fails
-    useAlignmentPanelForSuperposition(ap);
-    addStructure(pdbentry, seq, chains, true, ap.alignFrame);
-    return true;
+    useAlignmentPanelForSuperposition(alignPanel);
+    addStructure(pdbentry, seq, chains, alignPanel.alignFrame);
   }
 
   /**
@@ -504,33 +492,20 @@ public abstract class StructureViewerBase extends GStructureViewer
     }
   }
 
-  /**
-   * Check if the PDB file is already loaded, if so offer to add it to the
-   * existing viewer
-   * 
-   * @param seq
-   * @param chains
-   * @param apanel
-   * @param pdbId
-   * @return true if the user chooses to add to a viewer, or to cancel entirely
-   */
   @Override
   public boolean addAlreadyLoadedFile(SequenceI[] seq, String[] chains,
           final AlignmentViewPanel apanel, String pdbId)
   {
-    boolean finished = false;
     String alreadyMapped = apanel.getStructureSelectionManager()
             .alreadyMappedToFile(pdbId);
 
-    if (alreadyMapped != null)
+    if (alreadyMapped == null)
     {
-      /*
-       * the PDB file is already loaded
-       */
-      addSequenceMappingsToStructure(seq, chains, apanel, alreadyMapped);
-      finished = true;
+      return false;
     }
-    return finished;
+
+    addSequenceMappingsToStructure(seq, chains, apanel, alreadyMapped);
+    return true;
   }
 
   void setChainMenuItems(List<String> chainNames)
@@ -592,7 +567,7 @@ public abstract class StructureViewerBase extends GStructureViewer
     AlignmentI al = getAlignmentPanel().av.getAlignment();
     ColourSchemeI cs = ColourSchemes.getInstance()
             .getColourScheme(colourSchemeName, al, null);
-    getBinding().setJalviewColourScheme(cs);
+       getBinding().setJalviewColourScheme(cs, getAlignmentPanel());
   }
 
   /**
@@ -603,6 +578,8 @@ public abstract class StructureViewerBase extends GStructureViewer
     colourMenu.removeAll();
     AlignmentI al = getAlignmentPanel().av.getAlignment();
 
+       colourMenu.addSeparator();
+       
     /*
      * add colour by sequence, by chain, by charge and cysteine
      */
@@ -611,11 +588,11 @@ public abstract class StructureViewerBase extends GStructureViewer
     colourMenu.add(chargeColour);
     chargeColour.setEnabled(!al.isNucleotide());
 
-    /*
-     * add all 'simple' (per-residue) colour schemes registered to Jalview
-     */
+       /*
+        * add all colour schemes registered to Jalview
+        */
     ButtonGroup itemGroup = ColourMenuHelper.addMenuItems(colourMenu, this,
-            al, true);
+                               al);
 
     /*
      * add 'colour by viewer' (menu item text is set in subclasses)
@@ -773,12 +750,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
@@ -810,11 +781,11 @@ public abstract class StructureViewerBase extends GStructureViewer
       int[] alm = new int[_alignwith.size()];
       int a = 0;
 
-      for (AlignmentPanel ap : _alignwith)
+      for (AlignmentPanel alignPanel : _alignwith)
       {
-        als[a] = ap.av.getAlignment();
+        als[a] = alignPanel.av.getAlignment();
         alm[a] = -1;
-        alc[a++] = ap.av.getAlignment().getHiddenColumns();
+        alc[a++] = alignPanel.av.getAlignment().getHiddenColumns();
       }
       reply = getBinding().superposeStructures(als, alm, alc);
       if (reply != null)
@@ -826,9 +797,9 @@ public abstract class StructureViewerBase extends GStructureViewer
     } catch (Exception e)
     {
       StringBuffer sp = new StringBuffer();
-      for (AlignmentPanel ap : _alignwith)
+      for (AlignmentPanel alignPanel : _alignwith)
       {
-        sp.append("'" + ap.alignFrame.getTitle() + "' ");
+        sp.append("'" + alignPanel.alignFrame.getTitle() + "' ");
       }
       Cache.log.info("Couldn't align structures with the " + sp.toString()
               + "associated alignment panels.", e);
@@ -854,7 +825,7 @@ public abstract class StructureViewerBase extends GStructureViewer
     if (viewerColour.isSelected())
     {
       // disable automatic sequence colouring.
-      getBinding().setColourBySequence(false);
+      getBinding().setColourBy(ColourBy.Viewer);
     }
   }
 
@@ -876,12 +847,12 @@ public abstract class StructureViewerBase extends GStructureViewer
   public void seqColour_actionPerformed(ActionEvent actionEvent)
   {
     AAStructureBindingModel binding = getBinding();
-    binding.setColourBySequence(seqColour.isSelected());
+    boolean colourBySequence = seqColour.isSelected();
     if (_colourwith == null)
     {
       _colourwith = new Vector<>();
     }
-    if (binding.isColourBySequence())
+    if (colourBySequence)
     {
       if (!binding.isLoadingFromArchive())
       {
@@ -892,9 +863,9 @@ public abstract class StructureViewerBase extends GStructureViewer
         }
       }
       // Set the colour using the current view for the associated alignframe
-      for (AlignmentPanel ap : _colourwith)
+      for (AlignmentPanel alignPanel : _colourwith)
       {
-        binding.colourBySequence(ap);
+        binding.colourBySequence(alignPanel);
       }
       seqColoursApplied = true;
     }
@@ -976,6 +947,7 @@ public abstract class StructureViewerBase extends GStructureViewer
   /**
    * Configures the title and menu items of the viewer panel.
    */
+  @Override
   public void updateTitleAndMenus()
   {
     AAStructureBindingModel binding = getBinding();
@@ -1018,6 +990,12 @@ public abstract class StructureViewerBase extends GStructureViewer
   }
 
   @Override
+  public String toString()
+  {
+    return getTitle();
+  }
+
+  @Override
   public boolean hasMapping()
   {
     if (worker != null && (addingStructures || _started))
@@ -1054,4 +1032,10 @@ public abstract class StructureViewerBase extends GStructureViewer
     return seqColoursApplied;
   }
 
+  @Override
+  public void raiseViewer()
+  {
+    toFront();
+  }
+
 }