org.springframework.beans.support
Class PagedListHolder

Direct Known Subclasses:

RefreshablePagedListHolder

public class PagedListHolder

implements Serializable

PagedListHolder is a simple state holder for handling lists of objects, separating them into pages. Page numbering starts with 0.

This is mainly targetted at usage in web UIs. Typically, an instance will be instantiated with a list of beans, put into the session, and exported as model. The properties can all be set/get programmatically, but the most common way will be data binding, i.e. populating the bean from request parameters. The getters will mainly be used by the view.

Supports sorting the underlying list via a SortDefinition implementation, available as property "sort". By default, a MutableSortDefinition instance that toggles the ascending value on setting the same property again is used.

The data binding names have to be called "pageSize" and "sort.ascending", as expected by BeanWrapper. Note that the names and the nesting syntax match the respective JSTL EL expressions, like "myModelAttr.pageSize" and "myModelAttr.sort.ascending".

This class just provides support for an unmodifiable List of beans. If you need on-demand refresh because of Locale or filter changes, consider RefreshablePagedListHolder.

Author:

Juergen Hoeller

Since: 19.05.2003

See Also: getPageList(), RefreshablePagedListHolder, MutableSortDefinition

public final static int DEFAULT_MAX_LINKED_PAGES

public final static int DEFAULT_PAGE_SIZE

public PagedListHolder()

Create a new holder instance. You'll need to set a source list to be able to use the holder.

public PagedListHolder(List source)

Create a new holder instance with the given source list.

public int getFirstElementOnPage()

Return the element index of the first element on the current page. Element numbering starts with 0.

public int getFirstLinkedPage()

Return the first page to which create a link around the current page.

public int getLastElementOnPage()

Return the element index of the last element on the current page. Element numbering starts with 0.

public int getLastLinkedPage()

Return the first page to which create a link around the current page.

public int getMaxLinkedPages()

Return the maximum number of page links to a few pages around the current one.

public int getNrOfElements()

Return the total number of elements in the source list.

public int getNrOfPages()

Return the number of pages for the current source list.

public int getPage()

Return the current page number. Page numbering starts with 0.

public List getPageList()

Return a sub-list representing the current page.

public int getPageSize()

Return the current page size.

public Date getRefreshDate()

Return the last time the list has been fetched from the source provider.

public SortDefinition getSort()

Return the sort definition for this holder.

public List getSource()

Return the source list for this holder.

public boolean isFirstPage()

Return if the current page is the first one.

public boolean isLastPage()

Return if the current page is the last one.

public void nextPage()

Switch to next page. Will stay on last page if already on last page.

public void previousPage()

Switch to previous page. Will stay on first page if already on first page.

public void resort()

Resort the list if necessary, i.e. if the current sort instance isn't equal to the backed-up sortUsed instance.

public void setMaxLinkedPages(int maxLinkedPages)

Set the maximum number of page links to a few pages around the current one.

public void setPage(int page)

Set the current page number. Page numbering starts with 0.

public void setPageSize(int pageSize)

Set the current page size. Resets the current page number if changed.

Default value is 10.

public void setSort(SortDefinition sort)

Set the sort definition for this holder. Typically an instance of MutableSortDefinition.

See Also:

MutableSortDefinition

public void setSource(List source)

Set the source list for this holder.

Association Links

to Class java.util.List

to Class org.springframework.beans.support.SortDefinition

to Class org.springframework.beans.support.SortDefinition