public class ListViewHelper
extends java.lang.Object
Constructor and Description |
---|
ListViewHelper(RequestContext requestContext,
java.lang.String filterField)
Initializes the helper.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getFilterParam()
Gets the filter parameter specified by the user
|
int |
getItemsPerPage()
Number of items on page
|
java.lang.String |
getPreviousFilterParam()
Gets the filter parameter specified by the user on the immediately prior request
|
void |
isFiltering(boolean flag)
Indicate if the data result can be filtered
|
void |
prepare()
Sets up the environment for list view processing
This should be called immediately before rendering the page containing
the list view
|
void |
prepare(java.lang.String displayName)
Sets up the environment for list view processing
This should be called immediately before rendering the page containing
the list view
|
void |
setData(DataResult data)
Sets the DataResult reference
|
void |
setItemsPerPage(int size)
Set number of items per page
|
public ListViewHelper(RequestContext requestContext, java.lang.String filterField)
requestContext
- current requestfilterField
- name of the DTO/Map field which will be filtered
For example, if the DTO has a getLabel
method, then the
field name would be label.public void setData(DataResult data)
data
- data to drive the list viewpublic void isFiltering(boolean flag)
flag
- on/off togglepublic java.lang.String getFilterParam()
public java.lang.String getPreviousFilterParam()
public void prepare()
public void prepare(java.lang.String displayName)
displayName
- the name to store the list view's data underpublic void setItemsPerPage(int size)
size
- number of items on pagepublic int getItemsPerPage()