src/jalview/appletgui/ExtJmol.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.appletgui;
  22
  23 import jalview.api.AlignmentViewPanel;
  24 import jalview.api.FeatureRenderer;
  25 import jalview.api.SequenceRenderer;
  26 import jalview.datamodel.PDBEntry;
  27 import jalview.datamodel.SequenceI;
  28 import jalview.ext.jmol.JalviewJmolBinding;
  29 import jalview.io.DataSourceType;
  30
  31 import java.awt.Container;
  32 import java.util.ArrayList;
  33 import java.util.List;
  34 import java.util.Map;
  35 import java.util.Vector;
  36
  37 import org.jmol.api.JmolAppConsoleInterface;
  38 import org.jmol.java.BS;
  39 import org.jmol.viewer.Viewer;
  40
  41 /**
  42  * bind an alignment view to an external Jmol instance.
  43  *
  44  * @author JimP
  45  *
  46  */
  47 public class ExtJmol extends JalviewJmolBinding
  48 {
  49
  50   private AlignmentPanel ap;
  51
  52   protected ExtJmol(AlignFrame alframe, PDBEntry[] pdbentry,
  53           SequenceI[][] seq, DataSourceType protocol)
  54   {
  55     super(alframe.alignPanel.getStructureSelectionManager(), pdbentry, seq,
  56             protocol);
  57   }
  58
  59   public ExtJmol(Viewer viewer, AlignmentPanel alignPanel,
  60           SequenceI[][] seqs)
  61   {
  62     super(alignPanel.getStructureSelectionManager(), seqs, viewer);
  63     ap = alignPanel;
  64     notifyFileLoaded(null, null, null, null, 0);
  65   }
  66
  67   @Override
  68   public void updateColours(Object source)
  69   {
  70   }
  71
  72   @Override
  73   public void showUrl(String arg0)
  74   {
  75     showUrl(arg0, "jmol");
  76   }
  77
  78   @Override
  79   public FeatureRenderer getFeatureRenderer(AlignmentViewPanel alignment)
  80   {
  81     AlignmentPanel alignPanel = (AlignmentPanel) alignment;
  82     if (alignPanel.av.isShowSequenceFeatures())
  83     {
  84       return alignPanel.getFeatureRenderer();
  85     }
  86     else
  87     {
  88       return null;
  89     }
  90   }
  91
  92
  93   @Override
  94   public SequenceRenderer getSequenceRenderer(AlignmentViewPanel alignment)
  95   {
  96     return ((AlignmentPanel) alignment).getSequenceRenderer();
  97   }
  98
  99   @Override
 100   public void notifyScriptTermination(String strStatus, int msWalltime)
 101   {
 102     // ignore
 103   }
 104
 105   @Override
 106   public void sendConsoleEcho(String strEcho)
 107   {
 108     // ignore
 109   }
 110
 111   @Override
 112   public void sendConsoleMessage(String strStatus)
 113   {
 114     // ignore
 115   }
 116
 117   @Override
 118   public void showUrl(String url, String target)
 119   {
 120     ap.alignFrame.showURL(url, target);
 121   }
 122
 123   @Override
 124   public void refreshGUI()
 125   {
 126     // ignore
 127   }
 128
 129   @Override
 130   public void selectionChanged(BS arg0)
 131   {
 132     System.out.println(arg0);
 133   }
 134
 135   @Override
 136   public void refreshPdbEntries()
 137   {
 138     List<PDBEntry> pdbe = new ArrayList<>();
 139     List<String> fileids = new ArrayList<>();
 140     SequenceI[] sq = ap.av.getAlignment().getSequencesArray();
 141     for (int s = 0; s < sq.length; s++)
 142     {
 143       Vector<PDBEntry> pdbids = sq[s].getAllPDBEntries();
 144       if (pdbids != null)
 145       {
 146         for (int pe = 0, peSize = pdbids.size(); pe < peSize; pe++)
 147         {
 148           PDBEntry pentry = pdbids.elementAt(pe);
 149           if (!fileids.contains(pentry.getId()))
 150           {
 151             pdbe.add(pentry);
 152           }
 153           else
 154           {
 155             fileids.add(pentry.getId());
 156           }
 157         }
 158       }
 159     }
 160     PDBEntry[] newEntries = new PDBEntry[pdbe.size()];
 161     for (int pe = 0; pe < pdbe.size(); pe++)
 162     {
 163       newEntries[pe] = pdbe.get(pe);
 164     }
 165     setPdbentry(newEntries);
 166   }
 167
 168   @Override
 169   public void showConsole(boolean show)
 170   {
 171     // This never gets called because we haven't overriden the associated Jmol's
 172     // console
 173     System.err.println(
 174             "WARNING: unexpected call to ExtJmol's showConsole method. (showConsole="
 175                     + show);
 176   }
 177
 178   @Override
 179   protected JmolAppConsoleInterface createJmolConsole(
 180           Container consolePanel, String buttonsToShow)
 181   {
 182     return null;
 183   }
 184
 185   @Override
 186   protected void releaseUIResources()
 187   {
 188     ap = null;
 189     closeConsole();
 190
 191   }
 192
 193   @Override
 194   public void releaseReferences(Object svl)
 195   {
 196   }
 197
 198   @Override
 199   public Map<String, Object> getJSpecViewProperty(String arg0)
 200   {
 201     return null;
 202   }
 203
 204 }