info.magnolia.templating.models.util

Class Pagination

java.lang.Object

info.magnolia.templating.models.util.Pagination

public class Pagination
extends Object

Simple class providing pagination.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_RESULTS
static String	DEFAULT_POSITION
static String	PARAMETER_CURRENT_PAGE
static String	POSITION_TOP
static String	PROPERTY_MAX_RESULTS
static String	PROPERTY_POSITION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Pagination()
	Pagination(String link, Collection items, javax.jcr.Node content)

Method Summary

Methods

Modifier and Type	Method and Description
int	getBeginIndex() Returns the index to be displayed before the current page.
int	getCount()
int	getCurrentPage() Returns the current page (according to the GET parameters value, see PARAMETER_CURRENT_PAGE, or 1).
int	getEndIndex() Returns the index to be displayed after the current page.
int	getNumPages() Returns the number of pages.
protected int	getOffset() Return the current offset.
Collection	getPageItems() Returns a sub-List of all items from offset (see getOffset()) to limit (calculated from max results per page and the before mentioned offset).
String	getPageLink(int i) Returns a link the n-th page.
String	getPosition() Returns the current position of the pagination element (see DEFAULT_POSITION, POSITION_TOP).
protected void	setCount(int count)
protected void	setResults(int maxResultsPerPage)

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_CURRENT_PAGE

public static final String PARAMETER_CURRENT_PAGE

See Also:

Constant Field Values

PROPERTY_MAX_RESULTS

public static final String PROPERTY_MAX_RESULTS

See Also:

Constant Field Values

PROPERTY_POSITION

public static final String PROPERTY_POSITION

See Also:

Constant Field Values

POSITION_TOP

public static final String POSITION_TOP

See Also:

Constant Field Values

DEFAULT_POSITION

public static final String DEFAULT_POSITION

See Also:

Constant Field Values

DEFAULT_MAX_RESULTS

public static final int DEFAULT_MAX_RESULTS

See Also:

Constant Field Values

Constructor Detail

Pagination

public Pagination(String link,
          Collection items,
          javax.jcr.Node content)

Pagination

protected Pagination()

Method Detail

setResults

protected void setResults(int maxResultsPerPage)

setCount

protected void setCount(int count)

getCount

public int getCount()

getPageItems

public Collection getPageItems()

Returns a sub-List of all items from offset (see getOffset()) to limit (calculated from max results per page and the before mentioned offset).

getOffset

protected int getOffset()

Return the current offset.

getCurrentPage

public int getCurrentPage()

Returns the current page (according to the GET parameters value, see PARAMETER_CURRENT_PAGE, or 1).

getPageLink

public String getPageLink(int i)

Returns a link the n-th page.

getNumPages

public int getNumPages()

Returns the number of pages.

getBeginIndex

public int getBeginIndex()

Returns the index to be displayed before the current page.

getEndIndex

public int getEndIndex()

Returns the index to be displayed after the current page.

getPosition

public String getPosition()

Returns the current position of the pagination element (see DEFAULT_POSITION, POSITION_TOP).