src/jalview/gui/AppJmolBinding.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.gui;
  19
  20 import java.awt.Container;
  21 import java.awt.event.ComponentEvent;
  22 import java.awt.event.ComponentListener;
  23 import java.awt.event.ContainerEvent;
  24 import java.awt.event.ContainerListener;
  25 import java.util.BitSet;
  26
  27 import javax.swing.JPanel;
  28
  29 import jalview.api.AlignmentViewPanel;
  30 import jalview.bin.Cache;
  31 import jalview.datamodel.AlignmentI;
  32 import jalview.datamodel.PDBEntry;
  33 import jalview.datamodel.SequenceI;
  34 import jalview.structure.StructureSelectionManager;
  35
  36 import org.jmol.api.JmolAppConsoleInterface;
  37 import org.jmol.api.JmolViewer;
  38 import org.jmol.popup.JmolPopup;
  39 import org.openscience.jmol.app.jmolpanel.AppConsole;
  40
  41 public class AppJmolBinding extends jalview.ext.jmol.JalviewJmolBinding
  42 {
  43
  44   /**
  45    *
  46    */
  47   private AppJmol appJmolWindow;
  48
  49   public AppJmolBinding(AppJmol appJmol, StructureSelectionManager sSm, PDBEntry[] pdbentry,
  50           SequenceI[][] sequenceIs, String[][] chains, String protocol)
  51   {
  52     super(sSm, pdbentry, sequenceIs, chains, protocol);
  53     appJmolWindow = appJmol;
  54   }
  55
  56   FeatureRenderer fr = null;
  57
  58   @Override
  59   public jalview.api.FeatureRenderer getFeatureRenderer(AlignmentViewPanel alignment)
  60   {
  61     AlignmentPanel ap = (alignment==null) ? appJmolWindow.ap : (AlignmentPanel) alignment;
  62     if (ap.av.showSequenceFeatures)
  63     {
  64       if (fr==null)
  65       {
  66         fr=ap.cloneFeatureRenderer();
  67       } else {
  68         ap.updateFeatureRenderer(fr);
  69       }
  70     }
  71
  72     return fr;
  73   }
  74
  75   @Override
  76   public jalview.api.SequenceRenderer getSequenceRenderer(AlignmentViewPanel alignment)
  77   {
  78     return new SequenceRenderer(((AlignmentPanel)alignment).av);
  79   }
  80
  81   public void sendConsoleEcho(String strEcho)
  82   {
  83     if (console != null)
  84     {
  85       console.sendConsoleEcho(strEcho);
  86     }
  87   }
  88
  89   public void sendConsoleMessage(String strStatus)
  90   {
  91     if (console != null && strStatus != null)
  92     // && !strStatus.equals("Script completed"))
  93     // should we squash the script completed string ?
  94     {
  95       console.sendConsoleMessage(strStatus);
  96     }
  97   }
  98
  99   @Override
 100   public void showUrl(String url, String target)
 101   {
 102     try
 103     {
 104       jalview.util.BrowserLauncher.openURL(url);
 105     } catch (Exception e)
 106     {
 107       Cache.log.error("Failed to launch Jmol-associated url " + url, e);
 108       // TODO: 2.6 : warn user if browser was not configured.
 109     }
 110   }
 111
 112   @Override
 113   public void refreshGUI()
 114   {
 115     // appJmolWindow.repaint();
 116     javax.swing.SwingUtilities.invokeLater(new Runnable()
 117     {
 118       public void run()
 119       {
 120         appJmolWindow.updateTitleAndMenus();
 121         appJmolWindow.revalidate();
 122       }
 123     });
 124   }
 125
 126   public void updateColours(Object source)
 127   {
 128     AlignmentPanel ap = (AlignmentPanel) source,topap;
 129     // ignore events from panels not used to colour this view
 130     if (!appJmolWindow.isUsedforcolourby(ap))
 131       return;
 132     if (!isLoadingFromArchive()) {
 133       colourBySequence(ap.av.getShowSequenceFeatures(), ap);
 134     }
 135   }
 136
 137   public void notifyScriptTermination(String strStatus, int msWalltime)
 138   {
 139     // todo - script termination doesn't happen ?
 140     // if (console != null)
 141     // console.notifyScriptTermination(strStatus,
 142     // msWalltime);
 143   }
 144
 145   public void showUrl(String url)
 146   {
 147     showUrl(url, "jmol");
 148   }
 149
 150   public void newJmolPopup(boolean translateLocale, String menuName,
 151           boolean asPopup)
 152   {
 153
 154     jmolpopup = new JmolPopup();
 155     jmolpopup.initialize(viewer, translateLocale, menuName,
 156             asPopup);
 157   }
 158
 159   public void selectionChanged(BitSet arg0)
 160   {
 161     // TODO Auto-generated method stub
 162
 163   }
 164
 165   public void refreshPdbEntries()
 166   {
 167     // TODO Auto-generated method stub
 168
 169   }
 170
 171   public void showConsole(boolean b)
 172   {
 173     appJmolWindow.showConsole(b);
 174   }
 175
 176   /**
 177    * add the given sequences to the mapping scope for the given pdb file handle
 178    *
 179    * @param pdbFile
 180    *          - pdbFile identifier
 181    * @param seq
 182    *          - set of sequences it can be mapped to
 183    */
 184   public void addSequenceForStructFile(String pdbFile, SequenceI[] seq)
 185   {
 186     for (int pe = 0; pe < pdbentry.length; pe++)
 187     {
 188       if (pdbentry[pe].getFile().equals(pdbFile))
 189       {
 190         addSequence(pe, seq);
 191       }
 192     }
 193   }
 194
 195   @Override
 196   protected JmolAppConsoleInterface createJmolConsole(JmolViewer viewer2,
 197           Container consolePanel, String buttonsToShow)
 198   {
 199     return new AppConsole(viewer, consolePanel, buttonsToShow);
 200   }
 201
 202   @Override
 203   protected void releaseUIResources()
 204   {
 205     appJmolWindow = null;
 206     if (console != null)
 207     {
 208       try
 209       {
 210         console.setVisible(false);
 211       } catch (Error e)
 212       {
 213       } catch (Exception x)
 214       {
 215       }
 216       ;
 217       console = null;
 218     }
 219
 220   }
 221
 222   @Override
 223   public void releaseReferences(Object svl)
 224   {
 225     if (svl instanceof SeqPanel) {
 226       appJmolWindow.removeAlignmentPanel(((SeqPanel) svl).ap);
 227
 228     };
 229   }
 230 }