JAL-3818 process Jmol callbacks in AWT thread
[jalview.git] / src / jalview / ext / jmol / JalviewJmolBinding.java
index 68cc792..61926dc 100644 (file)
  */
 package jalview.ext.jmol;
 
-import jalview.api.AlignmentViewPanel;
-import jalview.api.FeatureRenderer;
-import jalview.api.SequenceRenderer;
-import jalview.datamodel.AlignmentI;
-import jalview.datamodel.ColumnSelection;
-import jalview.datamodel.PDBEntry;
-import jalview.datamodel.SequenceI;
-import jalview.io.AppletFormatAdapter;
-import jalview.schemes.ColourSchemeI;
-import jalview.schemes.ResidueProperties;
-import jalview.structure.StructureMapping;
-import jalview.structure.StructureMappingcommandSet;
-import jalview.structure.StructureSelectionManager;
-import jalview.structures.models.AAStructureBindingModel;
-import jalview.util.MessageManager;
-
-import java.awt.Color;
 import java.awt.Container;
 import java.awt.event.ComponentEvent;
 import java.awt.event.ComponentListener;
 import java.io.File;
 import java.net.URL;
-import java.security.AccessControlException;
-import java.util.Hashtable;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
+import java.util.StringTokenizer;
 import java.util.Vector;
 
+import javax.swing.SwingUtilities;
+
 import org.jmol.adapter.smarter.SmarterJmolAdapter;
 import org.jmol.api.JmolAppConsoleInterface;
 import org.jmol.api.JmolSelectionListener;
 import org.jmol.api.JmolStatusListener;
 import org.jmol.api.JmolViewer;
-import org.jmol.constant.EnumCallback;
-import org.jmol.popup.JmolPopup;
+import org.jmol.c.CBK;
+import org.jmol.viewer.Viewer;
 
-public abstract class JalviewJmolBinding extends AAStructureBindingModel
-        implements JmolStatusListener, JmolSelectionListener,
-        ComponentListener
-{
-  /*
-   * state flag used to check if the Jmol viewer's paint method can be called
-   */
-  private boolean finishedInit = false;
+import jalview.api.AlignmentViewPanel;
+import jalview.api.FeatureRenderer;
+import jalview.api.FeatureSettingsModelI;
+import jalview.api.SequenceRenderer;
+import jalview.bin.Cache;
+import jalview.datamodel.PDBEntry;
+import jalview.datamodel.SequenceI;
+import jalview.gui.AppJmol;
+import jalview.gui.IProgressIndicator;
+import jalview.gui.StructureViewer.ViewerType;
+import jalview.io.DataSourceType;
+import jalview.io.StructureFile;
+import jalview.structure.AtomSpec;
+import jalview.structure.StructureCommand;
+import jalview.structure.StructureCommandI;
+import jalview.structure.StructureSelectionManager;
+import jalview.structures.models.AAStructureBindingModel;
+import jalview.ws.dbsources.Pdb;
+import javajs.util.BS;
 
-  boolean allChainsSelected = false;
+public abstract class JalviewJmolBinding extends AAStructureBindingModel
+    implements JmolStatusListener, JmolSelectionListener, ComponentListener {
+  private String lastMessage;
 
   /*
    * when true, try to search the associated datamodel for sequences that are
@@ -72,61 +71,36 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
    */
   private boolean associateNewStructs = false;
 
-  Vector atomsPicked = new Vector();
-
-  public Vector chainNames;
-
-  Hashtable chainFile;
-
-  StringBuffer eval = new StringBuffer();
-
-  public String fileLoadingError;
+  private Vector<String> atomsPicked = new Vector<>();
 
-  /*
-   * the default or current model displayed if the model cannot be identified
-   * from the selection message
-   */
-  int frameNo = 0;
-
-  protected JmolPopup jmolpopup;
+  private String lastCommand;
 
-  String lastCommand;
+  private boolean loadedInline;
 
-  String lastMessage;
+  private StringBuffer resetLastRes = new StringBuffer();
 
-  boolean loadedInline;
+  public Viewer jmolViewer;
 
-  /**
-   * current set of model filenames loaded in the Jmol instance
-   */
-  String[] modelFileNames = null;
-
-  StringBuffer resetLastRes = new StringBuffer();
-
-  public JmolViewer viewer;
-
-  public JalviewJmolBinding(StructureSelectionManager ssm,
-          PDBEntry[] pdbentry, SequenceI[][] sequenceIs, String[][] chains,
-          String protocol)
-  {
-    super(ssm, pdbentry, sequenceIs, chains, protocol);
+  public JalviewJmolBinding(StructureSelectionManager ssm, PDBEntry[] pdbentry, SequenceI[][] sequenceIs,
+      DataSourceType protocol) {
+    super(ssm, pdbentry, sequenceIs, protocol);
+    setStructureCommands(new JmolCommands());
     /*
      * viewer = JmolViewer.allocateViewer(renderPanel, new SmarterJmolAdapter(),
-     * "jalviewJmol", ap.av.applet .getDocumentBase(),
-     * ap.av.applet.getCodeBase(), "", this);
+     * "jalviewJmol", ap.av.applet .getDocumentBase(), ap.av.applet.getCodeBase(),
+     * "", this);
      * 
      * jmolpopup = JmolPopup.newJmolPopup(viewer, true, "Jmol", true);
      */
   }
 
-  public JalviewJmolBinding(StructureSelectionManager ssm,
-          SequenceI[][] seqs, JmolViewer theViewer)
-  {
+  public JalviewJmolBinding(StructureSelectionManager ssm, SequenceI[][] seqs, Viewer theViewer) {
     super(ssm, seqs);
 
-    viewer = theViewer;
-    viewer.setJmolStatusListener(this);
-    viewer.addSelectionListener(this);
+    jmolViewer = theViewer;
+    jmolViewer.setJmolStatusListener(this);
+    jmolViewer.addSelectionListener(this);
+    setStructureCommands(new JmolCommands());
   }
 
   /**
@@ -135,498 +109,45 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
    * 
    * @return
    */
-  public String getViewerTitle()
-  {
-    return getViewerTitle("JMol", true);
+  public String getViewerTitle() {
+    return getViewerTitle("Jmol", true);
   }
 
-  /**
-   * prepare the view for a given set of models/chains. chainList contains
-   * strings of the form 'pdbfilename:Chaincode'
-   * 
-   * @param chainList
-   *          list of chains to make visible
-   */
-  public void centerViewer(Vector chainList)
-  {
-    StringBuffer cmd = new StringBuffer();
-    String lbl;
-    int mlength, p;
-    for (int i = 0, iSize = chainList.size(); i < iSize; i++)
-    {
-      mlength = 0;
-      lbl = (String) chainList.elementAt(i);
-      do
-      {
-        p = mlength;
-        mlength = lbl.indexOf(":", p);
-      } while (p < mlength && mlength < (lbl.length() - 2));
-      // TODO: lookup each pdb id and recover proper model number for it.
-      cmd.append(":" + lbl.substring(mlength + 1) + " /"
-              + (1 + getModelNum((String) chainFile.get(lbl))) + " or ");
-    }
-    if (cmd.length() > 0)
-    {
-      cmd.setLength(cmd.length() - 4);
-    }
-    evalStateCommand("select *;restrict " + cmd + ";cartoon;center " + cmd);
-  }
+  private String jmolScript(String script) {
+    Cache.log.debug(">>Jmol>> " + script);
+    String s = jmolViewer.evalStringQuiet(script); // scriptWait(script); BH
+    Cache.log.debug("<<Jmol<< " + s);
 
-  public void closeViewer()
-  {
-    viewer.setModeMouse(org.jmol.viewer.JmolConstants.MOUSE_NONE);
-    // remove listeners for all structures in viewer
-    getSsm().removeStructureViewerListener(this, this.getPdbFile());
-    // and shut down jmol
-    viewer.evalStringQuiet("zap");
-    viewer.setJmolStatusListener(null);
-    lastCommand = null;
-    viewer = null;
-    releaseUIResources();
+    return s;
   }
 
-  public void colourByChain()
-  {
-    colourBySequence = false;
-    // TODO: colour by chain should colour each chain distinctly across all
-    // visible models
-    // TODO: http://issues.jalview.org/browse/JAL-628
-    evalStateCommand("select *;color chain");
-  }
-
-  public void colourByCharge()
-  {
-    colourBySequence = false;
-    evalStateCommand("select *;color white;select ASP,GLU;color red;"
-            + "select LYS,ARG;color blue;select CYS;color yellow");
-  }
-
-  /**
-   * superpose the structures associated with sequences in the alignment
-   * according to their corresponding positions.
-   */
-  public void superposeStructures(AlignmentI alignment)
-  {
-    superposeStructures(alignment, -1, null);
-  }
-
-  /**
-   * superpose the structures associated with sequences in the alignment
-   * according to their corresponding positions. ded)
-   * 
-   * @param refStructure
-   *          - select which pdb file to use as reference (default is -1 - the
-   *          first structure in the alignment)
-   */
-  public void superposeStructures(AlignmentI alignment, int refStructure)
-  {
-    superposeStructures(alignment, refStructure, null);
-  }
-
-  /**
-   * superpose the structures associated with sequences in the alignment
-   * according to their corresponding positions. ded)
-   * 
-   * @param refStructure
-   *          - select which pdb file to use as reference (default is -1 - the
-   *          first structure in the alignment)
-   * @param hiddenCols
-   *          TODO
-   */
-  public void superposeStructures(AlignmentI alignment, int refStructure,
-          ColumnSelection hiddenCols)
-  {
-    superposeStructures(new AlignmentI[]
-    { alignment }, new int[]
-    { refStructure }, new ColumnSelection[]
-    { hiddenCols });
-  }
-
-  public void superposeStructures(AlignmentI[] _alignment,
-          int[] _refStructure, ColumnSelection[] _hiddenCols)
-  {
-    assert (_alignment.length == _refStructure.length && _alignment.length != _hiddenCols.length);
-
-    String[] files = getPdbFile();
-    // check to see if we are still waiting for Jmol files
-    long starttime = System.currentTimeMillis();
-    boolean waiting = true;
-    do
-    {
-      waiting = false;
-      for (String file : files)
-      {
-        try
-        {
-          // HACK - in Jalview 2.8 this call may not be threadsafe so we catch
-          // every possible exception
-          StructureMapping[] sm = getSsm().getMapping(file);
-          if (sm == null || sm.length == 0)
-          {
-            waiting = true;
-          }
-        } catch (Exception x)
-        {
-          waiting = true;
-        } catch (Error q)
-        {
-          waiting = true;
-        }
-      }
-      // we wait around for a reasonable time before we give up
-    } while (waiting
-            && System.currentTimeMillis() < (10000 + 1000 * files.length + starttime));
-    if (waiting)
-    {
-      System.err
-              .println("RUNTIME PROBLEM: Jmol seems to be taking a long time to process all the structures.");
-      return;
-    }
-    StringBuffer selectioncom = new StringBuffer();
-    // In principle - nSeconds specifies the speed of animation for each
-    // superposition - but is seems to behave weirdly, so we don't specify it.
-    String nSeconds = " ";
-    if (files.length > 10)
-    {
-      nSeconds = " 0.00001 ";
-    }
-    else
-    {
-      nSeconds = " " + (2.0 / files.length) + " ";
-      // if (nSeconds).substring(0,5)+" ";
-    }
-    // see JAL-1345 - should really automatically turn off the animation for
-    // large numbers of structures, but Jmol doesn't seem to allow that.
-    nSeconds = " ";
-    // union of all aligned positions are collected together.
-    for (int a = 0; a < _alignment.length; a++)
-    {
-      int refStructure = _refStructure[a];
-      AlignmentI alignment = _alignment[a];
-      ColumnSelection hiddenCols = _hiddenCols[a];
-      if (a > 0
-              && selectioncom.length() > 0
-              && !selectioncom.substring(selectioncom.length() - 1).equals(
-                      "|"))
-      {
-        selectioncom.append("|");
-      }
-      // process this alignment
-      if (refStructure >= files.length)
-      {
-        System.err.println("Invalid reference structure value "
-                + refStructure);
-        refStructure = -1;
-      }
-      if (refStructure < -1)
-      {
-        refStructure = -1;
-      }
-      StringBuffer command = new StringBuffer();
-
-      boolean matched[] = new boolean[alignment.getWidth()];
-      for (int m = 0; m < matched.length; m++)
-      {
-
-        matched[m] = (hiddenCols != null) ? hiddenCols.isVisible(m) : true;
-      }
-
-      int commonrpositions[][] = new int[files.length][alignment.getWidth()];
-      String isel[] = new String[files.length];
-      // reference structure - all others are superposed in it
-      String[] targetC = new String[files.length];
-      String[] chainNames = new String[files.length];
-      for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
-      {
-        StructureMapping[] mapping = getSsm().getMapping(files[pdbfnum]);
-        // RACE CONDITION - getMapping only returns Jmol loaded filenames once
-        // Jmol callback has completed.
-        if (mapping == null || mapping.length < 1)
-        {
-          throw new Error(MessageManager.getString("error.implementation_error_jmol_getting_data"));
-        }
-        int lastPos = -1;
-        final int sequenceCountForPdbFile = getSequence()[pdbfnum].length;
-        for (int s = 0; s < sequenceCountForPdbFile; s++)
-        {
-          for (int sp, m = 0; m < mapping.length; m++)
-          {
-            if (mapping[m].getSequence() == getSequence()[pdbfnum][s]
-                    && (sp = alignment.findIndex(getSequence()[pdbfnum][s])) > -1)
-            {
-              if (refStructure == -1)
-              {
-                refStructure = pdbfnum;
-              }
-              SequenceI asp = alignment.getSequenceAt(sp);
-              for (int r = 0; r < matched.length; r++)
-              {
-                if (!matched[r])
-                {
-                  continue;
-                }
-                matched[r] = false; // assume this is not a good site
-                if (r >= asp.getLength())
-                {
-                  continue;
-                }
-
-                if (jalview.util.Comparison.isGap(asp.getCharAt(r)))
-                {
-                  // no mapping to gaps in sequence
-                  continue;
-                }
-                int t = asp.findPosition(r); // sequence position
-                int apos = mapping[m].getAtomNum(t);
-                int pos = mapping[m].getPDBResNum(t);
-
-                if (pos < 1 || pos == lastPos)
-                {
-                  // can't align unmapped sequence
-                  continue;
-                }
-                matched[r] = true; // this is a good ite
-                lastPos = pos;
-                // just record this residue position
-                commonrpositions[pdbfnum][r] = pos;
-              }
-              // create model selection suffix
-              isel[pdbfnum] = "/" + (pdbfnum + 1) + ".1";
-              if (mapping[m].getChain() == null
-                      || mapping[m].getChain().trim().length() == 0)
-              {
-                targetC[pdbfnum] = "";
-              }
-              else
-              {
-                targetC[pdbfnum] = ":" + mapping[m].getChain();
-              }
-              chainNames[pdbfnum] = mapping[m].getPdbId()
-                      + targetC[pdbfnum];
-              // move on to next pdb file
-              s = getSequence()[pdbfnum].length;
-              break;
-            }
-          }
-        }
-      }
-
-      // TODO: consider bailing if nmatched less than 4 because superposition
-      // not
-      // well defined.
-      // TODO: refactor superposable position search (above) from jmol selection
-      // construction (below)
-
-      String[] selcom = new String[files.length];
-      int nmatched = 0;
-      // generate select statements to select regions to superimpose structures
-      {
-        for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
-        {
-          String chainCd = targetC[pdbfnum];
-          int lpos = -1;
-          boolean run = false;
-          StringBuffer molsel = new StringBuffer();
-          molsel.append("{");
-          for (int r = 0; r < matched.length; r++)
-          {
-            if (matched[r])
-            {
-              if (pdbfnum == 0)
-              {
-                nmatched++;
-              }
-              if (lpos != commonrpositions[pdbfnum][r] - 1)
-              {
-                // discontinuity
-                if (lpos != -1)
-                {
-                  molsel.append(lpos);
-                  molsel.append(chainCd);
-                  // molsel.append("} {");
-                  molsel.append("|");
-                }
-              }
-              else
-              {
-                // continuous run - and lpos >-1
-                if (!run)
-                {
-                  // at the beginning, so add dash
-                  molsel.append(lpos);
-                  molsel.append("-");
-                }
-                run = true;
-              }
-              lpos = commonrpositions[pdbfnum][r];
-              // molsel.append(lpos);
-            }
-          }
-          // add final selection phrase
-          if (lpos != -1)
-          {
-            molsel.append(lpos);
-            molsel.append(chainCd);
-            molsel.append("}");
-          }
-          if (molsel.length() > 1)
-          {
-            selcom[pdbfnum] = molsel.toString();
-            selectioncom.append("((");
-            selectioncom.append(selcom[pdbfnum].substring(1,
-                    selcom[pdbfnum].length() - 1));
-            selectioncom.append(" )& ");
-            selectioncom.append(pdbfnum + 1);
-            selectioncom.append(".1)");
-            if (pdbfnum < files.length - 1)
-            {
-              selectioncom.append("|");
-            }
-          }
-          else
-          {
-            selcom[pdbfnum] = null;
-          }
-        }
-      }
-      for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
-      {
-        if (pdbfnum == refStructure || selcom[pdbfnum] == null
-                || selcom[refStructure] == null)
-        {
-          continue;
-        }
-        command.append("echo ");
-        command.append("\"Superposing (");
-        command.append(chainNames[pdbfnum]);
-        command.append(") against reference (");
-        command.append(chainNames[refStructure]);
-        command.append(")\";\ncompare " + nSeconds);
-        command.append("{");
-        command.append(1 + pdbfnum);
-        command.append(".1} {");
-        command.append(1 + refStructure);
-        command.append(".1} SUBSET {*.CA | *.P} ATOMS ");
-
-        // form the matched pair strings
-        String sep = "";
-        for (int s = 0; s < 2; s++)
-        {
-          command.append(selcom[(s == 0 ? pdbfnum : refStructure)]);
-        }
-        command.append(" ROTATE TRANSLATE;\n");
-      }
-      if (selectioncom.length() > 0)
-      {
-        System.out.println("Select regions:\n" + selectioncom.toString());
-        evalStateCommand("select *; cartoons off; backbone; select ("
-                + selectioncom.toString() + "); cartoons; ");
-        // selcom.append("; ribbons; ");
-        System.out
-                .println("Superimpose command(s):\n" + command.toString());
-
-        evalStateCommand(command.toString());
-      }
-    }
-    if (selectioncom.length() > 0)
-    {// finally, mark all regions that were superposed.
-      if (selectioncom.substring(selectioncom.length() - 1).equals("|"))
-      {
-        selectioncom.setLength(selectioncom.length() - 1);
-      }
-      System.out.println("Select regions:\n" + selectioncom.toString());
-      evalStateCommand("select *; cartoons off; backbone; select ("
-              + selectioncom.toString() + "); cartoons; ");
-      // evalStateCommand("select *; backbone; select "+selcom.toString()+"; cartoons; center "+selcom.toString());
+  @Override
+  public List<String> executeCommand(StructureCommandI command, boolean getReply) {
+    if (command == null) {
+      return null;
     }
-  }
-
-  public void evalStateCommand(String command)
-  {
+    String cmd = command.getCommand();
     jmolHistory(false);
-    if (lastCommand == null || !lastCommand.equals(command))
-    {
-      viewer.evalStringQuiet(command + "\n");
+    if (lastCommand == null || !lastCommand.equals(cmd)) {
+      jmolScript(cmd + "\n");
     }
     jmolHistory(true);
-    lastCommand = command;
-  }
-
-  /**
-   * colour any structures associated with sequences in the given alignment
-   * using the getFeatureRenderer() and getSequenceRenderer() renderers but only
-   * if colourBySequence is enabled.
-   */
-  public void colourBySequence(boolean showFeatures,
-          jalview.api.AlignmentViewPanel alignmentv)
-  {
-    if (!colourBySequence || !isLoadingFinished())
-    {
-      return;
-    }
-    if (getSsm() == null)
-    {
-      return;
-    }
-    String[] files = getPdbFile();
-
-    SequenceRenderer sr = getSequenceRenderer(alignmentv);
-
-    FeatureRenderer fr = null;
-    if (showFeatures)
-    {
-      fr = getFeatureRenderer(alignmentv);
-    }
-    AlignmentI alignment = alignmentv.getAlignment();
-
-    for (jalview.structure.StructureMappingcommandSet cpdbbyseq : getColourBySequenceCommands(files, sr, fr, alignment))
-    {
-      for (String cbyseq : cpdbbyseq.commands)
-      {
-        executeWhenReady(cbyseq);
-      }
-    }
-  }
-
-  /**
-   * @param files
-   * @param sr
-   * @param fr
-   * @param alignment
-   * @return
-   */
-  protected StructureMappingcommandSet[] getColourBySequenceCommands(
-          String[] files, SequenceRenderer sr, FeatureRenderer fr,
-          AlignmentI alignment)
-  {
-    return JmolCommands
-            .getColourBySequenceCommand(getSsm(), files, getSequence(), sr,
-                    fr,
-                    alignment);
-  }
-
-  /**
-   * @param command
-   */
-  protected void executeWhenReady(String command)
-  {
-    evalStateCommand(command);
+    lastCommand = cmd;
+    return null;
   }
 
-  public void createImage(String file, String type, int quality)
-  {
+  public void createImage(String file, String type, int quality) {
     System.out.println("JMOL CREATE IMAGE");
   }
 
-  public String createImage(String fileName, String type,
-          Object textOrBytes, int quality)
-  {
+  @Override
+  public String createImage(String fileName, String type, Object textOrBytes, int quality) {
     System.out.println("JMOL CREATE IMAGE");
     return null;
   }
 
-  public String eval(String strEval)
-  {
+  @Override
+  public String eval(String strEval) {
     // System.out.println(strEval);
     // "# 'eval' is implemented only for the applet.";
     return null;
@@ -635,63 +156,17 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
   // End StructureListener
   // //////////////////////////
 
-  public float[][] functionXY(String functionName, int x, int y)
-  {
+  @Override
+  public float[][] functionXY(String functionName, int x, int y) {
     return null;
   }
 
-  public float[][][] functionXYZ(String functionName, int nx, int ny, int nz)
-  {
+  @Override
+  public float[][][] functionXYZ(String functionName, int nx, int ny, int nz) {
     // TODO Auto-generated method stub
     return null;
   }
 
-  public Color getColour(int atomIndex, int pdbResNum, String chain,
-          String pdbfile)
-  {
-    if (getModelNum(pdbfile) < 0)
-    {
-      return null;
-    }
-    // TODO: verify atomIndex is selecting correct model.
-    return new Color(viewer.getAtomArgb(atomIndex));
-  }
-
-  /**
-   * returns the current featureRenderer that should be used to colour the
-   * structures
-   * 
-   * @param alignment
-   * 
-   * @return
-   */
-  public abstract FeatureRenderer getFeatureRenderer(
-          AlignmentViewPanel alignment);
-
-  /**
-   * instruct the Jalview binding to update the pdbentries vector if necessary
-   * prior to matching the jmol view's contents to the list of structure files
-   * Jalview knows about.
-   */
-  public abstract void refreshPdbEntries();
-
-  private int getModelNum(String modelFileName)
-  {
-    String[] mfn = getPdbFile();
-    if (mfn == null)
-    {
-      return -1;
-    }
-    for (int i = 0; i < mfn.length; i++)
-    {
-      if (mfn[i].equalsIgnoreCase(modelFileName))
-      {
-        return i;
-      }
-    }
-    return -1;
-  }
-
   /**
    * map between index of model filename returned from getPdbFile and the first
    * index of models from this file in the viewer. Note - this is not trimmed -
@@ -699,59 +174,31 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
    */
   private int _modelFileNameMap[];
 
-  // ////////////////////////////////
-  // /StructureListener
-  public synchronized String[] getPdbFile()
-  {
-    if (viewer == null)
-    {
+  @Override
+  public synchronized String[] getStructureFiles() {
+    if (jmolViewer == null) {
       return new String[0];
     }
-    if (modelFileNames == null)
-    {
-
-      String mset[] = new String[viewer.getModelCount()];
-      _modelFileNameMap = new int[mset.length];
-      int j = 1;
-      String m = viewer.getModelFileName(0);
-      if (m != null)
-      {
-        try
-        {
-          mset[0] = new File(m).getAbsolutePath();
-        } catch (AccessControlException x)
-        {
-          // usually not allowed to do this in applet, so keep raw handle
-          mset[0] = m;
-          // System.err.println("jmolBinding: Using local file string from Jmol: "+m);
+
+    if (modelFileNames == null) {
+      int modelCount = jmolViewer.ms.mc;
+      String filePath = null;
+      List<String> mset = new ArrayList<>();
+      for (int i = 0; i < modelCount; ++i) {
+        /*
+         * defensive check for null as getModelFileName can return null even when model
+         * count ms.mc is > 0
+         */
+        filePath = jmolViewer.ms.getModelFileName(i);
+        if (filePath != null && !mset.contains(filePath)) {
+          mset.add(filePath);
         }
       }
-      for (int i = 1; i < mset.length; i++)
-      {
-        m = viewer.getModelFileName(i);
-        if (m != null)
-        {
-          try
-          {
-            mset[j] = new File(m).getAbsolutePath();
-          } catch (AccessControlException x)
-          {
-            // usually not allowed to do this in applet, so keep raw handle
-            mset[j] = m;
-            // System.err.println("jmolBinding: Using local file string from Jmol: "+m);
-          }
-        }
-        _modelFileNameMap[j] = i; // record the model index for the filename
-        // skip any additional models in the same file (NMR structures)
-        if ((mset[j] == null ? mset[j] != mset[j - 1]
-                : (mset[j - 1] == null || !mset[j].equals(mset[j - 1]))))
-        {
-          j++;
-        }
+      if (!mset.isEmpty()) {
+        modelFileNames = mset.toArray(new String[mset.size()]);
       }
-      modelFileNames = new String[j];
-      System.arraycopy(mset, 0, modelFileNames, 0, j);
     }
+
     return modelFileNames;
   }
 
@@ -759,101 +206,69 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
    * map from string to applet
    */
   @Override
-  public Map<String, Object> getRegistryInfo()
-  {
+  public Map<String, Object> getRegistryInfo() {
     // TODO Auto-generated method stub
     return null;
   }
 
-  /**
-   * returns the current sequenceRenderer that should be used to colour the
-   * structures
-   * 
-   * @param alignment
-   * 
-   * @return
-   */
-  public abstract SequenceRenderer getSequenceRenderer(
-          AlignmentViewPanel alignment);
-
   // ///////////////////////////////
   // JmolStatusListener
 
-  public void handlePopupMenu(int x, int y)
-  {
-    jmolpopup.show(x, y);
+  public void handlePopupMenu(int x, int y) {
+    // jmolpopup.show(x, y);
+    // jmolpopup.jpiShow(x, y);
   }
 
-  // jmol/ssm only
-  public void highlightAtom(int atomIndex, int pdbResNum, String chain,
-          String pdbfile)
-  {
-    if (modelFileNames == null)
-    {
-      return;
+  /**
+   * Highlight zero, one or more atoms on the structure
+   */
+  @Override
+  public void highlightAtoms(List<AtomSpec> atoms) {
+    if (atoms != null) {
+      if (resetLastRes.length() > 0) {
+        jmolScript(resetLastRes.toString());
+        resetLastRes.setLength(0);
+      }
+      for (AtomSpec atom : atoms) {
+        highlightAtom(atom.getAtomIndex(), atom.getPdbResNum(), atom.getChain(), atom.getPdbFile());
+      }
     }
+  }
 
-    // look up file model number for this pdbfile
-    int mdlNum = 0;
-    String fn;
-    // may need to adjust for URLencoding here - we don't worry about that yet.
-    while (mdlNum < modelFileNames.length
-            && !pdbfile.equals(modelFileNames[mdlNum]))
-    {
-      // System.out.println("nomatch:"+pdbfile+"\nmodelfn:"+fn);
-      mdlNum++;
-    }
-    if (mdlNum == modelFileNames.length)
-    {
+  // jmol/ssm only
+  public void highlightAtom(int atomIndex, int pdbResNum, String chain, String pdbfile) {
+    String modelId = getModelIdForFile(pdbfile);
+    if (modelId.isEmpty()) {
       return;
     }
 
     jmolHistory(false);
-    // if (!pdbfile.equals(pdbentry.getFile()))
-    // return;
-    if (resetLastRes.length() > 0)
-    {
-      viewer.evalStringQuiet(resetLastRes.toString());
-    }
 
-    eval.setLength(0);
-    eval.append("select " + pdbResNum); // +modelNum
-
-    resetLastRes.setLength(0);
-    resetLastRes.append("select " + pdbResNum); // +modelNum
-
-    eval.append(":");
-    resetLastRes.append(":");
-    if (!chain.equals(" "))
-    {
-      eval.append(chain);
-      resetLastRes.append(chain);
-    }
-    {
-      eval.append(" /" + (mdlNum + 1));
-      resetLastRes.append("/" + (mdlNum + 1));
+    StringBuilder selection = new StringBuilder(32);
+    StringBuilder cmd = new StringBuilder(64);
+    selection.append("select ").append(String.valueOf(pdbResNum));
+    selection.append(":");
+    if (!chain.equals(" ")) {
+      selection.append(chain);
     }
-    eval.append(";wireframe 100;" + eval.toString() + " and not hetero;");
+    selection.append(" /").append(modelId);
 
-    resetLastRes.append(";wireframe 0;" + resetLastRes.toString()
-            + " and not hetero; spacefill 0;");
+    cmd.append(selection).append(";wireframe 100;").append(selection).append(" and not hetero;")
+        .append("spacefill 200;select none");
 
-    eval.append("spacefill 200;select none");
+    resetLastRes.append(selection).append(";wireframe 0;").append(selection).append(" and not hetero; spacefill 0;");
 
-    viewer.evalStringQuiet(eval.toString());
+    jmolScript(cmd.toString());
     jmolHistory(true);
-
   }
 
-  boolean debug = true;
+  private boolean debug = true;
 
-  private void jmolHistory(boolean enable)
-  {
-    viewer.evalStringQuiet("History " + ((debug || enable) ? "on" : "off"));
+  private void jmolHistory(boolean enable) {
+    jmolScript("History " + ((debug || enable) ? "on" : "off"));
   }
 
-  public void loadInline(String string)
-  {
+  public void loadInline(String string) {
     loadedInline = true;
     // TODO: re JAL-623
     // viewer.loadInline(strModel, isAppend);
@@ -863,145 +278,133 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
     // Then, construct pass a reader for the string to Jmol.
     // ((org.jmol.Viewer.Viewer) viewer).loadModelFromFile(fullPathName,
     // fileName, null, reader, false, null, null, 0);
-    viewer.openStringInline(string);
+    jmolViewer.openStringInline(string);
   }
 
-  public void mouseOverStructure(int atomIndex, String strInfo)
-  {
+  protected void mouseOverStructure(int atomIndex, final String strInfo) {
     int pdbResNum;
     int alocsep = strInfo.indexOf("^");
     int mdlSep = strInfo.indexOf("/");
     int chainSeparator = strInfo.indexOf(":"), chainSeparator1 = -1;
 
-    if (chainSeparator == -1)
-    {
+    if (chainSeparator == -1) {
       chainSeparator = strInfo.indexOf(".");
-      if (mdlSep > -1 && mdlSep < chainSeparator)
-      {
+      if (mdlSep > -1 && mdlSep < chainSeparator) {
         chainSeparator1 = chainSeparator;
         chainSeparator = mdlSep;
       }
     }
     // handle insertion codes
-    if (alocsep != -1)
-    {
-      pdbResNum = Integer.parseInt(strInfo.substring(
-              strInfo.indexOf("]") + 1, alocsep));
+    if (alocsep != -1) {
+      pdbResNum = Integer.parseInt(strInfo.substring(strInfo.indexOf("]") + 1, alocsep));
 
-    }
-    else
-    {
-      pdbResNum = Integer.parseInt(strInfo.substring(
-              strInfo.indexOf("]") + 1, chainSeparator));
+    } else {
+      pdbResNum = Integer.parseInt(strInfo.substring(strInfo.indexOf("]") + 1, chainSeparator));
     }
     String chainId;
 
-    if (strInfo.indexOf(":") > -1)
-    {
-      chainId = strInfo.substring(strInfo.indexOf(":") + 1,
-              strInfo.indexOf("."));
-    }
-    else
-    {
+    if (strInfo.indexOf(":") > -1) {
+      chainId = strInfo.substring(strInfo.indexOf(":") + 1, strInfo.indexOf("."));
+    } else {
       chainId = " ";
     }
 
-    String pdbfilename = modelFileNames[frameNo]; // default is first or current
-    // model
-    if (mdlSep > -1)
-    {
-      if (chainSeparator1 == -1)
-      {
+    String pdbfilename = modelFileNames[0]; // default is first model
+    if (mdlSep > -1) {
+      if (chainSeparator1 == -1) {
         chainSeparator1 = strInfo.indexOf(".", mdlSep);
       }
-      String mdlId = (chainSeparator1 > -1) ? strInfo.substring(mdlSep + 1,
-              chainSeparator1) : strInfo.substring(mdlSep + 1);
-      try
-      {
+      String mdlId = (chainSeparator1 > -1) ? strInfo.substring(mdlSep + 1, chainSeparator1)
+          : strInfo.substring(mdlSep + 1);
+      try {
         // recover PDB filename for the model hovered over.
-        int _mp = _modelFileNameMap.length - 1, mnumber = new Integer(mdlId)
-                .intValue() - 1;
-        while (mnumber < _modelFileNameMap[_mp])
-        {
-          _mp--;
-        }
-        pdbfilename = modelFileNames[_mp];
-        if (pdbfilename == null)
-        {
-          pdbfilename = new File(viewer.getModelFileName(mnumber))
-                  .getAbsolutePath();
-        }
+        int mnumber = Integer.valueOf(mdlId).intValue() - 1;
+        if (_modelFileNameMap != null) {
+          int _mp = _modelFileNameMap.length - 1;
+
+          while (mnumber < _modelFileNameMap[_mp]) {
+            _mp--;
+          }
+          pdbfilename = modelFileNames[_mp];
+        } else {
+          if (mnumber >= 0 && mnumber < modelFileNames.length) {
+            pdbfilename = modelFileNames[mnumber];
+          }
 
-      } catch (Exception e)
-      {
+          if (pdbfilename == null) {
+            pdbfilename = new File(jmolViewer.ms.getModelFileName(mnumber)).getAbsolutePath();
+          }
+        }
+      } catch (Exception e) {
       }
-      ;
-    }
-    if (lastMessage == null || !lastMessage.equals(strInfo))
-    {
-      getSsm().mouseOverStructure(pdbResNum, chainId, pdbfilename);
     }
 
-    lastMessage = strInfo;
+    /*
+     * highlight position on alignment(s); if some text is returned, show this as a
+     * second line on the structure hover tooltip
+     */
+    String label = getSsm().mouseOverStructure(pdbResNum, chainId, pdbfilename);
+    if (label != null) {
+      // change comma to pipe separator (newline token for Jmol)
+      label = label.replace(',', '|');
+      StringTokenizer toks = new StringTokenizer(strInfo, " ");
+      StringBuilder sb = new StringBuilder();
+      sb.append("select ").append(String.valueOf(pdbResNum)).append(":").append(chainId).append("/1");
+      sb.append(";set hoverLabel \"").append(toks.nextToken()).append(" ").append(toks.nextToken());
+      sb.append("|").append(label).append("\"");
+      executeCommand(new StructureCommand(sb.toString()), false);
+    }
   }
 
-  public void notifyAtomHovered(int atomIndex, String strInfo, String data)
-  {
-    if (data != null)
-    {
-      System.err.println("Ignoring additional hover info: " + data
-              + " (other info: '" + strInfo + "' pos " + atomIndex + ")");
+  public void notifyAtomHovered(int atomIndex, String strInfo, String data) {
+    if (strInfo.equals(lastMessage)) {
+      return;
+    }
+    lastMessage = strInfo;
+    if (data != null) {
+      System.err.println(
+          "Ignoring additional hover info: " + data + " (other info: '" + strInfo + "' pos " + atomIndex + ")");
     }
     mouseOverStructure(atomIndex, strInfo);
   }
 
   /*
    * { if (history != null && strStatus != null &&
-   * !strStatus.equals("Script completed")) { history.append("\n" + strStatus);
-   * } }
+   * !strStatus.equals("Script completed")) { history.append("\n" + strStatus); }
+   * }
    */
 
-  public void notifyAtomPicked(int atomIndex, String strInfo, String strData)
-  {
+  public void notifyAtomPicked(int atomIndex, String strInfo, String strData) {
     /**
-     * this implements the toggle label behaviour copied from the original
-     * structure viewer, MCView
+     * this implements the toggle label behaviour copied from the original structure
+     * viewer, mc_view
      */
-    if (strData != null)
-    {
+    if (strData != null) {
       System.err.println("Ignoring additional pick data string " + strData);
     }
     int chainSeparator = strInfo.indexOf(":");
     int p = 0;
-    if (chainSeparator == -1)
-    {
+    if (chainSeparator == -1) {
       chainSeparator = strInfo.indexOf(".");
     }
 
-    String picked = strInfo.substring(strInfo.indexOf("]") + 1,
-            chainSeparator);
+    String picked = strInfo.substring(strInfo.indexOf("]") + 1, chainSeparator);
     String mdlString = "";
-    if ((p = strInfo.indexOf(":")) > -1)
-    {
-      picked += strInfo.substring(p + 1, strInfo.indexOf("."));
+    if ((p = strInfo.indexOf(":")) > -1) {
+      picked += strInfo.substring(p, strInfo.indexOf("."));
     }
 
-    if ((p = strInfo.indexOf("/")) > -1)
-    {
+    if ((p = strInfo.indexOf("/")) > -1) {
       mdlString += strInfo.substring(p, strInfo.indexOf(" #"));
     }
-    picked = "((" + picked + ".CA" + mdlString + ")|(" + picked + ".P"
-            + mdlString + "))";
+    picked = "((" + picked + ".CA" + mdlString + ")|(" + picked + ".P" + mdlString + "))";
     jmolHistory(false);
 
-    if (!atomsPicked.contains(picked))
-    {
-      viewer.evalStringQuiet("select " + picked + ";label %n %r:%c");
+    if (!atomsPicked.contains(picked)) {
+      jmolScript("select " + picked + ";label %n %r:%c");
       atomsPicked.addElement(picked);
-    }
-    else
-    {
-      viewer.evalString("select " + picked + ";label off");
+    } else {
+      jmolViewer.evalString("select " + picked + ";label off");
       atomsPicked.removeElement(picked);
     }
     jmolHistory(true);
@@ -1016,36 +419,48 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
   }
 
   @Override
-  public void notifyCallback(EnumCallback type, Object[] data)
-  {
-    try
-    {
-      switch (type)
-      {
+  public void notifyCallback(CBK type, Object[] data) {
+    /*
+     * ensure processed in AWT thread to avoid risk of deadlocks
+     */
+    SwingUtilities.invokeLater(new Runnable() {
+
+      @Override
+      public void run() {
+        processCallback(type, data);
+      }
+    });
+  }
+
+  /**
+   * Processes one callback notification from Jmol
+   * 
+   * @param type
+   * @param data
+   */
+  protected void processCallback(CBK type, Object[] data) {
+    try {
+      switch (type) {
       case LOADSTRUCT:
-        notifyFileLoaded((String) data[1], (String) data[2],
-                (String) data[3], (String) data[4],
-                ((Integer) data[5]).intValue());
+        notifyFileLoaded((String) data[1], (String) data[2], (String) data[3], (String) data[4],
+            ((Integer) data[5]).intValue());
 
         break;
       case PICK:
-        notifyAtomPicked(((Integer) data[2]).intValue(), (String) data[1],
-                (String) data[0]);
+        notifyAtomPicked(((Integer) data[2]).intValue(), (String) data[1], (String) data[0]);
         // also highlight in alignment
+        // deliberate fall through
       case HOVER:
-        notifyAtomHovered(((Integer) data[2]).intValue(), (String) data[1],
-                (String) data[0]);
+        notifyAtomHovered(((Integer) data[2]).intValue(), (String) data[1], (String) data[0]);
         break;
       case SCRIPT:
-        notifyScriptTermination((String) data[2],
-                ((Integer) data[3]).intValue());
+        notifyScriptTermination((String) data[2], ((Integer) data[3]).intValue());
         break;
       case ECHO:
         sendConsoleEcho((String) data[1]);
         break;
       case MESSAGE:
-        sendConsoleMessage((data == null) ? ((String) null)
-                : (String) data[1]);
+        sendConsoleMessage((data == null) ? ((String) null) : (String) data[1]);
         break;
       case ERROR:
         // System.err.println("Ignoring error callback.");
@@ -1058,22 +473,18 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
 
       case CLICK:
       default:
-        System.err.println("Unhandled callback " + type + " "
-                + data[1].toString());
+        System.err.println("Unhandled callback " + type + " " + data[1].toString());
         break;
       }
-    } catch (Exception e)
-    {
+    } catch (Exception e) {
       System.err.println("Squashed Jmol callback handler error:");
       e.printStackTrace();
     }
   }
 
   @Override
-  public boolean notifyEnabled(EnumCallback callbackPick)
-  {
-    switch (callbackPick)
-    {
+  public boolean notifyEnabled(CBK callbackPick) {
+    switch (callbackPick) {
     case ECHO:
     case LOADSTRUCT:
     case MEASURE:
@@ -1083,13 +494,9 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
     case HOVER:
     case ERROR:
       return true;
-    case RESIZE:
-    case SYNC:
-    case CLICK:
-    case ANIMFRAME:
-    case MINIMIZATION:
+    default:
+      return false;
     }
-    return false;
   }
 
   // incremented every time a load notification is successfully handled -
@@ -1097,16 +504,13 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
   // referrring to new structures.
   private long loadNotifiesHandled = 0;
 
-  public long getLoadNotifiesHandled()
-  {
+  public long getLoadNotifiesHandled() {
     return loadNotifiesHandled;
   }
 
-  public void notifyFileLoaded(String fullPathName, String fileName2,
-          String modelName, String errorMsg, int modelParts)
-  {
-    if (errorMsg != null)
-    {
+  public void notifyFileLoaded(String fullPathName, String fileName2, String modelName, String errorMsg,
+      int modelParts) {
+    if (errorMsg != null) {
       fileLoadingError = errorMsg;
       refreshGUI();
       return;
@@ -1120,37 +524,31 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
     fileLoadingError = null;
     String[] oldmodels = modelFileNames;
     modelFileNames = null;
-    chainNames = new Vector();
-    chainFile = new Hashtable();
     boolean notifyLoaded = false;
-    String[] modelfilenames = getPdbFile();
+    String[] modelfilenames = getStructureFiles();
+    if (modelfilenames == null) {
+      // Jmol is still loading files!
+      return;
+    }
     // first check if we've lost any structures
-    if (oldmodels != null && oldmodels.length > 0)
-    {
+    if (oldmodels != null && oldmodels.length > 0) {
       int oldm = 0;
-      for (int i = 0; i < oldmodels.length; i++)
-      {
-        for (int n = 0; n < modelfilenames.length; n++)
-        {
-          if (modelfilenames[n] == oldmodels[i])
-          {
+      for (int i = 0; i < oldmodels.length; i++) {
+        for (int n = 0; n < modelfilenames.length; n++) {
+          if (modelfilenames[n] == oldmodels[i]) {
             oldmodels[i] = null;
             break;
           }
         }
-        if (oldmodels[i] != null)
-        {
+        if (oldmodels[i] != null) {
           oldm++;
         }
       }
-      if (oldm > 0)
-      {
+      if (oldm > 0) {
         String[] oldmfn = new String[oldm];
         oldm = 0;
-        for (int i = 0; i < oldmodels.length; i++)
-        {
-          if (oldmodels[i] != null)
-          {
+        for (int i = 0; i < oldmodels.length; i++) {
+          if (oldmodels[i] != null) {
             oldmfn[oldm++] = oldmodels[i];
           }
         }
@@ -1160,91 +558,68 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
       }
     }
     refreshPdbEntries();
-    for (int modelnum = 0; modelnum < modelfilenames.length; modelnum++)
-    {
+    for (int modelnum = 0; modelnum < modelfilenames.length; modelnum++) {
       String fileName = modelfilenames[modelnum];
       boolean foundEntry = false;
-      MCview.PDBfile pdb = null;
-      String pdbfile = null, pdbfhash = null;
+      StructureFile pdb = null;
+      String pdbfile = null;
       // model was probably loaded inline - so check the pdb file hashcode
-      if (loadedInline)
-      {
+      if (loadedInline) {
         // calculate essential attributes for the pdb data imported inline.
         // prolly need to resolve modelnumber properly - for now just use our
         // 'best guess'
-        pdbfile = viewer.getData("" + (1 + _modelFileNameMap[modelnum])
-                + ".0", "PDB");
-        pdbfhash = "" + pdbfile.hashCode();
+        pdbfile = jmolViewer.getData("" + (1 + _modelFileNameMap[modelnum]) + ".0", "PDB");
       }
-        // search pdbentries and sequences to find correct pdbentry for this
-        // model
-      for (int pe = 0; pe < getPdbCount(); pe++)
-      {
+      // search pdbentries and sequences to find correct pdbentry for this
+      // model
+      for (int pe = 0; pe < getPdbCount(); pe++) {
         boolean matches = false;
-        if (fileName == null)
-        {
+        addSequence(pe, getSequence()[pe]);
+        if (fileName == null) {
           if (false)
           // see JAL-623 - need method of matching pasted data up
           {
-            pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe],
-                    pdbfile, AppletFormatAdapter.PASTE);
-            getPdbEntry(modelnum).setFile("INLINE" + pdb.id);
+            pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe], pdbfile, DataSourceType.PASTE,
+                getIProgressIndicator());
+            getPdbEntry(modelnum).setFile("INLINE" + pdb.getId());
             matches = true;
             foundEntry = true;
           }
-        }
-        else
-        {
-          File fl;
-          if (matches = (fl = new File(getPdbEntry(pe).getFile()))
-                  .equals(new File(fileName)))
-          {
+        } else {
+          File fl = new File(getPdbEntry(pe).getFile());
+          matches = fl.equals(new File(fileName));
+          if (matches) {
             foundEntry = true;
             // TODO: Jmol can in principle retrieve from CLASSLOADER but
             // this
             // needs
             // to be tested. See mantis bug
             // https://mantis.lifesci.dundee.ac.uk/view.php?id=36605
-            String protocol = AppletFormatAdapter.URL;
-            try
-            {
-              if (fl.exists())
-              {
-                protocol = AppletFormatAdapter.FILE;
+            DataSourceType protocol = DataSourceType.URL;
+            try {
+              if (fl.exists()) {
+                protocol = DataSourceType.FILE;
               }
-            } catch (Exception e)
-            {
-            } catch (Error e)
-            {
+            } catch (Exception e) {
+            } catch (Error e) {
             }
             // Explicitly map to the filename used by Jmol ;
-            pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe],
-                    fileName, protocol);
+            pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe], fileName, protocol, getIProgressIndicator());
             // pdbentry[pe].getFile(), protocol);
 
           }
         }
-        if (matches)
-        {
-          // add an entry for every chain in the model
-          for (int i = 0; i < pdb.chains.size(); i++)
-          {
-            String chid = new String(pdb.id + ":"
-                    + pdb.chains.elementAt(i).id);
-            chainFile.put(chid, fileName);
-            chainNames.addElement(chid);
-          }
+        if (matches) {
+          stashFoundChains(pdb, fileName);
           notifyLoaded = true;
         }
       }
 
-      if (!foundEntry && associateNewStructs)
-      {
+      if (!foundEntry && associateNewStructs) {
         // this is a foreign pdb file that jalview doesn't know about - add
         // it to the dataset and try to find a home - either on a matching
         // sequence or as a new sequence.
-        String pdbcontent = viewer.getData("/" + (modelnum + 1) + ".1",
-                "PDB");
+        String pdbcontent = jmolViewer.getData("/" + (modelnum + 1) + ".1", "PDB");
         // parse pdb file into a chain, etc.
         // locate best match for pdb in associated views and add mapping to
         // ssm
@@ -1255,24 +630,22 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
     }
     // FILE LOADED OK
     // so finally, update the jmol bits and pieces
-    if (jmolpopup != null)
-    {
-      // potential for deadlock here:
-      // jmolpopup.updateComputedMenus();
-    }
-    if (!isLoadingFromArchive())
-    {
-      viewer.evalStringQuiet("model 0; select backbone;restrict;cartoon;wireframe off;spacefill off");
+    // if (jmolpopup != null)
+    // {
+    // // potential for deadlock here:
+    // // jmolpopup.updateComputedMenus();
+    // }
+    if (!isLoadingFromArchive()) {
+      jmolScript("model *; select backbone;restrict;cartoon;wireframe off;spacefill off");
     }
     // register ourselves as a listener and notify the gui that it needs to
     // update itself.
     getSsm().addStructureViewerListener(this);
-    if (notifyLoaded)
-    {
+    if (notifyLoaded) {
       FeatureRenderer fr = getFeatureRenderer(null);
-      if (fr != null)
-      {
-        fr.featuresAdded();
+      if (fr != null) {
+        FeatureSettingsModelI colours = new Pdb().getFeatureColourScheme();
+        ((AppJmol) getViewer()).getAlignmentPanel().av.applyFeaturesStyle(colours);
       }
       refreshGUI();
       loadNotifiesHandled++;
@@ -1280,13 +653,15 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
     setLoadingFromArchive(false);
   }
 
-  public void notifyNewPickingModeMeasurement(int iatom, String strMeasure)
-  {
+  protected IProgressIndicator getIProgressIndicator() {
+    return null;
+  }
+
+  public void notifyNewPickingModeMeasurement(int iatom, String strMeasure) {
     notifyAtomPicked(iatom, strMeasure, null);
   }
 
-  public abstract void notifyScriptTermination(String strStatus,
-          int msWalltime);
+  public abstract void notifyScriptTermination(String strStatus, int msWalltime);
 
   /**
    * display a message echoed from the jmol viewer
@@ -1296,64 +671,29 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
   public abstract void sendConsoleEcho(String strEcho); /*
                                                          * { showConsole(true);
                                                          * 
-                                                         * history.append("\n" +
-                                                         * strEcho); }
+                                                         * history.append("\n" + strEcho); }
                                                          */
 
   // /End JmolStatusListener
   // /////////////////////////////
 
   /**
-   * @param strStatus
-   *          status message - usually the response received after a script
-   *          executed
+   * @param strStatus status message - usually the response received after a
+   *                  script executed
    */
   public abstract void sendConsoleMessage(String strStatus);
 
-  public void setCallbackFunction(String callbackType,
-          String callbackFunction)
-  {
-    System.err.println("Ignoring set-callback request to associate "
-            + callbackType + " with function " + callbackFunction);
-
-  }
-
-  public void setJalviewColourScheme(ColourSchemeI cs)
-  {
-    colourBySequence = false;
-
-    if (cs == null)
-    {
-      return;
-    }
-
-    int index;
-    Color col;
-    jmolHistory(false);
-    // TODO: Switch between nucleotide or aa selection expressions
-    StringBuilder command = new StringBuilder(128);
-    command.append("select *;color white;");
-    for (String res : ResidueProperties.aa3Hash.keySet())
-    {
-      index = ResidueProperties.aa3Hash.get(res).intValue();
-      if (index > 20)
-      {
-        continue;
-      }
-
-      col = cs.findColour(ResidueProperties.aa[index].charAt(0));
-
-      command.append("select " + res + ";color[" + col.getRed() + ","
-              + col.getGreen() + "," + col.getBlue() + "];");
-    }
+  @Override
+  public void setCallbackFunction(String callbackType, String callbackFunction) {
+    System.err
+        .println("Ignoring set-callback request to associate " + callbackType + " with function " + callbackFunction);
 
-    evalStateCommand(command.toString());
-    jmolHistory(true);
   }
 
-  public void showHelp()
-  {
-    showUrl("http://jmol.sourceforge.net/docs/JmolUserGuide/", "jmolHelp");
+  public void showHelp() {
+    showUrl("http://wiki.jmol.org"
+    // BH 2018 "http://jmol.sourceforge.net/docs/JmolUserGuide/"
+        , "jmolHelp");
   }
 
   /**
@@ -1364,130 +704,93 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
   public abstract void showUrl(String url, String target);
 
   /**
-   * called when the binding thinks the UI needs to be refreshed after a Jmol
-   * state change. this could be because structures were loaded, or because an
-   * error has occured.
-   */
-  public abstract void refreshGUI();
-
-  /**
    * called to show or hide the associated console window container.
    * 
    * @param show
    */
   public abstract void showConsole(boolean show);
 
+  public static Viewer getJmolData(JmolParser jmolParser) {
+    return (Viewer) JmolViewer.allocateViewer(null, null, null, null, null, "-x -o -n", jmolParser);
+  }
+
   /**
+   * 
+   * 
+   * 
    * @param renderPanel
-   * @param jmolfileio
-   *          - when true will initialise jmol's file IO system (should be false
-   *          in applet context)
+   * @param jmolfileio     - when true will initialise jmol's file IO system
+   *                       (should be false in applet context)
    * @param htmlName
    * @param documentBase
    * @param codeBase
    * @param commandOptions
    */
-  public void allocateViewer(Container renderPanel, boolean jmolfileio,
-          String htmlName, URL documentBase, URL codeBase,
-          String commandOptions)
-  {
-    allocateViewer(renderPanel, jmolfileio, htmlName, documentBase,
-            codeBase, commandOptions, null, null);
+  public void allocateViewer(Container renderPanel, boolean jmolfileio, String htmlName, URL documentBase, URL codeBase,
+      String commandOptions) {
+    allocateViewer(renderPanel, jmolfileio, htmlName, documentBase, codeBase, commandOptions, null, null);
   }
 
   /**
    * 
    * @param renderPanel
-   * @param jmolfileio
-   *          - when true will initialise jmol's file IO system (should be false
-   *          in applet context)
+   * @param jmolfileio     - when true will initialise jmol's file IO system
+   *                       (should be false in applet context)
    * @param htmlName
    * @param documentBase
    * @param codeBase
    * @param commandOptions
-   * @param consolePanel
-   *          - panel to contain Jmol console
-   * @param buttonsToShow
-   *          - buttons to show on the console, in ordr
+   * @param consolePanel   - panel to contain Jmol console
+   * @param buttonsToShow  - buttons to show on the console, in order
    */
-  public void allocateViewer(Container renderPanel, boolean jmolfileio,
-          String htmlName, URL documentBase, URL codeBase,
-          String commandOptions, final Container consolePanel,
-          String buttonsToShow)
-  {
-    if (commandOptions == null)
-    {
+  public void allocateViewer(Container renderPanel, boolean jmolfileio, String htmlName, URL documentBase, URL codeBase,
+      String commandOptions, final Container consolePanel, String buttonsToShow) {
+
+    System.err.println("Allocating Jmol Viewer: " + commandOptions);
+
+    if (commandOptions == null) {
       commandOptions = "";
     }
-    viewer = JmolViewer.allocateViewer(renderPanel,
-            (jmolfileio ? new SmarterJmolAdapter() : null), htmlName
-                    + ((Object) this).toString(), documentBase, codeBase,
-            commandOptions, this);
-
-    console = createJmolConsole(viewer, consolePanel, buttonsToShow);
-    if (consolePanel != null)
-    {
+    jmolViewer = (Viewer) JmolViewer.allocateViewer(renderPanel, (jmolfileio ? new SmarterJmolAdapter() : null),
+        htmlName + ((Object) this).toString(), documentBase, codeBase, commandOptions, this);
+
+    jmolViewer.setJmolStatusListener(this); // extends JmolCallbackListener
+
+    try {
+      console = createJmolConsole(consolePanel, buttonsToShow);
+    } catch (Throwable e) {
+      System.err.println("Could not create Jmol application console. " + e.getMessage());
+      e.printStackTrace();
+    }
+    if (consolePanel != null) {
       consolePanel.addComponentListener(this);
 
     }
 
   }
 
-  protected abstract JmolAppConsoleInterface createJmolConsole(
-          JmolViewer viewer2, Container consolePanel, String buttonsToShow);
+  protected abstract JmolAppConsoleInterface createJmolConsole(Container consolePanel, String buttonsToShow);
 
-  protected org.jmol.api.JmolAppConsoleInterface console = null;
-
-  public void setBackgroundColour(java.awt.Color col)
-  {
-    jmolHistory(false);
-    viewer.evalStringQuiet("background [" + col.getRed() + ","
-            + col.getGreen() + "," + col.getBlue() + "];");
-    jmolHistory(true);
-  }
+  // BH 2018 -- Jmol console is not working due to problems with styled
+  // documents.
 
-  /**
-   * 
-   * @param pdbfile
-   * @return text report of alignment between pdbfile and any associated
-   *         alignment sequences
-   */
-  public String printMapping(String pdbfile)
-  {
-    return getSsm().printMapping(pdbfile);
-  }
+  protected org.jmol.api.JmolAppConsoleInterface console = null;
 
   @Override
-  public void resizeInnerPanel(String data)
-  {
+  public int[] resizeInnerPanel(String data) {
     // Jalview doesn't honour resize panel requests
-
-  }
-
-  public boolean isFinishedInit()
-  {
-    return finishedInit;
-  }
-
-  public void setFinishedInit(boolean finishedInit)
-  {
-    this.finishedInit = finishedInit;
+    return null;
   }
 
   /**
    * 
    */
-  protected void closeConsole()
-  {
-    if (console != null)
-    {
-      try
-      {
+  protected void closeConsole() {
+    if (console != null) {
+      try {
         console.setVisible(false);
-      } catch (Error e)
-      {
-      } catch (Exception x)
-      {
+      } catch (Error e) {
+      } catch (Exception x) {
       }
       ;
       console = null;
@@ -1498,24 +801,21 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
    * ComponentListener method
    */
   @Override
-  public void componentMoved(ComponentEvent e)
-  {
+  public void componentMoved(ComponentEvent e) {
   }
 
   /**
    * ComponentListener method
    */
   @Override
-  public void componentResized(ComponentEvent e)
-  {
+  public void componentResized(ComponentEvent e) {
   }
 
   /**
    * ComponentListener method
    */
   @Override
-  public void componentShown(ComponentEvent e)
-  {
+  public void componentShown(ComponentEvent e) {
     showConsole(true);
   }
 
@@ -1523,8 +823,57 @@ public abstract class JalviewJmolBinding extends AAStructureBindingModel
    * ComponentListener method
    */
   @Override
-  public void componentHidden(ComponentEvent e)
-  {
+  public void componentHidden(ComponentEvent e) {
     showConsole(false);
   }
+
+  @Override
+  protected String getModelIdForFile(String pdbFile) {
+    if (modelFileNames == null) {
+      return "";
+    }
+    for (int i = 0; i < modelFileNames.length; i++) {
+      if (modelFileNames[i].equalsIgnoreCase(pdbFile)) {
+        return String.valueOf(i + 1);
+      }
+    }
+    return "";
+  }
+
+  @Override
+  protected ViewerType getViewerType() {
+    return ViewerType.JMOL;
+  }
+
+  @Override
+  protected String getModelId(int pdbfnum, String file) {
+    return String.valueOf(pdbfnum + 1);
+  }
+
+  /**
+   * Returns ".spt" - the Jmol session file extension
+   * 
+   * @return
+   * @see https://chemapps.stolaf.edu/jmol/docs/#writemodel
+   */
+  @Override
+  public String getSessionFileExtension() {
+    return ".spt";
+  }
+
+  @Override
+  public void selectionChanged(BS arg0) {
+    // TODO Auto-generated method stub
+
+  }
+
+  @Override
+  public SequenceRenderer getSequenceRenderer(AlignmentViewPanel avp) {
+    return new jalview.gui.SequenceRenderer(avp.getAlignViewport());
+  }
+
+  @Override
+  public String getHelpURL() {
+    return "http://wiki.jmol.org"; // BH 2018
+  }
 }