src/jalview/gui/AppJmolBinding.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
   3  * Copyright (C) 2010 J Procter, AM Waterhouse, 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
  35 import org.jmol.api.JmolAppConsoleInterface;
  36 import org.jmol.api.JmolViewer;
  37 import org.jmol.popup.JmolPopup;
  38 import org.openscience.jmol.app.jmolpanel.AppConsole;
  39
  40 public class AppJmolBinding extends jalview.ext.jmol.JalviewJmolBinding
  41 {
  42
  43   /**
  44    *
  45    */
  46   private AppJmol appJmolWindow;
  47
  48   public AppJmolBinding(AppJmol appJmol, PDBEntry[] pdbentry,
  49           SequenceI[][] sequenceIs, String[][] chains, String protocol)
  50   {
  51     super(pdbentry, sequenceIs, chains, protocol);
  52     appJmolWindow = appJmol;
  53   }
  54
  55   FeatureRenderer fr = null;
  56
  57   @Override
  58   public jalview.api.FeatureRenderer getFeatureRenderer(AlignmentViewPanel alignment)
  59   {
  60     AlignmentPanel ap = (alignment==null) ? appJmolWindow.ap : (AlignmentPanel) alignment;
  61     if (ap.av.showSequenceFeatures)
  62     {
  63       if (fr == null)
  64       {
  65         fr = new FeatureRenderer(ap);
  66       }
  67
  68       fr.transferSettings(ap.
  69               seqPanel.seqCanvas.getFeatureRenderer());
  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 unrelated or non-user interactive frames
 130     if ((topap=appJmolWindow.getAlignmentPanelFor(ap.av.getAlignment()))==null || topap.alignFrame.getCurrentView() != ap.av || !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 = JmolPopup.newJmolPopup(viewer, translateLocale, menuName,
 155             asPopup);
 156   }
 157
 158   public void selectionChanged(BitSet arg0)
 159   {
 160     // TODO Auto-generated method stub
 161
 162   }
 163
 164   public void refreshPdbEntries()
 165   {
 166     // TODO Auto-generated method stub
 167
 168   }
 169
 170   public void showConsole(boolean b)
 171   {
 172     appJmolWindow.showConsole(b);
 173   }
 174
 175   /**
 176    * add the given sequences to the mapping scope for the given pdb file handle
 177    *
 178    * @param pdbFile
 179    *          - pdbFile identifier
 180    * @param seq
 181    *          - set of sequences it can be mapped to
 182    */
 183   public void addSequenceForStructFile(String pdbFile, SequenceI[] seq)
 184   {
 185     for (int pe = 0; pe < pdbentry.length; pe++)
 186     {
 187       if (pdbentry[pe].getFile().equals(pdbFile))
 188       {
 189         addSequence(pe, seq);
 190       }
 191     }
 192   }
 193
 194   @Override
 195   protected JmolAppConsoleInterface createJmolConsole(JmolViewer viewer2,
 196           Container consolePanel, String buttonsToShow)
 197   {
 198     return new AppConsole(viewer, consolePanel, buttonsToShow);
 199   }
 200
 201   @Override
 202   protected void releaseUIResources()
 203   {
 204     appJmolWindow = null;
 205     if (console != null)
 206     {
 207       try
 208       {
 209         console.setVisible(false);
 210       } catch (Error e)
 211       {
 212       } catch (Exception x)
 213       {
 214       }
 215       ;
 216       console = null;
 217     }
 218
 219   }
 220
 221   @Override
 222   public void releaseReferences(Object svl)
 223   {
 224     if (svl instanceof SeqPanel) {
 225       appJmolWindow.removeAlignmentPanel(((SeqPanel) svl).ap);
 226
 227     };
 228   }
 229 }