src/jalview/bin/JalviewLite.java

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