2 * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)
3 * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
5 * This file is part of Jalview.
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 of the License, or (at your option) any later version.
11 * Jalview is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty
13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
20 import jalview.appletgui.AlignFrame;
21 import jalview.appletgui.EmbmenuFrame;
22 import jalview.appletgui.FeatureSettings;
23 import jalview.datamodel.Alignment;
24 import jalview.datamodel.AlignmentI;
25 import jalview.datamodel.ColumnSelection;
26 import jalview.datamodel.PDBEntry;
27 import jalview.datamodel.Sequence;
28 import jalview.datamodel.SequenceGroup;
29 import jalview.datamodel.SequenceI;
30 import jalview.io.AnnotationFile;
31 import jalview.io.AppletFormatAdapter;
32 import jalview.io.FileParse;
33 import jalview.io.IdentifyFile;
34 import jalview.io.JnetAnnotationMaker;
35 import jalview.javascript.JSFunctionExec;
36 import jalview.javascript.JsCallBack;
37 import jalview.structure.SelectionListener;
38 import jalview.structure.StructureSelectionManager;
40 import java.applet.Applet;
41 import java.awt.Button;
42 import java.awt.Color;
43 import java.awt.Component;
45 import java.awt.Frame;
46 import java.awt.Graphics;
47 import java.awt.event.ActionEvent;
48 import java.awt.event.WindowAdapter;
49 import java.awt.event.WindowEvent;
50 import java.io.BufferedReader;
51 import java.io.InputStreamReader;
52 import java.util.StringTokenizer;
53 import java.util.Vector;
55 import netscape.javascript.JSObject;
58 * Jalview Applet. Runs in Java 1.18 runtime
63 public class JalviewLite extends Applet
66 // /////////////////////////////////////////
67 // The following public methods maybe called
68 // externally, eg via javascript in HTML page
70 * @return String list of selected sequence IDs, each terminated by the 'boolean not' character (""+0x00AC) or
73 public String getSelectedSequences()
75 return getSelectedSequencesFrom(getDefaultTargetFrame());
80 * separator string or null for default
81 * @return String list of selected sequence IDs, each terminated by given separator string
83 public String getSelectedSequences(String sep)
85 return getSelectedSequencesFrom(getDefaultTargetFrame(), sep);
90 * alignframe containing selection
91 * @return String list of selected sequence IDs, each terminated by current default separator sequence
94 public String getSelectedSequencesFrom(AlignFrame alf)
96 return getSelectedSequencesFrom(alf,separator); // ""+0x00AC);
100 * get list of selected sequence IDs separated by given separator
103 * window containing selection
105 * separator string to use - default is 'boolean not'
106 * @return String list of selected sequence IDs, each terminated by the given
109 public String getSelectedSequencesFrom(AlignFrame alf, String sep)
111 StringBuffer result = new StringBuffer("");
112 if (sep == null || sep.length() == 0)
114 sep = separator; // "+0x00AC;
116 if (alf.viewport.getSelectionGroup() != null)
118 SequenceI[] seqs = alf.viewport.getSelectionGroup()
119 .getSequencesInOrder(alf.viewport.getAlignment());
121 for (int i = 0; i < seqs.length; i++)
123 result.append(seqs[i].getName());
128 return result.toString();
134 * id of sequence to highlight
136 * integer position [ tobe implemented or range ] on sequence
137 * @param alignedPosition
138 * true/false/empty string - indicate if position is an alignment
139 * column or unaligned sequence position
141 public void highlight(String sequenceId, String position,
142 String alignedPosition)
144 highlightIn(getDefaultTargetFrame(), sequenceId, position, alignedPosition);
150 * id of sequence to highlight
152 * integer position [ tobe implemented or range ] on sequence
153 * @param alignedPosition
154 * false, blank or something else - indicate if position is an
155 * alignment column or unaligned sequence position
157 public void highlightIn(AlignFrame alf, String sequenceId, String position,
158 String alignedPosition)
160 // TODO: could try to highlight in all alignments if alf==null
161 SequenceI sq = alf.getAlignViewport().getAlignment()
162 .findName(sequenceId);
168 apos = new Integer(position).intValue();
170 } catch (NumberFormatException ex)
174 // use vamsas listener to broadcast to all listeners in scope
175 if (alignedPosition != null
176 && (alignedPosition.trim().length() == 0 || alignedPosition
177 .toLowerCase().indexOf("false") > -1))
179 StructureSelectionManager.getStructureSelectionManager()
180 .mouseOverVamsasSequence(sq, sq.findIndex(apos));
184 StructureSelectionManager.getStructureSelectionManager()
185 .mouseOverVamsasSequence(sq, apos);
192 * select regions of the currrent alignment frame
195 * String separated list of sequence ids or empty string
197 * String separated list { column range or column, ..} or empty
200 public void select(String sequenceIds, String columns)
202 selectIn(getDefaultTargetFrame(), sequenceIds, columns, separator);
206 * select regions of the currrent alignment frame
209 * String separated list { column range, seq1...seqn sequence ids }
211 * separator between toselect fields
213 public void select(String sequenceIds, String columns, String sep)
215 selectIn(getDefaultTargetFrame(), sequenceIds, columns, sep);
219 * select regions of the given alignment frame
223 * String separated list { column range, seq1...seqn sequence ids }
225 * separator between toselect fields
227 public void selectIn(AlignFrame alf, String sequenceIds, String columns)
229 selectIn(alf, sequenceIds, columns, separator);
233 * select regions of the given alignment frame
237 * String separated list { column range, seq1...seqn sequence ids }
239 * separator between toselect fields
241 public void selectIn(AlignFrame alf, String sequenceIds, String columns,
244 if (sep == null || sep.length() == 0)
250 System.err.println("Selecting region using separator string '"+separator+"'");
254 String[] ids = separatorListToArray(sequenceIds, sep);
255 String[] cols = separatorListToArray(columns, sep);
256 SequenceGroup sel = new SequenceGroup();
257 ColumnSelection csel = new ColumnSelection();
258 AlignmentI al = alf.viewport.getAlignment();
259 int start = 0, end = al.getWidth(), alw = al.getWidth();
260 if (ids != null && ids.length > 0)
262 for (int i = 0; i < ids.length; i++)
264 if (ids[i].trim().length() == 0)
268 SequenceI sq = al.findName(ids[i]);
271 sel.addSequence(sq, false);
275 if (cols != null && cols.length > 0)
277 boolean seset = false;
278 for (int i = 0; i < cols.length; i++)
280 String cl = cols[i].trim();
281 if (cl.length() == 0)
286 if ((p = cl.indexOf("-")) > -1)
288 int from = -1, to = -1;
291 from = new Integer(cl.substring(0, p)).intValue();
293 } catch (NumberFormatException ex)
296 .println("ERROR: Couldn't parse first integer in range element column selection string '"
297 + cl + "' - format is 'from-to'");
302 to = new Integer(cl.substring(p + 1)).intValue();
304 } catch (NumberFormatException ex)
307 .println("ERROR: Couldn't parse second integer in range element column selection string '"
308 + cl + "' - format is 'from-to'");
311 if (from >= 0 && to >= 0)
328 // comment to prevent range extension
338 for (int r = from; r <= to; r++)
340 if (r >= 0 && r < alw)
347 System.err.println("Range '" + cl + "' deparsed as [" + from
353 System.err.println("ERROR: Invalid Range '" + cl
354 + "' deparsed as [" + from + "," + to + "]");
362 r = new Integer(cl).intValue();
364 } catch (NumberFormatException ex)
367 .println("ERROR: Couldn't parse integer from point selection element of column selection string '"
371 if (r >= 0 && r <= alw)
381 // comment to prevent range extension
394 System.err.println("Point selection '" + cl
395 + "' deparsed as [" + r + "]");
400 System.err.println("ERROR: Invalid Point selection '" + cl
401 + "' deparsed as [" + r + "]");
406 sel.setStartRes(start);
408 alf.select(sel, csel);
413 * get sequences selected in current alignFrame and return their alignment in
414 * format 'format' either with or without suffix
417 * - where selection is
419 * - format of alignment file
421 * - "true" to append /start-end string to each sequence ID
422 * @return selected sequences as flat file or empty string if there was no
425 public String getSelectedSequencesAsAlignment(String format, String suffix)
427 return getSelectedSequencesAsAlignmentFrom(getDefaultTargetFrame(), format,
432 * get sequences selected in alf and return their alignment in format 'format'
433 * either with or without suffix
436 * - where selection is
438 * - format of alignment file
440 * - "true" to append /start-end string to each sequence ID
441 * @return selected sequences as flat file or empty string if there was no
444 public String getSelectedSequencesAsAlignmentFrom(AlignFrame alf,
445 String format, String suffix)
449 boolean seqlimits = suffix.equalsIgnoreCase("true");
450 if (alf.viewport.getSelectionGroup() != null)
452 String reply = new AppletFormatAdapter().formatSequences(format,
453 new Alignment(alf.viewport.getSelectionAsNewSequence()),
457 } catch (Exception ex)
459 ex.printStackTrace();
460 return "Error retrieving alignment in " + format + " format. ";
465 public String getAlignment(String format)
467 return getAlignmentFrom(getDefaultTargetFrame(), format, "true");
470 public String getAlignmentFrom(AlignFrame alf, String format)
472 return getAlignmentFrom(alf, format, "true");
475 public String getAlignment(String format, String suffix)
477 return getAlignmentFrom(getDefaultTargetFrame(), format, suffix);
480 public String getAlignmentFrom(AlignFrame alf, String format,
485 boolean seqlimits = suffix.equalsIgnoreCase("true");
487 String reply = new AppletFormatAdapter().formatSequences(format,
488 alf.viewport.getAlignment(), seqlimits);
490 } catch (Exception ex)
492 ex.printStackTrace();
493 return "Error retrieving alignment in " + format + " format. ";
497 public void loadAnnotation(String annotation)
499 loadAnnotationFrom(getDefaultTargetFrame(), annotation);
502 public void loadAnnotationFrom(AlignFrame alf, String annotation)
504 if (new AnnotationFile().readAnnotationFile(alf.getAlignViewport()
505 .getAlignment(), annotation, AppletFormatAdapter.PASTE))
507 alf.alignPanel.fontChanged();
508 alf.alignPanel.setScrollValues(0, 0);
512 alf.parseFeaturesFile(annotation, AppletFormatAdapter.PASTE);
516 public String getFeatures(String format)
518 return getFeaturesFrom(getDefaultTargetFrame(), format);
521 public String getFeaturesFrom(AlignFrame alf, String format)
523 return alf.outputFeatures(false, format);
526 public String getAnnotation()
528 return getAnnotationFrom(getDefaultTargetFrame());
531 public String getAnnotationFrom(AlignFrame alf)
533 return alf.outputAnnotations(false);
536 public AlignFrame newView()
538 return newViewFrom(getDefaultTargetFrame());
541 public AlignFrame newView(String name)
543 return newViewFrom(getDefaultTargetFrame(), name);
546 public AlignFrame newViewFrom(AlignFrame alf)
548 return alf.newView(null);
551 public AlignFrame newViewFrom(AlignFrame alf, String name)
553 return alf.newView(name);
559 * alignment file as a string
562 * @return null or new alignment frame
564 public AlignFrame loadAlignment(String text, String title)
568 String format = new IdentifyFile().Identify(text,
569 AppletFormatAdapter.PASTE);
572 al = new AppletFormatAdapter().readFile(text,
573 AppletFormatAdapter.PASTE, format);
574 if (al.getHeight() > 0)
576 return new AlignFrame(al, this, title, false);
578 } catch (java.io.IOException ex)
580 ex.printStackTrace();
585 public void setMouseoverListener(String listener)
587 setMouseoverListener(currentAlignFrame, listener);
590 private Vector mouseoverListeners = new Vector();
592 public void setMouseoverListener(AlignFrame af, String listener)
594 if (listener != null)
596 listener = listener.trim();
597 if (listener.length() == 0)
600 .println("jalview Javascript error: Ignoring empty function for mouseover listener.");
604 jalview.javascript.MouseOverListener mol = new jalview.javascript.MouseOverListener(
606 mouseoverListeners.addElement(mol);
607 StructureSelectionManager.getStructureSelectionManager()
608 .addStructureViewerListener(mol);
611 System.err.println("Added a mouseover listener for "
612 + ((af == null) ? "All frames" : "Just views for "
613 + af.getAlignViewport().getSequenceSetId()));
614 System.err.println("There are now " + mouseoverListeners.size()
615 + " listeners in total.");
619 public void setSelectionListener(String listener)
621 setSelectionListener(null, listener);
624 public void setSelectionListener(AlignFrame af, String listener)
626 if (listener != null)
628 listener = listener.trim();
629 if (listener.length() == 0)
632 .println("jalview Javascript error: Ignoring empty function for selection listener.");
636 jalview.javascript.JsSelectionSender mol = new jalview.javascript.JsSelectionSender(
638 mouseoverListeners.addElement(mol);
639 StructureSelectionManager.getStructureSelectionManager()
640 .addSelectionListener(mol);
643 System.err.println("Added a selection listener for "
644 + ((af == null) ? "All frames" : "Just views for "
645 + af.getAlignViewport().getSequenceSetId()));
646 System.err.println("There are now " + mouseoverListeners.size()
647 + " listeners in total.");
652 * remove any callback using the given listener function and associated with
653 * the given alignFrame (or null for all callbacks)
660 public void removeJavascriptListener(AlignFrame af, String listener)
662 if (listener != null)
664 listener = listener.trim();
665 if (listener.length() == 0)
670 boolean rprt = false;
671 for (int ms = 0, msSize = mouseoverListeners.size(); ms < msSize;)
673 Object lstn = mouseoverListeners.elementAt(ms);
674 JsCallBack lstner = (JsCallBack) lstn;
675 if ((af == null || lstner.getAlignFrame() == af)
676 && (listener == null || lstner.getListenerFunction().equals(
679 mouseoverListeners.removeElement(lstner);
681 if (lstner instanceof SelectionListener)
683 StructureSelectionManager.getStructureSelectionManager()
684 .removeSelectionListener((SelectionListener) lstner);
688 StructureSelectionManager.getStructureSelectionManager()
689 .removeStructureViewerListener(lstner, null);
694 System.err.println("Removed listener '" + listener + "'");
704 System.err.println("There are now " + mouseoverListeners.size()
705 + " listeners in total.");
711 if (mouseoverListeners != null)
713 while (mouseoverListeners.size() > 0)
715 Object mol = mouseoverListeners.elementAt(0);
716 mouseoverListeners.removeElement(mol);
717 if (mol instanceof SelectionListener)
719 StructureSelectionManager.getStructureSelectionManager()
720 .removeSelectionListener((SelectionListener) mol);
724 StructureSelectionManager.getStructureSelectionManager()
725 .removeStructureViewerListener(mol, null);
729 jalview.javascript.JSFunctionExec.stopQueue();
733 * send a mouseover message to all the alignment windows associated with the
734 * given residue in the pdbfile
740 public void mouseOverStructure(int pdbResNum, String chain, String pdbfile)
742 StructureSelectionManager.getStructureSelectionManager()
743 .mouseOverStructure(pdbResNum, chain, pdbfile);
746 // //////////////////////////////////////////////
747 // //////////////////////////////////////////////
749 public static int lastFrameX = 200;
751 public static int lastFrameY = 200;
753 boolean fileFound = true;
755 String file = "No file";
757 Button launcher = new Button("Start Jalview");
760 * The currentAlignFrame is static, it will change if and when the user
761 * selects a new window. Note that it will *never* point back to the embedded
762 * AlignFrame if the applet is started as embedded on the page and then
763 * afterwards a new view is created.
765 public AlignFrame currentAlignFrame = null;
768 * This is the first frame to be displayed, and does not change. API calls
769 * will default to this instance if currentAlignFrame is null.
771 AlignFrame initialAlignFrame = null;
773 boolean embedded = false;
775 private boolean checkForJmol = true;
777 private boolean checkedForJmol = false; // ensure we don't check for jmol
779 // every time the app is re-inited
781 public boolean jmolAvailable = false;
783 private boolean alignPdbStructures = false;
785 public static boolean debug = false;
787 static String builddate = null, version = null;
789 private static void initBuildDetails()
791 if (builddate == null)
793 builddate = "unknown";
795 java.net.URL url = JalviewLite.class
796 .getResource("/.build_properties");
801 BufferedReader reader = new BufferedReader(new InputStreamReader(
804 while ((line = reader.readLine()) != null)
806 if (line.indexOf("VERSION") > -1)
808 version = line.substring(line.indexOf("=") + 1);
810 if (line.indexOf("BUILD_DATE") > -1)
812 builddate = line.substring(line.indexOf("=") + 1);
815 } catch (Exception ex)
817 ex.printStackTrace();
823 public static String getBuildDate()
829 public static String getVersion()
835 // public JSObject scriptObject = null;
838 * init method for Jalview Applet
842 // remove any handlers that might be hanging around from an earlier instance
845 JSObject scriptObject = JSObject.getWindow(this);
846 } catch (Exception ex)
851 .println("Warning: No JalviewLite javascript callbacks available.");
855 * turn on extra applet debugging
857 String dbg = getParameter("debug");
860 debug = dbg.toLowerCase().equals("true");
865 System.err.println("JalviewLite Version " + getVersion());
866 System.err.println("Build Date : " + getBuildDate());
870 * if true disable the check for jmol
872 String chkforJmol = getParameter("nojmol");
873 if (chkforJmol != null)
875 checkForJmol = !chkforJmol.equals("true");
878 * get the separator parameter if present
880 String sep = getParameter("separator");
883 if (sep.length() > 0)
888 System.err.println("Separator set to '" + separator + "'");
894 "Invalid separator parameter - must be non-zero length");
900 String param = getParameter("RGB");
906 r = Integer.parseInt(param.substring(0, 2), 16);
907 g = Integer.parseInt(param.substring(2, 4), 16);
908 b = Integer.parseInt(param.substring(4, 6), 16);
909 } catch (Exception ex)
916 param = getParameter("label");
919 launcher.setLabel(param);
922 setBackground(new Color(r, g, b));
924 file = getParameter("file");
928 // Maybe the sequences are added as parameters
929 StringBuffer data = new StringBuffer("PASTE");
931 while ((file = getParameter("sequence" + i)) != null)
933 data.append(file.toString() + "\n");
936 if (data.length() > 5)
938 file = data.toString();
942 final JalviewLite jvapplet = this;
943 if (getParameter("embedded") != null
944 && getParameter("embedded").equalsIgnoreCase("true"))
946 // Launch as embedded applet in page
948 LoadingThread loader = new LoadingThread(file, jvapplet);
951 else if (file != null)
953 if (getParameter("showbutton") == null
954 || !getParameter("showbutton").equalsIgnoreCase(
957 // Add the JalviewLite 'Button' to the page
959 launcher.addActionListener(new java.awt.event.ActionListener()
961 public void actionPerformed(ActionEvent e)
963 LoadingThread loader = new LoadingThread(file, jvapplet);
970 // Open jalviewLite immediately.
971 LoadingThread loader = new LoadingThread(file, jvapplet);
977 // jalview initialisation with no alignment. loadAlignment() method can
978 // still be called to open new alignments.
981 // callInitCallback();
985 private void callInitCallback()
987 String initjscallback = getParameter("oninit");
988 if (initjscallback == null)
992 initjscallback = initjscallback.trim();
993 if (initjscallback.length() > 0)
995 JSObject scriptObject = null;
997 scriptObject = JSObject.getWindow(this);
998 } catch (Exception ex) {};
999 if (scriptObject != null)
1003 // do onInit with the JS executor thread
1004 new JSFunctionExec(this).executeJavascriptFunction(true,
1005 initjscallback, null, "Calling oninit callback '" + initjscallback
1007 } catch (Exception e)
1009 System.err.println("Exception when executing _oninit callback '"
1010 + initjscallback + "'.");
1011 e.printStackTrace();
1016 System.err.println("Not executing _oninit callback '"
1017 + initjscallback + "' - no scripting allowed.");
1023 * Initialises and displays a new java.awt.Frame
1026 * java.awt.Frame to be displayed
1028 * title of new frame
1030 * width if new frame
1032 * height of new frame
1034 public static void addFrame(final Frame frame, String title, int width,
1037 frame.setLocation(lastFrameX, lastFrameY);
1040 frame.setSize(width, height);
1041 frame.setTitle(title);
1042 frame.addWindowListener(new WindowAdapter()
1044 public void windowClosing(WindowEvent e)
1046 if (frame instanceof AlignFrame)
1048 ((AlignFrame) frame).closeMenuItem_actionPerformed();
1049 if (((AlignFrame) frame).viewport.applet.currentAlignFrame == frame)
1051 ((AlignFrame) frame).viewport.applet.currentAlignFrame = null;
1056 if (frame instanceof EmbmenuFrame)
1058 ((EmbmenuFrame) frame).destroyMenus();
1060 frame.setMenuBar(null);
1064 public void windowActivated(WindowEvent e)
1066 if (frame instanceof AlignFrame)
1068 ((AlignFrame) frame).viewport.applet.currentAlignFrame = (AlignFrame) frame;
1071 System.err.println("Activated window " + frame);
1075 super.windowActivated(e);
1078 * Probably not necessary to do this - see TODO above. (non-Javadoc)
1081 * java.awt.event.WindowAdapter#windowDeactivated(java.awt.event.WindowEvent
1084 * public void windowDeactivated(WindowEvent e) { if (currentAlignFrame ==
1085 * frame) { currentAlignFrame = null; if (debug) {
1086 * System.err.println("Deactivated window "+frame); } }
1087 * super.windowDeactivated(e); }
1090 frame.setVisible(true);
1094 * This paints the background surrounding the "Launch Jalview button" <br>
1096 * If file given in parameter not found, displays error message
1101 public void paint(Graphics g)
1105 g.setColor(new Color(200, 200, 200));
1106 g.setColor(Color.cyan);
1107 g.fillRect(0, 0, getSize().width, getSize().height);
1108 g.setColor(Color.red);
1109 g.drawString("Jalview can't open file", 5, 15);
1110 g.drawString("\"" + file + "\"", 5, 30);
1114 g.setColor(Color.black);
1115 g.setFont(new Font("Arial", Font.BOLD, 24));
1116 g.drawString("Jalview Applet", 50, getSize().height / 2 - 30);
1117 g.drawString("Loading Data...", 50, getSize().height / 2);
1121 * get all components associated with the applet of the given type
1126 public Vector getAppletWindow(Class class1)
1128 Vector wnds = new Vector();
1129 Component[] cmp = getComponents();
1132 for (int i = 0; i < cmp.length; i++)
1134 if (class1.isAssignableFrom(cmp[i].getClass()))
1136 wnds.addElement(cmp);
1143 class LoadJmolThread extends Thread
1145 private boolean running = false;
1149 if (running || checkedForJmol)
1158 if (!System.getProperty("java.version").startsWith("1.1"))
1160 Class.forName("org.jmol.adapter.smarter.SmarterJmolAdapter");
1161 jmolAvailable = true;
1166 .println("Jmol not available - Using MCview for structures");
1168 } catch (java.lang.ClassNotFoundException ex)
1174 jmolAvailable = false;
1178 .println("Skipping Jmol check. Will use MCView (probably)");
1181 checkedForJmol = true;
1185 public boolean notFinished()
1187 return running || !checkedForJmol;
1191 class LoadingThread extends Thread
1194 * State variable: File source
1199 * State variable: protocol for access to file source
1204 * State variable: format of file source
1212 private void dbgMsg(String msg)
1216 System.err.println(msg);
1221 * update the protocol state variable for accessing the datasource located
1225 * @return possibly updated datasource string
1227 public String setProtocolState(String file)
1229 if (file.startsWith("PASTE"))
1231 file = file.substring(5);
1232 protocol = AppletFormatAdapter.PASTE;
1234 else if (inArchive(file))
1236 protocol = AppletFormatAdapter.CLASSLOADER;
1240 file = addProtocol(file);
1241 protocol = AppletFormatAdapter.URL;
1243 dbgMsg("Protocol identified as '" + protocol + "'");
1247 public LoadingThread(String _file, JalviewLite _applet)
1255 LoadJmolThread jmolchecker = new LoadJmolThread();
1256 jmolchecker.start();
1257 while (jmolchecker.notFinished())
1259 // wait around until the Jmol check is complete.
1263 } catch (Exception e)
1269 // applet.callInitCallback();
1272 private void startLoading()
1274 AlignFrame newAlignFrame;
1275 dbgMsg("Loading thread started with:\n>>file\n" + _file + ">>endfile");
1276 file = setProtocolState(_file);
1278 format = new jalview.io.IdentifyFile().Identify(file, protocol);
1279 dbgMsg("File identified as '" + format + "'");
1280 dbgMsg("Loading started.");
1281 Alignment al = null;
1284 al = new AppletFormatAdapter().readFile(file, protocol, format);
1285 } catch (java.io.IOException ex)
1287 dbgMsg("File load exception.");
1288 ex.printStackTrace();
1293 FileParse fp = new FileParse(file, protocol);
1295 dbgMsg(">>>Dumping contents of '" + file + "' " + "("
1297 while ((ln = fp.nextLine()) != null)
1301 dbgMsg(">>>Dump finished.");
1302 } catch (Exception e)
1305 .println("Exception when trying to dump the content of the file parameter.");
1306 e.printStackTrace();
1310 if ((al != null) && (al.getHeight() > 0))
1312 dbgMsg("Successfully loaded file.");
1313 newAlignFrame = new AlignFrame(al, applet, file, embedded);
1314 if (initialAlignFrame == null)
1316 initialAlignFrame = newAlignFrame;
1318 // update the focus.
1319 currentAlignFrame = newAlignFrame;
1321 if (protocol == jalview.io.AppletFormatAdapter.PASTE)
1323 newAlignFrame.setTitle("Sequences from "
1324 + applet.getDocumentBase());
1327 newAlignFrame.statusBar.setText("Successfully loaded file " + file);
1329 String treeFile = applet.getParameter("tree");
1330 if (treeFile == null)
1332 treeFile = applet.getParameter("treeFile");
1335 if (treeFile != null)
1339 treeFile = setProtocolState(treeFile);
1341 * if (inArchive(treeFile)) { protocol =
1342 * AppletFormatAdapter.CLASSLOADER; } else { protocol =
1343 * AppletFormatAdapter.URL; treeFile = addProtocol(treeFile); }
1345 jalview.io.NewickFile fin = new jalview.io.NewickFile(treeFile,
1350 if (fin.getTree() != null)
1352 newAlignFrame.loadTree(fin, treeFile);
1353 dbgMsg("Successfuly imported tree.");
1357 dbgMsg("Tree parameter did not resolve to a valid tree.");
1359 } catch (Exception ex)
1361 ex.printStackTrace();
1365 String param = applet.getParameter("features");
1368 param = setProtocolState(param);
1370 newAlignFrame.parseFeaturesFile(param, protocol);
1373 param = applet.getParameter("showFeatureSettings");
1374 if (param != null && param.equalsIgnoreCase("true"))
1376 newAlignFrame.viewport.showSequenceFeatures(true);
1377 new FeatureSettings(newAlignFrame.alignPanel);
1380 param = applet.getParameter("annotations");
1383 param = setProtocolState(param);
1385 if (new AnnotationFile().readAnnotationFile(
1386 newAlignFrame.viewport.getAlignment(), param, protocol))
1388 newAlignFrame.alignPanel.fontChanged();
1389 newAlignFrame.alignPanel.setScrollValues(0, 0);
1394 .println("Annotations were not added from annotation file '"
1400 param = applet.getParameter("jnetfile");
1405 param = setProtocolState(param);
1406 jalview.io.JPredFile predictions = new jalview.io.JPredFile(
1408 JnetAnnotationMaker.add_annotation(predictions,
1409 newAlignFrame.viewport.getAlignment(), 0, false); // false==do
1417 newAlignFrame.alignPanel.fontChanged();
1418 newAlignFrame.alignPanel.setScrollValues(0, 0);
1419 } catch (Exception ex)
1421 ex.printStackTrace();
1425 * <param name="alignpdbfiles" value="false/true"/> Undocumented for 2.6
1426 * - related to JAL-434
1428 applet.setAlignPdbStructures(getDefaultParameter("alignpdbfiles",
1431 * <param name="PDBfile" value="1gaq.txt PDB|1GAQ|1GAQ|A PDB|1GAQ|1GAQ|B
1434 * <param name="PDBfile2" value="1gaq.txt A=SEQA B=SEQB C=SEQB">
1436 * <param name="PDBfile3" value="1q0o Q45135_9MICO">
1439 int pdbFileCount = 0;
1440 // Accumulate pdbs here if they are heading for the same view (if
1441 // alignPdbStructures is true)
1442 Vector pdbs = new Vector();
1445 if (pdbFileCount > 0)
1446 param = applet.getParameter("PDBFILE" + pdbFileCount);
1448 param = applet.getParameter("PDBFILE");
1452 PDBEntry pdb = new PDBEntry();
1455 SequenceI[] seqs = null;
1456 String[] chains = null;
1458 StringTokenizer st = new StringTokenizer(param, " ");
1460 if (st.countTokens() < 2)
1462 String sequence = applet.getParameter("PDBSEQ");
1463 if (sequence != null)
1464 seqs = new SequenceI[]
1465 { (Sequence) newAlignFrame.getAlignViewport()
1466 .getAlignment().findName(sequence) };
1471 param = st.nextToken();
1472 Vector tmp = new Vector();
1473 Vector tmp2 = new Vector();
1475 while (st.hasMoreTokens())
1477 seqstring = st.nextToken();
1478 StringTokenizer st2 = new StringTokenizer(seqstring, "=");
1479 if (st2.countTokens() > 1)
1481 // This is the chain
1482 tmp2.addElement(st2.nextToken());
1483 seqstring = st2.nextToken();
1485 tmp.addElement((Sequence) newAlignFrame.getAlignViewport()
1486 .getAlignment().findName(seqstring));
1489 seqs = new SequenceI[tmp.size()];
1491 if (tmp2.size() == tmp.size())
1493 chains = new String[tmp2.size()];
1494 tmp2.copyInto(chains);
1497 param = setProtocolState(param);
1499 if (// !jmolAvailable
1501 protocol == AppletFormatAdapter.CLASSLOADER)
1503 // TODO: verify this Re:
1504 // https://mantis.lifesci.dundee.ac.uk/view.php?id=36605
1505 // This exception preserves the current behaviour where, even if
1506 // the local pdb file was identified in the class loader
1507 protocol = AppletFormatAdapter.URL; // this is probably NOT
1509 param = addProtocol(param); //
1516 for (int i = 0; i < seqs.length; i++)
1518 if (seqs[i] != null)
1520 ((Sequence) seqs[i]).addPDBId(pdb);
1524 if (JalviewLite.debug)
1526 // this may not really be a problem but we give a warning
1529 .println("Warning: Possible input parsing error: Null sequence for attachment of PDB (sequence "
1535 if (!alignPdbStructures)
1537 newAlignFrame.newStructureView(applet, pdb, seqs, chains,
1542 pdbs.addElement(new Object[]
1543 { pdb, seqs, chains, new String(protocol) });
1549 } while (pdbFileCount < 10);
1550 if (pdbs.size() > 0)
1552 SequenceI[][] seqs = new SequenceI[pdbs.size()][];
1553 PDBEntry[] pdb = new PDBEntry[pdbs.size()];
1554 String[][] chains = new String[pdbs.size()][];
1555 String[] protocols = new String[pdbs.size()];
1556 for (int pdbsi = 0, pdbsiSize = pdbs.size(); pdbsi < pdbsiSize; pdbsi++)
1558 Object[] o = (Object[]) pdbs.elementAt(pdbsi);
1559 pdb[pdbsi] = (PDBEntry) o[0];
1560 seqs[pdbsi] = (SequenceI[]) o[1];
1561 chains[pdbsi] = (String[]) o[2];
1562 protocols[pdbsi] = (String) o[3];
1564 newAlignFrame.alignedStructureView(applet, pdb, seqs, chains,
1568 // ///////////////////////////
1569 // modify display of features
1571 // hide specific groups
1572 param = applet.getParameter("hidefeaturegroups");
1575 applet.setFeatureGroupStateOn(newAlignFrame, param, false);
1577 // show specific groups
1578 param = applet.getParameter("showfeaturegroups");
1581 applet.setFeatureGroupStateOn(newAlignFrame, param, true);
1587 applet.remove(launcher);
1593 * Discovers whether the given file is in the Applet Archive
1599 boolean inArchive(String file)
1601 // This might throw a security exception in certain browsers
1602 // Netscape Communicator for instance.
1605 boolean rtn = (getClass().getResourceAsStream("/" + file) != null);
1608 System.err.println("Resource '" + file + "' was "
1609 + (rtn ? "" : "not") + " located by classloader.");
1612 } catch (Exception ex)
1614 System.out.println("Exception checking resources: " + file + " "
1620 String addProtocol(String file)
1622 if (file.indexOf("://") == -1)
1624 file = applet.getCodeBase() + file;
1627 System.err.println("Prepended codebase for resource: '" + file
1637 * @return the default alignFrame acted on by the public applet methods. May
1638 * return null with an error message on System.err indicating the
1641 public AlignFrame getDefaultTargetFrame()
1643 if (currentAlignFrame != null)
1645 return currentAlignFrame;
1647 if (initialAlignFrame != null)
1649 return initialAlignFrame;
1652 .println("Implementation error: Jalview Applet API cannot work out which AlignFrame to use.");
1657 * separator used for separatorList
1659 protected String separator = ""+((char)0x00AC); // the default used to be '|' but many sequence IDS include pipes.
1662 * parse the string into a list
1665 * @return elements separated by separator
1667 public String[] separatorListToArray(String list)
1669 return separatorListToArray(list, separator);
1673 * parse the string into a list
1677 * @return elements separated by separator
1679 public String[] separatorListToArray(String list, String separator)
1681 // note separator local variable intentionally masks object field
1682 int seplen = separator.length();
1683 if (list == null || list.equals("") || list.equals(separator))
1685 java.util.Vector jv = new Vector();
1687 while ((pos = list.indexOf(separator, cp)) > cp)
1689 jv.addElement(list.substring(cp, pos));
1692 if (cp < list.length())
1694 String c = list.substring(cp);
1695 if (!c.equals(separator))
1702 String[] v = new String[jv.size()];
1703 for (int i = 0; i < v.length; i++)
1705 v[i] = (String) jv.elementAt(i);
1707 jv.removeAllElements();
1710 System.err.println("Array from '" + separator
1711 + "' separated List:\n" + v.length);
1712 for (int i = 0; i < v.length; i++)
1714 System.err.println("item " + i + " '" + v[i] + "'");
1721 System.err.println("Empty Array from '" + separator
1722 + "' separated List");
1728 * concatenate the list with separator
1731 * @return concatenated string
1733 public String arrayToSeparatorList(String[] list)
1735 return arrayToSeparatorList(list, separator);
1739 * concatenate the list with separator
1743 * @return concatenated string
1745 public String arrayToSeparatorList(String[] list, String separator)
1747 StringBuffer v = new StringBuffer();
1748 if (list != null && list.length > 0)
1750 for (int i = 0, iSize = list.length; i < iSize; i++)
1752 if (list[i] != null)
1756 v.append(separator);
1763 System.err.println("Returning '" + separator
1764 + "' separated List:\n");
1765 System.err.println(v);
1767 return v.toString();
1771 System.err.println("Returning empty '" + separator
1772 + "' separated List\n");
1774 return "" + separator;
1779 * @see jalview.appletgui.AlignFrame#getFeatureGroups()
1781 public String getFeatureGroups()
1783 String lst = arrayToSeparatorList(getDefaultTargetFrame()
1784 .getFeatureGroups());
1790 * alignframe to get feature groups on
1792 * @see jalview.appletgui.AlignFrame#getFeatureGroups()
1794 public String getFeatureGroupsOn(AlignFrame alf)
1796 String lst = arrayToSeparatorList(alf.getFeatureGroups());
1803 * @see jalview.appletgui.AlignFrame#getFeatureGroupsOfState(boolean)
1805 public String getFeatureGroupsOfState(boolean visible)
1807 return arrayToSeparatorList(getDefaultTargetFrame()
1808 .getFeatureGroupsOfState(visible));
1813 * align frame to get groups of state visible
1816 * @see jalview.appletgui.AlignFrame#getFeatureGroupsOfState(boolean)
1818 public String getFeatureGroupsOfStateOn(AlignFrame alf, boolean visible)
1820 return arrayToSeparatorList(alf.getFeatureGroupsOfState(visible));
1825 * tab separated list of group names
1828 * @see jalview.appletgui.AlignFrame#setFeatureGroupState(java.lang.String[],
1831 public void setFeatureGroupStateOn(AlignFrame alf, String groups,
1834 boolean st = state;// !(state==null || state.equals("") ||
1835 // state.toLowerCase().equals("false"));
1836 alf.setFeatureGroupState(separatorListToArray(groups), st);
1839 public void setFeatureGroupState(String groups, boolean state)
1841 setFeatureGroupStateOn(getDefaultTargetFrame(), groups, state);
1845 * List separator string
1847 * @return the separator
1849 public String getSeparator()
1855 * List separator string
1858 * the separator to set. empty string will reset separator to default
1860 public void setSeparator(String separator)
1862 if (separator==null || separator.length()<1)
1865 separator = ""+((char)0x00AC);
1867 this.separator = separator;
1870 System.err.println("Default Separator now: '"+separator+"'");
1875 * get boolean value of applet parameter 'name' and return default if
1876 * parameter is not set
1881 * the value to return otherwise
1882 * @return true or false
1884 public boolean getDefaultParameter(String name, boolean def)
1887 if ((stn = getParameter(name)) == null)
1891 if (stn.toLowerCase().equals("true"))
1899 * bind a pdb file to a sequence in the given alignFrame.
1902 * - null or specific alignFrame. This specifies the dataset that
1903 * will be searched for a seuqence called sequenceId
1905 * - sequenceId within the dataset.
1906 * @param pdbEntryString
1907 * - the short name for the PDB file
1909 * - pdb file - either a URL or a valid PDB file.
1910 * @return true if binding was as success TODO: consider making an exception
1911 * structure for indicating when PDB parsing or seqeunceId location
1914 public boolean addPdbFile(AlignFrame alFrame, String sequenceId,
1915 String pdbEntryString, String pdbFile)
1917 return alFrame.addPdbFile(sequenceId, pdbEntryString, pdbFile);
1920 protected void setAlignPdbStructures(boolean alignPdbStructures)
1922 this.alignPdbStructures = alignPdbStructures;
1925 public boolean isAlignPdbStructures()
1927 return alignPdbStructures;
1936 * bind structures in a viewer to any matching sequences in an alignFrame (use
1937 * sequenceIds to limit scope of search to specific sequences)
1941 * @param sequenceIds
1942 * @return TODO: consider making an exception structure for indicating when
1943 * binding fails public SequenceStructureBinding
1944 * addStructureViewInstance( AlignFrame alFrame, Object viewer, String
1947 * if (sequenceIds != null && sequenceIds.length() > 0) { return
1948 * alFrame.addStructureViewInstance(viewer,
1949 * separatorListToArray(sequenceIds)); } else { return
1950 * alFrame.addStructureViewInstance(viewer, null); } // return null; }