NetUI Tag Library Documentation (Version 1.0.2)

netui-data
netui-data:getDataGridState Tag

Utility data grid tag that allows the page author to gain access to the org.apache.beehive.netui.databinding.datagrid.api.DataGridState object outside of the body of a <netui-data:dataGrid> tag.

Syntax

<netui-data:getDataGridState
    [dataGridConfig="string_var"]
    gridName="string_gridName"
    var="string_var" >
    ... JSP content ...
</netui-data:getDataGridState>

Description

Utility data grid tag that allows the page author to gain access to the org.apache.beehive.netui.databinding.datagrid.api.DataGridState object outside of the body of a <netui-data:dataGrid> tag. When building UI for sorting, filtering, or paging, this UI does not need to exist inside of the HTML table rendered by the data grid tags. In order to render UI for sorting, filtering, and paging, it is often necessary to gain access to the state exposed to a data grid via the org.apache.beehive.netui.databinding.datagrid.api.DataGridState object. For example:

   <netui-data:getDataGridState gridName="employees" var="employeeGridState"/>
   <c:if test="${pageScope.employeeGridState.sortModel.sorts} != null}">
     ... render UI when sorts are present ...
   </c:if>
 
this will expose the "employees" data grid's list of org.apache.beehive.netui.databinding.datagrid.api.sort.SortModel to the JSP for access by the JSP EL.

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

Set a org.apache.beehive.netui.databinding.datagrid.api.DataGridConfig instance used to create a org.apache.beehive.netui.databinding.datagrid.api.DataGridState object. This attribute is optional; when unset, the default org.apache.beehive.netui.databinding.datagrid.api.DataGridConfig is used.
gridName
Required: Yes  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: No

Set the data grid name whose org.apache.beehive.netui.databinding.datagrid.api.DataGridState should be placed in the javax.servlet.jsp.JspContext.
var
Required: Yes  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: No

Set the name used to store the org.apache.beehive.netui.databinding.datagrid.api.DataGridState object as a javax.servlet.jsp.JspContext attribute.


Tag Information
Tag Classorg.apache.beehive.netui.tags.databinding.datagrid.GetDataGridState
TagExtraInfo ClassNone
Body Contentscriptless
Display NameNone