JAL-1563 house keeping/updated API doc for new method added for FTS pagination

[jalview.git] / src / jalview / fts / api / GFTSPanelI.java

diff --git a/src/jalview/fts/api/GFTSPanelI.java b/src/jalview/fts/api/GFTSPanelI.java
index 46121fc..16bf404 100644 (file)
--- a/src/jalview/fts/api/GFTSPanelI.java
+++ b/src/jalview/fts/api/GFTSPanelI.java
@@ -92,4 +92,35 @@ public interface GFTSPanelI
    * @param isSearchInProgress
    */
   public void setSearchInProgress(Boolean isSearchInProgress);
+
+  /**
+   * Action performed when previous page (<<) button is pressed pressed.
+   */
+  public void prevPageAction();
+
+  /**
+   * Action performed when next page (>>) button is pressed pressed.
+   */
+  public void nextPageAction();
+
+  /**
+   * Checks if the current service's search result is paginate-able
+   * 
+   * @return true means the service provides paginated results
+   */
+  public boolean isPaginationEnabled();
+
+  /**
+   * Updates the 'enabled' state for the previous page button
+   * 
+   * @param isEnabled
+   */
+  public void setPrevPageButtonEnabled(boolean isEnabled);
+
+  /**
+   * Updates the 'enabled' state for the next page button
+   * 
+   * @param isEnabled
+   */
+  public void setNextPageButtonEnabled(boolean isEnabled);
 }