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.structure.StructureSelectionManager;
  30
  31 import java.awt.Container;
  32 import java.util.Map;
  33
  34 import org.jmol.api.JmolAppConsoleInterface;
  35 import org.jmol.java.BS;
  36 import org.openscience.jmol.app.jmolpanel.console.AppConsole;
  37
  38 public class AppJmolBinding extends JalviewJmolBinding
  39 {
  40   private AppJmol appJmolWindow;
  41
  42   private FeatureRenderer fr = null;
  43
  44   public AppJmolBinding(AppJmol appJmol, StructureSelectionManager sSm,
  45           PDBEntry[] pdbentry, SequenceI[][] sequenceIs, String protocol)
  46   {
  47     super(sSm, pdbentry, sequenceIs, protocol);
  48     appJmolWindow = appJmol;
  49   }
  50
  51   @Override
  52   public FeatureRenderer getFeatureRenderer(AlignmentViewPanel alignment)
  53   {
  54     AlignmentPanel ap = (alignment == null) ? appJmolWindow
  55             .getAlignmentPanel() : (AlignmentPanel) alignment;
  56     if (ap.av.isShowSequenceFeatures())
  57     {
  58       if (fr == null)
  59       {
  60         fr = (jalview.gui.FeatureRenderer) ap.cloneFeatureRenderer();
  61       }
  62       else
  63       {
  64         ap.updateFeatureRenderer(fr);
  65       }
  66     }
  67
  68     return fr;
  69   }
  70
  71   @Override
  72   public SequenceRenderer getSequenceRenderer(AlignmentViewPanel alignment)
  73   {
  74     return new SequenceRenderer(((AlignmentPanel) alignment).av);
  75   }
  76
  77   @Override
  78   public void sendConsoleEcho(String strEcho)
  79   {
  80     if (console != null)
  81     {
  82       console.sendConsoleEcho(strEcho);
  83     }
  84   }
  85
  86   @Override
  87   public void sendConsoleMessage(String strStatus)
  88   {
  89     if (console != null && strStatus != null)
  90     // && !strStatus.equals("Script completed"))
  91     // should we squash the script completed string ?
  92     {
  93       console.sendConsoleMessage(strStatus);
  94     }
  95   }
  96
  97   @Override
  98   public void showUrl(String url, String target)
  99   {
 100     try
 101     {
 102       jalview.util.BrowserLauncher.openURL(url);
 103     } catch (Exception e)
 104     {
 105       Cache.log.error("Failed to launch Jmol-associated url " + url, e);
 106       // TODO: 2.6 : warn user if browser was not configured.
 107     }
 108   }
 109
 110   @Override
 111   public void refreshGUI()
 112   {
 113     // appJmolWindow.repaint();
 114     javax.swing.SwingUtilities.invokeLater(new Runnable()
 115     {
 116       @Override
 117       public void run()
 118       {
 119         appJmolWindow.updateTitleAndMenus();
 120         appJmolWindow.revalidate();
 121       }
 122     });
 123   }
 124
 125   @Override
 126   public void updateColours(Object source)
 127   {
 128     AlignmentPanel ap = (AlignmentPanel) source;
 129     // ignore events from panels not used to colour this view
 130     if (!appJmolWindow.isUsedforcolourby(ap))
 131     {
 132       return;
 133     }
 134     if (!isLoadingFromArchive())
 135     {
 136       colourBySequence(ap);
 137     }
 138   }
 139
 140   @Override
 141   public void notifyScriptTermination(String strStatus, int msWalltime)
 142   {
 143     // todo - script termination doesn't happen ?
 144     // if (console != null)
 145     // console.notifyScriptTermination(strStatus,
 146     // msWalltime);
 147   }
 148
 149   @Override
 150   public void showUrl(String url)
 151   {
 152     showUrl(url, "jmol");
 153   }
 154
 155   public void newJmolPopup(String menuName)
 156   {
 157     // jmolpopup = new JmolAwtPopup();
 158     // jmolpopup.jpiInitialize((viewer), menuName);
 159   }
 160
 161   @Override
 162   public void selectionChanged(BS arg0)
 163   {
 164     // TODO Auto-generated method stub
 165
 166   }
 167
 168   @Override
 169   public void refreshPdbEntries()
 170   {
 171     // TODO Auto-generated method stub
 172
 173   }
 174
 175   @Override
 176   public void showConsole(boolean b)
 177   {
 178     appJmolWindow.showConsole(b);
 179   }
 180
 181   @Override
 182   protected JmolAppConsoleInterface createJmolConsole(
 183           Container consolePanel, String buttonsToShow)
 184   {
 185     viewer.setJmolCallbackListener(this);
 186     return new AppConsole(viewer, consolePanel, buttonsToShow);
 187   }
 188
 189   @Override
 190   protected void releaseUIResources()
 191   {
 192     appJmolWindow = null;
 193     closeConsole();
 194   }
 195
 196   @Override
 197   public void releaseReferences(Object svl)
 198   {
 199     if (svl instanceof SeqPanel)
 200     {
 201       appJmolWindow.removeAlignmentPanel(((SeqPanel) svl).ap);
 202     }
 203   }
 204
 205   @Override
 206   public Map<String, Object> getJSpecViewProperty(String arg0)
 207   {
 208     // TODO Auto-generated method stub
 209     return null;
 210   }
 211
 212   @Override
 213   public JalviewStructureDisplayI getViewer()
 214   {
 215     return appJmolWindow;
 216   }
 217 }