src/jalview/bin/JalviewLite.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.bin;
  22
  23 import jalview.api.StructureSelectionManagerProvider;
  24 import jalview.appletgui.AlignFrame;
  25 import jalview.appletgui.AlignViewport;
  26 import jalview.appletgui.EmbmenuFrame;
  27 import jalview.appletgui.FeatureSettings;
  28 import jalview.datamodel.Alignment;
  29 import jalview.datamodel.AlignmentI;
  30 import jalview.datamodel.AlignmentOrder;
  31 import jalview.datamodel.ColumnSelection;
  32 import jalview.datamodel.PDBEntry;
  33 import jalview.datamodel.Sequence;
  34 import jalview.datamodel.SequenceGroup;
  35 import jalview.datamodel.SequenceI;
  36 import jalview.io.AnnotationFile;
  37 import jalview.io.AppletFormatAdapter;
  38 import jalview.io.FileParse;
  39 import jalview.io.IdentifyFile;
  40 import jalview.io.JnetAnnotationMaker;
  41 import jalview.javascript.JSFunctionExec;
  42 import jalview.javascript.JalviewLiteJsApi;
  43 import jalview.javascript.JsCallBack;
  44 import jalview.structure.SelectionListener;
  45 import jalview.structure.StructureSelectionManager;
  46 import jalview.util.MessageManager;
  47
  48 import java.applet.Applet;
  49 import java.awt.Button;
  50 import java.awt.Color;
  51 import java.awt.Component;
  52 import java.awt.EventQueue;
  53 import java.awt.Font;
  54 import java.awt.Frame;
  55 import java.awt.Graphics;
  56 import java.awt.event.ActionEvent;
  57 import java.awt.event.WindowAdapter;
  58 import java.awt.event.WindowEvent;
  59 import java.io.BufferedReader;
  60 import java.io.InputStreamReader;
  61 import java.net.URL;
  62 import java.util.Hashtable;
  63 import java.util.StringTokenizer;
  64 import java.util.Vector;
  65
  66 import netscape.javascript.JSException;
  67 import netscape.javascript.JSObject;
  68
  69 /**
  70  * Jalview Applet. Runs in Java 1.18 runtime
  71  *
  72  * @author $author$
  73  * @version $Revision: 1.92 $
  74  */
  75 public class JalviewLite extends Applet implements
  76         StructureSelectionManagerProvider, JalviewLiteJsApi
  77 {
  78
  79   public StructureSelectionManager getStructureSelectionManager()
  80   {
  81     return StructureSelectionManager.getStructureSelectionManager(this);
  82   }
  83
  84   // /////////////////////////////////////////
  85   // The following public methods maybe called
  86   // externally, eg via javascript in HTML page
  87   /*
  88    * (non-Javadoc)
  89    *
  90    * @see jalview.bin.JalviewLiteJsApi#getSelectedSequences()
  91    */
  92   public String getSelectedSequences()
  93   {
  94     return getSelectedSequencesFrom(getDefaultTargetFrame());
  95   }
  96
  97   /*
  98    * (non-Javadoc)
  99    *
 100    * @see jalview.bin.JalviewLiteJsApi#getSelectedSequences(java.lang.String)
 101    */
 102   public String getSelectedSequences(String sep)
 103   {
 104     return getSelectedSequencesFrom(getDefaultTargetFrame(), sep);
 105   }
 106
 107   /*
 108    * (non-Javadoc)
 109    *
 110    * @see
 111    * jalview.bin.JalviewLiteJsApi#getSelectedSequencesFrom(jalview.appletgui
 112    * .AlignFrame)
 113    */
 114   public String getSelectedSequencesFrom(AlignFrame alf)
 115   {
 116     return getSelectedSequencesFrom(alf, separator); // ""+0x00AC);
 117   }
 118
 119   /*
 120    * (non-Javadoc)
 121    *
 122    * @see
 123    * jalview.bin.JalviewLiteJsApi#getSelectedSequencesFrom(jalview.appletgui
 124    * .AlignFrame, java.lang.String)
 125    */
 126   public String getSelectedSequencesFrom(AlignFrame alf, String sep)
 127   {
 128     StringBuffer result = new StringBuffer("");
 129     if (sep == null || sep.length() == 0)
 130     {
 131       sep = separator; // "+0x00AC;
 132     }
 133     if (alf.viewport.getSelectionGroup() != null)
 134     {
 135       SequenceI[] seqs = alf.viewport.getSelectionGroup()
 136               .getSequencesInOrder(alf.viewport.getAlignment());
 137
 138       for (int i = 0; i < seqs.length; i++)
 139       {
 140         result.append(seqs[i].getName());
 141         result.append(sep);
 142       }
 143     }
 144
 145     return result.toString();
 146   }
 147
 148   /*
 149    * (non-Javadoc)
 150    *
 151    * @see jalview.bin.JalviewLiteJsApi#highlight(java.lang.String,
 152    * java.lang.String, java.lang.String)
 153    */
 154   public void highlight(String sequenceId, String position,
 155           String alignedPosition)
 156   {
 157     highlightIn(getDefaultTargetFrame(), sequenceId, position,
 158             alignedPosition);
 159   }
 160
 161   /*
 162    * (non-Javadoc)
 163    *
 164    * @see jalview.bin.JalviewLiteJsApi#highlightIn(jalview.appletgui.AlignFrame,
 165    * java.lang.String, java.lang.String, java.lang.String)
 166    */
 167   public void highlightIn(final AlignFrame alf, final String sequenceId,
 168           final String position, final String alignedPosition)
 169   {
 170     // TODO: could try to highlight in all alignments if alf==null
 171     jalview.analysis.SequenceIdMatcher matcher = new jalview.analysis.SequenceIdMatcher(
 172             alf.viewport.getAlignment().getSequencesArray());
 173     final SequenceI sq = matcher.findIdMatch(sequenceId);
 174     if (sq != null)
 175     {
 176       int apos = -1;
 177       try
 178       {
 179         apos = new Integer(position).intValue();
 180         apos--;
 181       } catch (NumberFormatException ex)
 182       {
 183         return;
 184       }
 185       final StructureSelectionManagerProvider me = this;
 186       final int pos = apos;
 187       // use vamsas listener to broadcast to all listeners in scope
 188       if (alignedPosition != null
 189               && (alignedPosition.trim().length() == 0 || alignedPosition
 190                       .toLowerCase().indexOf("false") > -1))
 191       {
 192         java.awt.EventQueue.invokeLater(new Runnable()
 193         {
 194           @Override
 195           public void run()
 196           {
 197             StructureSelectionManager.getStructureSelectionManager(me)
 198                     .mouseOverVamsasSequence(sq, sq.findIndex(pos), null);
 199           }
 200         });
 201       }
 202       else
 203       {
 204         java.awt.EventQueue.invokeLater(new Runnable()
 205         {
 206           @Override
 207           public void run()
 208           {
 209             StructureSelectionManager.getStructureSelectionManager(me)
 210                     .mouseOverVamsasSequence(sq, pos, null);
 211           }
 212         });
 213       }
 214     }
 215   }
 216
 217   /*
 218    * (non-Javadoc)
 219    *
 220    * @see jalview.bin.JalviewLiteJsApi#select(java.lang.String,
 221    * java.lang.String)
 222    */
 223   public void select(String sequenceIds, String columns)
 224   {
 225     selectIn(getDefaultTargetFrame(), sequenceIds, columns, separator);
 226   }
 227
 228   /*
 229    * (non-Javadoc)
 230    *
 231    * @see jalview.bin.JalviewLiteJsApi#select(java.lang.String,
 232    * java.lang.String, java.lang.String)
 233    */
 234   public void select(String sequenceIds, String columns, String sep)
 235   {
 236     selectIn(getDefaultTargetFrame(), sequenceIds, columns, sep);
 237   }
 238
 239   /*
 240    * (non-Javadoc)
 241    *
 242    * @see jalview.bin.JalviewLiteJsApi#selectIn(jalview.appletgui.AlignFrame,
 243    * java.lang.String, java.lang.String)
 244    */
 245   public void selectIn(AlignFrame alf, String sequenceIds, String columns)
 246   {
 247     selectIn(alf, sequenceIds, columns, separator);
 248   }
 249
 250   /*
 251    * (non-Javadoc)
 252    *
 253    * @see jalview.bin.JalviewLiteJsApi#selectIn(jalview.appletgui.AlignFrame,
 254    * java.lang.String, java.lang.String, java.lang.String)
 255    */
 256   public void selectIn(final AlignFrame alf, String sequenceIds,
 257           String columns, String sep)
 258   {
 259     if (sep == null || sep.length() == 0)
 260     {
 261       sep = separator;
 262     }
 263     else
 264     {
 265       if (debug)
 266       {
 267         System.err.println("Selecting region using separator string '"
 268                 + separator + "'");
 269       }
 270     }
 271     // deparse fields
 272     String[] ids = separatorListToArray(sequenceIds, sep);
 273     String[] cols = separatorListToArray(columns, sep);
 274     final SequenceGroup sel = new SequenceGroup();
 275     final ColumnSelection csel = new ColumnSelection();
 276     AlignmentI al = alf.viewport.getAlignment();
 277     jalview.analysis.SequenceIdMatcher matcher = new jalview.analysis.SequenceIdMatcher(
 278             alf.viewport.getAlignment().getSequencesArray());
 279     int start = 0, end = al.getWidth(), alw = al.getWidth();
 280     boolean seqsfound = true;
 281     if (ids != null && ids.length > 0)
 282     {
 283       seqsfound = false;
 284       for (int i = 0; i < ids.length; i++)
 285       {
 286         if (ids[i].trim().length() == 0)
 287         {
 288           continue;
 289         }
 290         SequenceI sq = matcher.findIdMatch(ids[i]);
 291         if (sq != null)
 292         {
 293           seqsfound = true;
 294           sel.addSequence(sq, false);
 295         }
 296       }
 297     }
 298     boolean inseqpos = false;
 299     if (cols != null && cols.length > 0)
 300     {
 301       boolean seset = false;
 302       for (int i = 0; i < cols.length; i++)
 303       {
 304         String cl = cols[i].trim();
 305         if (cl.length() == 0)
 306         {
 307           continue;
 308         }
 309         int p;
 310         if ((p = cl.indexOf("-")) > -1)
 311         {
 312           int from = -1, to = -1;
 313           try
 314           {
 315             from = new Integer(cl.substring(0, p)).intValue();
 316             from--;
 317           } catch (NumberFormatException ex)
 318           {
 319             System.err
 320                     .println("ERROR: Couldn't parse first integer in range element column selection string '"
 321                             + cl + "' - format is 'from-to'");
 322             return;
 323           }
 324           try
 325           {
 326             to = new Integer(cl.substring(p + 1)).intValue();
 327             to--;
 328           } catch (NumberFormatException ex)
 329           {
 330             System.err
 331                     .println("ERROR: Couldn't parse second integer in range element column selection string '"
 332                             + cl + "' - format is 'from-to'");
 333             return;
 334           }
 335           if (from >= 0 && to >= 0)
 336           {
 337             // valid range
 338             if (from < to)
 339             {
 340               int t = to;
 341               to = from;
 342               to = t;
 343             }
 344             if (!seset)
 345             {
 346               start = from;
 347               end = to;
 348               seset = true;
 349             }
 350             else
 351             {
 352               // comment to prevent range extension
 353               if (start > from)
 354               {
 355                 start = from;
 356               }
 357               if (end < to)
 358               {
 359                 end = to;
 360               }
 361             }
 362             for (int r = from; r <= to; r++)
 363             {
 364               if (r >= 0 && r < alw)
 365               {
 366                 csel.addElement(r);
 367               }
 368             }
 369             if (debug)
 370             {
 371               System.err.println("Range '" + cl + "' deparsed as [" + from
 372                       + "," + to + "]");
 373             }
 374           }
 375           else
 376           {
 377             System.err.println("ERROR: Invalid Range '" + cl
 378                     + "' deparsed as [" + from + "," + to + "]");
 379           }
 380         }
 381         else
 382         {
 383           int r = -1;
 384           try
 385           {
 386             r = new Integer(cl).intValue();
 387             r--;
 388           } catch (NumberFormatException ex)
 389           {
 390             if (cl.toLowerCase().equals("sequence"))
 391             {
 392               // we are in the dataset sequence's coordinate frame.
 393               inseqpos = true;
 394             }
 395             else
 396             {
 397               System.err
 398                       .println("ERROR: Couldn't parse integer from point selection element of column selection string '"
 399                               + cl + "'");
 400               return;
 401             }
 402           }
 403           if (r >= 0 && r <= alw)
 404           {
 405             if (!seset)
 406             {
 407               start = r;
 408               end = r;
 409               seset = true;
 410             }
 411             else
 412             {
 413               // comment to prevent range extension
 414               if (start > r)
 415               {
 416                 start = r;
 417               }
 418               if (end < r)
 419               {
 420                 end = r;
 421               }
 422             }
 423             csel.addElement(r);
 424             if (debug)
 425             {
 426               System.err.println("Point selection '" + cl
 427                       + "' deparsed as [" + r + "]");
 428             }
 429           }
 430           else
 431           {
 432             System.err.println("ERROR: Invalid Point selection '" + cl
 433                     + "' deparsed as [" + r + "]");
 434           }
 435         }
 436       }
 437     }
 438     if (seqsfound)
 439     {
 440       // we only propagate the selection when it was the null selection, or the
 441       // given sequences were found in the alignment.
 442       if (inseqpos && sel.getSize() > 0)
 443       {
 444         // assume first sequence provides reference frame ?
 445         SequenceI rs = sel.getSequenceAt(0);
 446         start = rs.findIndex(start);
 447         end = rs.findIndex(end);
 448         if (csel != null)
 449         {
 450           Vector cs = csel.getSelected();
 451           csel.clear();
 452           for (int csi = 0, csiS = cs.size(); csi < csiS; csi++)
 453           {
 454             csel.addElement(rs.findIndex(((Integer) cs.elementAt(csi))
 455                     .intValue()));
 456           }
 457         }
 458       }
 459       sel.setStartRes(start);
 460       sel.setEndRes(end);
 461       EventQueue.invokeLater(new Runnable()
 462       {
 463         @Override
 464         public void run()
 465         {
 466           alf.select(sel, csel);
 467         }
 468       });
 469     }
 470   }
 471
 472   /*
 473    * (non-Javadoc)
 474    *
 475    * @see
 476    * jalview.bin.JalviewLiteJsApi#getSelectedSequencesAsAlignment(java.lang.
 477    * String, java.lang.String)
 478    */
 479   public String getSelectedSequencesAsAlignment(String format, String suffix)
 480   {
 481     return getSelectedSequencesAsAlignmentFrom(getDefaultTargetFrame(),
 482             format, suffix);
 483   }
 484
 485   /*
 486    * (non-Javadoc)
 487    *
 488    * @see
 489    * jalview.bin.JalviewLiteJsApi#getSelectedSequencesAsAlignmentFrom(jalview
 490    * .appletgui.AlignFrame, java.lang.String, java.lang.String)
 491    */
 492   public String getSelectedSequencesAsAlignmentFrom(AlignFrame alf,
 493           String format, String suffix)
 494   {
 495     try
 496     {
 497       boolean seqlimits = suffix.equalsIgnoreCase("true");
 498       if (alf.viewport.getSelectionGroup() != null)
 499       {
 500         // JBPNote: getSelectionAsNewSequence behaviour has changed - this
 501         // method now returns a full copy of sequence data
 502         // TODO consider using getSequenceSelection instead here
 503         String reply = new AppletFormatAdapter().formatSequences(format,
 504                 new Alignment(alf.viewport.getSelectionAsNewSequence()),
 505                 seqlimits);
 506         return reply;
 507       }
 508     } catch (Exception ex)
 509     {
 510       ex.printStackTrace();
 511       return "Error retrieving alignment in " + format + " format. ";
 512     }
 513     return "";
 514   }
 515
 516   /*
 517    * (non-Javadoc)
 518    *
 519    * @see jalview.bin.JalviewLiteJsApi#getAlignmentOrder()
 520    */
 521   public String getAlignmentOrder()
 522   {
 523     return getAlignmentOrderFrom(getDefaultTargetFrame());
 524   }
 525
 526   /*
 527    * (non-Javadoc)
 528    *
 529    * @see
 530    * jalview.bin.JalviewLiteJsApi#getAlignmentOrderFrom(jalview.appletgui.AlignFrame
 531    * )
 532    */
 533   public String getAlignmentOrderFrom(AlignFrame alf)
 534   {
 535     return getAlignmentOrderFrom(alf, separator);
 536   }
 537
 538   /*
 539    * (non-Javadoc)
 540    *
 541    * @see
 542    * jalview.bin.JalviewLiteJsApi#getAlignmentOrderFrom(jalview.appletgui.AlignFrame
 543    * , java.lang.String)
 544    */
 545   public String getAlignmentOrderFrom(AlignFrame alf, String sep)
 546   {
 547     AlignmentI alorder = alf.getAlignViewport().getAlignment();
 548     String[] order = new String[alorder.getHeight()];
 549     for (int i = 0; i < order.length; i++)
 550     {
 551       order[i] = alorder.getSequenceAt(i).getName();
 552     }
 553     return arrayToSeparatorList(order);
 554   }
 555
 556   /*
 557    * (non-Javadoc)
 558    *
 559    * @see jalview.bin.JalviewLiteJsApi#orderBy(java.lang.String,
 560    * java.lang.String)
 561    */
 562   public String orderBy(String order, String undoName)
 563   {
 564     return orderBy(order, undoName, separator);
 565   }
 566
 567   /*
 568    * (non-Javadoc)
 569    *
 570    * @see jalview.bin.JalviewLiteJsApi#orderBy(java.lang.String,
 571    * java.lang.String, java.lang.String)
 572    */
 573   public String orderBy(String order, String undoName, String sep)
 574   {
 575     return orderAlignmentBy(getDefaultTargetFrame(), order, undoName, sep);
 576   }
 577
 578   /*
 579    * (non-Javadoc)
 580    *
 581    * @see
 582    * jalview.bin.JalviewLiteJsApi#orderAlignmentBy(jalview.appletgui.AlignFrame,
 583    * java.lang.String, java.lang.String, java.lang.String)
 584    */
 585   public String orderAlignmentBy(AlignFrame alf, String order,
 586           String undoName, String sep)
 587   {
 588     String[] ids = separatorListToArray(order, sep);
 589     SequenceI[] sqs = null;
 590     if (ids != null && ids.length > 0)
 591     {
 592       jalview.analysis.SequenceIdMatcher matcher = new jalview.analysis.SequenceIdMatcher(
 593               alf.viewport.getAlignment().getSequencesArray());
 594       int s = 0;
 595       sqs = new SequenceI[ids.length];
 596       for (int i = 0; i < ids.length; i++)
 597       {
 598         if (ids[i].trim().length() == 0)
 599         {
 600           continue;
 601         }
 602         SequenceI sq = matcher.findIdMatch(ids[i]);
 603         if (sq != null)
 604         {
 605           sqs[s++] = sq;
 606         }
 607       }
 608       if (s > 0)
 609       {
 610         SequenceI[] sqq = new SequenceI[s];
 611         System.arraycopy(sqs, 0, sqq, 0, s);
 612         sqs = sqq;
 613       }
 614       else
 615       {
 616         sqs = null;
 617       }
 618     }
 619     if (sqs == null)
 620     {
 621       return "";
 622     }
 623     ;
 624     final AlignmentOrder aorder = new AlignmentOrder(sqs);
 625
 626     if (undoName != null && undoName.trim().length() == 0)
 627     {
 628       undoName = null;
 629     }
 630     final String _undoName = undoName;
 631     // TODO: deal with synchronization here: cannot raise any events until after
 632     // this has returned.
 633     return alf.sortBy(aorder, _undoName) ? "true" : "";
 634   }
 635
 636   /*
 637    * (non-Javadoc)
 638    *
 639    * @see jalview.bin.JalviewLiteJsApi#getAlignment(java.lang.String)
 640    */
 641   public String getAlignment(String format)
 642   {
 643     return getAlignmentFrom(getDefaultTargetFrame(), format, "true");
 644   }
 645
 646   /*
 647    * (non-Javadoc)
 648    *
 649    * @see
 650    * jalview.bin.JalviewLiteJsApi#getAlignmentFrom(jalview.appletgui.AlignFrame,
 651    * java.lang.String)
 652    */
 653   public String getAlignmentFrom(AlignFrame alf, String format)
 654   {
 655     return getAlignmentFrom(alf, format, "true");
 656   }
 657
 658   /*
 659    * (non-Javadoc)
 660    *
 661    * @see jalview.bin.JalviewLiteJsApi#getAlignment(java.lang.String,
 662    * java.lang.String)
 663    */
 664   public String getAlignment(String format, String suffix)
 665   {
 666     return getAlignmentFrom(getDefaultTargetFrame(), format, suffix);
 667   }
 668
 669   /*
 670    * (non-Javadoc)
 671    *
 672    * @see
 673    * jalview.bin.JalviewLiteJsApi#getAlignmentFrom(jalview.appletgui.AlignFrame,
 674    * java.lang.String, java.lang.String)
 675    */
 676   public String getAlignmentFrom(AlignFrame alf, String format,
 677           String suffix)
 678   {
 679     try
 680     {
 681       boolean seqlimits = suffix.equalsIgnoreCase("true");
 682
 683       String reply = new AppletFormatAdapter().formatSequences(format,
 684               alf.viewport.getAlignment(), seqlimits);
 685       return reply;
 686     } catch (Exception ex)
 687     {
 688       ex.printStackTrace();
 689       return "Error retrieving alignment in " + format + " format. ";
 690     }
 691   }
 692
 693   /*
 694    * (non-Javadoc)
 695    *
 696    * @see jalview.bin.JalviewLiteJsApi#loadAnnotation(java.lang.String)
 697    */
 698   public void loadAnnotation(String annotation)
 699   {
 700     loadAnnotationFrom(getDefaultTargetFrame(), annotation);
 701   }
 702
 703   /*
 704    * (non-Javadoc)
 705    *
 706    * @see
 707    * jalview.bin.JalviewLiteJsApi#loadAnnotationFrom(jalview.appletgui.AlignFrame
 708    * , java.lang.String)
 709    */
 710   public void loadAnnotationFrom(AlignFrame alf, String annotation)
 711   {
 712     if (new AnnotationFile().readAnnotationFile(alf.getAlignViewport()
 713             .getAlignment(), annotation, AppletFormatAdapter.PASTE))
 714     {
 715       alf.alignPanel.fontChanged();
 716       alf.alignPanel.setScrollValues(0, 0);
 717     }
 718     else
 719     {
 720       alf.parseFeaturesFile(annotation, AppletFormatAdapter.PASTE);
 721     }
 722   }
 723
 724   /*
 725    * (non-Javadoc)
 726    *
 727    * @see jalview.bin.JalviewLiteJsApi#loadAnnotation(java.lang.String)
 728    */
 729   public void loadFeatures(String features, boolean autoenabledisplay)
 730   {
 731     loadFeaturesFrom(getDefaultTargetFrame(), features, autoenabledisplay);
 732   }
 733
 734   /*
 735    * (non-Javadoc)
 736    *
 737    * @see
 738    * jalview.bin.JalviewLiteJsApi#loadAnnotationFrom(jalview.appletgui.AlignFrame
 739    * , java.lang.String)
 740    */
 741   public boolean loadFeaturesFrom(AlignFrame alf, String features,
 742           boolean autoenabledisplay)
 743   {
 744     return alf.parseFeaturesFile(features, AppletFormatAdapter.PASTE,
 745             autoenabledisplay);
 746   }
 747
 748   /*
 749    * (non-Javadoc)
 750    *
 751    * @see jalview.bin.JalviewLiteJsApi#getFeatures(java.lang.String)
 752    */
 753   public String getFeatures(String format)
 754   {
 755     return getFeaturesFrom(getDefaultTargetFrame(), format);
 756   }
 757
 758   /*
 759    * (non-Javadoc)
 760    *
 761    * @see
 762    * jalview.bin.JalviewLiteJsApi#getFeaturesFrom(jalview.appletgui.AlignFrame,
 763    * java.lang.String)
 764    */
 765   public String getFeaturesFrom(AlignFrame alf, String format)
 766   {
 767     return alf.outputFeatures(false, format);
 768   }
 769
 770   /*
 771    * (non-Javadoc)
 772    *
 773    * @see jalview.bin.JalviewLiteJsApi#getAnnotation()
 774    */
 775   public String getAnnotation()
 776   {
 777     return getAnnotationFrom(getDefaultTargetFrame());
 778   }
 779
 780   /*
 781    * (non-Javadoc)
 782    *
 783    * @see
 784    * jalview.bin.JalviewLiteJsApi#getAnnotationFrom(jalview.appletgui.AlignFrame
 785    * )
 786    */
 787   public String getAnnotationFrom(AlignFrame alf)
 788   {
 789     return alf.outputAnnotations(false);
 790   }
 791
 792   /*
 793    * (non-Javadoc)
 794    *
 795    * @see jalview.bin.JalviewLiteJsApi#newView()
 796    */
 797   public AlignFrame newView()
 798   {
 799     return newViewFrom(getDefaultTargetFrame());
 800   }
 801
 802   /*
 803    * (non-Javadoc)
 804    *
 805    * @see jalview.bin.JalviewLiteJsApi#newView(java.lang.String)
 806    */
 807   public AlignFrame newView(String name)
 808   {
 809     return newViewFrom(getDefaultTargetFrame(), name);
 810   }
 811
 812   /*
 813    * (non-Javadoc)
 814    *
 815    * @see jalview.bin.JalviewLiteJsApi#newViewFrom(jalview.appletgui.AlignFrame)
 816    */
 817   public AlignFrame newViewFrom(AlignFrame alf)
 818   {
 819     return alf.newView(null);
 820   }
 821
 822   /*
 823    * (non-Javadoc)
 824    *
 825    * @see jalview.bin.JalviewLiteJsApi#newViewFrom(jalview.appletgui.AlignFrame,
 826    * java.lang.String)
 827    */
 828   public AlignFrame newViewFrom(AlignFrame alf, String name)
 829   {
 830     return alf.newView(name);
 831   }
 832
 833   /*
 834    * (non-Javadoc)
 835    *
 836    * @see jalview.bin.JalviewLiteJsApi#loadAlignment(java.lang.String,
 837    * java.lang.String)
 838    */
 839   public AlignFrame loadAlignment(String text, String title)
 840   {
 841     Alignment al = null;
 842
 843     String format = new IdentifyFile().Identify(text,
 844             AppletFormatAdapter.PASTE);
 845     try
 846     {
 847       al = new AppletFormatAdapter().readFile(text,
 848               AppletFormatAdapter.PASTE, format);
 849       if (al.getHeight() > 0)
 850       {
 851         return new AlignFrame(al, this, title, false);
 852       }
 853     } catch (java.io.IOException ex)
 854     {
 855       ex.printStackTrace();
 856     }
 857     return null;
 858   }
 859
 860   /*
 861    * (non-Javadoc)
 862    *
 863    * @see jalview.bin.JalviewLiteJsApi#setMouseoverListener(java.lang.String)
 864    */
 865   public void setMouseoverListener(String listener)
 866   {
 867     setMouseoverListener(currentAlignFrame, listener);
 868   }
 869
 870   private Vector<jalview.javascript.JSFunctionExec> javascriptListeners = new Vector<jalview.javascript.JSFunctionExec>();
 871
 872   /*
 873    * (non-Javadoc)
 874    *
 875    * @see
 876    * jalview.bin.JalviewLiteJsApi#setMouseoverListener(jalview.appletgui.AlignFrame
 877    * , java.lang.String)
 878    */
 879   public void setMouseoverListener(AlignFrame af, String listener)
 880   {
 881     if (listener != null)
 882     {
 883       listener = listener.trim();
 884       if (listener.length() == 0)
 885       {
 886         System.err
 887                 .println("jalview Javascript error: Ignoring empty function for mouseover listener.");
 888         return;
 889       }
 890     }
 891     jalview.javascript.MouseOverListener mol = new jalview.javascript.MouseOverListener(
 892             this, af, listener);
 893     javascriptListeners.addElement(mol);
 894     StructureSelectionManager.getStructureSelectionManager(this)
 895             .addStructureViewerListener(mol);
 896     if (debug)
 897     {
 898       System.err.println("Added a mouseover listener for "
 899               + ((af == null) ? "All frames" : "Just views for "
 900                       + af.getAlignViewport().getSequenceSetId()));
 901       System.err.println("There are now " + javascriptListeners.size()
 902               + " listeners in total.");
 903     }
 904   }
 905
 906   /*
 907    * (non-Javadoc)
 908    *
 909    * @see jalview.bin.JalviewLiteJsApi#setSelectionListener(java.lang.String)
 910    */
 911   public void setSelectionListener(String listener)
 912   {
 913     setSelectionListener(null, listener);
 914   }
 915
 916   /*
 917    * (non-Javadoc)
 918    *
 919    * @see
 920    * jalview.bin.JalviewLiteJsApi#setSelectionListener(jalview.appletgui.AlignFrame
 921    * , java.lang.String)
 922    */
 923   public void setSelectionListener(AlignFrame af, String listener)
 924   {
 925     if (listener != null)
 926     {
 927       listener = listener.trim();
 928       if (listener.length() == 0)
 929       {
 930         System.err
 931                 .println("jalview Javascript error: Ignoring empty function for selection listener.");
 932         return;
 933       }
 934     }
 935     jalview.javascript.JsSelectionSender mol = new jalview.javascript.JsSelectionSender(
 936             this, af, listener);
 937     javascriptListeners.addElement(mol);
 938     StructureSelectionManager.getStructureSelectionManager(this)
 939             .addSelectionListener(mol);
 940     if (debug)
 941     {
 942       System.err.println("Added a selection listener for "
 943               + ((af == null) ? "All frames" : "Just views for "
 944                       + af.getAlignViewport().getSequenceSetId()));
 945       System.err.println("There are now " + javascriptListeners.size()
 946               + " listeners in total.");
 947     }
 948   }
 949
 950   /*
 951    * (non-Javadoc)
 952    *
 953    * @see jalview.bin.JalviewLiteJsApi#setStructureListener(java.lang.String,
 954    * java.lang.String)
 955    */
 956   public void setStructureListener(String listener, String modelSet)
 957   {
 958     if (listener != null)
 959     {
 960       listener = listener.trim();
 961       if (listener.length() == 0)
 962       {
 963         System.err
 964                 .println("jalview Javascript error: Ignoring empty function for selection listener.");
 965         return;
 966       }
 967     }
 968     jalview.javascript.MouseOverStructureListener mol = new jalview.javascript.MouseOverStructureListener(
 969             this, listener, separatorListToArray(modelSet));
 970     javascriptListeners.addElement(mol);
 971     StructureSelectionManager.getStructureSelectionManager(this)
 972             .addStructureViewerListener(mol);
 973     if (debug)
 974     {
 975       System.err.println("Added a javascript structure viewer listener '"
 976               + listener + "'");
 977       System.err.println("There are now " + javascriptListeners.size()
 978               + " listeners in total.");
 979     }
 980   }
 981
 982   /*
 983    * (non-Javadoc)
 984    *
 985    * @see
 986    * jalview.bin.JalviewLiteJsApi#removeJavascriptListener(jalview.appletgui
 987    * .AlignFrame, java.lang.String)
 988    */
 989   public void removeJavascriptListener(AlignFrame af, String listener)
 990   {
 991     if (listener != null)
 992     {
 993       listener = listener.trim();
 994       if (listener.length() == 0)
 995       {
 996         listener = null;
 997       }
 998     }
 999     boolean rprt = false;
1000     for (int ms = 0, msSize = javascriptListeners.size(); ms < msSize;)
1001     {
1002       Object lstn = javascriptListeners.elementAt(ms);
1003       JsCallBack lstner = (JsCallBack) lstn;
1004       if ((af == null || lstner.getAlignFrame() == af)
1005               && (listener == null || lstner.getListenerFunction().equals(
1006                       listener)))
1007       {
1008         javascriptListeners.removeElement(lstner);
1009         msSize--;
1010         if (lstner instanceof SelectionListener)
1011         {
1012           StructureSelectionManager.getStructureSelectionManager(this)
1013                   .removeSelectionListener((SelectionListener) lstner);
1014         }
1015         else
1016         {
1017           StructureSelectionManager.getStructureSelectionManager(this)
1018                   .removeStructureViewerListener(lstner, null);
1019         }
1020         rprt = debug;
1021         if (debug)
1022         {
1023           System.err.println("Removed listener '" + listener + "'");
1024         }
1025       }
1026       else
1027       {
1028         ms++;
1029       }
1030     }
1031     if (rprt)
1032     {
1033       System.err.println("There are now " + javascriptListeners.size()
1034               + " listeners in total.");
1035     }
1036   }
1037
1038   public void stop()
1039   {
1040     System.err.println("Applet " + getName() + " stop().");
1041     tidyUp();
1042   }
1043
1044   public void destroy()
1045   {
1046     System.err.println("Applet " + getName() + " destroy().");
1047     tidyUp();
1048   }
1049
1050   private void tidyUp()
1051   {
1052     removeAll();
1053     if (currentAlignFrame != null && currentAlignFrame.viewport != null
1054             && currentAlignFrame.viewport.applet != null)
1055     {
1056       AlignViewport av = currentAlignFrame.viewport;
1057       currentAlignFrame.closeMenuItem_actionPerformed();
1058       av.applet = null;
1059       currentAlignFrame = null;
1060     }
1061     if (javascriptListeners != null)
1062     {
1063       while (javascriptListeners.size() > 0)
1064       {
1065         jalview.javascript.JSFunctionExec mol = javascriptListeners
1066                 .elementAt(0);
1067         javascriptListeners.removeElement(mol);
1068         if (mol instanceof SelectionListener)
1069         {
1070           StructureSelectionManager.getStructureSelectionManager(this)
1071                   .removeSelectionListener((SelectionListener) mol);
1072         }
1073         else
1074         {
1075           StructureSelectionManager.getStructureSelectionManager(this)
1076                   .removeStructureViewerListener(mol, null);
1077         }
1078         mol.jvlite = null;
1079       }
1080     }
1081     if (jsFunctionExec != null)
1082     {
1083       jsFunctionExec.stopQueue();
1084       jsFunctionExec.jvlite = null;
1085     }
1086     initialAlignFrame = null;
1087     jsFunctionExec = null;
1088     javascriptListeners = null;
1089     StructureSelectionManager.release(this);
1090   }
1091
1092   private jalview.javascript.JSFunctionExec jsFunctionExec;
1093
1094   /*
1095    * (non-Javadoc)
1096    *
1097    * @see jalview.bin.JalviewLiteJsApi#mouseOverStructure(java.lang.String,
1098    * java.lang.String, java.lang.String)
1099    */
1100   public void mouseOverStructure(final String pdbResNum,
1101           final String chain, final String pdbfile)
1102   {
1103     final StructureSelectionManagerProvider me = this;
1104     java.awt.EventQueue.invokeLater(new Runnable()
1105     {
1106       @Override
1107       public void run()
1108       {
1109         try
1110         {
1111           StructureSelectionManager.getStructureSelectionManager(me)
1112                   .mouseOverStructure(new Integer(pdbResNum).intValue(),
1113                           chain, pdbfile);
1114           if (debug)
1115           {
1116             System.err.println("mouseOver for '" + pdbResNum
1117                     + "' in chain '" + chain + "' in structure '" + pdbfile
1118                     + "'");
1119           }
1120         } catch (NumberFormatException e)
1121         {
1122           System.err.println("Ignoring invalid residue number string '"
1123                   + pdbResNum + "'");
1124         }
1125
1126       }
1127     });
1128   }
1129
1130   /*
1131    * (non-Javadoc)
1132    *
1133    * @see
1134    * jalview.bin.JalviewLiteJsApi#scrollViewToIn(jalview.appletgui.AlignFrame,
1135    * java.lang.String, java.lang.String)
1136    */
1137   public void scrollViewToIn(final AlignFrame alf, final String topRow,
1138           final String leftHandColumn)
1139   {
1140     java.awt.EventQueue.invokeLater(new Runnable()
1141     {
1142       @Override
1143       public void run()
1144       {
1145         try
1146         {
1147           alf.scrollTo(new Integer(topRow).intValue(), new Integer(
1148                   leftHandColumn).intValue());
1149
1150         } catch (Exception ex)
1151         {
1152           System.err.println("Couldn't parse integer arguments (topRow='"
1153                   + topRow + "' and leftHandColumn='" + leftHandColumn
1154                   + "')");
1155           ex.printStackTrace();
1156         }
1157       }
1158     });
1159   }
1160
1161   /*
1162    * (non-Javadoc)
1163    *
1164    * @see
1165    * jalview.javascript.JalviewLiteJsApi#scrollViewToRowIn(jalview.appletgui
1166    * .AlignFrame, java.lang.String)
1167    */
1168   @Override
1169   public void scrollViewToRowIn(final AlignFrame alf, final String topRow)
1170   {
1171
1172     java.awt.EventQueue.invokeLater(new Runnable()
1173     {
1174       @Override
1175       public void run()
1176       {
1177         try
1178         {
1179           alf.scrollToRow(new Integer(topRow).intValue());
1180
1181         } catch (Exception ex)
1182         {
1183           System.err.println("Couldn't parse integer arguments (topRow='"
1184                   + topRow + "')");
1185           ex.printStackTrace();
1186         }
1187
1188       }
1189     });
1190   }
1191
1192   /*
1193    * (non-Javadoc)
1194    *
1195    * @see
1196    * jalview.javascript.JalviewLiteJsApi#scrollViewToColumnIn(jalview.appletgui
1197    * .AlignFrame, java.lang.String)
1198    */
1199   @Override
1200   public void scrollViewToColumnIn(final AlignFrame alf,
1201           final String leftHandColumn)
1202   {
1203     java.awt.EventQueue.invokeLater(new Runnable()
1204     {
1205
1206       @Override
1207       public void run()
1208       {
1209         try
1210         {
1211           alf.scrollToColumn(new Integer(leftHandColumn).intValue());
1212
1213         } catch (Exception ex)
1214         {
1215           System.err
1216                   .println("Couldn't parse integer arguments (leftHandColumn='"
1217                           + leftHandColumn + "')");
1218           ex.printStackTrace();
1219         }
1220       }
1221     });
1222
1223   }
1224
1225   // //////////////////////////////////////////////
1226   // //////////////////////////////////////////////
1227
1228   public static int lastFrameX = 200;
1229
1230   public static int lastFrameY = 200;
1231
1232   boolean fileFound = true;
1233
1234   String file = "No file";
1235
1236   Button launcher = new Button("Start Jalview");
1237
1238   /**
1239    * The currentAlignFrame is static, it will change if and when the user
1240    * selects a new window. Note that it will *never* point back to the embedded
1241    * AlignFrame if the applet is started as embedded on the page and then
1242    * afterwards a new view is created.
1243    */
1244   public AlignFrame currentAlignFrame = null;
1245
1246   /**
1247    * This is the first frame to be displayed, and does not change. API calls
1248    * will default to this instance if currentAlignFrame is null.
1249    */
1250   AlignFrame initialAlignFrame = null;
1251
1252   boolean embedded = false;
1253
1254   private boolean checkForJmol = true;
1255
1256   private boolean checkedForJmol = false; // ensure we don't check for jmol
1257
1258   // every time the app is re-inited
1259
1260   public boolean jmolAvailable = false;
1261
1262   private boolean alignPdbStructures = false;
1263
1264   /**
1265    * use an external structure viewer exclusively (no jmols or MCViews will be
1266    * opened by JalviewLite itself)
1267    */
1268   public boolean useXtrnalSviewer = false;
1269
1270   public static boolean debug = false;
1271
1272   static String builddate = null, version = null;
1273
1274   private static void initBuildDetails()
1275   {
1276     if (builddate == null)
1277     {
1278       builddate = "unknown";
1279       version = "test";
1280       java.net.URL url = JalviewLite.class
1281               .getResource("/.build_properties");
1282       if (url != null)
1283       {
1284         try
1285         {
1286           BufferedReader reader = new BufferedReader(new InputStreamReader(
1287                   url.openStream()));
1288           String line;
1289           while ((line = reader.readLine()) != null)
1290           {
1291             if (line.indexOf("VERSION") > -1)
1292             {
1293               version = line.substring(line.indexOf("=") + 1);
1294             }
1295             if (line.indexOf("BUILD_DATE") > -1)
1296             {
1297               builddate = line.substring(line.indexOf("=") + 1);
1298             }
1299           }
1300         } catch (Exception ex)
1301         {
1302           ex.printStackTrace();
1303         }
1304       }
1305     }
1306   }
1307
1308   public static String getBuildDate()
1309   {
1310     initBuildDetails();
1311     return builddate;
1312   }
1313
1314   public static String getVersion()
1315   {
1316     initBuildDetails();
1317     return version;
1318   }
1319
1320   // public JSObject scriptObject = null;
1321
1322   /**
1323    * init method for Jalview Applet
1324    */
1325   public void init()
1326   {
1327     // remove any handlers that might be hanging around from an earlier instance
1328     try
1329     {
1330       if (debug)
1331       {
1332         System.err.println("Applet context is '"
1333                 + getAppletContext().getClass().toString() + "'");
1334       }
1335       JSObject scriptObject = JSObject.getWindow(this);
1336       if (debug && scriptObject != null)
1337       {
1338         System.err.println("Applet has Javascript callback support.");
1339       }
1340
1341     } catch (Exception ex)
1342     {
1343       System.err
1344               .println("Warning: No JalviewLite javascript callbacks available.");
1345       if (debug)
1346       {
1347         ex.printStackTrace();
1348       }
1349     }
1350     /**
1351      * turn on extra applet debugging
1352      */
1353     String dbg = getParameter("debug");
1354     if (dbg != null)
1355     {
1356       debug = dbg.toLowerCase().equals("true");
1357     }
1358     if (debug)
1359     {
1360
1361       System.err.println("JalviewLite Version " + getVersion());
1362       System.err.println("Build Date : " + getBuildDate());
1363
1364     }
1365     String externalsviewer = getParameter("externalstructureviewer");
1366     if (externalsviewer != null)
1367     {
1368       useXtrnalSviewer = externalsviewer.trim().toLowerCase()
1369               .equals("true");
1370     }
1371     /**
1372      * if true disable the check for jmol
1373      */
1374     String chkforJmol = getParameter("nojmol");
1375     if (chkforJmol != null)
1376     {
1377       checkForJmol = !chkforJmol.equals("true");
1378     }
1379     /**
1380      * get the separator parameter if present
1381      */
1382     String sep = getParameter("separator");
1383     if (sep != null)
1384     {
1385       if (sep.length() > 0)
1386       {
1387         separator = sep;
1388         if (debug)
1389         {
1390           System.err.println("Separator set to '" + separator + "'");
1391         }
1392       }
1393       else
1394       {
1395         throw new Error(
1396                 "Invalid separator parameter - must be non-zero length");
1397       }
1398     }
1399     int r = 255;
1400     int g = 255;
1401     int b = 255;
1402     String param = getParameter("RGB");
1403
1404     if (param != null)
1405     {
1406       try
1407       {
1408         r = Integer.parseInt(param.substring(0, 2), 16);
1409         g = Integer.parseInt(param.substring(2, 4), 16);
1410         b = Integer.parseInt(param.substring(4, 6), 16);
1411       } catch (Exception ex)
1412       {
1413         r = 255;
1414         g = 255;
1415         b = 255;
1416       }
1417     }
1418     param = getParameter("label");
1419     if (param != null)
1420     {
1421       launcher.setLabel(param);
1422     }
1423
1424     setBackground(new Color(r, g, b));
1425
1426     file = getParameter("file");
1427
1428     if (file == null)
1429     {
1430       // Maybe the sequences are added as parameters
1431       StringBuffer data = new StringBuffer("PASTE");
1432       int i = 1;
1433       while ((file = getParameter("sequence" + i)) != null)
1434       {
1435         data.append(file.toString() + "\n");
1436         i++;
1437       }
1438       if (data.length() > 5)
1439       {
1440         file = data.toString();
1441       }
1442     }
1443
1444     final JalviewLite jvapplet = this;
1445     if (getParameter("embedded") != null
1446             && getParameter("embedded").equalsIgnoreCase("true"))
1447     {
1448       // Launch as embedded applet in page
1449       embedded = true;
1450       LoadingThread loader = new LoadingThread(file, jvapplet);
1451       loader.start();
1452     }
1453     else if (file != null)
1454     {
1455       if (getParameter("showbutton") == null
1456               || !getParameter("showbutton").equalsIgnoreCase("false"))
1457       {
1458         // Add the JalviewLite 'Button' to the page
1459         add(launcher);
1460         launcher.addActionListener(new java.awt.event.ActionListener()
1461         {
1462           public void actionPerformed(ActionEvent e)
1463           {
1464             LoadingThread loader = new LoadingThread(file, jvapplet);
1465             loader.start();
1466           }
1467         });
1468       }
1469       else
1470       {
1471         // Open jalviewLite immediately.
1472         LoadingThread loader = new LoadingThread(file, jvapplet);
1473         loader.start();
1474       }
1475     }
1476     else
1477     {
1478       // jalview initialisation with no alignment. loadAlignment() method can
1479       // still be called to open new alignments.
1480       file = "NO FILE";
1481       fileFound = false;
1482       callInitCallback();
1483     }
1484   }
1485   private void initLiveConnect()
1486   {
1487     // try really hard to get the liveConnect thing working
1488     boolean notFailed=false;
1489     int tries=0;
1490     while (!notFailed && tries<10) {
1491       if (tries>0)
1492       {
1493         System.err.println("LiveConnect request thread going to sleep.");
1494       }
1495       try {
1496         Thread.sleep(700*(1+tries));
1497       }
1498       catch (InterruptedException q) {};
1499       if (tries++>0)
1500       {
1501         System.err.println("LiveConnect request thread woken up.");
1502       }
1503       try {
1504         JSObject scriptObject = JSObject.getWindow(this);
1505         if (scriptObject.eval("navigator")!=null)
1506         {
1507           notFailed=true;
1508         }
1509       } catch (JSException jsex)
1510       {
1511         System.err.println("Attempt "+tries+" to access LiveConnect javascript failed.");
1512       }
1513     }
1514   }
1515   private void callInitCallback()
1516   {
1517     String initjscallback = getParameter("oninit");
1518     if (initjscallback == null)
1519     {
1520       return;
1521     }
1522     initjscallback = initjscallback.trim();
1523     if (initjscallback.length() > 0)
1524     {
1525       JSObject scriptObject = null;
1526       try
1527       {
1528         scriptObject = JSObject.getWindow(this);
1529       } catch (Exception ex)
1530       {
1531       }
1532       ;
1533       // try really hard to let the browser plugin know we want liveconnect
1534       initLiveConnect();
1535
1536       if (scriptObject != null)
1537       {
1538         try
1539         {
1540           // do onInit with the JS executor thread
1541           new JSFunctionExec(this).executeJavascriptFunction(true,
1542                   initjscallback, null, "Calling oninit callback '"
1543                           + initjscallback + "'.");
1544         } catch (Exception e)
1545         {
1546           System.err.println("Exception when executing _oninit callback '"
1547                   + initjscallback + "'.");
1548           e.printStackTrace();
1549         }
1550       }
1551       else
1552       {
1553         System.err.println("Not executing _oninit callback '"
1554                 + initjscallback + "' - no scripting allowed.");
1555       }
1556     }
1557   }
1558
1559   /**
1560    * Initialises and displays a new java.awt.Frame
1561    *
1562    * @param frame
1563    *          java.awt.Frame to be displayed
1564    * @param title
1565    *          title of new frame
1566    * @param width
1567    *          width if new frame
1568    * @param height
1569    *          height of new frame
1570    */
1571   public static void addFrame(final Frame frame, String title, int width,
1572           int height)
1573   {
1574     frame.setLocation(lastFrameX, lastFrameY);
1575     lastFrameX += 40;
1576     lastFrameY += 40;
1577     frame.setSize(width, height);
1578     frame.setTitle(title);
1579     frame.addWindowListener(new WindowAdapter()
1580     {
1581       public void windowClosing(WindowEvent e)
1582       {
1583         if (frame instanceof AlignFrame)
1584         {
1585           AlignViewport vp = ((AlignFrame) frame).viewport;
1586           ((AlignFrame) frame).closeMenuItem_actionPerformed();
1587           if (vp.applet.currentAlignFrame == frame)
1588           {
1589             vp.applet.currentAlignFrame = null;
1590           }
1591           vp.applet = null;
1592           vp = null;
1593
1594         }
1595         lastFrameX -= 40;
1596         lastFrameY -= 40;
1597         if (frame instanceof EmbmenuFrame)
1598         {
1599           ((EmbmenuFrame) frame).destroyMenus();
1600         }
1601         frame.setMenuBar(null);
1602         frame.dispose();
1603       }
1604
1605       public void windowActivated(WindowEvent e)
1606       {
1607         if (frame instanceof AlignFrame)
1608         {
1609           ((AlignFrame) frame).viewport.applet.currentAlignFrame = (AlignFrame) frame;
1610           if (debug)
1611           {
1612             System.err.println("Activated window " + frame);
1613           }
1614         }
1615         // be good.
1616         super.windowActivated(e);
1617       }
1618       /*
1619        * Probably not necessary to do this - see TODO above. (non-Javadoc)
1620        *
1621        * @see
1622        * java.awt.event.WindowAdapter#windowDeactivated(java.awt.event.WindowEvent
1623        * )
1624        *
1625        * public void windowDeactivated(WindowEvent e) { if (currentAlignFrame ==
1626        * frame) { currentAlignFrame = null; if (debug) {
1627        * System.err.println("Deactivated window "+frame); } }
1628        * super.windowDeactivated(e); }
1629        */
1630     });
1631     frame.setVisible(true);
1632   }
1633
1634   /**
1635    * This paints the background surrounding the "Launch Jalview button" <br>
1636    * <br>
1637    * If file given in parameter not found, displays error message
1638    *
1639    * @param g
1640    *          graphics context
1641    */
1642   public void paint(Graphics g)
1643   {
1644     if (!fileFound)
1645     {
1646       g.setColor(new Color(200, 200, 200));
1647       g.setColor(Color.cyan);
1648       g.fillRect(0, 0, getSize().width, getSize().height);
1649       g.setColor(Color.red);
1650       g.drawString(MessageManager.getString("label.jalview_cannot_open_file"), 5, 15);
1651       g.drawString("\"" + file + "\"", 5, 30);
1652     }
1653     else if (embedded)
1654     {
1655       g.setColor(Color.black);
1656       g.setFont(new Font("Arial", Font.BOLD, 24));
1657       g.drawString(MessageManager.getString("label.jalview_applet"), 50, getSize().height / 2 - 30);
1658       g.drawString(MessageManager.getString("label.loading_data") + "...", 50, getSize().height / 2);
1659     }
1660   }
1661
1662   /**
1663    * get all components associated with the applet of the given type
1664    *
1665    * @param class1
1666    * @return
1667    */
1668   public Vector getAppletWindow(Class class1)
1669   {
1670     Vector wnds = new Vector();
1671     Component[] cmp = getComponents();
1672     if (cmp != null)
1673     {
1674       for (int i = 0; i < cmp.length; i++)
1675       {
1676         if (class1.isAssignableFrom(cmp[i].getClass()))
1677         {
1678           wnds.addElement(cmp);
1679         }
1680       }
1681     }
1682     return wnds;
1683   }
1684
1685   class LoadJmolThread extends Thread
1686   {
1687     private boolean running = false;
1688
1689     public void run()
1690     {
1691       if (running || checkedForJmol)
1692       {
1693         return;
1694       }
1695       running = true;
1696       if (checkForJmol)
1697       {
1698         try
1699         {
1700           if (!System.getProperty("java.version").startsWith("1.1"))
1701           {
1702             Class.forName("org.jmol.adapter.smarter.SmarterJmolAdapter");
1703             jmolAvailable = true;
1704           }
1705           if (!jmolAvailable)
1706           {
1707             System.out
1708                     .println("Jmol not available - Using MCview for structures");
1709           }
1710         } catch (java.lang.ClassNotFoundException ex)
1711         {
1712         }
1713       }
1714       else
1715       {
1716         jmolAvailable = false;
1717         if (debug)
1718         {
1719           System.err
1720                   .println("Skipping Jmol check. Will use MCView (probably)");
1721         }
1722       }
1723       checkedForJmol = true;
1724       running = false;
1725     }
1726
1727     public boolean notFinished()
1728     {
1729       return running || !checkedForJmol;
1730     }
1731   }
1732
1733   class LoadingThread extends Thread
1734   {
1735     /**
1736      * State variable: File source
1737      */
1738     String file;
1739
1740     /**
1741      * State variable: protocol for access to file source
1742      */
1743     String protocol;
1744
1745     /**
1746      * State variable: format of file source
1747      */
1748     String format;
1749
1750     String _file;
1751
1752     JalviewLite applet;
1753
1754     private void dbgMsg(String msg)
1755     {
1756       if (applet.debug)
1757       {
1758         System.err.println(msg);
1759       }
1760     }
1761
1762     /**
1763      * update the protocol state variable for accessing the datasource located
1764      * by file.
1765      *
1766      * @param file
1767      * @return possibly updated datasource string
1768      */
1769     public String setProtocolState(String file)
1770     {
1771       if (file.startsWith("PASTE"))
1772       {
1773         file = file.substring(5);
1774         protocol = AppletFormatAdapter.PASTE;
1775       }
1776       else if (inArchive(file))
1777       {
1778         protocol = AppletFormatAdapter.CLASSLOADER;
1779       }
1780       else
1781       {
1782         file = addProtocol(file);
1783         protocol = AppletFormatAdapter.URL;
1784       }
1785       dbgMsg("Protocol identified as '" + protocol + "'");
1786       return file;
1787     }
1788
1789     public LoadingThread(String _file, JalviewLite _applet)
1790     {
1791       this._file = _file;
1792       applet = _applet;
1793     }
1794
1795     public void run()
1796     {
1797       LoadJmolThread jmolchecker = new LoadJmolThread();
1798       jmolchecker.start();
1799       while (jmolchecker.notFinished())
1800       {
1801         // wait around until the Jmol check is complete.
1802         try
1803         {
1804           Thread.sleep(2);
1805         } catch (Exception e)
1806         {
1807         }
1808         ;
1809       }
1810       startLoading();
1811       // applet.callInitCallback();
1812     }
1813
1814     private void startLoading()
1815     {
1816       AlignFrame newAlignFrame;
1817       dbgMsg("Loading thread started with:\n>>file\n" + _file + ">>endfile");
1818       file = setProtocolState(_file);
1819
1820       format = new jalview.io.IdentifyFile().Identify(file, protocol);
1821       dbgMsg("File identified as '" + format + "'");
1822       dbgMsg("Loading started.");
1823       Alignment al = null;
1824       try
1825       {
1826         al = new AppletFormatAdapter().readFile(file, protocol, format);
1827       } catch (java.io.IOException ex)
1828       {
1829         dbgMsg("File load exception.");
1830         ex.printStackTrace();
1831         if (debug)
1832         {
1833           try
1834           {
1835             FileParse fp = new FileParse(file, protocol);
1836             String ln = null;
1837             dbgMsg(">>>Dumping contents of '" + file + "' " + "("
1838                     + protocol + ")");
1839             while ((ln = fp.nextLine()) != null)
1840             {
1841               dbgMsg(ln);
1842             }
1843             dbgMsg(">>>Dump finished.");
1844           } catch (Exception e)
1845           {
1846             System.err
1847                     .println("Exception when trying to dump the content of the file parameter.");
1848             e.printStackTrace();
1849           }
1850         }
1851       }
1852       if ((al != null) && (al.getHeight() > 0))
1853       {
1854         dbgMsg("Successfully loaded file.");
1855         newAlignFrame = new AlignFrame(al, applet, file, embedded);
1856         if (initialAlignFrame == null)
1857         {
1858           initialAlignFrame = newAlignFrame;
1859         }
1860         // update the focus.
1861         currentAlignFrame = newAlignFrame;
1862
1863         if (protocol == jalview.io.AppletFormatAdapter.PASTE)
1864         {
1865           newAlignFrame.setTitle(MessageManager.formatMessage("label.sequences_from", new String[]{applet.getDocumentBase().toString()}));
1866         }
1867
1868         newAlignFrame.statusBar.setText(MessageManager.formatMessage("label.successfully_loaded_file", new String []{file}));
1869
1870         String treeFile = applet.getParameter("tree");
1871         if (treeFile == null)
1872         {
1873           treeFile = applet.getParameter("treeFile");
1874         }
1875
1876         if (treeFile != null)
1877         {
1878           try
1879           {
1880             treeFile = setProtocolState(treeFile);
1881             /*
1882              * if (inArchive(treeFile)) { protocol =
1883              * AppletFormatAdapter.CLASSLOADER; } else { protocol =
1884              * AppletFormatAdapter.URL; treeFile = addProtocol(treeFile); }
1885              */
1886             jalview.io.NewickFile fin = new jalview.io.NewickFile(treeFile,
1887                     protocol);
1888
1889             fin.parse();
1890
1891             if (fin.getTree() != null)
1892             {
1893               newAlignFrame.loadTree(fin, treeFile);
1894               dbgMsg("Successfuly imported tree.");
1895             }
1896             else
1897             {
1898               dbgMsg("Tree parameter did not resolve to a valid tree.");
1899             }
1900           } catch (Exception ex)
1901           {
1902             ex.printStackTrace();
1903           }
1904         }
1905
1906         /*
1907          * Try to load T-Coffee score file
1908          */
1909         String sScoreFile = applet.getParameter("scoreFile");
1910         if (sScoreFile != null && !"".equals(sScoreFile))
1911         {
1912           try
1913           {
1914             if (debug)
1915             {
1916               System.err
1917                       .println("Attempting to load T-COFFEE score file from the scoreFile parameter");
1918             }
1919             if (!newAlignFrame.loadScoreFile(sScoreFile))
1920             {
1921               System.err
1922                       .println("Failed to parse T-COFFEE parameter as a valid score file ('"
1923                               + sScoreFile + "')");
1924             }
1925           } catch (Exception e)
1926           {
1927             System.err.printf("Cannot read score file: '%s'. Cause: %s \n",
1928                     sScoreFile, e.getMessage());
1929           }
1930         }
1931
1932         // ///////////////////////////
1933         // modify display of features
1934         // we do this before any features have been loaded, ensuring any hidden
1935         // groups are hidden when features first displayed
1936         //
1937         // hide specific groups
1938         //
1939         String param = applet.getParameter("hidefeaturegroups");
1940         if (param != null)
1941         {
1942           newAlignFrame.setFeatureGroupState(separatorListToArray(param),
1943                   false);
1944           // applet.setFeatureGroupStateOn(newAlignFrame, param, false);
1945         }
1946         // show specific groups
1947         param = applet.getParameter("showfeaturegroups");
1948         if (param != null)
1949         {
1950           newAlignFrame.setFeatureGroupState(separatorListToArray(param),
1951                   true);
1952           // applet.setFeatureGroupStateOn(newAlignFrame, param, true);
1953         }
1954         // and now load features
1955         param = applet.getParameter("features");
1956         if (param != null)
1957         {
1958           param = setProtocolState(param);
1959
1960           newAlignFrame.parseFeaturesFile(param, protocol);
1961         }
1962
1963         param = applet.getParameter("showFeatureSettings");
1964         if (param != null && param.equalsIgnoreCase("true"))
1965         {
1966           newAlignFrame.viewport.showSequenceFeatures(true);
1967           new FeatureSettings(newAlignFrame.alignPanel);
1968         }
1969
1970         param = applet.getParameter("annotations");
1971         if (param != null)
1972         {
1973           param = setProtocolState(param);
1974
1975           if (new AnnotationFile().readAnnotationFile(
1976                   newAlignFrame.viewport.getAlignment(), param, protocol))
1977           {
1978             newAlignFrame.alignPanel.fontChanged();
1979             newAlignFrame.alignPanel.setScrollValues(0, 0);
1980           }
1981           else
1982           {
1983             System.err
1984                     .println("Annotations were not added from annotation file '"
1985                             + param + "'");
1986           }
1987
1988         }
1989
1990         param = applet.getParameter("jnetfile");
1991         if (param != null)
1992         {
1993           try
1994           {
1995             param = setProtocolState(param);
1996             jalview.io.JPredFile predictions = new jalview.io.JPredFile(
1997                     param, protocol);
1998             JnetAnnotationMaker.add_annotation(predictions,
1999                     newAlignFrame.viewport.getAlignment(), 0, false); // false==do
2000             // not
2001             // add
2002             // sequence
2003             // profile
2004             // from
2005             // concise
2006             // output
2007             newAlignFrame.alignPanel.fontChanged();
2008             newAlignFrame.alignPanel.setScrollValues(0, 0);
2009           } catch (Exception ex)
2010           {
2011             ex.printStackTrace();
2012           }
2013         }
2014         /*
2015          * <param name="alignpdbfiles" value="false/true"/> Undocumented for 2.6
2016          * - related to JAL-434
2017          */
2018         applet.setAlignPdbStructures(getDefaultParameter("alignpdbfiles",
2019                 false));
2020         /*
2021          * <param name="PDBfile" value="1gaq.txt PDB|1GAQ|1GAQ|A PDB|1GAQ|1GAQ|B
2022          * PDB|1GAQ|1GAQ|C">
2023          *
2024          * <param name="PDBfile2" value="1gaq.txt A=SEQA B=SEQB C=SEQB">
2025          *
2026          * <param name="PDBfile3" value="1q0o Q45135_9MICO">
2027          */
2028
2029         int pdbFileCount = 0;
2030         // Accumulate pdbs here if they are heading for the same view (if
2031         // alignPdbStructures is true)
2032         Vector pdbs = new Vector();
2033         // create a lazy matcher if we're asked to
2034         jalview.analysis.SequenceIdMatcher matcher = (applet
2035                 .getDefaultParameter("relaxedidmatch", false)) ? new jalview.analysis.SequenceIdMatcher(
2036                 newAlignFrame.getAlignViewport().getAlignment()
2037                         .getSequencesArray()) : null;
2038
2039         do
2040         {
2041           if (pdbFileCount > 0)
2042           {
2043             param = applet.getParameter("PDBFILE" + pdbFileCount);
2044           }
2045           else
2046           {
2047             param = applet.getParameter("PDBFILE");
2048           }
2049
2050           if (param != null)
2051           {
2052             PDBEntry pdb = new PDBEntry();
2053
2054             String seqstring;
2055             SequenceI[] seqs = null;
2056             String[] chains = null;
2057
2058             StringTokenizer st = new StringTokenizer(param, " ");
2059
2060             if (st.countTokens() < 2)
2061             {
2062               String sequence = applet.getParameter("PDBSEQ");
2063               if (sequence != null)
2064                 seqs = new SequenceI[]
2065                 { matcher == null ? (Sequence) newAlignFrame
2066                         .getAlignViewport().getAlignment()
2067                         .findName(sequence) : matcher.findIdMatch(sequence) };
2068
2069             }
2070             else
2071             {
2072               param = st.nextToken();
2073               Vector tmp = new Vector();
2074               Vector tmp2 = new Vector();
2075
2076               while (st.hasMoreTokens())
2077               {
2078                 seqstring = st.nextToken();
2079                 StringTokenizer st2 = new StringTokenizer(seqstring, "=");
2080                 if (st2.countTokens() > 1)
2081                 {
2082                   // This is the chain
2083                   tmp2.addElement(st2.nextToken());
2084                   seqstring = st2.nextToken();
2085                 }
2086                 tmp.addElement(matcher == null ? (Sequence) newAlignFrame
2087                         .getAlignViewport().getAlignment()
2088                         .findName(seqstring) : matcher
2089                         .findIdMatch(seqstring));
2090               }
2091
2092               seqs = new SequenceI[tmp.size()];
2093               tmp.copyInto(seqs);
2094               if (tmp2.size() == tmp.size())
2095               {
2096                 chains = new String[tmp2.size()];
2097                 tmp2.copyInto(chains);
2098               }
2099             }
2100             param = setProtocolState(param);
2101
2102             if (// !jmolAvailable
2103             // &&
2104             protocol == AppletFormatAdapter.CLASSLOADER
2105                     && !useXtrnalSviewer)
2106             {
2107               // Re: JAL-357 : the bug isn't a problem if we are using an
2108               // external viewer!
2109               // TODO: verify this Re:
2110               // https://mantis.lifesci.dundee.ac.uk/view.php?id=36605
2111               // This exception preserves the current behaviour where, even if
2112               // the local pdb file was identified in the class loader
2113               protocol = AppletFormatAdapter.URL; // this is probably NOT
2114               // CORRECT!
2115               param = addProtocol(param); //
2116             }
2117
2118             pdb.setFile(param);
2119
2120             if (seqs != null)
2121             {
2122               for (int i = 0; i < seqs.length; i++)
2123               {
2124                 if (seqs[i] != null)
2125                 {
2126                   ((Sequence) seqs[i]).addPDBId(pdb);
2127                 }
2128                 else
2129                 {
2130                   if (JalviewLite.debug)
2131                   {
2132                     // this may not really be a problem but we give a warning
2133                     // anyway
2134                     System.err
2135                             .println("Warning: Possible input parsing error: Null sequence for attachment of PDB (sequence "
2136                                     + i + ")");
2137                   }
2138                 }
2139               }
2140
2141               if (!alignPdbStructures)
2142               {
2143                 newAlignFrame.newStructureView(applet, pdb, seqs, chains,
2144                         protocol);
2145               }
2146               else
2147               {
2148                 pdbs.addElement(new Object[]
2149                 { pdb, seqs, chains, new String(protocol) });
2150               }
2151             }
2152           }
2153
2154           pdbFileCount++;
2155         } while (param != null || pdbFileCount < 10);
2156         if (pdbs.size() > 0)
2157         {
2158           SequenceI[][] seqs = new SequenceI[pdbs.size()][];
2159           PDBEntry[] pdb = new PDBEntry[pdbs.size()];
2160           String[][] chains = new String[pdbs.size()][];
2161           String[] protocols = new String[pdbs.size()];
2162           for (int pdbsi = 0, pdbsiSize = pdbs.size(); pdbsi < pdbsiSize; pdbsi++)
2163           {
2164             Object[] o = (Object[]) pdbs.elementAt(pdbsi);
2165             pdb[pdbsi] = (PDBEntry) o[0];
2166             seqs[pdbsi] = (SequenceI[]) o[1];
2167             chains[pdbsi] = (String[]) o[2];
2168             protocols[pdbsi] = (String) o[3];
2169           }
2170           newAlignFrame.alignedStructureView(applet, pdb, seqs, chains,
2171                   protocols);
2172
2173         }
2174       }
2175       else
2176       {
2177         fileFound = false;
2178         applet.remove(launcher);
2179         applet.repaint();
2180       }
2181       callInitCallback();
2182     }
2183
2184     /**
2185      * Discovers whether the given file is in the Applet Archive
2186      *
2187      * @param file
2188      *          String
2189      * @return boolean
2190      */
2191     boolean inArchive(String file)
2192     {
2193       // This might throw a security exception in certain browsers
2194       // Netscape Communicator for instance.
2195       try
2196       {
2197         boolean rtn = (getClass().getResourceAsStream("/" + file) != null);
2198         if (debug)
2199         {
2200           System.err.println("Resource '" + file + "' was "
2201                   + (rtn ? "" : "not") + " located by classloader.");
2202         }
2203         return rtn;
2204       } catch (Exception ex)
2205       {
2206         System.out.println("Exception checking resources: " + file + " "
2207                 + ex);
2208         return false;
2209       }
2210     }
2211
2212     String addProtocol(String file)
2213     {
2214       if (file.indexOf("://") == -1)
2215       {
2216         String fl = applet.resolveUrlForLocalOrAbsolute(file,
2217                 getDocumentBase());
2218         try
2219         {
2220           if (new java.net.URL(fl).openStream() != null)
2221           {
2222             if (debug)
2223             {
2224               System.err.println("Prepended document base for resource: '"
2225                       + file + "'");
2226             }
2227             return fl;
2228           }
2229         } catch (Exception x)
2230         {
2231         }
2232         ;
2233         fl = applet.resolveUrlForLocalOrAbsolute(file, getCodeBase());
2234         try
2235         {
2236           if (new java.net.URL(fl).openStream() != null)
2237           {
2238             if (debug)
2239             {
2240               System.err.println("Prepended codebase for resource: '"
2241                       + file + "'");
2242             }
2243             return fl;
2244           }
2245         } catch (Exception x)
2246         {
2247         }
2248         ;
2249
2250       }
2251
2252       return file;
2253     }
2254   }
2255
2256   /**
2257    * @return the default alignFrame acted on by the public applet methods. May
2258    *         return null with an error message on System.err indicating the
2259    *         fact.
2260    */
2261   public AlignFrame getDefaultTargetFrame()
2262   {
2263     if (currentAlignFrame != null)
2264     {
2265       return currentAlignFrame;
2266     }
2267     if (initialAlignFrame != null)
2268     {
2269       return initialAlignFrame;
2270     }
2271     System.err
2272             .println("Implementation error: Jalview Applet API cannot work out which AlignFrame to use.");
2273     return null;
2274   }
2275
2276   /**
2277    * separator used for separatorList
2278    */
2279   protected String separator = "" + ((char) 0x00AC); // the default used to be
2280                                                      // '|' but many sequence
2281                                                      // IDS include pipes.
2282
2283   /**
2284    * set to enable the URL based javascript execution mechanism
2285    */
2286   public boolean jsfallbackEnabled = false;
2287
2288   /**
2289    * parse the string into a list
2290    *
2291    * @param list
2292    * @return elements separated by separator
2293    */
2294   public String[] separatorListToArray(String list)
2295   {
2296     return separatorListToArray(list, separator);
2297   }
2298
2299   /**
2300    * parse the string into a list
2301    *
2302    * @param list
2303    * @param separator
2304    * @return elements separated by separator
2305    */
2306   public String[] separatorListToArray(String list, String separator)
2307   {
2308     // note separator local variable intentionally masks object field
2309     int seplen = separator.length();
2310     if (list == null || list.equals("") || list.equals(separator))
2311       return null;
2312     java.util.Vector jv = new Vector();
2313     int cp = 0, pos;
2314     while ((pos = list.indexOf(separator, cp)) > cp)
2315     {
2316       jv.addElement(list.substring(cp, pos));
2317       cp = pos + seplen;
2318     }
2319     if (cp < list.length())
2320     {
2321       String c = list.substring(cp);
2322       if (!c.equals(separator))
2323       {
2324         jv.addElement(c);
2325       }
2326     }
2327     if (jv.size() > 0)
2328     {
2329       String[] v = new String[jv.size()];
2330       for (int i = 0; i < v.length; i++)
2331       {
2332         v[i] = (String) jv.elementAt(i);
2333       }
2334       jv.removeAllElements();
2335       if (debug)
2336       {
2337         System.err.println("Array from '" + separator
2338                 + "' separated List:\n" + v.length);
2339         for (int i = 0; i < v.length; i++)
2340         {
2341           System.err.println("item " + i + " '" + v[i] + "'");
2342         }
2343       }
2344       return v;
2345     }
2346     if (debug)
2347     {
2348       System.err.println("Empty Array from '" + separator
2349               + "' separated List");
2350     }
2351     return null;
2352   }
2353
2354   /**
2355    * concatenate the list with separator
2356    *
2357    * @param list
2358    * @return concatenated string
2359    */
2360   public String arrayToSeparatorList(String[] list)
2361   {
2362     return arrayToSeparatorList(list, separator);
2363   }
2364
2365   /**
2366    * concatenate the list with separator
2367    *
2368    * @param list
2369    * @param separator
2370    * @return concatenated string
2371    */
2372   public String arrayToSeparatorList(String[] list, String separator)
2373   {
2374     StringBuffer v = new StringBuffer();
2375     if (list != null && list.length > 0)
2376     {
2377       for (int i = 0, iSize = list.length; i < iSize; i++)
2378       {
2379         if (list[i] != null)
2380         {
2381           if (i > 0)
2382           {
2383             v.append(separator);
2384           }
2385           v.append(list[i]);
2386         }
2387       }
2388       if (debug)
2389       {
2390         System.err.println("Returning '" + separator
2391                 + "' separated List:\n");
2392         System.err.println(v);
2393       }
2394       return v.toString();
2395     }
2396     if (debug)
2397     {
2398       System.err.println("Returning empty '" + separator
2399               + "' separated List\n");
2400     }
2401     return "" + separator;
2402   }
2403
2404   /*
2405    * (non-Javadoc)
2406    *
2407    * @see jalview.bin.JalviewLiteJsApi#getFeatureGroups()
2408    */
2409   public String getFeatureGroups()
2410   {
2411     String lst = arrayToSeparatorList(getDefaultTargetFrame()
2412             .getFeatureGroups());
2413     return lst;
2414   }
2415
2416   /*
2417    * (non-Javadoc)
2418    *
2419    * @see
2420    * jalview.bin.JalviewLiteJsApi#getFeatureGroupsOn(jalview.appletgui.AlignFrame
2421    * )
2422    */
2423   public String getFeatureGroupsOn(AlignFrame alf)
2424   {
2425     String lst = arrayToSeparatorList(alf.getFeatureGroups());
2426     return lst;
2427   }
2428
2429   /*
2430    * (non-Javadoc)
2431    *
2432    * @see jalview.bin.JalviewLiteJsApi#getFeatureGroupsOfState(boolean)
2433    */
2434   public String getFeatureGroupsOfState(boolean visible)
2435   {
2436     return arrayToSeparatorList(getDefaultTargetFrame()
2437             .getFeatureGroupsOfState(visible));
2438   }
2439
2440   /*
2441    * (non-Javadoc)
2442    *
2443    * @see
2444    * jalview.bin.JalviewLiteJsApi#getFeatureGroupsOfStateOn(jalview.appletgui
2445    * .AlignFrame, boolean)
2446    */
2447   public String getFeatureGroupsOfStateOn(AlignFrame alf, boolean visible)
2448   {
2449     return arrayToSeparatorList(alf.getFeatureGroupsOfState(visible));
2450   }
2451
2452   /*
2453    * (non-Javadoc)
2454    *
2455    * @see jalview.bin.JalviewLiteJsApi#setFeatureGroupStateOn(jalview.appletgui.
2456    * AlignFrame, java.lang.String, boolean)
2457    */
2458   public void setFeatureGroupStateOn(final AlignFrame alf,
2459           final String groups, boolean state)
2460   {
2461     final boolean st = state;// !(state==null || state.equals("") ||
2462     // state.toLowerCase().equals("false"));
2463     java.awt.EventQueue.invokeLater(new Runnable()
2464     {
2465       @Override
2466       public void run()
2467       {
2468         alf.setFeatureGroupState(separatorListToArray(groups), st);
2469       }
2470     });
2471   }
2472
2473   /*
2474    * (non-Javadoc)
2475    *
2476    * @see jalview.bin.JalviewLiteJsApi#setFeatureGroupState(java.lang.String,
2477    * boolean)
2478    */
2479   public void setFeatureGroupState(String groups, boolean state)
2480   {
2481     setFeatureGroupStateOn(getDefaultTargetFrame(), groups, state);
2482   }
2483
2484   /*
2485    * (non-Javadoc)
2486    *
2487    * @see jalview.bin.JalviewLiteJsApi#getSeparator()
2488    */
2489   public String getSeparator()
2490   {
2491     return separator;
2492   }
2493
2494   /*
2495    * (non-Javadoc)
2496    *
2497    * @see jalview.bin.JalviewLiteJsApi#setSeparator(java.lang.String)
2498    */
2499   public void setSeparator(String separator)
2500   {
2501     if (separator == null || separator.length() < 1)
2502     {
2503       // reset to default
2504       separator = "" + ((char) 0x00AC);
2505     }
2506     this.separator = separator;
2507     if (debug)
2508     {
2509       System.err.println("Default Separator now: '" + separator + "'");
2510     }
2511   }
2512
2513   /**
2514    * get boolean value of applet parameter 'name' and return default if
2515    * parameter is not set
2516    *
2517    * @param name
2518    *          name of paremeter
2519    * @param def
2520    *          the value to return otherwise
2521    * @return true or false
2522    */
2523   public boolean getDefaultParameter(String name, boolean def)
2524   {
2525     String stn;
2526     if ((stn = getParameter(name)) == null)
2527     {
2528       return def;
2529     }
2530     if (stn.toLowerCase().equals("true"))
2531     {
2532       return true;
2533     }
2534     return false;
2535   }
2536
2537   /*
2538    * (non-Javadoc)
2539    *
2540    * @see jalview.bin.JalviewLiteJsApi#addPdbFile(jalview.appletgui.AlignFrame,
2541    * java.lang.String, java.lang.String, java.lang.String)
2542    */
2543   public boolean addPdbFile(AlignFrame alFrame, String sequenceId,
2544           String pdbEntryString, String pdbFile)
2545   {
2546     return alFrame.addPdbFile(sequenceId, pdbEntryString, pdbFile);
2547   }
2548
2549   protected void setAlignPdbStructures(boolean alignPdbStructures)
2550   {
2551     this.alignPdbStructures = alignPdbStructures;
2552   }
2553
2554   public boolean isAlignPdbStructures()
2555   {
2556     return alignPdbStructures;
2557   }
2558
2559   public void start()
2560   {
2561     // callInitCallback();
2562   }
2563
2564   private Hashtable<String, long[]> jshashes = new Hashtable<String, long[]>();
2565
2566   private Hashtable<String, Hashtable<String, String[]>> jsmessages = new Hashtable<String, Hashtable<String, String[]>>();
2567
2568   public void setJsMessageSet(String messageclass, String viewId,
2569           String[] colcommands)
2570   {
2571     Hashtable<String, String[]> msgset = jsmessages.get(messageclass);
2572     if (msgset == null)
2573     {
2574       msgset = new Hashtable<String, String[]>();
2575       jsmessages.put(messageclass, msgset);
2576     }
2577     msgset.put(viewId, colcommands);
2578     long[] l = new long[colcommands.length];
2579     for (int i = 0; i < colcommands.length; i++)
2580     {
2581       l[i] = colcommands[i].hashCode();
2582     }
2583     jshashes.put(messageclass + "|" + viewId, l);
2584   }
2585
2586   /*
2587    * (non-Javadoc)
2588    *
2589    * @see jalview.bin.JalviewLiteJsApi#getJsMessage(java.lang.String,
2590    * java.lang.String)
2591    */
2592   public String getJsMessage(String messageclass, String viewId)
2593   {
2594     Hashtable<String, String[]> msgset = jsmessages.get(messageclass);
2595     if (msgset != null)
2596     {
2597       String[] msgs = msgset.get(viewId);
2598       if (msgs != null)
2599       {
2600         for (int i = 0; i < msgs.length; i++)
2601         {
2602           if (msgs[i] != null)
2603           {
2604             String m = msgs[i];
2605             msgs[i] = null;
2606             return m;
2607           }
2608         }
2609       }
2610     }
2611     return "";
2612   }
2613
2614   public boolean isJsMessageSetChanged(String string, String string2,
2615           String[] colcommands)
2616   {
2617     long[] l = jshashes.get(string + "|" + string2);
2618     if (l == null && colcommands != null)
2619     {
2620       return true;
2621     }
2622     for (int i = 0; i < colcommands.length; i++)
2623     {
2624       if (l[i] != colcommands[i].hashCode())
2625       {
2626         return true;
2627       }
2628     }
2629     return false;
2630   }
2631
2632   private Vector jsExecQueue = new Vector();
2633
2634   public Vector getJsExecQueue()
2635   {
2636     return jsExecQueue;
2637   }
2638
2639   public void setExecutor(JSFunctionExec jsFunctionExec2)
2640   {
2641     jsFunctionExec = jsFunctionExec2;
2642   }
2643
2644   /**
2645    * return the given colour value parameter or the given default if parameter
2646    * not given
2647    *
2648    * @param colparam
2649    * @param defcolour
2650    * @return
2651    */
2652   public Color getDefaultColourParameter(String colparam, Color defcolour)
2653   {
2654     String colprop = getParameter(colparam);
2655     if (colprop == null || colprop.trim().length() == 0)
2656     {
2657       return defcolour;
2658     }
2659     Color col = jalview.schemes.ColourSchemeProperty
2660             .getAWTColorFromName(colprop);
2661     if (col == null)
2662     {
2663       try
2664       {
2665         col = new jalview.schemes.UserColourScheme(colprop).findColour('A');
2666       } catch (Exception ex)
2667       {
2668         System.err.println("Couldn't parse '" + colprop
2669                 + "' as a colour for " + colparam);
2670         col = null;
2671       }
2672     }
2673     return (col == null) ? defcolour : col;
2674
2675   }
2676
2677   public void openJalviewHelpUrl()
2678   {
2679     String helpUrl = getParameter("jalviewhelpurl");
2680     if (helpUrl == null || helpUrl.trim().length() < 5)
2681     {
2682       helpUrl = "http://www.jalview.org/help.html";
2683     }
2684     showURL(helpUrl, "HELP");
2685   }
2686
2687   /**
2688    * form a complete URL given a path to a resource and a reference location on
2689    * the same server
2690    *
2691    * @param url
2692    *          - an absolute path on the same server as localref or a document
2693    *          located relative to localref
2694    * @param localref
2695    *          - a URL on the same server as url
2696    * @return a complete URL for the resource located by url
2697    */
2698   private String resolveUrlForLocalOrAbsolute(String url, URL localref)
2699   {
2700     String codebase = localref.toString();
2701     if (url.indexOf("/") == 0)
2702     {
2703       url = codebase.substring(0, codebase.length()
2704               - localref.getFile().length())
2705               + url;
2706     }
2707     else
2708     {
2709       url = localref + url;
2710     }
2711     return url;
2712   }
2713
2714   /**
2715    * open a URL in the browser - resolving it according to relative refs and
2716    * coping with javascript: protocol if necessary.
2717    *
2718    * @param url
2719    * @param target
2720    */
2721   public void showURL(String url, String target)
2722   {
2723     try
2724     {
2725       if (url.indexOf(":") == -1)
2726       {
2727         // TODO: verify (Bas Vroling bug) prepend codebase or server URL to
2728         // form valid URL
2729         // Should really use docbase, not codebase.
2730         URL prepend;
2731         url = resolveUrlForLocalOrAbsolute(
2732                 url,
2733                 prepend = getDefaultParameter("resolvetocodebase", false) ? getDocumentBase()
2734                         : getCodeBase());
2735         if (debug)
2736         {
2737           System.err
2738                   .println("Show url (prepended "
2739                           + prepend
2740                           + " - toggle resolvetocodebase if code/docbase resolution is wrong): "
2741                           + url);
2742         }
2743       }
2744       else
2745       {
2746         if (debug)
2747         {
2748           System.err.println("Show url: " + url);
2749         }
2750       }
2751       if (url.indexOf("javascript:") == 0)
2752       {
2753         // no target for the javascript context
2754         getAppletContext().showDocument(new java.net.URL(url));
2755       }
2756       else
2757       {
2758         getAppletContext().showDocument(new java.net.URL(url), target);
2759       }
2760     } catch (Exception ex)
2761     {
2762       ex.printStackTrace();
2763     }
2764   }
2765
2766   /**
2767    * bind structures in a viewer to any matching sequences in an alignFrame (use
2768    * sequenceIds to limit scope of search to specific sequences)
2769    *
2770    * @param alFrame
2771    * @param viewer
2772    * @param sequenceIds
2773    * @return TODO: consider making an exception structure for indicating when
2774    *         binding fails public SequenceStructureBinding
2775    *         addStructureViewInstance( AlignFrame alFrame, Object viewer, String
2776    *         sequenceIds) {
2777    *
2778    *         if (sequenceIds != null && sequenceIds.length() > 0) { return
2779    *         alFrame.addStructureViewInstance(viewer,
2780    *         separatorListToArray(sequenceIds)); } else { return
2781    *         alFrame.addStructureViewInstance(viewer, null); } // return null; }
2782    */
2783 }