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 java.lang.String LABEL_FIRST
           
static java.lang.String LABEL_LAST
           
static java.lang.String LABEL_NEXT
           
static java.lang.String LABEL_PREVIOUS
           
static java.lang.String PARAMETER_ITEMS_PER_PAGE
          Default value for Items Per Page Parameter
static java.lang.String PARAMETER_PAGE_INDEX
          Default value for Page Index Parameter
 
Method Summary
 java.lang.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.
 java.lang.String getItemsPerPageParameterName()
          Get the parameter name of the items_per_page
 java.lang.String getLabelFirst()
          Get First label
 java.lang.String getLabelItemCount()
          Get Item Count label
 java.lang.String getLabelItemCountPerPage()
          Get Item Count per page label
 java.lang.String getLabelLast()
          Get First label
 java.lang.String getLabelNext()
          Get Next label
 java.lang.String getLabelPrevious()
          Get Previous label
 java.lang.String getLastPageLink()
          Returns the previous page link
 java.lang.String getNextPageLink()
          Returns the previous page link
 int getPageCurrent()
          Returns the current page index
 java.util.List<E> getPageItems()
          Returns the List
 int getPagesCount()
          Gets the number of pages
 java.util.List<PaginatorPage> getPagesLinks()
          Returns Pages Links
 java.lang.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(java.lang.String strItemsPerPageParameterName)
          Set the parameter name of the items_per_page
 

Field Detail

PARAMETER_PAGE_INDEX

static final java.lang.String PARAMETER_PAGE_INDEX
Default value for Page Index Parameter

See Also:
Constant Field Values

PARAMETER_ITEMS_PER_PAGE

static final java.lang.String PARAMETER_ITEMS_PER_PAGE
Default value for Items Per Page Parameter

See Also:
Constant Field Values

LABEL_FIRST

static final java.lang.String LABEL_FIRST
See Also:
Constant Field Values

LABEL_PREVIOUS

static final java.lang.String LABEL_PREVIOUS
See Also:
Constant Field Values

LABEL_NEXT

static final java.lang.String LABEL_NEXT
See Also:
Constant Field Values

LABEL_LAST

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

getPagesCount

int getPagesCount()
Gets the number of pages

Returns:
the number of pages

getPageItems

java.util.List<E> getPageItems()
Returns the List

Returns:
The List

getPageCurrent

int getPageCurrent()
Returns the current page index

Returns:
The current page index

getFirstPageLink

java.lang.String getFirstPageLink()
Returns the previous page link

Returns:
The previous page link

getPreviousPageLink

java.lang.String getPreviousPageLink()
Returns the previous page link

Returns:
The previous page link

getLastPageLink

java.lang.String getLastPageLink()
Returns the previous page link

Returns:
The previous page link

getNextPageLink

java.lang.String getNextPageLink()
Returns the previous page link

Returns:
The previous page link

getPagesLinks

java.util.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

java.lang.String getLabelFirst()
Get First label

Returns:
The Label

getLabelPrevious

java.lang.String getLabelPrevious()
Get Previous label

Returns:
The Label

getLabelNext

java.lang.String getLabelNext()
Get Next label

Returns:
The Label

getLabelLast

java.lang.String getLabelLast()
Get First label

Returns:
The Label

getLabelItemCount

java.lang.String getLabelItemCount()
Get Item Count label

Returns:
The Label

getLabelItemCountPerPage

java.lang.String getLabelItemCountPerPage()
Get Item Count per page label

Returns:
The Label

getItemsPerPageParameterName

java.lang.String getItemsPerPageParameterName()
Get the parameter name of the items_per_page

Returns:
the parameter name

setItemsPerPageParameterName

void setItemsPerPageParameterName(java.lang.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 © 2012 Mairie de Paris. All Rights Reserved.