fr.paris.lutece.util.html
Interface IPaginator<E>

Type Parameters:
E - the type
All Known Implementing Classes:
AbstractPaginator, DelegatePaginator, LocalizedDelegatePaginator, LocalizedPaginator, Paginator

public interface IPaginator<E>

Handles paging


Field Summary
static String LABEL_FIRST
           
static String LABEL_LAST
           
static String LABEL_NEXT
           
static String LABEL_PREVIOUS
           
static String PARAMETER_ITEMS_PER_PAGE
          Default value for Items Per Page Parameter
static String PARAMETER_PAGE_INDEX
          Default value for Page Index Parameter
 
Method Summary
 String getFirstPageLink()
          Returns the previous page link
 int getItemsCount()
          Returns the number of items in the collection
 int getItemsPerPage()
          Gets the items count per page.
 String getItemsPerPageParameterName()
          Get the parameter name of the items_per_page
 String getLabelFirst()
          Get First label
 String getLabelItemCount()
          Get Item Count label
 String getLabelItemCountPerPage()
          Get Item Count per page label
 String getLabelLast()
          Get First label
 String getLabelNext()
          Get Next label
 String getLabelPrevious()
          Get Previous label
 String getLastPageLink()
          Returns the previous page link
 String getNextPageLink()
          Returns the previous page link
 int getPageCurrent()
          Returns the current page index
 List<E> getPageItems()
          Returns the List
 int getPagesCount()
          Gets the number of pages
 List<PaginatorPage> getPagesLinks()
          Returns Pages Links
 String getPreviousPageLink()
          Returns the previous page link
 int getRangeMax()
          Returns the index of the last item of the current page range
 int getRangeMin()
          Returns the index of the first item of the current page range
 void setItemsPerPageParameterName(String strItemsPerPageParameterName)
          Set the parameter name of the items_per_page
 

Field Detail

PARAMETER_PAGE_INDEX

static final String PARAMETER_PAGE_INDEX
Default value for Page Index Parameter

See Also:
Constant Field Values

PARAMETER_ITEMS_PER_PAGE

static final String PARAMETER_ITEMS_PER_PAGE
Default value for Items Per Page Parameter

See Also:
Constant Field Values

LABEL_FIRST

static final String LABEL_FIRST
See Also:
Constant Field Values

LABEL_PREVIOUS

static final String LABEL_PREVIOUS
See Also:
Constant Field Values

LABEL_NEXT

static final String LABEL_NEXT
See Also:
Constant Field Values

LABEL_LAST

static final String LABEL_LAST
See Also:
Constant Field Values
Method Detail

getPagesCount

int getPagesCount()
Gets the number of pages

Returns:
the number of pages

getPageItems

List<E> getPageItems()
Returns the List

Returns:
The List

getPageCurrent

int getPageCurrent()
Returns the current page index

Returns:
The current page index

getFirstPageLink

String getFirstPageLink()
Returns the previous page link

Returns:
The previous page link

getPreviousPageLink

String getPreviousPageLink()
Returns the previous page link

Returns:
The previous page link

getLastPageLink

String getLastPageLink()
Returns the previous page link

Returns:
The previous page link

getNextPageLink

String getNextPageLink()
Returns the previous page link

Returns:
The previous page link

getPagesLinks

List<PaginatorPage> getPagesLinks()
Returns Pages Links

Returns:
Pages Links

getRangeMin

int getRangeMin()
Returns the index of the first item of the current page range

Returns:
The index of the first item of the current page range

getRangeMax

int getRangeMax()
Returns the index of the last item of the current page range

Returns:
The index of the last item of the current page range

getItemsCount

int getItemsCount()
Returns the number of items in the collection

Returns:
The number of items in the collection

getLabelFirst

String getLabelFirst()
Get First label

Returns:
The Label

getLabelPrevious

String getLabelPrevious()
Get Previous label

Returns:
The Label

getLabelNext

String getLabelNext()
Get Next label

Returns:
The Label

getLabelLast

String getLabelLast()
Get First label

Returns:
The Label

getLabelItemCount

String getLabelItemCount()
Get Item Count label

Returns:
The Label

getLabelItemCountPerPage

String getLabelItemCountPerPage()
Get Item Count per page label

Returns:
The Label

getItemsPerPageParameterName

String getItemsPerPageParameterName()
Get the parameter name of the items_per_page

Returns:
the parameter name

setItemsPerPageParameterName

void setItemsPerPageParameterName(String strItemsPerPageParameterName)
Set the parameter name of the items_per_page

Parameters:
strItemsPerPageParameterName - the parameter name

getItemsPerPage

int getItemsPerPage()
Gets the items count per page.

Returns:
items count per page.


Copyright © 2014 Mairie de Paris. All Rights Reserved.