929a871106b9c3c4888212175405efac1d13cc9f
[jalview.git] / 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
30 import java.awt.Container;
31 import java.util.ArrayList;
32 import java.util.List;
33 import java.util.Map;
34 import java.util.Vector;
35
36 import org.jmol.api.JmolAppConsoleInterface;
37 import org.jmol.java.BS;
38 import org.jmol.viewer.Viewer;
39
40 /**
41  * bind an alignment view to an external Jmol instance.
42  * 
43  * @author JimP
44  * 
45  */
46 public class ExtJmol extends JalviewJmolBinding
47 {
48
49   private AlignmentPanel ap;
50
51   protected ExtJmol(jalview.appletgui.AlignFrame alframe,
52           PDBEntry[] pdbentry, SequenceI[][] seq, String[][] chains,
53           String protocol)
54   {
55     super(alframe.alignPanel.getStructureSelectionManager(), pdbentry, seq,
56             chains, 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   public void updateColours(Object source)
68   {
69
70     // TODO Auto-generated method stub
71
72   }
73
74   public void showUrl(String arg0)
75   {
76     showUrl(arg0, "jmol");
77   }
78
79   @Override
80   public FeatureRenderer getFeatureRenderer(AlignmentViewPanel alignment)
81   {
82     AlignmentPanel ap = (AlignmentPanel) alignment;
83     if (ap.av.isShowSequenceFeatures())
84     {
85       return ap.getFeatureRenderer();
86     }
87     else
88     {
89       return null;
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   public void selectionChanged(BS arg0)
130   {
131     System.out.println(arg0);
132   }
133
134   @Override
135   public void refreshPdbEntries()
136   {
137     List<PDBEntry> pdbe = new ArrayList<PDBEntry>();
138     List<String> fileids = new ArrayList<String>();
139     SequenceI[] sq = ap.av.getAlignment().getSequencesArray();
140     for (int s = 0; s < sq.length; s++)
141     {
142       Vector<PDBEntry> pdbids = sq[s].getAllPDBEntries();
143       if (pdbids != null)
144       {
145         for (int pe = 0, peSize = pdbids.size(); pe < peSize; pe++)
146         {
147           PDBEntry pentry = pdbids.elementAt(pe);
148           if (!fileids.contains(pentry.getId()))
149           {
150             pdbe.add(pentry);
151           }
152           else
153           {
154             fileids.add(pentry.getId());
155           }
156         }
157       }
158     }
159     PDBEntry[] newEntries = new PDBEntry[pdbe.size()];
160     for (int pe = 0; pe < pdbe.size(); pe++)
161     {
162       newEntries[pe] = pdbe.get(pe);
163     }
164     setPdbentry(newEntries);
165   }
166
167   @Override
168   public void showConsole(boolean show)
169   {
170     // This never gets called because we haven't overriden the associated Jmol's
171     // console
172     System.err
173             .println("WARNING: unexpected call to ExtJmol's showConsole method. (showConsole="
174                     + show);
175   }
176
177   @Override
178   protected JmolAppConsoleInterface createJmolConsole(
179           Container consolePanel, String buttonsToShow)
180   {
181     // TODO Auto-generated method stub
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     // TODO Auto-generated method stub
197
198   }
199
200   @Override
201   public Map<String, Object> getJSpecViewProperty(String arg0)
202   {
203     // TODO Auto-generated method stub
204     return null;
205   }
206
207 }