|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectSimpleTagSupport
AbstractSimpleTag
ConfigurePager
public class ConfigurePager
The configurePager tag is used to parameterize the data used to render a data grid's pager. This
tag should be used inside of a <netui-data:dataGrid> tag. The tag supports adding a custom
PagerRenderer
via the setPagerRendererClass(String)
, overriding the default page
size for a data grid via the setDefaultPageSize(Integer)
attribute, and setting
the current data grid's page size via the setPageSize(int)
attribute. This tag produces
no output and does not evaluate its body.
Constructor Summary | |
---|---|
ConfigurePager()
|
Method Summary | |
---|---|
void |
doTag()
Execute the ConfigurePager tag. |
String |
getTagName()
The name of this tag; this value is used for error reporting. |
void |
setDefaultPageSize(Integer defaultPageSize)
Set the default page size for the data grid. |
void |
setDisableDefaultPager(boolean disableDefaultPager)
Sets the value of an attribute that enables or disables rendering the data grid's default pager. |
void |
setPageAction(String pageAction)
Set the action used to perform paging. |
void |
setPageHref(String pageHref)
Set the HREF used to perform paging. |
void |
setPagerFormat(String pagerFormat)
Set the appearance of the pager rendered by the data grid. |
void |
setPagerRendererClass(String pagerRendererClass)
Set a Java class name to create a PagerRenderer used to render a data grid's pager. |
void |
setPageSize(int pageSize)
Set the page size for the current data grid. |
Methods inherited from class AbstractSimpleTag |
---|
getBufferBody, getHtmlTag, getIdForTagId, getInlineError, getPageContext, getScriptReporter, getUserLocale, hasErrors, registerTagError, registerTagError, reportErrors, rewriteName, setNonEmptyValueAttribute, setRequiredValueAttribute, write |
Methods inherited from class SimpleTagSupport |
---|
findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConfigurePager()
Method Detail |
---|
public String getTagName()
getTagName
in interface INetuiTag
getTagName
in class AbstractSimpleTag
public void setPageSize(int pageSize)
setDefaultPageSize(Integer)
attribute. If this value is not set, the
setDefaultPageSize(Integer)
is used to determine the maximum size of a data grid's
page. Use this value when a data grid allows a user to vary the number of rows in a grid.
public void setPagerFormat(String pagerFormat)
Page # of # Previous Nextwhere Previous and Next are anchors that can navigate to the previous and next pages. When there is no previous or next page, Previous or Next are displayed as literal text.
Page # of # First Previous Next Lastwhere First, Previous, Next, and Last are anchors that can navigate to the first, previous, next, and last pages respectively. When the anchors would reference invalid pages, First, Previous, Nest, and Last are displayed as literal text.
public void setPageHref(String pageHref)
setPageAction(String)
may be set.
public void setPageAction(String pageAction)
setPageHref(String)
may be set.
public void setDisableDefaultPager(boolean disableDefaultPager)
false
, the data grid will not render its pager and rendering
is left to the page author. When rendering is disabled, a pager can be rendered using the
RenderPager
tag or manually in a page.
public void setPagerRendererClass(String pagerRendererClass)
PagerRenderer
used to render a data grid's pager. The
class referenced by this name must extend the PagerRenderer
base class.
public void setDefaultPageSize(Integer defaultPageSize)
PagerModel.DEFAULT_PAGE_SIZE
.
This value overrides that default so that the normal rendering of such a data grid is
change in the absence of an override provided by the setPageSize(int)
attribute.
public void doTag() throws JspException
DataGridTagModel
state object which is used when the data grid renders its pager.
doTag
in interface SimpleTag
doTag
in class SimpleTagSupport
JspException
- when errors occur when processing this tag's attribute values
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |