Interface Pager
-
public interface Pager
This class is responsible for providing pagination support for search results. This class does all of the logic required to provide any information HTL templates may need to display the pagination interface element.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getCurrentPage()
Get the current page.boolean
getMorePagesAfter()
Whether there are additional pages in pagination set than are displayable currently at the end of the page list.boolean
getMorePagesBefore()
Whether there are additional pages in pagination set than are displayable currently at the start of the page list.Map<String,String>
getNextPageParameters()
Get the mext page parameters for supporting linking to the mext page.List<PagerPage>
getPages()
Get all pagination parameters available for the current result set.Map<String,String>
getPreviousPageParameters()
Get the previous page parameters for supporting linking to the previous page.int
getTotalPages()
Get the total number of pages.
-
-
-
Method Detail
-
getPages
@Nonnull List<PagerPage> getPages()
Get all pagination parameters available for the current result set.- Returns:
- the pagination parameters
-
getPreviousPageParameters
@Nonnull Map<String,String> getPreviousPageParameters()
Get the previous page parameters for supporting linking to the previous page.- Returns:
- the previous page parameters
-
getNextPageParameters
@Nonnull Map<String,String> getNextPageParameters()
Get the mext page parameters for supporting linking to the mext page.- Returns:
- the mext page parameters
-
getCurrentPage
int getCurrentPage()
Get the current page.- Returns:
- the current page
-
getTotalPages
int getTotalPages()
Get the total number of pages.- Returns:
- the total number of pages
-
getMorePagesBefore
boolean getMorePagesBefore()
Whether there are additional pages in pagination set than are displayable currently at the start of the page list.- Returns:
- true if more pages before current starting page
-
getMorePagesAfter
boolean getMorePagesAfter()
Whether there are additional pages in pagination set than are displayable currently at the end of the page list.- Returns:
- true if more pages after current end page
-
-