A common search result tree control. Encapsulates the standard My webMethods Server search result tree look-and-feel.
You can use the Async Search Result Tree control in any generic portlet application. In Composite Application Framework, the Async Search Result Tree control is used in the Search Results portlet of a Search Bar/Search Result portlet application. A Search Results portlet can be created using the New Portlet wizard, selecting the Search Results Portlet option on the first page of the wizard. The two portlets are connected using wiring. You can wire the portlets using the lastSearchState
property of the Search Bar portlet to the queryString
property of the Search Results portlet.
If you generate a new Search Results portlet with Composite Application Framework, you do not have to add any preferences manually. Preferences are generated automatically for you. For more information, see information about setting preferences for the Search Results portlet in the portlet preferences description in the webMethods CAF Development Help.
When specifying the initialDepth
attribute, use 0 to indicate roots only; 1 to indicate roots and children; 2 to indicate roots, children and grandchildren, etc.
Similarly, when specifying the refillDepth
attribute, use 0 to indicate children only; 1 to indicate children and grandchildren; 2 to indicate children, grandchildren, and great grandchildren, etc.
Children
javax.faces.Column
, Basic Column control
Info | Value |
---|---|
Component Type | com.webmethods.caf.faces.search.AsyncSearchResultTree |
Handler Class | com.webmethods.caf.faces.component.DynamicControlHandler |
Renderer Type | com.webmethods.caf.faces.tree.AsyncTree |
Description | Displays search data model as a tree that loads nodes asynchronously |
Palette Location | CAF Html/Control/Search/Async Search Result Tree |
Client-Side Model | CAF.Tree.Model |
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.String )
| 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.String )
| 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:
|
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". |
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 |
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:
|
headerClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The CSS class for header cells |
id | false | java.lang.String | Control identifier |
initialDepth | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
|
Depth to load initially on the client (0=roots only)
If not specified, the default value is "0". |
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 |
progressDelay | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
|
Milliseconds to wait before showing progress dialog
If not specified, the default value is "0". |
progressFlashOnComplete | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True if panel should flash when asynchronous loading has completed
If not specified, the default value is "true". |
progressMsg | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Progress dialog message; defaults to a localized message, in English "Loading..." |
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}". |
refillDepth | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer )
|
Depth to load when filling-in node children asynchronously (0=children only)
If not specified, the default value is "0". |
refreshOnShow | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to refresh content every time panel is toggled visible. Ignored if Lazy Load is false.
If not specified, the default value is "false". |
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') |
rules | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
|
Specifies the interior dividing line display in a table.
Valid values are:
|
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:
|
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 |
suppressInputs | false | javax.el.ValueExpression
(must evaluate to java.util.Collection )
|
WARNING: This property has been deprecated. Ids of controls on which to disallow update processing while handling asynchronous requestsIf not specified, the default value is "false". |
title | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| HTML "title" attribute value (often displayed as a tooltip) |
value | true | java.lang.String | 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 |
Output generated by Vdldoc View Declaration Language Documentation Generator.