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.bin.Cache;
  25 import jalview.datamodel.PDBEntry;
  26 import jalview.datamodel.SequenceI;
  27 import jalview.ext.jmol.JalviewJmolBinding;
  28 import jalview.structure.StructureSelectionManager;
  29
  30 import java.awt.Container;
  31 import java.util.Map;
  32
  33 import org.jmol.api.JmolAppConsoleInterface;
  34 import org.jmol.java.BS;
  35 import org.jmol.popup.JmolAwtPopup;
  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[][] chains,
  46           String protocol)
  47   {
  48     super(sSm, pdbentry, sequenceIs, chains, protocol);
  49     appJmolWindow = appJmol;
  50   }
  51
  52   @Override
  53   public FeatureRenderer getFeatureRenderer(
  54           AlignmentViewPanel alignment)
  55   {
  56     AlignmentPanel ap = (alignment == null) ? appJmolWindow.getAlignmentPanel()
  57             : (AlignmentPanel) alignment;
  58     if (ap.av.isShowSequenceFeatures())
  59     {
  60       if (fr == null)
  61       {
  62         fr = (jalview.gui.FeatureRenderer) ap.cloneFeatureRenderer();
  63       }
  64       else
  65       {
  66         ap.updateFeatureRenderer(fr);
  67       }
  68     }
  69
  70     return fr;
  71   }
  72
  73   @Override
  74   public SequenceRenderer getSequenceRenderer(
  75           AlignmentViewPanel alignment)
  76   {
  77     return new SequenceRenderer(((AlignmentPanel) alignment).av);
  78   }
  79
  80   @Override
  81   public void sendConsoleEcho(String strEcho)
  82   {
  83     if (console != null)
  84     {
  85       console.sendConsoleEcho(strEcho);
  86     }
  87   }
  88
  89   @Override
  90   public void sendConsoleMessage(String strStatus)
  91   {
  92     if (console != null && strStatus != null)
  93     // && !strStatus.equals("Script completed"))
  94     // should we squash the script completed string ?
  95     {
  96       console.sendConsoleMessage(strStatus);
  97     }
  98   }
  99
 100   @Override
 101   public void showUrl(String url, String target)
 102   {
 103     try
 104     {
 105       jalview.util.BrowserLauncher.openURL(url);
 106     } catch (Exception e)
 107     {
 108       Cache.log.error("Failed to launch Jmol-associated url " + url, e);
 109       // TODO: 2.6 : warn user if browser was not configured.
 110     }
 111   }
 112
 113   @Override
 114   public void refreshGUI()
 115   {
 116     // appJmolWindow.repaint();
 117     javax.swing.SwingUtilities.invokeLater(new Runnable()
 118     {
 119       public void run()
 120       {
 121         appJmolWindow.updateTitleAndMenus();
 122         appJmolWindow.revalidate();
 123       }
 124     });
 125   }
 126
 127   public void updateColours(Object source)
 128   {
 129     AlignmentPanel ap = (AlignmentPanel) source, topap;
 130     // ignore events from panels not used to colour this view
 131     if (!appJmolWindow.isUsedforcolourby(ap))
 132     {
 133       return;
 134     }
 135     if (!isLoadingFromArchive())
 136     {
 137       colourBySequence(ap.av.isShowSequenceFeatures(), ap);
 138     }
 139   }
 140
 141   @Override
 142   public void notifyScriptTermination(String strStatus, int msWalltime)
 143   {
 144     // todo - script termination doesn't happen ?
 145     // if (console != null)
 146     // console.notifyScriptTermination(strStatus,
 147     // msWalltime);
 148   }
 149
 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 }