NetUI Tag Library Documentation (Version 1.0.1)

netui-data
netui-data:configurePager Tag

The configurePager tag is used to parameterize the data used to render a data grid's pager.

Syntax

<netui-data:configurePager
    [defaultPageSize="string"]
    [disableDefaultPager="boolean"]
    [pageAction="String_pageAction"]
    [pageHref="String_pageUri"]
    [pageSize="int_pageSize"]
    [pagerFormat="String_pagerStyle"]
    [pagerRendererClass="string"] />

Description

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 org.apache.beehive.netui.databinding.datagrid.api.rendering.PagerRenderer via the <netui-data:configurePager>, overriding the default page size for a data grid via the <netui-data:configurePager> attribute, and setting the current data grid's page size via the <netui-data:configurePager> attribute. This tag produces no output and does not evaluate its body.

Attributes
defaultPageSize
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set the default page size for the data grid. The grid has a default page size that is used when no other page size is specified; this value is org.apache.beehive.netui.databinding.datagrid.api.pager.PagerModel. 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 <netui-data:configurePager> attribute.
disableDefaultPager
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the value of an attribute that enables or disables rendering the data grid's default pager. When this value is set to 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 <netui-data:renderPager> tag or manually in a page.
pageAction
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set the action used to perform paging. When a pager renders anchors for navigating the data set in a data grid, this action is used as the request URI to perform the paging. Only one of this and the <netui-data:configurePager> may be set.
pageHref
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set the HREF used to perform paging. When a pager renders anchors for navigating the data set inside of the data grid, this HREF when set is used as the request URI to perform the paging. Only one of this and the <netui-data:configurePager> may be set.
pageSize
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set the page size for the current data grid. This value is the maximum number of data rows that will be rendered by a data grid. When this value is set, it overides the <netui-data:configurePager> attribute. If this value is not set, the <netui-data:configurePager> 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.
pagerFormat
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set the style of the pager rendered by the data grid. This attribute allows the page author to choose from a set of pre-defined pager renderers which can be used to render paging UI in a data grid. The values include: prevNext which renders a pager as:
   Page # of # Previous Next
 
where 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.

firstPrevNextLast which renders a pager as:
   Page # of # First Previous Next Last
 
where 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.
pagerRendererClass
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set a Java class name to create a org.apache.beehive.netui.databinding.datagrid.api.rendering.PagerRenderer used to render a data grid's pager. The class referenced by this name must extend the org.apache.beehive.netui.databinding.datagrid.api.rendering.PagerRenderer base class.


Tag Information
Tag Classorg.apache.beehive.netui.tags.databinding.datagrid.ConfigurePager
TagExtraInfo ClassNone
Body Contentempty
Display NameNone