update author list in license for (JAL-826)
[jalview.git] / src / jalview / javascript / JalviewLiteJsApi.java
index 02da9d4..1231d18 100644 (file)
@@ -1,3 +1,20 @@
+/*******************************************************************************
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ *******************************************************************************/
 package jalview.javascript;
 
 import jalview.appletgui.AlignFrame;
@@ -352,7 +369,7 @@ public interface JalviewLiteJsApi
   /**
    * register a javascript function to handle events normally routed to a Jmol structure viewer.
    * @param listener - javascript function (arguments are variable, see jalview.javascript.MouseOverStructureListener for full details)
-   * @param modelSet - separator separated list of PDB file URIs that this viewer is handling. 
+   * @param modelSet - separator separated list of PDB file URIs that this viewer is handling. These files must be in the same order they appear in Jmol (e.g. first one is frame 1, second is frame 2, etc). 
      @see jalview.javascript.MouseOverStructureListener 
    */
   public abstract void setStructureListener(String listener, String modelSet);
@@ -400,7 +417,7 @@ public interface JalviewLiteJsApi
           String pdbEntryString, String pdbFile);
 
   /**
-   * adjust horizontal/vertical scroll to the make the given location the top left hand corner for given current view
+   * adjust horizontal/vertical scroll to make the given location the top left hand corner for the given view
    * 
    * @param alf
    * @param topRow
@@ -408,6 +425,20 @@ public interface JalviewLiteJsApi
    */
   public abstract void scrollViewToIn(AlignFrame alf, String topRow,
           String leftHandColumn);
+  /**
+   * adjust vertical scroll to make the given row the top one for given view
+   * 
+   * @param alf
+   * @param topRow
+   */
+  public abstract void scrollViewToRowIn(AlignFrame alf, String topRow);
+  /**
+   * adjust horizontal scroll to make the given column the left one in the given view
+   * 
+   * @param alf
+   * @param leftHandColumn
+   */
+  public abstract void scrollViewToColumnIn(AlignFrame alf, String leftHandColumn);
 
   /**
    *