Note: For more control information, refer to the CAF control documentation in the webMethods CAF Development Help.
Displays search data model as a table| Info | Value |
|---|---|
| Component Type | com.webmethods.caf.faces.search.SearchResultTable |
| Handler Class | None |
| Renderer Type | javax.faces.Table |
| Description | Displays search data model as a table |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Control identifier |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean)
| True to render control; false to ignore it |
first | true | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Index of first item in model to display (zero-based) |
rows | true | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Number of rows to display per page |
filter | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Filter expression |
var | true | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of variable reference to the current row object |
value | true | javax.el.ValueExpression
(must evaluate to null)
| Data model |
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 |
title | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| HTML "title" attribute value (often displayed as a tooltip) |
dir | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the directionality of the flow of the content for the current element |
lang | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the language of the enclosed content |
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 |
onmousedown | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| JavaScript "onmousedown" event handler |
onmouseup | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| JavaScript "onmouseup" event handler |
onmousemove | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| JavaScript "onmousemove" event handler |
onmouseover | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| JavaScript "onmouseover" event handler |
onmouseout | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| JavaScript "onmouseout" event handler |
onkeypress | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| JavaScript "onkeypress" event handler |
onkeydown | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| JavaScript "onkeydown" event handler |
onkeyup | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| JavaScript "onkeyup" event handler |
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. |
frame | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the sides of the outer table border for which to draw borders. |
rules | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the interior dividing line display in a table. |
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 |
width | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Specifies the table width in pixels or a percentage of the available width |
headerClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| The CSS class for header cells |
footerClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| The CSS class for footer cells |
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. |
columnClasses | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A comma separated list of CSS classes for the table body <td> elements. |
selectedRowClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| CSS class name for selected rows |
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 |
rowHeight | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Row height in pixels (ex '20px') or ems (ex '2em') |
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.) |
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 |
firstParamName | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of request parameter that specifies table's first row |
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 |
sortParamName | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of request parameter that specifies table's sort info |
filterParamName | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of request parameter that specifies table's filter expression |
exportExcludeComponentsCSV | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| CSV of Component IDs that should be excluded when exporting the table data |
exportCharacterEncoding | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Character Encoding for the exported data file |
exportFileName | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| The filename for the exported table data |
exportShowEncodingDialog | false | javax.el.ValueExpression
(must evaluate to boolean)
| True to show the character encoding selection dialog before exporting |
exportProvider | false | javax.el.ValueExpression
(must evaluate to com.webmethods.caf.faces.data.ITableContentProvider)
| Provider for exported content |
querySupplied | false | javax.el.ValueExpression
(must evaluate to javax.faces.el.ValueBinding)
| Value binding that specifies if a search query has been supplied |
dragAndDropColumns | false | javax.el.ValueExpression
(must evaluate to boolean)
| Allow drag-to-resize-columns and drag-to-reorder-columns. |
displayOptions | false | javax.el.ValueExpression
(must evaluate to boolean)
| If true, the 'Options...' button will be rendered to open search results options dialog |
exportButtonAvailable | false | javax.el.ValueExpression
(must evaluate to boolean)
| If true, the 'Export Table..' button will be rendered in the header |
Output generated by Vdldoc View Declaration Language Documentation Generator.