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