NetUI Tag Library Documentation (Version 1.0.1)

netui-data
netui-data:headerCell Tag

This tag is used to render an HTML table header cell and should generally be used inside of the data grid's <netui-data:header> tag.

Syntax

<netui-data:headerCell
    [cellAbbr="string_cellDir"]
    [cellAlign="string_cellAlign"]
    [cellAxis="string_cellAxis"]
    [cellChar="string_cellAlignChar"]
    [cellCharoff="string_cellAlignCharOff"]
    [cellColspan="int_cellColspan"]
    [cellDir="string_cellDir"]
    [cellHeaders="string_cellHeaders"]
    [cellLang="string_cellLang"]
    [cellOnClick="string_cellOnClick"]
    [cellOnDblClick="string_cellOnDblClick"]
    [cellOnKeyDown="string_cellOnKeyDown"]
    [cellOnKeyPress="string_cellOnKeyPress"]
    [cellOnKeyUp="string_cellOnKeyUp"]
    [cellOnMouseDown="string_cellOnMouseDown"]
    [cellOnMouseMove="string_cellOnMouseMove"]
    [cellOnMouseOut="string_cellOnMouseOut"]
    [cellOnMouseOver="string_cellOnMouseOver"]
    [cellOnMouseUp="string_cellOnMouseUp"]
    [cellRowspan="int_cellRowspan"]
    [cellScope="string_cellScope"]
    [cellStyle="string_cellStyle"]
    [cellStyleClass="string_cellStyleClass"]
    [cellTagId="string_cellTagId"]
    [cellTitle="string_cellTitle"]
    [cellValign="string_cellValign"]
    [disableFilterRendering="string_disableFilterRendering"]
    [disableSortRendering="string_disableSortRendering"]
    [filterAction="string_filterAction"]
    [filterExpression="string_filterExpression"]
    [filterHref="string_filterHref"]
    [headerText="string_headerText"]
    [scopeId="string_scopeId"]
    [sortAction="string_sortAction"]
    [sortExpression="string_sortExpression"]
    [sortHref="string_sortHref"]
    [value="object_headerText"] >
    ... JSP content ...
</netui-data:headerCell>

Description

This tag is used to render an HTML table header cell and should generally be used inside of the data grid's <netui-data:header> tag. Cells rendered with this tag usually appear at the top of a column of data displayed in a grid. Content for the body of a table header cell can be specified in one of two ways:

This tag can accept in its body any content which is allowable inside of a JSP javax.servlet.jsp.tagext.SimpleTag. If the header text attribute is provided, it will supercede the content rendered by the body, though the body will still be evaluated.

The header cell is also able to display UI for showing and changing the sort and filter state of a data grid. By default, this tag renders a clickable arrow indicating the sort state and allow ing a page user to change the sort state. The state of a sort is usually associated with the data displayed in a column though the data in the column and the expression used to sort the data are loosely coupled via a 'sort expression'. The sort expression text is used to lookup the org.apache.beehive.netui.databinding.datagrid.api.sort.Sort state from the org.apache.beehive.netui.databinding.datagrid.api.DataGridState associated with the containing data grid. If sorts are found, this tag will render the appropriate UI for the sort. Only a single sort may be associated with the sort expression. The clickable link rendered for changing the sort state is built using either the <netui-data:headerCell> or the <netui-data:headerCell> attributes. Sort UI rendering can be disabled using the <netui-data:headerCell> attribute. Custom UI can be rendered for changing or displaying the sort state by providing a body for this tag and using the JSP EL data bindable org.apache.beehive.netui.databinding.datagrid.api.DataGridState object available via the data grid's dataGrid implicit object.

The header cell provides attributes for supporting authoring of filter UI, but this tag does not by default implement a filter UI. The attributes are provided here so that their values can be data bound when building custom filter UI.

The set of JSP implicit objects available to the body include:

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

The abbreviated form of the cell's content for the HTML th tag.
cellAlign
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The horizontal alignment for the HTML th tag.
cellAxis
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The axis attribute for the HTML th tag.
cellChar
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The horizontal alignment character for the HTML th tag.
cellCharoff
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The horizontal alignment character offset for the HTML th tag.
cellColspan
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The colspan for the HTML th tag.
cellDir
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The text direction attribute for the HTML th tag.
cellHeaders
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The headers attribute for the HTML th tag.
cellLang
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The language for the HTML th tag.
cellOnClick
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onClick JavaScript for the HTML th tag.
cellOnDblClick
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onDblClick JavaScript for the HTML th tag.
cellOnKeyDown
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyDown JavaScript for the HTML th tag.
cellOnKeyPress
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyPress JavaScript event for the HTML th tag.
cellOnKeyUp
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onKeyUp JavaScript for the HTML th tag.
cellOnMouseDown
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseDown JavaScript for the HTML th tag.
cellOnMouseMove
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseMove JavaScript for the HTML th tag.
cellOnMouseOut
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseOut JavaScript event for the HTML th tag.
cellOnMouseOver
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseOver JavaScript for the HTML th tag.
cellOnMouseUp
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The onMouseUp JavaScript for the HTML th tag.
cellRowspan
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The row span for the HTML th tag.
cellScope
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The scope attribute for the HTML th tag.
cellStyle
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The style for the HTML th tag.
cellStyleClass
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The style class for the HTML th tag.
cellTagId
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The tagId for the HTML th tag.
cellTitle
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The title for the HTML th tag.
cellValign
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

The vertical alignment for the HTML th tag.
disableFilterRendering
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set a boolean which can be used to enable / disable rendering of UI associated with filtering inside of the data grid.
disableSortRendering
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set a boolean which can be used to enable / disable rendering of UI associated with sorting inside of the data grid.
filterAction
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set the name of an action used to perform filtering on a data grid. This action must exist in the context of the current Page Flow. It is used to build anchor URIs that when clicked change or display UI that allows for change to the cell's filter state. Only one of this and the <netui-data:headerCell> may be set on this tag.
filterExpression
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set the filter expression for this header cell. The value of this attribute is used to lookup org.apache.beehive.netui.databinding.datagrid.api.filter.Filter state for a data grid If filters are found matching this filter expression, the column is said to be 'filtered'. When a column is filtered, it is possible for the header cell UI to change to allow changing or removing the filter. By default, no UI is rendered for filtered columns. To have data cells rendered with filter information, this filter expression value should be set on the org.apache.beehive.netui.tags.databinding.datagrid.AbstractHtmlTableCell attribute for cell tags rendered inside of the <netui-data:rows> tag.
filterHref
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Set an href used to build URIs to change the filter state for this header cell. Only one of this and the <netui-data:headerCell> attribute may be set on this tag.
headerText
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the text to render for this table header cell. This text will be rendered inside of the <th> tags.
scopeId
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the scopeId for any anchors rendered by this header cell.
sortAction
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

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

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

Set an href used to build URIs to change the sort state for this header cell. Only one of this and the <netui-data:headerCell> attribute may be set on this tag.
value
Required: No  |   Type: String  |   Supports runtime evaluation / JSP Expression Language: Yes

Sets the value to format and render for this table header cell.


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