|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.beans.support.PagedListHolder
public class PagedListHolder
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.
getPageList()
,
RefreshablePagedListHolder
,
MutableSortDefinition
,
Serialized FormField Summary | |
---|---|
static int |
DEFAULT_MAX_LINKED_PAGES
|
static int |
DEFAULT_PAGE_SIZE
|
Constructor Summary | |
---|---|
PagedListHolder()
Create a new holder instance. |
|
PagedListHolder(List source)
Create a new holder instance with the given source list, starting with a default sort definition (with "toggleAscendingOnProperty" activated). |
|
PagedListHolder(List source,
SortDefinition sort)
Create a new holder instance with the given source list. |
Method Summary | |
---|---|
protected SortDefinition |
copySortDefinition(SortDefinition sort)
Create a deep copy of the given sort definition, for use as state holder to compare a modified sort definition against. |
protected void |
doSort(List source,
SortDefinition sort)
Actually perform sorting of the given source list, according to the given sort definition. |
int |
getFirstElementOnPage()
Return the element index of the first element on the current page. |
int |
getFirstLinkedPage()
Return the first page to which create a link around the current page. |
int |
getLastElementOnPage()
Return the element index of the last element on the current page. |
int |
getLastLinkedPage()
Return the last page to which create a link around the current page. |
int |
getMaxLinkedPages()
Return the maximum number of page links to a few pages around the current one. |
int |
getNrOfElements()
Return the total number of elements in the source list. |
int |
getPage()
Return the current page number. |
int |
getPageCount()
Return the number of pages for the current source list. |
List |
getPageList()
Return a sub-list representing the current page. |
int |
getPageSize()
Return the current page size. |
Date |
getRefreshDate()
Return the last time the list has been fetched from the source provider. |
SortDefinition |
getSort()
Return the sort definition for this holder. |
List |
getSource()
Return the source list for this holder. |
boolean |
isFirstPage()
Return if the current page is the first one. |
boolean |
isLastPage()
Return if the current page is the last one. |
void |
nextPage()
Switch to next page. |
void |
previousPage()
Switch to previous page. |
void |
resort()
Resort the list if necessary, i.e. if the current sort instance
isn't equal to the backed-up sortUsed instance. |
void |
setMaxLinkedPages(int maxLinkedPages)
Set the maximum number of page links to a few pages around the current one. |
void |
setPage(int page)
Set the current page number. |
void |
setPageSize(int pageSize)
Set the current page size. |
void |
setSort(SortDefinition sort)
Set the sort definition for this holder. |
void |
setSource(List source)
Set the source list for this holder. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_PAGE_SIZE
public static final int DEFAULT_MAX_LINKED_PAGES
Constructor Detail |
---|
public PagedListHolder()
setSource(java.util.List)
public PagedListHolder(List source)
source
- the source ListMutableSortDefinition.setToggleAscendingOnProperty(boolean)
public PagedListHolder(List source, SortDefinition sort)
source
- the source Listsort
- the SortDefinition to start withMethod Detail |
---|
public void setSource(List source)
public List getSource()
public Date getRefreshDate()
public void setSort(SortDefinition sort)
MutableSortDefinition
public SortDefinition getSort()
public void setPageSize(int pageSize)
Default value is 10.
public int getPageSize()
public void setPage(int page)
public int getPage()
public void setMaxLinkedPages(int maxLinkedPages)
public int getMaxLinkedPages()
public int getPageCount()
public boolean isFirstPage()
public boolean isLastPage()
public void previousPage()
public void nextPage()
public int getNrOfElements()
public int getFirstElementOnPage()
public int getLastElementOnPage()
public List getPageList()
public int getFirstLinkedPage()
public int getLastLinkedPage()
public void resort()
sort
instance
isn't equal to the backed-up sortUsed
instance.
Calls doSort
to trigger actual sorting.
protected SortDefinition copySortDefinition(SortDefinition sort)
Default implementation creates a MutableSortDefinition instance.
Can be overridden in subclasses, in particular in case of custom
extensions to the SortDefinition interface. Is allowed to return
null, which means that no sort state will be held, triggering
actual sorting for each resort
call.
sort
- the current SortDefinition object
MutableSortDefinition.MutableSortDefinition(SortDefinition)
protected void doSort(List source, SortDefinition sort)
The default implementation uses Spring's PropertyComparator. Can be overridden in subclasses.
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |