JAL-3148 show/hide features on structure independent of alignment
[jalview.git] / src / jalview / appletgui / AppletJmol.java
index 18e7d1a..681fc7d 100644 (file)
@@ -24,10 +24,11 @@ import jalview.bin.JalviewLite;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SequenceI;
-import jalview.io.FileParse;
 import jalview.io.DataSourceType;
+import jalview.io.FileParse;
 import jalview.io.StructureFile;
 import jalview.schemes.BuriedColourScheme;
+import jalview.schemes.ColourSchemeI;
 import jalview.schemes.HelixColourScheme;
 import jalview.schemes.HydrophobicColourScheme;
 import jalview.schemes.PurinePyrimidineColourScheme;
@@ -37,6 +38,7 @@ import jalview.schemes.TurnColourScheme;
 import jalview.schemes.UserColourScheme;
 import jalview.schemes.ZappoColourScheme;
 import jalview.structure.StructureSelectionManager;
+import jalview.structures.models.AAStructureBindingModel.ColourBy;
 import jalview.util.MessageManager;
 
 import java.awt.BorderLayout;
@@ -61,12 +63,11 @@ import java.awt.event.KeyListener;
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
 import java.util.ArrayList;
-import java.util.Hashtable;
 import java.util.List;
 import java.util.Vector;
 
 public class AppletJmol extends EmbmenuFrame implements
-// StructureListener,
+        // StructureListener,
         KeyListener, ActionListener, ItemListener
 
 {
@@ -89,32 +90,35 @@ public class AppletJmol extends EmbmenuFrame implements
   CheckboxMenuItem jmolColour = new CheckboxMenuItem(
           MessageManager.getString("action.using_jmol"), false);
 
-  MenuItem chain = new MenuItem(MessageManager.getString("action.by_chain"));
+  MenuItem chain = new MenuItem(
+          MessageManager.getString("action.by_chain"));
 
   MenuItem charge = new MenuItem(
           MessageManager.getString("label.charge_cysteine"));
 
-  MenuItem zappo = new MenuItem(MessageManager.getString("label.zappo"));
+  MenuItem zappo = new MenuItem(
+          MessageManager.getString("label.colourScheme_zappo"));
 
-  MenuItem taylor = new MenuItem(MessageManager.getString("label.taylor"));
+  MenuItem taylor = new MenuItem(
+          MessageManager.getString("label.colourScheme_taylor"));
 
   MenuItem hydro = new MenuItem(
-          MessageManager.getString("label.hydrophobicity"));
+          MessageManager.getString("label.colourScheme_hydrophobic"));
 
   MenuItem helix = new MenuItem(
-          MessageManager.getString("label.helix_propensity"));
+          MessageManager.getString("label.colourScheme_helix_propensity"));
 
   MenuItem strand = new MenuItem(
-          MessageManager.getString("label.strand_propensity"));
+          MessageManager.getString("label.colourScheme_strand_propensity"));
 
   MenuItem turn = new MenuItem(
-          MessageManager.getString("label.turn_propensity"));
+          MessageManager.getString("label.colourScheme_turn_propensity"));
 
   MenuItem buried = new MenuItem(
-          MessageManager.getString("label.buried_index"));
+          MessageManager.getString("label.colourScheme_buried_index"));
 
   MenuItem purinepyrimidine = new MenuItem(
-          MessageManager.getString("label.purine_pyrimidine"));
+          MessageManager.getString("label.colourScheme_purine/pyrimidine"));
 
   MenuItem user = new MenuItem(
           MessageManager.getString("label.user_defined_colours"));
@@ -132,7 +136,7 @@ public class AppletJmol extends EmbmenuFrame implements
 
   AlignmentPanel ap;
 
-  List<AlignmentPanel> _aps = new ArrayList<AlignmentPanel>(); // remove? never
+  List<AlignmentPanel> _aps = new ArrayList<>(); // remove? never
                                                                // added to
 
   String fileLoadingError;
@@ -181,15 +185,15 @@ public class AppletJmol extends EmbmenuFrame implements
   {
     this.ap = ap;
     jmb = new AppletJmolBinding(this, ap.getStructureSelectionManager(),
-            new PDBEntry[] { pdbentry }, new SequenceI[][] { seq },
-            new String[][] { chains }, protocol);
-    jmb.setColourBySequence(true);
+            new PDBEntry[]
+            { pdbentry }, new SequenceI[][] { seq }, protocol);
+    jmb.setColourBy(ColourBy.Sequence);
     if (pdbentry.getId() == null || pdbentry.getId().length() < 1)
     {
       if (protocol == DataSourceType.PASTE)
       {
-        pdbentry.setId("PASTED PDB"
-                + (chains == null ? "_" : chains.toString()));
+        pdbentry.setId(
+                "PASTED PDB" + (chains == null ? "_" : chains.toString()));
       }
       else
       {
@@ -209,9 +213,9 @@ public class AppletJmol extends EmbmenuFrame implements
     StructureFile reader = null;
     if (alreadyMapped != null)
     {
-      reader = StructureSelectionManager.getStructureSelectionManager(
-              ap.av.applet).setMapping(seq, chains, pdbentry.getFile(),
-              protocol);
+      reader = StructureSelectionManager
+              .getStructureSelectionManager(ap.av.applet)
+              .setMapping(seq, chains, pdbentry.getFile(), protocol, null);
       // PROMPT USER HERE TO ADD TO NEW OR EXISTING VIEW?
       // FOR NOW, LETS JUST OPEN A NEW WINDOW
     }
@@ -267,15 +271,15 @@ public class AppletJmol extends EmbmenuFrame implements
 
     try
     {
-      jmb.allocateViewer(renderPanel, true, ap.av.applet.getName()
-              + "_jmol_", ap.av.applet.getDocumentBase(),
-              ap.av.applet.getCodeBase(), "-applet", scriptWindow, null);
+      jmb.allocateViewer(renderPanel, true,
+              ap.av.applet.getName() + "_jmol_",
+              ap.av.applet.getDocumentBase(), ap.av.applet.getCodeBase(),
+              "-applet", scriptWindow, null);
     } catch (Exception e)
     {
-      System.err
-              .println("Couldn't create a jmol viewer. Args to allocate viewer were:\nDocumentBase="
-                      + ap.av.applet.getDocumentBase()
-                      + "\nCodebase="
+      System.err.println(
+              "Couldn't create a jmol viewer. Args to allocate viewer were:\nDocumentBase="
+                      + ap.av.applet.getDocumentBase() + "\nCodebase="
                       + ap.av.applet.getCodeBase());
       e.printStackTrace();
       dispose();
@@ -291,12 +295,9 @@ public class AppletJmol extends EmbmenuFrame implements
         closeViewer();
       }
     });
-    if (pdbentry.getProperty() == null)
-    {
-      pdbentry.setProperty(new Hashtable<String, String>());
-      pdbentry.getProperty().put("protocol", protocol.toString());
-    }
+    pdbentry.setProperty("protocol", protocol);
     if (pdbentry.getFile() != null)
+
     {
       // import structure data from pdbentry.getFile based on given protocol
       if (protocol == DataSourceType.PASTE)
@@ -321,8 +322,8 @@ public class AppletJmol extends EmbmenuFrame implements
           {
             if (jalview.bin.JalviewLite.debug)
             {
-              System.err
-                      .println("AppletJmol:Trying to reuse existing PDBfile IO parser.");
+              System.err.println(
+                      "AppletJmol:Trying to reuse existing PDBfile IO parser.");
             }
             // re-use the one we opened earlier
             freader = reader.getReader();
@@ -331,8 +332,8 @@ public class AppletJmol extends EmbmenuFrame implements
           {
             if (jalview.bin.JalviewLite.debug)
             {
-              System.err
-                      .println("AppletJmol:Creating new PDBfile IO parser.");
+              System.err.println(
+                      "AppletJmol:Creating new PDBfile IO parser.");
             }
             FileParse fp = new FileParse(pdbentry.getFile(), protocol);
             fp.mark();
@@ -348,9 +349,8 @@ public class AppletJmol extends EmbmenuFrame implements
           }
           if (freader == null)
           {
-            throw new Exception(
-                    MessageManager
-                            .getString("exception.invalid_datasource_couldnt_obtain_reader"));
+            throw new Exception(MessageManager.getString(
+                    "exception.invalid_datasource_couldnt_obtain_reader"));
           }
           jmb.viewer.openReader(pdbentry.getFile(), pdbentry.getId(),
                   freader);
@@ -374,7 +374,7 @@ public class AppletJmol extends EmbmenuFrame implements
     jmb.loadInline(string);
   }
 
-  void setChainMenuItems(Vector<String> chains)
+  void setChainMenuItems(List<String> chains)
   {
     chainMenu.removeAll();
 
@@ -396,7 +396,7 @@ public class AppletJmol extends EmbmenuFrame implements
 
   void centerViewer()
   {
-    Vector<String> toshow = new Vector<String>();
+    Vector<String> toshow = new Vector<>();
     for (int i = 0; i < chainMenu.getItemCount(); i++)
     {
       if (chainMenu.getItem(i) instanceof CheckboxMenuItem)
@@ -435,8 +435,8 @@ public class AppletJmol extends EmbmenuFrame implements
       } catch (OutOfMemoryError ex)
       {
         frame.dispose();
-        System.err
-                .println("Out of memory when trying to create dialog box with sequence-structure mapping.");
+        System.err.println(
+                "Out of memory when trying to create dialog box with sequence-structure mapping.");
         return;
       }
       jalview.bin.JalviewLite.addFrame(frame,
@@ -457,41 +457,41 @@ public class AppletJmol extends EmbmenuFrame implements
     else if (evt.getSource() == zappo)
     {
       setEnabled(zappo);
-      jmb.setJalviewColourScheme(new ZappoColourScheme());
+      setColourScheme(new ZappoColourScheme());
     }
     else if (evt.getSource() == taylor)
     {
       setEnabled(taylor);
-      jmb.setJalviewColourScheme(new TaylorColourScheme());
+      setColourScheme(new TaylorColourScheme());
     }
     else if (evt.getSource() == hydro)
     {
       setEnabled(hydro);
-      jmb.setJalviewColourScheme(new HydrophobicColourScheme());
+      setColourScheme(new HydrophobicColourScheme());
     }
     else if (evt.getSource() == helix)
     {
       setEnabled(helix);
-      jmb.setJalviewColourScheme(new HelixColourScheme());
+      setColourScheme(new HelixColourScheme());
     }
     else if (evt.getSource() == strand)
     {
       setEnabled(strand);
-      jmb.setJalviewColourScheme(new StrandColourScheme());
+      setColourScheme(new StrandColourScheme());
     }
     else if (evt.getSource() == turn)
     {
       setEnabled(turn);
-      jmb.setJalviewColourScheme(new TurnColourScheme());
+      setColourScheme(new TurnColourScheme());
     }
     else if (evt.getSource() == buried)
     {
       setEnabled(buried);
-      jmb.setJalviewColourScheme(new BuriedColourScheme());
+      setColourScheme(new BuriedColourScheme());
     }
     else if (evt.getSource() == purinepyrimidine)
     {
-      jmb.setJalviewColourScheme(new PurinePyrimidineColourScheme());
+      setColourScheme(new PurinePyrimidineColourScheme());
     }
     else if (evt.getSource() == user)
     {
@@ -502,10 +502,10 @@ public class AppletJmol extends EmbmenuFrame implements
     {
       try
       {
-        ap.av.applet.getAppletContext().showDocument(
-                new java.net.URL(
+        ap.av.applet.getAppletContext()
+                .showDocument(new java.net.URL(
                         "http://jmol.sourceforge.net/docs/JmolUserGuide/"),
-                "jmolHelp");
+                        "jmolHelp");
       } catch (java.net.MalformedURLException ex)
       {
       }
@@ -526,7 +526,12 @@ public class AppletJmol extends EmbmenuFrame implements
     }
   }
 
-  /**
+  private void setColourScheme(ColourSchemeI cs) 
+  {
+    jmb.setJalviewColourScheme(cs, ap, ap.av.isShowSequenceFeatures());
+  }
+
+/**
    * tick or untick the seqColour menu entry or jmoColour entry depending upon
    * if it was selected or not.
    * 
@@ -536,7 +541,7 @@ public class AppletJmol extends EmbmenuFrame implements
   {
     jmolColour.setState(itm == jmolColour);
     seqColour.setState(itm == seqColour);
-    jmb.setColourBySequence(itm == seqColour);
+    jmb.setColourBy(itm == seqColour ? ColourBy.Sequence : ColourBy.Viewer);
   }
 
   @Override
@@ -545,12 +550,12 @@ public class AppletJmol extends EmbmenuFrame implements
     if (evt.getSource() == jmolColour)
     {
       setEnabled(jmolColour);
-      jmb.setColourBySequence(false);
+      jmb.setColourBy(ColourBy.Viewer);
     }
     else if (evt.getSource() == seqColour)
     {
       setEnabled(seqColour);
-      jmb.colourBySequence(ap);
+      jmb.colourBySequence(ap, ap.av.isShowSequenceFeatures());
     }
     else if (!allChainsSelected)
     {
@@ -583,18 +588,18 @@ public class AppletJmol extends EmbmenuFrame implements
   public void updateColours(Object source)
   {
     AlignmentPanel panel = (AlignmentPanel) source;
-    jmb.colourBySequence(panel);
+    jmb.colourBySequence(panel, ap.av.isShowSequenceFeatures());
   }
 
   public void updateTitleAndMenus()
   {
-    if (jmb.fileLoadingError != null && jmb.fileLoadingError.length() > 0)
+    if (jmb.hasFileLoadingError())
     {
       repaint();
       return;
     }
-    setChainMenuItems(jmb.chainNames);
-    jmb.colourBySequence(ap);
+    setChainMenuItems(jmb.getChainNames());
+    jmb.colourBySequence(ap, ap.av.isShowSequenceFeatures());
 
     setTitle(jmb.getViewerTitle());
   }
@@ -697,7 +702,7 @@ public class AppletJmol extends EmbmenuFrame implements
    */
   public void setJalviewColourScheme(UserColourScheme ucs)
   {
-    jmb.setJalviewColourScheme(ucs);
+    setColourScheme(ucs);
   }
 
   public AlignmentPanel getAlignmentPanelFor(AlignmentI alignment)