src/jalview/bin/JalviewJSApi.java

   1 package jalview.bin;
   2
   3 import jalview.gui.AlignFrame;
   4 import jalview.javascript.JalviewLiteJsApi;
   5
   6 /**
   7  * JAL-3369 JalviewJS API BH 2019.07.17
   8  *
   9  * @author hansonr
  10  *
  11  */
  12 public interface JalviewJSApi extends JalviewLiteJsApi
  13 {
  14
  15   void showOverview();
  16
  17   /**
  18    * process commandline arguments after the JavaScript application has started
  19    *
  20    * @param args
  21    * @return
  22    */
  23   Object parseArguments(String[] args);
  24
  25
  26   /**
  27    * Open a new Tree panel on the desktop statically. Params are standard (not
  28    * set by Groovy). No dialog is opened.
  29    *
  30    * @param af
  31    *          may be null
  32    * @param treeType
  33    * @param modelName
  34    * @return null, or the string "label.you_need_at_least_n_sequences" if number
  35    *         of sequences selected is inappropriate
  36    */
  37   public Object openTreePanel(AlignFrame af, String treeType,
  38           String modelName);
  39
  40   /**
  41    * public static method for JalviewJS API to open a PCAPanel without
  42    * necessarily using a dialog.
  43    *
  44    * @param af
  45    *          may be null
  46    * @param modelName
  47    * @return the PCAPanel, or the string "label.you_need_at_least_n_sequences"
  48    *         if number of sequences selected is inappropriate
  49    */
  50   public Object openPcaPanel(AlignFrame af, String modelName);
  51
  52 }