org.xwiki.livedata

Class LiveDataPaginationConfiguration

java.lang.Object

org.xwiki.livedata.LiveDataPaginationConfiguration

@Unstable
public class LiveDataPaginationConfiguration
extends Object

Describes the live data pagination configuration.

Since:

12.10

Version:

$Id: 865ed74c05bd98c3fb434259a866c3f158ace9d3 $

Constructor Summary

Constructors

Constructor and Description
LiveDataPaginationConfiguration()

Method Summary

Modifier and Type	Method and Description
Integer	getMaxShownPages()
List<Integer>	getPageSizes()
Boolean	getShowEntryRange()
Boolean	getShowFirstLast()
Boolean	getShowNextPrevious()
Boolean	getShowPageSizeDropdown()
void	initialize() Prevent null values where it's possible.
void	setMaxShownPages(Integer maxShownPages) Sets the maximum number of page links to display in the pagination.
void	setPageSizes(List<Integer> pageSizes) Sets the values to display in the page size drop down that allows the user to change the page size.
void	setShowEntryRange(Boolean showEntryRange) Sets whether to show or not the current entry range.
void	setShowFirstLast(Boolean showFirstLast) Sets whether to show or not the first / last pagination links.
void	setShowNextPrevious(Boolean showNextPrevious) Sets whether to show or not the next / previous pagination links.
void	setShowPageSizeDropdown(Boolean showPageSizeDropdown) Sets whether to show or not the page size drop down that the user can use to change the number of entries displayed per page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LiveDataPaginationConfiguration

public LiveDataPaginationConfiguration()

Method Detail

getMaxShownPages

public Integer getMaxShownPages()

Returns:

the maximum number of page links to display in the pagination

setMaxShownPages

public void setMaxShownPages(Integer maxShownPages)

Sets the maximum number of page links to display in the pagination.

Parameters:

maxShownPages - the maximum number of page links to display in the pagination

getPageSizes

public List<Integer> getPageSizes()

Returns:

the values to display in the page size drop down

setPageSizes

public void setPageSizes(List<Integer> pageSizes)

Sets the values to display in the page size drop down that allows the user to change the page size.

Parameters:

pageSizes - the values to display on the page size drop down

getShowEntryRange

public Boolean getShowEntryRange()

Returns:

whether to show or not the current entry range

setShowEntryRange

public void setShowEntryRange(Boolean showEntryRange)

Sets whether to show or not the current entry range.

Parameters:

showEntryRange - true to show the current entry range, false otherwise

getShowNextPrevious

public Boolean getShowNextPrevious()

Returns:

whether to show or not the next / previous pagination links

setShowNextPrevious

public void setShowNextPrevious(Boolean showNextPrevious)

Sets whether to show or not the next / previous pagination links.

Parameters:

showNextPrevious - true to show the next / previous pagination links, false otherwise

getShowFirstLast

public Boolean getShowFirstLast()

Returns:

whether to show or not the first / last pagination links

setShowFirstLast

public void setShowFirstLast(Boolean showFirstLast)

Sets whether to show or not the first / last pagination links.

Parameters:

showFirstLast - true to show the first / last pagination links, false otherwise

getShowPageSizeDropdown

public Boolean getShowPageSizeDropdown()

Returns:

whether to show or not the page size drop down that the user can use to change the number of entries displayed per page

setShowPageSizeDropdown

public void setShowPageSizeDropdown(Boolean showPageSizeDropdown)

Sets whether to show or not the page size drop down that the user can use to change the number of entries displayed per page.

Parameters:

showPageSizeDropdown - true to show the page size drop down, false otherwise

initialize

public void initialize()

Prevent null values where it's possible.