|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectPagerRenderer
public abstract class PagerRenderer
This is the base class for data grid pager renderers. Subclasses can be used by the data grid to
render custom pager markup overriding one or both of the internalRender()
and noDataRender()
methods. Additional methods are implemented here as a convenience and may be overriden by
subclasses needing to change their behavior.
Constructor Summary | |
---|---|
PagerRenderer()
|
Method Summary | |
---|---|
protected void |
buildAnchor(AbstractRenderAppender appender,
Map queryParams,
String labelKey)
Build the anchor |
protected String |
buildDeadFirstLink()
Build literal text for the string displayed when there is no first page for the data set. |
protected String |
buildDeadLastLink()
Build literal text for the string displayed when there is no last page for the data set. |
protected String |
buildDeadNextLink()
Build literal text for the string displayed when there is no next page for the data set. |
protected String |
buildDeadPreviousLink()
Build literal text for the string displayed when there is no previous page for the data set. |
protected String |
buildLiveFirstLink()
Build an HTML anchor that contains URL state for navigating to the first page of a data set. |
protected String |
buildLiveLastLink()
Build an HTML anchor that contains URL state for navigating to the last page of a data set. |
protected String |
buildLiveNextPageLink()
Build an HTML anchor that contains URL state for navigating to the next page of a data set. |
protected String |
buildLivePreviousLink()
Build an HTML anchor that contains URL state for navigating to the previous page of a data set. |
protected String |
buildPageUri(Map queryParams)
|
protected DataGridTagModel |
getDataGridTagModel()
Get the DataGridTagModel to which this pager is associated. |
protected PagerModel |
getPagerModel()
Get the PagerModel that contains the current pager state. |
protected String |
internalRender()
Render the pager. |
protected String |
noDataRender()
Render the pager. |
String |
render()
This method should be called when the pager is to be rendered. |
void |
setDataGridTagModel(DataGridTagModel dataGridTagModel)
Set the DataGridTagModel with which this pager renderer instance is associated. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PagerRenderer()
Method Detail |
---|
public void setDataGridTagModel(DataGridTagModel dataGridTagModel)
Set the DataGridTagModel
with which this pager renderer instance is associated. Pager renderer
instances should not be shared between data grids without setting a DataGridTagModel
for
each data grid.
dataGridTagModel
- the DataGridTagModel
public String render()
This method should be called when the pager is to be rendered. The result will be the String that represents the result of rendering.
If there is no data in the data set, the method noDataRender()
will be invoked. Otherwise,
the internalRender()
method will be called.
protected PagerModel getPagerModel()
PagerModel
that contains the current pager state.
PagerModel
protected DataGridTagModel getDataGridTagModel()
DataGridTagModel
to which this pager is associated.
DataGridTagModel
protected String internalRender()
protected String noDataRender()
protected String buildLiveFirstLink()
protected String buildDeadFirstLink()
PagerModel
is already on the first page. By default, this text is
obtained using the IDataGridMessageKeys.PAGER_MSG_FIRST
message key.
protected String buildLivePreviousLink()
PagerModel
protected String buildDeadPreviousLink()
PagerModel
is on the first page. By default, this text is
obtained using the IDataGridMessageKeys.PAGER_MSG_PREVIOUS
message key.
protected String buildLiveNextPageLink()
PagerModel
protected String buildDeadNextLink()
PagerModel
is on the last page. By default, this text is
obtained using the IDataGridMessageKeys.PAGER_MSG_NEXT
message key.
protected String buildLiveLastLink()
protected String buildDeadLastLink()
PagerModel
is on the last page. By default, this text is
obtained using the IDataGridMessageKeys.PAGER_MSG_LAST
message key.
protected final void buildAnchor(AbstractRenderAppender appender, Map queryParams, String labelKey)
appender
- queryParams
- labelKey
- protected String buildPageUri(Map queryParams)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |