Java Doc for DataGrid.java in  » Library » Apache-beehive-1.0.2-src » org » apache » beehive » netui » tags » databinding » datagrid » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This tag is the containing tag for all tags and markup used to render a data grid. In its simplest form, a data grid is an HTML table containing an HTML table row for every item in a data set. The data grid also provides functionality for rendering the following major regions:

• a header -- a header contains the top-most rows in a data grid's HTML table and is rendered using the Header tag
• data rows -- markup rendered in the data grid for each record in the data set must be contained in a Rows tag
• a footer -- a footer contains the bottom-most rows in a data grid's HTML table and is rendered using the Footer tag
• caption -- an HTML table caption appears at the top of the table and is rendered using the Caption tag.

Inside of the Header and Rows rendering regions, the data grid renders HTML table cells. The data grid tag set provides a set of tags that can be used render these cells with varying content including:

• HTML <th> cells -- these are generally used inside the Header
• anchors -- these can be rendered using the AnchorCell tag
• images -- these can be rendered using the ImageCell tag
• image anchors-- these can be rendered using the ImageAnchorCell tag
• HTML spans -- these can be rendered using the SpanCell tag

When the data grid renders its data set, the container JSP EL implicit object is exposed in the JSP's JspContext and can be referenced using the ${contaimer} JSP EL expression. The current item of data from the data set can be referenced using the ${container.item} expression. If the item had a name property, it could be referenced as ${container.item.name}. By default, the data grid renders a paged data set which will only display a portion of the complete data set. The default page size is PagerModel.DEFAULT_PAGE_SIZE and can be changed by setting the ConfigurePager.setPageSize(int) attribute.

In addition to rendering a data grid, this tag set cooperates with a set of state management services exposed via the org.apache.beehive.netui.databinding.datagrid.api.DataGridStateFactory . These services help to manage state related to paging, sorting, and filtering. For example, the first row displayed in the grid's current page and the sorts for a particular column of data are can be read / written using these state objects. The data grid will use various state information from these classes at reunder time. For example, when rendering a paged data set, the data grid will use the org.apache.beehive.netui.databinding.datagrid.api.DataGridStateFactory to obtain a PagerModel which can be used to determine the current org.apache.beehive.netui.databinding.datagrid.api.pager.PagerModel.getRow . The grid will then use this row value to advance the grid to the appropriate page to display.

By default, the data grid uses a configuration JavaBean which provides instances of state containers and services that are used to maintain state and render grid markup. This config object is a subclass of DataGridConfig and is obtained via the DataGridConfigFactory . The default implementation is org.apache.beehive.netui.databinding.datagrid.runtime.config.DefaultDataGridConfig . Page authors may provide their own implementations of this object and set an instance via DataGrid.setDataGridConfig(org.apache.beehive.netui.databinding.datagrid.api.DataGridConfig) . This can be used to change default behaviors, change the appearance of the pager, and change the messages displayed during rendering among other things.

A simple, sortable, and pageable data grid that uses a first / previous // next / last pager might be written as:

 <netui-data:dataGrid dataSource="pageScope.zooAnimals">
 <netui-data:configurePager disableDefaultPager="true" pageAction="page" pagerFormat="firstPreviousNextLast"/>
 <netui-data:caption>
 <netui-data:renderPager/>
 <netui-data:caption>
 <netui-data:header>
 <netui-data:heaederCell value="Animal" sortExpression="animal"/>
 <netui-data:heaederCell value="Quantity" sortExpression="quantity"/>
 <netui-data:heaederCell value="Details"/>
 </netui-data:header>
 <netui-data:rows>
 <netui-data:spanCell value="${container.item.animalName}"/>
 <netui-data:spanCell value="${container.item.quantity}"/>
 <netui-data:anchorCell action="details" value="Details">
 <netui:parameter name="animalId" value="${container.item.animalId}"/>
 </netui-data:anchorCell>
 </netui-data:rows>
 </netui-data:dataGrid>
 

Render a data grid.

Implementation of the IBehaviorConsumer interface that extends the functionality of this tag beyond that exposed via the JSP tag attributes.

Set the DataGridConfig instance that this tag will use to create state containers and other data grid objects used during rendering.

Set the data source that references a data set to be rendered by the data grid.

Sets a boolean that enables / disables rendering of HTML table row groups in the data grid.

Set the resource bundle path used when getting messages from a DataGridResourceProvider during data grid rendering.

Set the name of a CSS policy to use when rendering HTML elements in a data grid.

Set the style class prefix used to namespace style class names rendered as attributes on HTML tags generated by the data grid.

Render a data grid. This method implements the logic used to iterate through the data grid's rendering states defined in DataGridTagModel .

Implementation of the IBehaviorConsumer interface that extends the functionality of this tag beyond that exposed via the JSP tag attributes. This method accepts the following facets:

Facet Name	Operation
resource	Adds or overrides a data grid resource key with a new value.

A new resource key is added in order to override a value defined in org.apache.beehive.netui.databinding.datagrid.api.rendering.IDataGridMessageKeys . When a message is overridden or added here, the page author is able to override a single string resource such as a pager mesage or sort href.

Set the DataGridConfig instance that this tag will use to create state containers and other data grid objects used during rendering. Custom implementations of this class can be provided that will override the defaults set in the org.apache.beehive.netui.databinding.datagrid.runtime.config.DefaultDataGridConfig .

Set the data source that references a data set to be rendered by the data grid. The data source should be a NetUI EL expression and generally looks like a JSP EL expression without the '${' and '}' characters. For example, to reference an array of Employee objects exposed via a NetUI page input, the expression might look like:

 <netui-data:dataGrid dataSource="pageInput.employeeArray" name="employeeGrid">
 

Sets a boolean that enables / disables rendering of HTML table row groups in the data grid. When row group rendering is enabled, the data grid tags will produce the thead, tbody, and tfoot HTML tags via the Header , Rows , and Footer tags respectively. In addition, as per the HTML specification, the data grid will reorder the output of the row groups to in order to produce valid HTML. When row group rendering is enabled and a page is using JavaScript, the data grid must be nested inside of a NetUI org.apache.beehive.netui.tags.javascript.ScriptContainer in order for JavaScript rendering to be ordered correctly. Legacy JavaScript script mode is not supported by the data grid.

Set the resource bundle path used when getting messages from a DataGridResourceProvider during data grid rendering. The resource bundle provided here will entirely override messages obtained from the DataGridResourceProvider and must include all message keys that are used for rendering. In order to replace individual messages, use the behavior available from the DataGrid.setBehavior(String,Object,String) method.

Set the name of a CSS policy to use when rendering HTML elements in a data grid. The data grid supports the default style policy names defined here org.apache.beehive.netui.databinding.datagrid.runtime.config.DefaultDataGridConfig.getStyleModel(StringString) .

Set the style class prefix used to namespace style class names rendered as attributes on HTML tags generated by the data grid. For example, when using the default style policy without setting this attribute, the style rendered for the generated HTML table tag will be:

 <table class="datagrid">
 

 <table class="foo">