JAL-3369 JAL-3253-applet adds JS app.showOverview()

[jalview.git] / src / jalview / bin / JalviewJSApi.java

diff --git a/src/jalview/bin/JalviewJSApi.java b/src/jalview/bin/JalviewJSApi.java
index 61850a4..b1fed25 100644 (file)
--- a/src/jalview/bin/JalviewJSApi.java
+++ b/src/jalview/bin/JalviewJSApi.java
@@ -12,13 +12,23 @@ import jalview.javascript.JalviewLiteJsApi;
 public interface JalviewJSApi extends JalviewLiteJsApi
 {
 
+  void showOverview();
+
+  /**
+   * process commandline arguments after the JavaScript application has started
+   * 
+   * @param args
+   * @return
+   */
   Object parseArguments(String[] args);
 
+
   /**
    * Open a new Tree panel on the desktop statically. Params are standard (not
    * set by Groovy). No dialog is opened.
    * 
    * @param af
+   *          may be null
    * @param treeType
    * @param modelName
    * @return null, or the string "label.you_need_at_least_n_sequences" if number
@@ -32,6 +42,7 @@ public interface JalviewJSApi extends JalviewLiteJsApi
    * necessarily using a dialog.
    * 
    * @param af
+   *          may be null
    * @param modelName
    * @return the PCAPanel, or the string "label.you_need_at_least_n_sequences"
    *         if number of sequences selected is inappropriate