E
- the element typepublic class PagedListHolder<E> extends Object implements Serializable
This is mainly targeted 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
will be used, toggling the ascending value on setting the same property again.
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".
getPageList()
,
MutableSortDefinition
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
DEFAULT_MAX_LINKED_PAGES
The default maximum number of page links.
|
static int |
DEFAULT_PAGE_SIZE
The default page size.
|
Constructor and Description |
---|
PagedListHolder()
Create a new holder instance.
|
PagedListHolder(List<E> source)
Create a new holder instance with the given source list, starting with
a default sort definition (with "toggleAscendingOnProperty" activated).
|
PagedListHolder(List<E> source,
SortDefinition sort)
Create a new holder instance with the given source list.
|
Modifier and Type | Method and Description |
---|---|
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<E> 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<E> |
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<E> |
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.
|
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<E> source)
Set the source list for this holder.
|
public static final int DEFAULT_PAGE_SIZE
public static final int DEFAULT_MAX_LINKED_PAGES
public PagedListHolder()
setSource(java.util.List<E>)
public PagedListHolder(List<E> source)
source
- the source ListMutableSortDefinition.setToggleAscendingOnProperty(boolean)
public PagedListHolder(List<E> source, SortDefinition sort)
source
- the source Listsort
- the SortDefinition to start with@Nullable public Date getRefreshDate()
public void setSort(@Nullable SortDefinition sort)
MutableSortDefinition
@Nullable 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 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 objectMutableSortDefinition(SortDefinition)
protected void doSort(List<E> source, SortDefinition sort)
The default implementation uses Spring's PropertyComparator. Can be overridden in subclasses.