org.opencms.jsp
Class CmsContentInfoBean

java.lang.Object
  org.opencms.jsp.CmsContentInfoBean

public class CmsContentInfoBean

extends Object

A container to store information about a collector's result.

Since:

6.0.0

Version:

$Revision: 1.10 $

Author:

Thomas Weckert

Field Summary

static String

PAGE_CONTEXT_ATTRIBUTE_NAME The name under which the collector info is saved in the page context.

Constructor Summary

CmsContentInfoBean()
Creates a new content info bean.

Method Summary

int	getPageCount() Returns the number of pages of browse through the result list.
int	getPageIndex() Returns the index of the current page that gets displayed.
int	getPageNavEndIndex() Returns the page index of the first element in the Google-like page navigation.
int	getPageNavLength() Returns the page index of the last element in the Google-like page navigation.
int	getPageNavStartIndex() Returns the page index of the first element in the Google-like page navigation.
int	getPageSize() Returns the size of a page.
int	getResultIndex() Returns the index of the current resource that gets iterated in the result list.
int	getResultSize() Returns the total size of the collector's result list.

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_CONTEXT_ATTRIBUTE_NAME

public static final String PAGE_CONTEXT_ATTRIBUTE_NAME

The name under which the collector info is saved in the page context.

See Also:

Constant Field Values

Constructor Detail

CmsContentInfoBean

public CmsContentInfoBean()

Creates a new content info bean.

Method Detail

getPageCount

public int getPageCount()

Returns the number of pages of browse through the result list.

Returns:

the number of pages of browse through the result list

getPageIndex

public int getPageIndex()

Returns the index of the current page that gets displayed.

Returns:

the index of the current page that gets displayed

getPageNavEndIndex

public int getPageNavEndIndex()

Returns the page index of the first element in the Google-like page navigation.

Returns:

the page index of the first element in the Google-like page navigation

getPageNavLength

public int getPageNavLength()

Returns the page index of the last element in the Google-like page navigation.

Returns:

page index of the last element in the Google-like page navigation

getPageNavStartIndex

public int getPageNavStartIndex()

Returns the page index of the first element in the Google-like page navigation.

Returns:

the page index of the first element in the Google-like page navigation

getPageSize

public int getPageSize()

Returns the size of a page.

Returns:

the size of a page

getResultIndex

public int getResultIndex()

Returns the index of the current resource that gets iterated in the result list.

Returns:

the index of the current resource that gets iterated in the result list

getResultSize

public int getResultSize()

Returns the total size of the collector's result list.

Returns:

the total size of the collector's result list