View Javadoc

1   /*
2    * $Id: IPagedCapability.java,v 1.2 2007/05/24 12:26:16 oeuillot Exp $
3    */
4   package org.rcfaces.core.component.capability;
5   
6   /**
7    * 
8    * @author Olivier Oeuillot (latest modification by $Author: oeuillot $)
9    * @version $Revision: 1.2 $ $Date: 2007/05/24 12:26:16 $
10   */
11  public interface IPagedCapability {
12  
13      /**
14       * Returns a boolean value specifying wether the results should be displayed
15       * by page (thus letting the user choose what page to display via the
16       * pager). It is ignored if the attribute "rows" is undefined. The default
17       * value is true. If "rows" is defined and "paged"'s value is set to false,
18       * pages are downloaded automatically when the last displayed row is
19       * selected.
20       * 
21       * @return true if display by page
22       */
23      boolean isPaged();
24  
25      /**
26       * Sets a boolean value specifying wether the results should be displayed by
27       * page (thus letting the user choose what page to display via the pager).
28       * It is ignored if the attribute "rows" is undefined. The default value is
29       * true. If "rows" is defined and "paged"'s value is set to false, pages are
30       * downloaded automatically when the last displayed row is selected.
31       * 
32       * @param paged
33       *            true if display by page
34       */
35      void setPaged(boolean paged);
36  
37      /**
38       * 
39       */
40      boolean isPagedSetted();
41  }