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 java.awt.Container;
  24 import java.io.File;
  25 import java.util.List;
  26 import java.util.Map;
  27
  28 import javax.swing.JComponent;
  29
  30 import org.jmol.api.JmolAppConsoleInterface;
  31 import org.openscience.jmol.app.jmolpanel.console.AppConsole;
  32
  33 import jalview.api.AlignmentViewPanel;
  34 import jalview.api.structures.JalviewStructureDisplayI;
  35 import jalview.bin.Cache;
  36 import jalview.datamodel.PDBEntry;
  37 import jalview.datamodel.SequenceI;
  38 import jalview.ext.jmol.JalviewJmolBinding;
  39 import jalview.io.DataSourceType;
  40 import jalview.structure.StructureSelectionManager;
  41 import jalview.util.Platform;
  42 import javajs.util.BS;
  43
  44 public class AppJmolBinding extends JalviewJmolBinding
  45 {
  46   public AppJmolBinding(AppJmol appJmol, StructureSelectionManager sSm,
  47           PDBEntry[] pdbentry, SequenceI[][] sequenceIs,
  48           DataSourceType protocol)
  49   {
  50     super(sSm, pdbentry, sequenceIs, protocol);
  51     setViewer(appJmol);
  52   }
  53
  54   @Override
  55   public SequenceRenderer getSequenceRenderer(AlignmentViewPanel alignment)
  56   {
  57     return new SequenceRenderer(((AlignmentPanel) alignment).av);
  58   }
  59
  60   @Override
  61   public void sendConsoleEcho(String strEcho)
  62   {
  63     if (console != null)
  64     {
  65       console.sendConsoleEcho(strEcho);
  66     }
  67   }
  68
  69   @Override
  70   public void sendConsoleMessage(String strStatus)
  71   {
  72     if (console != null && strStatus != null)
  73     // && !strStatus.equals("Script completed"))
  74     // should we squash the script completed string ?
  75     {
  76       console.sendConsoleMessage(strStatus);
  77     }
  78   }
  79
  80   @Override
  81   public void showUrl(String url, String target)
  82   {
  83     try
  84     {
  85       jalview.util.BrowserLauncher.openURL(url);
  86     } catch (Exception e)
  87     {
  88       Cache.log.error("Failed to launch Jmol-associated url " + url, e);
  89       // TODO: 2.6 : warn user if browser was not configured.
  90     }
  91   }
  92
  93   @Override
  94   public void refreshGUI()
  95   {
  96     // appJmolWindow.repaint();
  97     javax.swing.SwingUtilities.invokeLater(new Runnable()
  98     {
  99       @Override
 100       public void run()
 101       {
 102         JalviewStructureDisplayI theViewer = getViewer();
 103         // invokes colourbySequence() via seqColour_ActionPerformed()
 104         theViewer.updateTitleAndMenus();
 105         ((JComponent) theViewer).revalidate();
 106       }
 107     });
 108   }
 109
 110   @Override
 111   public void notifyScriptTermination(String strStatus, int msWalltime)
 112   {
 113     // todo - script termination doesn't happen ?
 114     // if (console != null)
 115     // console.notifyScriptTermination(strStatus,
 116     // msWalltime);
 117   }
 118
 119   @Override
 120   public void showUrl(String url)
 121   {
 122     showUrl(url, "jmol");
 123   }
 124
 125   public void newJmolPopup(String menuName)
 126   {
 127     // jmolpopup = new JmolAwtPopup();
 128     // jmolpopup.jpiInitialize((viewer), menuName);
 129   }
 130
 131   @Override
 132   public void selectionChanged(BS arg0)
 133   {
 134   }
 135
 136   @Override
 137   public void showConsole(boolean b)
 138   {
 139     getViewer().showConsole(b);
 140   }
 141
 142   @Override
 143   protected JmolAppConsoleInterface createJmolConsole(
 144           Container consolePanel, String buttonsToShow)
 145   {
 146     jmolViewer.setJmolCallbackListener(this);
 147     // BH comment: can't do this yet [for JS only, or generally?]
 148     return Platform.isJS() ? null
 149             : new AppConsole(jmolViewer, consolePanel, buttonsToShow);
 150   }
 151
 152   @Override
 153   protected void releaseUIResources()
 154   {
 155     setViewer(null);
 156     closeConsole();
 157   }
 158
 159   @Override
 160   public void releaseReferences(Object svl)
 161   {
 162     if (svl instanceof SeqPanel)
 163     {
 164       getViewer().removeAlignmentPanel(((SeqPanel) svl).ap);
 165     }
 166   }
 167
 168   @Override
 169   public Map<String, Object> getJSpecViewProperty(String arg0)
 170   {
 171     // TODO Auto-generated method stub
 172     return null;
 173   }
 174
 175   @SuppressWarnings("unused")
 176   public void cacheFiles(List<File> files)
 177   {
 178     if (files == null)
 179     {
 180       return;
 181     }
 182     for (File f : files)
 183     {
 184       Platform.cacheFileData(f);
 185     }
 186   }
 187 }