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