src/jalview/gui/AppJmolBinding.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   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
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.api.AlignmentViewPanel;
  24 import jalview.api.structures.JalviewStructureDisplayI;
  25 import jalview.bin.Cache;
  26 import jalview.datamodel.PDBEntry;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.ext.jmol.JalviewJmolBinding;
  29 import jalview.io.DataSourceType;
  30 import jalview.structure.StructureSelectionManager;
  31
  32 import java.awt.Container;
  33 import java.util.Map;
  34
  35 import org.jmol.api.JmolAppConsoleInterface;
  36 import org.jmol.java.BS;
  37 import org.openscience.jmol.app.jmolpanel.console.AppConsole;
  38
  39 public class AppJmolBinding extends JalviewJmolBinding
  40 {
  41   private AppJmol appJmolWindow;
  42
  43   public AppJmolBinding(AppJmol appJmol, StructureSelectionManager sSm,
  44           PDBEntry[] pdbentry, SequenceI[][] sequenceIs,
  45           DataSourceType protocol)
  46   {
  47     super(sSm, pdbentry, sequenceIs, protocol);
  48     appJmolWindow = appJmol;
  49   }
  50
  51   @Override
  52   public SequenceRenderer getSequenceRenderer(AlignmentViewPanel alignment)
  53   {
  54     return new SequenceRenderer(((AlignmentPanel) alignment).av);
  55   }
  56
  57   @Override
  58   public void sendConsoleEcho(String strEcho)
  59   {
  60     if (console != null)
  61     {
  62       console.sendConsoleEcho(strEcho);
  63     }
  64   }
  65
  66   @Override
  67   public void sendConsoleMessage(String strStatus)
  68   {
  69     if (console != null && strStatus != null)
  70     // && !strStatus.equals("Script completed"))
  71     // should we squash the script completed string ?
  72     {
  73       console.sendConsoleMessage(strStatus);
  74     }
  75   }
  76
  77   @Override
  78   public void showUrl(String url, String target)
  79   {
  80     try
  81     {
  82       jalview.util.BrowserLauncher.openURL(url);
  83     } catch (Exception e)
  84     {
  85       Cache.log.error("Failed to launch Jmol-associated url " + url, e);
  86       // TODO: 2.6 : warn user if browser was not configured.
  87     }
  88   }
  89
  90   @Override
  91   public void refreshGUI()
  92   {
  93     // appJmolWindow.repaint();
  94     javax.swing.SwingUtilities.invokeLater(new Runnable()
  95     {
  96       @Override
  97       public void run()
  98       {
  99         appJmolWindow.updateTitleAndMenus();
 100         appJmolWindow.revalidate();
 101       }
 102     });
 103   }
 104
 105   @Override
 106   public void updateColours(Object source)
 107   {
 108     AlignmentPanel ap = (AlignmentPanel) source;
 109     // ignore events from panels not used to colour this view
 110     if (!appJmolWindow.isUsedforcolourby(ap))
 111     {
 112       return;
 113     }
 114     if (!isLoadingFromArchive())
 115     {
 116       colourBySequence(ap);
 117     }
 118   }
 119
 120   @Override
 121   public void notifyScriptTermination(String strStatus, int msWalltime)
 122   {
 123     // todo - script termination doesn't happen ?
 124     // if (console != null)
 125     // console.notifyScriptTermination(strStatus,
 126     // msWalltime);
 127   }
 128
 129   @Override
 130   public void showUrl(String url)
 131   {
 132     showUrl(url, "jmol");
 133   }
 134
 135   public void newJmolPopup(String menuName)
 136   {
 137     // jmolpopup = new JmolAwtPopup();
 138     // jmolpopup.jpiInitialize((viewer), menuName);
 139   }
 140
 141   @Override
 142   public void selectionChanged(BS arg0)
 143   {
 144     // TODO Auto-generated method stub
 145
 146   }
 147
 148   @Override
 149   public void refreshPdbEntries()
 150   {
 151     // TODO Auto-generated method stub
 152
 153   }
 154
 155   @Override
 156   public void showConsole(boolean b)
 157   {
 158     appJmolWindow.showConsole(b);
 159   }
 160
 161   @Override
 162   protected JmolAppConsoleInterface createJmolConsole(
 163           Container consolePanel, String buttonsToShow)
 164   {
 165     viewer.setJmolCallbackListener(this);
 166     return new AppConsole(viewer, consolePanel, buttonsToShow);
 167   }
 168
 169   @Override
 170   protected void releaseUIResources()
 171   {
 172     appJmolWindow = null;
 173     closeConsole();
 174   }
 175
 176   @Override
 177   public void releaseReferences(Object svl)
 178   {
 179     if (svl instanceof SeqPanel)
 180     {
 181       appJmolWindow.removeAlignmentPanel(((SeqPanel) svl).ap);
 182     }
 183   }
 184
 185   @Override
 186   public Map<String, Object> getJSpecViewProperty(String arg0)
 187   {
 188     // TODO Auto-generated method stub
 189     return null;
 190   }
 191
 192   @Override
 193   public JalviewStructureDisplayI getViewer()
 194   {
 195     return appJmolWindow;
 196   }
 197
 198   @Override
 199   public jalview.api.FeatureRenderer getFeatureRenderer(
 200           AlignmentViewPanel alignment)
 201   {
 202     AlignmentPanel ap = (alignment == null)
 203             ? appJmolWindow.getAlignmentPanel()
 204             : (AlignmentPanel) alignment;
 205     if (ap.av.isShowSequenceFeatures())
 206     {
 207       return ap.av.getAlignPanel().getSeqPanel().seqCanvas.fr;
 208     }
 209
 210     return null;
 211   }
 212 }