Tag Documentation

Description:

A common search result table control. Encapsulates the standard My webMethods Server search result table look-and-feel.

You can use the Search Result control in any generic application. In Composite Application Framework, the Search Result control is used in the Search Results portlet of a Search Bar/Search Result portlet application. You can create a Search Results portlet using the New Portlet wizard, and selecting the Search Results Portlet option on the first page of the wizard. Connect the two portlets using wiring. Wire the lastSearchState property of the Search Bar portlet to the queryString property of the Search Results portlet.

Children

javax.faces.Column, Basic Column control

Component Information
Info	Value
Component Type	`com.webmethods.caf.faces.search.SearchResultTable`
Handler Class	None
Renderer Type	`com.webmethods.caf.faces.DataTable`
Description	Displays search data model as a table
Palette Location	`CAF Html/Control/Search/Search Result Table`
Client-Side Model	`CAF.Table.Model`

Attributes
Name	Required	Type	Description
`bgcolor`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The background color for all table cells
`border`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Specifies the size of the border around the table. If the value is 0 or absent, no border is rendered
`cellpadding`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Specifies the spacing between data in a table cell and the border of the cell.
`cellspacing`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Specifies the spacing between table cells.
`columnClasses`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A comma separated list of CSS classes for the table body <td> elements.
`customRowClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Binding expression that specifies a custom CSS class name to add to the current row
`dir`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the directionality of the flow of the content for the current element Valid values are: LTR RTL
`displayOptions`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Options...' button will be rendered to open search results options dialog If not specified, the default value is "false".
`dragAndDropColumns`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	Allow drag-to-resize-columns and drag-to-reorder-columns. If not specified, the default value is "false".
`exportButtonAvailable`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	If true, the 'Export Table..' button will be rendered in the header If not specified, the default value is "true".
`exportCharacterEncoding`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Character Encoding for the exported data file If not specified, the default value is "UTF-16LE".
`exportExcludeComponentsCSV`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	CSV of Component IDs that should be excluded when exporting the table data
`exportFileName`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The filename for the exported table data If not specified, the default value is "export.csv".
`exportProvider`	`false`	`javax.el.ValueExpression` (must evaluate to `com.webmethods.caf.faces.data.ITableContentProvider`)	Provider for exported content
`exportShowEncodingDialog`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to show the character encoding selection dialog before exporting If not specified, the default value is "true".
`filter`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Filter expression
`filterParamName`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of request parameter that specifies table's filter expression
`first`	`true`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Index of first item in model to display (zero-based) If not specified, the default value is "0".
`firstParamName`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of request parameter that specifies table's first row
`fixedHeight`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True if the table should have a fixed height, based on the number of rows-per-page If not specified, the default value is "false".
`footerClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The CSS class for footer cells
`frame`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the sides of the outer table border for which to draw borders. Valid values are: above below hsides vsides lhs rhs box border void
`headerClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The CSS class for header cells
`id`	`false`	`java.lang.String`	Control identifier
`lang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the language of the enclosed content
`maxOrdinal`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Maximum number of sort ordinals allowed (1=primary only, 2=primary and secondary only, etc.)
`onclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onclick" event handler
`ondblclick`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "ondblclick" event handler
`onkeydown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onkeydown" event handler
`onkeypress`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onkeypress" event handler
`onkeyup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onkeyup" event handler
`onmousedown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onmousedown" event handler
`onmousemove`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onmousemove" event handler
`onmouseout`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onmouseout" event handler
`onmouseover`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onmouseover" event handler
`onmouseup`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onmouseup" event handler
`querySupplied`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.el.ValueBinding`)	Value binding that specifies if a search query has been supplied If not specified, the default value is "#{empty activePageBean.activeSearchQueryString}".
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to render control; false to ignore it If not specified, the default value is "true".
`rowClasses`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A comma separated list of CSS classes for the table rows. The classes are used for the <tr> elements in the order they are listed, repeating the list over all rows in the table.
`rowHeight`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Row height in pixels (ex '20px') or ems (ex '2em')
`rows`	`true`	`javax.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Number of rows to display per page
`rowsParamName`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of request parameter that specifies number of rows for the table to display
`rules`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the interior dividing line display in a table. Valid values are: none groups rows cols all
`selectedRowClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	CSS class name for selected rows
`sortParamName`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of request parameter that specifies table's sort info
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML "style" attribute value
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML "class" attribute value Valid values are: portlet-font portlet-font-dim portlet-msg-status portlet-msg-info portlet-msg-error portlet-msg-alert portlet-msg-success portlet-section-header portlet-section-body portlet-section-alternate portlet-section-selected portlet-section-subheader portlet-section-footer portlet-section-text portlet-form-label portlet-form-input-field portlet-form-button portlet-icon-label portlet-dlg-icon-label portlet-form-field-label portlet-form-field portlet-menu portlet-menu-item portlet-menu-item-selected portlet-menu-item-hover portlet-menu-item-hover-selected portlet-menu-cascade-item portlet-menu-cascade-item-selected portlet-menu-description portlet-menu-caption [any_other_value]
`summary`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Aids accessibility for non-visual browsers by providing a summary of the table's purpose and structure
`title`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML "title" attribute value (often displayed as a tooltip)
`value`	`true`	`javax.el.ValueExpression` (must evaluate to `null`)	Data model
`var`	`true`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of variable reference to the current row object
`width`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the table width in pixels or a percentage of the available width

Search Result Table - caf_h:dataSearchResultTable