Module org.apache.wicket.core
Package org.apache.wicket.markup.html.navigation.paging

Interface IPageable

All Superinterfaces:
IClusterable, Serializable
All Known Subinterfaces:
IPageableItems
All Known Implementing Classes:
AbstractDataGridView, AbstractPageableView, AjaxFallbackDefaultDataTable, DataGridView, DataTable, DataView, DataViewBase, DefaultDataTable, GridView, PageableListView
public interface IPageable extends IClusterable
Components that implement this interface will be pageable, they should return the pagecount so that an object/component knows how many pages it can use for the setCurrentPage method. The PageableListView is one example that is Pageable. But also a Form could be pageable so that you can scroll to sets of records that you display in that form with any navigator you want.
Author:
jcompagner

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getCurrentPage()
     
    long
    getPageCount()
    Gets the total number of pages this pageable object has.
    void
    setCurrentPage(long page)
    Sets the a page that should be rendered (page number is zero-based)

  • Method Details

    • getCurrentPage

      long getCurrentPage()
      Returns:
      The current page that is or will be rendered (page number is zero-based)

    • setCurrentPage

      void setCurrentPage(long page)
      Sets the a page that should be rendered (page number is zero-based)
      Parameters:
      page - The page that should be rendered.

    • getPageCount

      long getPageCount()
      Gets the total number of pages this pageable object has.
      Returns:
      The total number of pages this pageable object has