CAF Html - caf_h

A control that displays a Java applet. The control's value attribute must name the jar containing the applet, or the control's href facet must contain a Portlet URL control that names the jar containing the applet. However, if the applet uses only a single class file, the control's codebase attribute must specify the base URL for the applet's class file.

Name the applet class using the control's code attribute such as MyApplet.class. If the applet is a serialized object, name the applet using the control's object attribute.

Children

UIParameter children specify applet parameters. All other children specify content to display if browser does not support plug-ins.

A client-side script that invokes a server-side action when called by some other client-side code using an asynchronous request. This control must be contained by a standard JavaServer Faces form.

You can download an article and an accompanying code sample describing how to work with the refresh attribute of this control from the Software AG Community website:

• Article: Refreshing Multiple Controls with Async Command Controls in CAF
• Code sample: multi_refresh_sample.zip

Children

Control Parameter children are added as request parameters to the submitted form when the command is invoked.

A client-side script that invokes a server-side action on a timed interval using an asynchronous request. This control must be contained by a standard JavaServer Faces form.

You can download an article and an accompanying code sample describing how to work with the refresh attribute of this control from the Software AG Community website:

• Article: Refreshing Multiple Controls with Async Command Controls in CAF
• Code sample: multi_refresh_sample.zip

Children

Any. Control Parameter children are added as request parameters to the submitted form when the command is invoked.

An icon that exports the contents of a specified table to a syndication feed such as a RSS/Atom. You must contain the Atom Feed Icon in a Form. You must set the Form control's requireSessionToken property to false.

To provide custom content for the export, for example to provide custom feed metadata like title or last updated date, you can bind the Atom Feed Icon control's feedProvider property value to a custom com.webmethods.caf.faces.data.IContentProvider instance, or bind the Atom Feed Icon control's entriesProvider property to a separate com.webmethods.caf.faces.data.ITableContentProvider instance.

An IContentProvider designed for atom feed metadata is the com.webmethods.caf.faces.data.export.AtomFeedExportProvider class. It maps the properties of an existing IContentProvider to a custom set of feed metadata elements or attributes with each element or attribute's content specified using a binding expression.

An ITableContentProvider designed for atom entry metadata is the com.webmethods.caf.faces.data.export.AtomEntriesExportProvider class. It maps the content of an existing ITableContentProvider to a custom set of entry metadata elements or attributes with each element or attribute's content also specified using a binding expression.

The following example demonstrates the creation of an AtomFeedExportProvider and an AtomEntriesExportProvider in custom page bean methods. You bind the properties for which these methods are getters, myAtomFeedProvider and myAtomEntriesProvider to the Atom Feed Icon control's feedProvider and entriesProvider property values.

This example assumes that you have an existing table content provider for the raw table data, accessible using the getMyExistingTableContentProvider() method. The getMyAtomFeedProvider() method creates a map of property name/value pairs for the feed metadata, specifying the standard atom id, title, and author elements, and including a custom newToday property to render as an attribute because its value is a simple String value. Although the AtomFeedExportProvider allows for remapping keys from the feed's original content provider, in this example the content provider is just a static map, so there is no need to do so. The keys are generated with the AtomFeedExportProvider static createDefaultKeys() method performs an identity mapping by mapping each property to itself. You can use this static method to get the default set of keys for a dynamic content-provider, and remap just one or two custom properties, without changing the remaining properties.

The getMyAtomEntriesProvider() method maps the three standard atom entry elements, id, title, and updated, plus two custom properties, priority and priorityName to row data, using binding expressions. You must specify the name of the row variable as the third argument to the AtomEntriesExportProvider constructor. For each atom entry, the content of the entry's id element is generated from the value of the table row's projectId and id properties. The content of the entry's title element is generated from the value of the table row's title property

public IContentProvider getMyAtomFeedProvider() {
   Map feedProperties = new HashMap();
   // standard atom metadata
   feedProperties.put("id", "issues");
   feedProperties.put("title", "Issues");
   feedProperties.put("author", "DevTrack");
   // custom metadata
   feedProperties.put("newToday", getNewToday());
   MapContentProvider feed = new MapContentProvider(feedProperties);
   Map keys = AtomFeedExportProvider.createDefaultKeys(feed,"feed");
   return new AtomFeedExportProvider(feed, keys, "feed"); }
public ITableContentProvider getMyAtomEntriesProvider() {
   ITableContentProvider existingProvider =
      getMyExistingTableContentProvider();
   Map keys = new HashMap(); // standard atom metadata keys.put("id",
   createValueBinding("#{row.projectId}_#{row.id}")); keys.put("title",
   createValueBinding("#{row.title}")); keys.put("updated",
   createValueBinding("#{row.lastModifiedDate}"));
   // custom metadata
   keys.put("priority", createValueBinding("#{row.priorityValue}"));
   keys.put("priorityName", createValueBinding("#{row.priorityName}"));
   return new AtomEntriesExportProvider(existingProvider,keys, "row"); }

This example shows how you might render the atom feed. The export processing handles escaping property values, for example, the Name should be "MWS" value is escaped as Name should be "MWS"):

<?xml version="1.0" encoding="UTF-8"?>
<feed xml:base="http://mws:8585/" xml:lang="en-US"
   xmlns="http://www.w3.org/2005/Atom"
      xmlns:x="http://webmethods.com/caf/faces/data/export/atom/custom"
   x:newToday="2">
   <id>issues</id>
   <title>Issues</title>
   <updated>2007-05-22T21:18:40Z</updated>
   <author>
      <name>DevTrack</name>
   </author>
   <generator uri="http://webmethods.com/caf/faces/data/export/atom"
      version="1.0">webMethods CAF AtomExportBean</generator>
   <entry x:priority="1" x:priorityName="Critical">
      <id>higgins_123</id>
      <title>Nothing Works</title>
      <updated>2007-05-22T21:18:40Z</updated>
   </entry>
   <entry x:priority="3" x:priorityName="Medium">
      <id>higgins_ABC</id>
      <title>Name should be 'MWS'</title>
      <updated>2007-05-22T12:22:33Z</updated>
   </entry>
   <entry x:priority="4" x:priorityName="Low">
      <id>getraer_TLC</id>
      <title>I like monkey</title>
      <updated>2007-03-02T01:12:11Z</updated>
   </entry>
</feed>

To render custom properties such as the newToday feed property and the priority and priorityName entry properties as elements, you can compose their values using Map or IContentProvider objects. Use the content key to indicate if the Map property or the IContentProvider should render as the content of the custom element.

In the following example, the feed's newToday property is built out of a map with the map's content property set to a String value. The feed's newToday property renders as an element with the specified String value as the element's content.

In the following example, the entries' priority property is built out of a map, with the map's content property bound to the current table row's priorityName property, and the map's number property bound to the current table row's priorityValue property. As a result, each entry's priority property renders as an element, with the table row's priorityName property as the entry's priority element's content, and the table row's priorityValue property as the number attribute of the entry's priority element.

public IContentProvider getMyAtomFeedProvider() {
   Map feedProperties = new HashMap();
   // standard atom metadata
   feedProperties.put("id", "issues");
   feedProperties.put("title", "Issues");
   feedProperties.put("author", "DevTrack");
   // custom metadata
   Map newToday = new HashMap();
   newToday.put("content", getNewToday());
   feedProperties.put("newToday", newToday);
   MapContentProvider feed = new MapContentProvider(feedProperties);
   Map keys = AtomFeedExportProvider.createDefaultKeys(feed, "feed");
   return new AtomFeedExportProvider(feed, keys, "feed");
}
public ITableContentProvider getMyAtomEntriesProvider() {
   ITableContentProvider existingProvider =
   getMyExistingTableContentProvider();
   Map keys = new HashMap(); // standard atom metadata keys.put("id",
   createValueBinding("#{row.projectId}_#{row.id}")); keys.put("title",
   createValueBinding("#{row.title}")); keys.put("updated",
   createValueBinding("#{row.lastModifiedDate}"));
   // custom metadata
   Map priority = new HashMap();
   priority.put("content", createValueBinding("#{row.priorityName}"));
   priority.put("number", createValueBinding("#{row.priorityValue}"));
   feedProperties.put("priority", priority);
   return new AtomEntriesExportProvider(existingProvider, keys, "row");}

You could render the atom feed as follows:

<?xml version="1.0" encoding="UTF-8"?>
<feed xml:base="http://mws:8585/" xml:lang="en-US"
   xmlns="http://www.w3.org/2005/Atom"
      xmlns:x="http://webmethods.com/caf/faces/data/export/atom/custom">
      <x:newToday>2</x:newToday>
      <id>issues</id>
      <title>Issues</title>
      <updated>2007-05-22T21:18:40Z</updated>
      <author>
         <name>DevTrack</name>
      </author>
      <generator uri="http://webmethods.com/caf/faces/data/export/atom"
         version="1.0">webMethods CAF AtomExportBean</generator>
      <entry>
         <x:priority number="1">Critical</x:priority>
         <id>higgins_123</id>
         <title>Nothing Works</title>
         <updated>2007-05-22T21:18:40Z</updated>
      </entry>
      <entry>
         <x:priority number="3">Medium</x:priority>
         <id>higgins_ABC</id>
         <title>Name should be 'MWS'</title>
         <updated>2007-05-22T12:22:33Z</updated>
      </entry>
      <entry>
         <x:priority number="4">Low</x:priority>
         <id>getraer_TLC</id>
         <title>I like monkey</title>
         <updated>2007-03-02T01:12:11Z</updated>
      </entry>
</feed>


You can specify a substitute URL for the syndication feed, using this control's feedUrl property. You must manually generate the feed at that location using a servlet.

Using a Feed Reader

When a user attempts to subscribe to a feed generated in this manner, the user's feed reader first must log into My webMethods Server. The user must use a desktop-based feed reader. The user can add a Web-based feed reader when My webMethods Server is accessible outside of the corporate firewall, or when the Web-based feed reader is hosted within the same firewall as My webMethods Server. The user must also configure the feed with My webMethods Server credentials by adding username and password parameters to the feed URL. For example, if the atom feed URL was the following:

http://mws:8585/meta/default/wm_xt_fabricfolder/0000005202?export=atom

The user can add his or her username and password to the URL as in the following:

http://mws:8585/meta/default/wm_xt_fabricfolder/0000005202?export=atom&username=alice&password=alicepassword

Some feed readers also allow specifying authentication credentials directly in the user interface. To enable the feed reader to authenticate the credentials, a system administrator must set the feed�s authentication scheme to use the basic authentication scheme. For more information on setting a page's authentication scheme, see the Portlet URL Script control.

Children

Any. Children are displayed as the icon label, after the icon.

javax.faces.Parameter children are added as request parameters to the link.

com.webmethods.caf.faces.portleturl.PortletUrlScript children can hook into clientside JavaScript events such as onClick.

WARNING: This tag has been deprecated. Replace with an Attachments List control

A control that enables the user to view a list of files, and add or remove files from the list. The list of files is referenced by the control's Attachments Provider property, which must be bound to an instance of com.webmethods.caf.faces.data.attachments.IAttachmentsProvider.

The Attachments Panel also provides the following:

1. An Add Attachments user interface that enables adding multiple attachments.
2. A set of validators to limit the MIME types, file extensions, and maximum file size. You can also create validator messages, along with custom validators for the Attachments Panel control.

To enable drag-and-drop functionality, implement the Attachments List control.

Formats a table containing data in chart form rather than in a table structure.

The data comes from a javax.faces.model.DataModel object. A standard ordered collection list container such as java.util.List is automatically wrapped in an ITableContentProvider container.

The following containers are wrapped automatically:

• java.lang.Object array
• java.util.List

Each item in a table row is mapped to the chart label item or a chart data item. The chart then uses the chart label items and chart data items to render the chart according to the item values.

Specifies the legends for the chart that is displayed in the rendered chart.

This control specifies either the color legend, which is displayed next to the chart, or the column legend for a bar chart, depending on the row or column setting. You can add only a single label column.

A hidden (data-only) column for a table. The content of this hidden column can be accessed using a client-side script.

A table column that displays a scroll bar that pages the table. The best practice is to use the Scrollbar Column with an Async Table that has its clientSideCache property set to true.

A control that draws a link to sort a table by a specified column. This functionality is incorporated automatically by the header in a Standard Column header.

If you add this control to a column's header or footer, you set the column's sort property to the appropriate sort key and click the link to maintain the current form state. If you place the Column Sort Link control in a different location on a page, you must specify the control's for property. To perform form sorting the Column Sort Link control, you must place the control in a command Form.

To enable restful sorting, you must set this target table's sortParamName property to the name of the request parameter from which the target table derives its sort property. For more information, see the Table control.

Children

Any. Children are used as the link's label.

A data table column that automatically limits its content to a single line and to the specified width of the column. Like a Standard Column, the content of the column will be rendered multiple times, one for each row displayed by the table. See the Standard Column control for more information about using columns.

Children

Any.

A client-side script that invokes a server-side action when called by client-side code. This control must be contained by a standard JavaServer Faces form.

Children

Control Parameter children are added as request parameters to the submitted form when the command is invoked.

A link that invokes a server-side action when clicked. This control must be contained by a standard JavaServer Faces form.

Children

Any. Children are displayed as link label after the content of the value property. Control Parameter children are added as request parameters to the submitted form when the link is clicked.

Enables a user to drag a user interface control.

If the move property is set to true, and if the target control is successfully dragged and dropped, and the target's Handle Drop behavior sets the CAF.Draggable.current.result flag to move, the target control's HTML content is removed from the current page. Otherwise, dragging and dropping has no effect on the target control.

The Allow Drag handler is invoked every time a user tries to drag the control with the Custom Drag behavior. The handler is passed two arguments, draggable and event. The draggable argument is the target control's CAF.Draggable object. The event argument is the browser mouse event that precipitates the drag. The handler should return true if the target control is draggable and false if control is not draggable.

A custom HTML element; use UIParameter children to specify attributes.

Children

Any. UIParameter children specify the HTML element's custom attributes.

An icon that adds a row to a table or list. To update the table, you must bind the table to com.webmethods.caf.faces.data.IUpdateableTableContentProvider.. The row is added to a table when the enclosing form is posted to the server and it passes validation.

A table whose content is populated from either a javax.faces.model.DataModel object, or a com.webmethods.caf.faces.data.ITableContentProvider object. For more information, see the Async Table control.

Each item in the list is mapped to a row in the table. Columns are configured by adding column children. With a categorized table, the column with the primary sort, a sort ordinal of 1, is rendered as the category for the group of rows with the same value for the specified column. All other columns are rendered once for each row.

To demonstrate how the Categorized Table differs from a regular Table, consider the following regular Table, which is sorted first by Product, then by Quantity:

The following illustrates the same data as a Categorized Table. Rows with the same value for the Product column are displayed as a category of rows, grouped by the Product column value:

The Async Table pages and sorts using asynchronous requests. For more information, see the Async Table control.

Children

javax.faces.Column, Basic Column control

An asynchronous list box control with content that comes from a com.webmethods.caf.faces.data.ITableContentProvider object.

Standard list-like containers are wrapped automatically as an ITableContentProvider. The following containers are wrapped automatically:

• java.lang.Object array
• java.util.List
• javax.sql.rowset.CachedRowset

Each item in the data model is mapped to a row in the list. The content of the list is rendered multiple times, once for each row displayed. The difference between the async list and a regular list is that the async list pages asynchronously. See the Async Table control (caf_h\dataAsyncTable) for more information about configuring its asynchronous properties.

The suppressInputs property is deprecated, and should not be used. To restrict the controls that are submitted and processed when a control is refreshed, place the control inside of a Disjoint Form control. Only the controls in that disjoint form will be submitted and processed.

Children

Any.

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

A table whose content is populated from either a javax.faces.model.DataModel object, or a com.webmethods.caf.faces.data.ITableContentProvider object.

The Async Table pages and sorts using asynchronous requests. When the Async Table control's clientSideCache property is set to true, the table caches rows that it has retrieved from the server until the page is refreshed, or the table or a parent of the table is refreshed. You can refresh the Async Table using the refresh() method of its client-side model. You can also use the Refresh Interval control to refresh the table on a timed basis.

You can configure the Async Table to buffer in its cache rows on either side of the visible page. When the bufferMin and bufferMax properties are set to positive integers, the table ensures that at least the bufferMin number of rows are cached on either side of the visible page.

• If the minimum number of rows is not buffered, the Async Table control retrieves the bufferMax number of rows on either side of the visible page to store in the cache.
• If the bufferChunk property is set to zero (0), the Async Table control retrieves the rows as one group.
• If the bufferChunk property is set to a positive integer, the Async Table control uses multiple asynchronous requests to retrieve the specific number of rows set in the bufferChunk property

For example, an Async Table has the following property settings:

    clientSideCache=true
    bufferMin=10
    bufferMax=100
    bufferChunk=0


In this example, the Async Table displays rows 1 through 10 of 1000. When the page is rendered initially, the Async Table displays rows 1 - 10, and buffer rows 11 - 110. If the user pages forward to rows 91 - 100, these rows are in the client-side cache, and the user can display the rows immediately without an additional request. If the user pages forward to rows 101 - 110, these rows are also in the client-side cache, and the user can see the rows immediately. However, the buffer now contains less than 10 rows on the next side of the visible page. The buffer contains zero rows, so the Async Table must request rows 111 - 210. If the user jumps to rows 991 - 1000, these rows are not in the client-side cache and neither are the previous 10 rows. This requires that the Async Table send a request for the rows 891 - 1000, displaying the last 10 rows in the table, and buffering the previous 100 rows.

In this second example, the Async Table has the following property settings:

    clientSideCache=true
    bufferMin=50
    bufferMax=50
    bufferChunk=10


In this second example, the Async Table displays rows 1 - 10 of 1000. When the page is rendered initially, the Async Table displays rows 1 - 10. As the Async Table waits for the user to do something, it makes 5 asynchronous requests, each for 10 more rows, buffering 50 rows on the next side of the cache. If the user pages forward to rows 11 - 20, these rows are available in the client-side cache and can display immediately without an additional request. However, the buffer contains less than 50 rows on the next side of the visible page. The buffer contains the next 40 rows. The Async Table must request rows 61 - 70. If the user jumps to rows 991 - 1000, these rows are not in the client-side cache. The Async Table must request rows 991 - 1000 to display the requested rows. The Async Table makes 5 more asynchronous requests, each retrieving 10 more previous rows, bringing the buffer up to 50 on the previous side of the cache.

Children

javax.faces.Column, Basic Column control

A tree populated with content from a com.webmethods.caf.faces.data.tree.ITreeContentProvider object. An ITreeContentProvider presents a flattened view of the tree, iterating over the tree structure in depth-first order. The Async Tree control differs from the standard Tree control in that the Async Tree control initially displays only a small portion of the tree and uses asynchronous requests to display other portions as a user expands nodes on the client.

LazyNodeTreeContentProvider

For large trees, use the LazyNodeTreeContentProvider, which is designed to access a tree's nodes only as needed, making it suitable for use with a data source that would normally require many queries to construct the full tree.

To use the LazyNodeTreeContentProvider, you must:

• Expose your data as a tree of com.webmethods.caf.faces.data.tree.INode objects.
• Configure your INode implementation to call the getChildren() method to confirm whether the node has children or not. If the node has children, a "+" icon is added to the node in the user interface. Lazy loading is still applied, as the method does not work recursively down the tree.

If the node has children, they are loaded when the user expands the node in the user interface. As a result, only a relatively small number of the tree nodes must load their children in a large data tree.

You can initialize the LazyNodeTreeContentProvider with a list of root nodes or with a single root node. You can configure the initial state of the LazyNodeTreeContentProvider to a certain depth by using its setOpenToDepth() method, where 0 indicates completely closed, 1 indicates show children, 2 indicates show children and grandchildren. For example:

INode root = new MyNodeImpl("my root info");
ITreeContentProvider tree = new LazyNodeTreeContentProvider(root);
tree.setOpenToDepth(1);


Columns and Rows

Just like the Table control, columns can be added to the Tree control to display content for each tree row. Table columns (including special columns, like Select Row columns) work in Trees exactly the same as they do in Tables. Additionally, special tree-specific Tree Toggle column controls enable users to expand and collapse tree rows. It is recommended that each tree include a Tree Toggle control.

You can sort columns by specifying a key in the column's sort property value. For more information, see the Standard Column control.

Asynchronous Properties

Use the Async Tree control's initialDepth, progressDelay, progressFlashOnComplete, progressMsg, refillDepth, refreshOnShow, and suppressInputs attributes to customize the tree's asynchronous behavior.

• Use the initialDepth property to set the number of tree nodes loaded the first time on the client.

  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.

• Use the refillDepth property to determine how many levels of nodes are loaded when the user tries to expand a node, and the node's children are not available on the client.

  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

A table whose content is populated from a javax.faces.model.DataModel or a com.webmethods.caf.faces.data.ITableContentProvider object. Standard list-like containers such as java.util.List are wrapped automatically as an ITableContentProvider. The following containers are wrapped automatically:

• java.lang.Object array
• java.util.List
• javax.sql.rowset.CachedRowset

Each item in the list is mapped to a row in the table. Columns are configured by adding column children. With a categorized table, the column with the primary sort, a sort ordinal of 1, is rendered as the category for the group of rows that have the same value for that column. All other columns are rendered once for each row.

To demonstrate how a Categorized Table differs from a regular Table, consider the following regular Table, which is sorted first by Product, then by Quantity:

The following illustrates the same data as a Categorized Table. Rows with the same value for the Product column are displayed as a category of rows, grouped by the Product column value:

Children

javax.faces.Column, Standard Column control

Specifies a control that traverses a com.webmethods.caf.faces.data.ITableContentProvider object displaying the control's content for each row in the provider.

Standard list-like containers are wrapped automatically as an ITableContentProvider. The following containers are wrapped automatically:

• java.lang.Object array
• java.util.List
• javax.sql.rowset.CachedRowset

Each item in the data model is mapped to a row in the list. The content of the list is rendered multiple times, once for each row displayed. The difference between the async list and a regular list is that the async list pages asynchronously. See the Async Table control (caf_h\dataAsyncTable) for more information about configuring its asynchronous properties.

To enable restful paging, you must set the list's firstParamName property to the name of the request parameter from which the list derives its first property. For example, conider a case where the list binds the myFirst request parameter to its first property, where an example URL is /myTable?myFirst=10. Using a value binding expression, #{param.myFirst}, you would set the value of the list's firstParamName property to "myFirst". Note that to bind the value of a request parameter to the list's first property, you must manually convert the request parameter value to a primitive int (see the getMyFirst() method below). The list does not need to be contained within a Command Form to do restful paging.

To enable restful page sizing, you must set the list's rowsParamName property to the name of the request parameter from which the list derives its rows property. For example, if the list binds the myRows request parameter to its rows property, where an example URL might be /myTable?myRows=10, you would set the value of the list's rowsParamName property to "myRows". To bind the value of a request parameter to the list's rows property, you must manually convert the request parameter value to a primitive int, see the getMyRows() method below for an example. The list does not need to be contained within a Command Form to do restful paging.

// Convert "myFirst" request parameter to a primitive int.
public int getMyFirst() {
   FacesContext context = FacesContext.getCurrentInstance();
   String s = (String) context.getExternalContext().getRequestParameterMap().get("myFirst");
   if (s != null)
      return Integer.parseInt(s);
   return 0;
}

// Convert "myRows" request parameter to a primitive int.
public int getMyRows() {
   FacesContext context = FacesContext.getCurrentInstance();
   String s = (String) context.getExternalContext().getRequestParameterMap().get("myRows");
   if (s != null)
      return Integer.parseInt(s);
   return 10;
}


Children

Any.

A button that moves the selected row or rows down one row in a table or list. You must bind the table or list to a com.webmethods.caf.faces.data.IReorderableTableContentProvider. The row is added to a table when the enclosing form is posted to the server and it passes validation.

Children

Any. Children are displayed as button label after the value of the label property.

A link that moves the selected row or rows down one row in a table or list. You must bind the table or list to a com.webmethods.caf.faces.data.IReorderableTableContentProvider. The row is added to a table when the enclosing form is posted to the server and it passes validation.

Children

Any. Children are displayed as link label after the value of the label property.

An icon that moves the selected row or rows up one row in a table or list. You must bind the table or list to a com.webmethods.caf.faces.data.IReorderableTableContentProvider. The row is added to a table when the enclosing form is posted to the server and it passes validation.

A control that draws page numbers as links, such as pages 1...12 13 14 15 16 17 18 19...100, which enable a user to jump higher numbered pages or lower number pages.

When you put the Data Pages control in a table's header or footer, form paging is enabled. Click a link to maintain the current form state. If you place this control in a different location on a page, you must specify the control's for property. This control must be contained within a command Form to do "form" paging.

To enable "restful" paging, you must set this target table's firstParamName property to the name of the request parameter from which the target table derives its first property. For more information, see the Table control.

A button that removes a row from a table or list. You must bind the table or list to a com.webmethods.caf.faces.data.IUpdateableTableContentProvider. The row is removed from a table when the enclosing form is posted to the server and it passes validation.

Children

Any. Children are displayed as button label after the value of the label property.

A link that removes a row from a table or list. You must bind the table or list to a com.webmethods.caf.faces.data.IUpdateableTableContentProvider. The row is removed from a table when the enclosing form is posted to the server and it passes validation.

Children

Any. Children are displayed as link label after the value of the label property.

A search result tree control that encapsulates the My webMethods Server search result tree look-and-feel.

You can use the Search Result Tree control in any generic application. In Composite Application Framework, the Search Result Tree is used in the Search Results portlet of a Search portlet application project. The search bar and search results portlets are connected 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

A check box that selects all rows or clears all selected rows in the table's visible page. You must implement the com.webmethods.caf.faces.data.ISelectableTableContentProvider interface to enable user row selection. The ISelectableTableContentProvider interface enables two states for table rows, selected or unselected. In selected state, specified rows are selected explicitly. In unselected state, all rows are implicitly selected, and only specified rows are unselected.

A link that toggles the selection mode of the containing row in a table. To enable users to select rows, the table's content provider must implement the com.webmethods.caf.faces.data.ISelectableTableContentProvider interface. This interface enables selecting rows in selected or unselected mode. In selected mode, the user must explicitly select a set of rows. In the unselected mode, all rows are implicitly selected and only specified rows are unselected.

You can disable links on a per-row basis by supplying a binding expression for the disabled property.

Children

Any. Children are displayed as a link label after the value of the label property.

A check box with four states for selecting the containing row in a tree. The four check box states are off, on, mixed-off, and mixed-on. Changing the selection state of descendant rows toggles only the mixed state of a row. For example, when all descendants of a selected row are deselected, the selected row remains selected. The user can select individual rows independent of the state of their descendants. You can disable check boxes on a per-row basis by supplying a binding expression for the disabled property.

To enable selecting rows, the tree's content provider must implement the com.webmethods.caf.faces.data.ISelectableTableContentProvide interface. The interface enables selecting rows that are in selected or unselected mode. In selected mode, specified rows are selected explicitly. In unselected mode, all rows are implicitly selected, and only specified rows are unselected. The tree's content provider might implement the com.webmethods.caf.faces.data.tree.ISelectableTreeContentProvider interface that enables the content provider to optimize mixed state calculations.

A list control with content that comes from a com.webmethods.caf.faces.data.ITableContentProvider object.

Standard list-like containers are wrapped automatically as an ITableContentProvider. The following containers are wrapped automatically:

• java.lang.Object array
• java.util.List
• javax.sql.rowset.CachedRowset

Each item in the data model is mapped to a row in the list. The content of the list is rendered multiple times, once for each row displayed. The difference between the async list and a regular list is that the async list pages asynchronously. See the Async Table control (caf_h\dataAsyncTable) for more information about configuring its asynchronous properties.

To enable restful paging, you must set the list's firstParamName property to the name of the request parameter from which the list derives its first property. For example, consider a case where the list binds the myFirst request parameter to its first property, where an example URL is /myTable?myFirst=10. Using a value binding expression, #{param.myFirst}, you would set the value of the list's firstParamName property to "myFirst". Note that to bind the value of a request parameter to the list's first property, you must manually convert the request parameter value to a primitive int (see the getMyFirst() method below). The list does not need to be contained within a Command Form to do restful paging.

To enable restful page sizing, you must set the list's rowsParamName property to the name of the request parameter from which the list derives its rows property. For example, if the list binds the myRows request parameter to its rows property, where an example URL might be /myTable?myRows=10, you would set the value of the list's rowsParamName property to "myRows". To bind the value of a request parameter to the list's rows property, you must manually convert the request parameter value to a primitive int, see the getMyRows() method below for an example. The list does not need to be contained within a Command Form to do restful paging.

// Convert "myFirst" request parameter to a primitive int.
public int getMyFirst() {
   FacesContext context = FacesContext.getCurrentInstance();
   String s = (String) context.getExternalContext().getRequestParameterMap().get("myFirst");
   if (s != null)
      return Integer.parseInt(s);
   return 0;
}

// Convert "myRows" request parameter to a primitive int.
public int getMyRows() {
   FacesContext context = FacesContext.getCurrentInstance();
   String s = (String) context.getExternalContext().getRequestParameterMap().get("myRows");
   if (s != null)
      return Integer.parseInt(s);
   return 10;
}


• The marker attribute does not apply to "ol" or "ul" types. Supported values can be a selection from the drop-down list on the Display tab in the control's Properties view, or any raw html string. Default is no marker.
• The layout attribute supported values can be selected from the drop-down list on the Display tab in the control's Properties view. Default is vertical.

Children

Any.

A list of tabs loaded with content from a com.webmethods.caf.faces.data.ITableContentProvider object. For information about data types and restful paging, see the Simple List control (caf_h\dataSimpleList).

Children

Any.

A table that displays the number of selected rows in the table.

If you drop this control into a table's header or footer, you need to do nothing else. If you place this control elsewhere on a page, you must specify the control's for property.

A special tree column that allows the user to toggle tree rows expanded and collapsed. The Tree Toggle control enables content. The tree renders the content of the column multiple times, once for each row displayed by the tree. The control's header facet automatically incorporates the functionality of the Column Sort Link control.

The control also optionally specifies the sorting behavior for the column. For more information, see the Standard Column control.

Children

Any.

Enables a user to add, remove, copy, or reorder the rows in a table by dragging the rows to perform the action.

If the Reorder attribute is set to true, the com.webmethods.caf.faces.data.IReorderableTableContentProvider interface for the target table's content provider is used to persist the new row order. The new row ordering is not sent to the server until the table's enclosing form is posted to the server after passing validation.

If the Add or Remove attributes are set to true, the target table's interface content-provider com.webmethods.caf.faces.data.IUpdateableTableContentProvider is used to persist the changes. The updated table information is not sent to the server until the table's enclosing form is posted to the server after passing validation.

If the Copy attribute is set to true and the Remove attribute is set to false, dragging a row from one table to a destination table adds a new row to the other table, without removing the original row from the first table. The destination table must have the Add attribute set to true. If the Remove attribute is set to true, the Copy attribute is ignored and dragging a row from one table to another removes the original row from the first table.

To populate the controls of a newly added row, the Drag to Move Rows behavior copies the value of controls with the same local ID from the dropped row into the new row.

For more information about adding, removing, and reordering rows, see "CAF.Table.Row.Model" in the CAF Development Help.

To customize Drag to Move Rows behavior, you can specify custom JavaScript code to execute when:

• The user starts dragging a row which initiates the allowDrag handler.
• The user drags a row over the table which initiates the allowDrop handler.
• The user drops a row on the table which initiates the handleDrop handler.

The allowDrag handler is invoked every time a user tries to drag a row in this behavior's target table. It is passed two arguments, draggable and event. The draggable argument is the dragged row's CAF.Draggable object; the event argument is the browser mouse event that precipitates the drag. The handler should return true if the row if draggable is enabled, and false if dragging is not enabled.

The allowDrop handler is invoked every time a user tries to drag a row over the Drag to Move Rows target table's boundaries. allowDrop is passed two arguments, src and dst. The src argument is the dragged HTML element, which is a container for a temporary copy of the original row element in a temporary table. The dst argument is the HTML drop-target element, which is a container for the target table. The handler should return true if the row can be dropped and false if it cannot.

If the allowDrop handler returned true or was not specified, the handleDrop handler is invoked every time a user tries to drop a row on the Drag to Move Rows behavior's target table. It is passed two arguments: src and dst. The src argument is the dragged HTML element, which is a container for a temporary copy of the original row element, into a temporary table. The dst argument is the HTML drop-target element, which is a container for the target table.

The handler should return true if it fully handled the drop, and false to allow the default handleDrop processing to execute when the dropped row is from another table. If add is allowed to create a new row and copy the values of controls with the same local ID from the original dropped row to the new row; and when the dropped row is from the same table and reorder is allowed, to move the row to its new location.

For more information, see "CAF.Draggable Class" in the CAF Development Help.

Enables the user to resize a target control by dragging the target control's edges. Changes to the size of the control are not persisted.

If the target control is a table, resizing the vertical size of the table changes the number of rows-per-page displayed by the table. Use an Async Table with the clientSideCache attribute set to true (enables lazy loading).

Displays a Flash movie (SWF file). The control's value attribute must specify the movie source, or the control's href facet must contain a Portlet Url control that specifies the movie source.

You must specify the height and width values for the SWF file in the default view.

Children

UIParameter children specify movie parameters. All other children specify content to display if the browser does not have the minimum required version of the Flash Player installed (alternate content).

Displays a message (such as validation messages) associated with a specific control with a fixed, specialized look-and-feel.

Displays the value of this control as formatted plain text. Preserves plain-text formatting (for example, newlines, tabs, and spaces).

A Google map. To use this control, you must configure the control's key property with a valid Google Maps API key. For more information, see Google Maps API Family. When registering a key, you must specify the host name and port number of the server. Use the host name and port number the user can see in the browser address bar when accessing the portlet or Web application. For example, if the user accesses the application using http://mws.example.com/, you need to use http://mws.example.com/ when registering for a key.

If the map is not rendered during the initial page load, that is, if the map is rendered only as part of an async refresh and not as part of the initial page, you must include a Google Map Key control as part of the initial page, configured with the Google Maps API key. Otherwise, you can ignore the Google Map Key control.

The center of the map is specified using the latitude and longitude property values. You can also specify the center of the map as follows:

• The map's initialAddress property, if the latitude and longitude are both set to 0. You can format the address as a natural-language address; you can concatenate multiple lines into a single line with spaces, for example, 600 108th Ave NE, Bellevue, WA 98004 USA. You can specify a two-letter ISO-3166 country code using the initialCountry property as a country/locale hint, though it is generally not needed.
• Auto-centering among the map's initial markers, if the map's latitude and longitude are both set to 0, its initialAddress is blank, and the map has markers.

You can add a variety of controls to the Google Map control:

• Use the Map Navigation Control to add map navigation controls such as a zoom control, and a map type control.
• Use Map Marker children of a Map Marker Group control to add individual markers to the map.
• Use a Dynamic Map Marker List control to add a list of markers from a dynamic data source such as an array of rows from a SQL result set or an array of items from a Web service result to the map.

Scripting

The Google Maps API is a full-featured, client-side JavaScript API, and is fully accessible for use with the CAF Google Maps controls.

To access the GMap2 object, the Google Maps API map object, associated with a Google Map control, use the map property of the control's CAF client-side model object. The following example looks up the GMap2 object of the Google Map control model with an ID of myMap, and uses the Google Maps API to zoom in one level:

var map = CAF.model("#{caf:cid("myMap")}").map;
map.zoomIn();

Client-Side Model

The CAF client-side model object for the Google Map control extends from the CAF.Input.Model object. For more information, see information about the client-side model see "Client-Side Model" in the webMethods CAF Development Help.

The value of the model object is the coordinates of the map's center in String form, for example, 37.0625;-95.67706. The following script centers a Google Map control with an ID of myMap over the city of Bellevue, Washington:

CAF.model("#{caf:cid("myMap")}")
     .setValue("37.0625;-95.677068");

The CAF.GMap.stringToGLatLng() and CAF.GMap.gLatLngToString() functions convert string coordinates to and from a GLatLng object, the Google Maps API coordinates object.

You can also use the CAF client-side model to set a map's center with a natural-language address. The following script centers a Google Map control with an ID of myMap over the city of Bellevue, Washington:

CAF.model("#{caf:cid("myMap")}")
     .setAddress("600 108th Ave NE, Bellevue, WA 98004");

You can also auto-center a map among the map's markers with the client-side model's autoCenter() method. The following script centers a Google Map control with an ID of myMap among the markers on the map:

CAF.model("#{caf:cid("myMap")}").autoCenter(true);

Pass a value of true to the autoCenter() method to automatically zoom so that all markers on the map are visible; pass a value of false or nothing to auto-center without changing the zoom level.

Script Controls

You can also use the standard Script-category controls like Return Value Script or Invoke Script to manipulate the map with the standard client-side actions, such as getValue or setValue. You can also use the custom Return Map Value Script and Invoke Map Script controls to access special map-only properties and actions, such as getLatitude or setAddress. The Return Map Coords Script control enables specifying the latitude and longitude coordinates when invoking the setValue or setCoords action.

Children

Map Navigation control, Dynamic Map Marker List control, Map Marker Group control, or Invoke Map Script control

A control that connects a standard client-side JavaScript control-model action to a parent control's (or specified for control's) client-side event. The following standard actions are available:

• raise actuates the command control specified by the control property
• setDisabled enables or disables the input control specified by the control property, based on the value of the value property or value facet; true to disable, false to enable.
• setValue sets the value of the control specified by the control property to the value of the value property or value facet.
• setVisible shows or hides the control specified by the control property, based on the value of the value property or value facet; true to show, false to hide.
• toggle shows the control specified by the control property if the control is hidden, hides the control specified by the control property if the control is visible.

In addition, the following map-specific actions are available:

• setCoords: (map or marker) sets the map's center or the marker's location to the specified string coordinate pair, for example, "37.0625;-95.677068".
• setAddress: (map or marker) sets the map's center or the marker's location to the specified natural-language address, for example, "600 108th Ave NE Bellevue, WA 98004".
• setZoom: (map-only) sets the map's zoom level to a number between 1 (whole world) and about 20 (city block).
• setMapType: (map-only) sets the map-type to either G_NORMAL_MAP, G_SATELLITE_MAP, or G_HYBRID_MAP.
• autoCenter: (map-only) centers the map among the map's markers.
• autoZoom: (map-only) zooms the map to fit the map's markers.
• setLabel: (marker-only) sets the marker's ToolTip to the specified value.
• setDescription: (marker-only) sets the contents of the marker's information (bubble) window to the specified value.
• showInfoWindow: (marker-only) opens the marker's information (bubble) window.
• hideInfoWindow: (marker-only) closes the marker's information (bubble) window.

You can nest other script controls inside the value facet of this script control to provide a value for actions that require a value.

Children

The Control Reference control can specify multiple controls to invoke client-side model actions.

An individual marker in a Map Marker Group control. The marker's location is specified using its latitude and longitude property values or using the marker's initialAddress property when the latitude and longitude are both set to 0. You can format the address as a natural-language address with multiple lines concatenated into a single line with spaces, for example, 123 Main Street, Bellevue, WA 98004 USA. You can specify a two-letter SO-3166 country code using the initialCountry property as a country/locale hint.

You can specify the marker's icon using properties such as the icon property. Use the standard Composite Application Framework marker icons by configuring the marker's icon property with the icon name such as red, orange, or yellow. You can also use a custom icon by configuring the icon property with the URL of the icon such as http://maps.google.com/mapfiles/arrow.png. You can configure the marker's selected icon similarly using the selectedImage property.

The content of the marker is used to render the marker's information (bubble) window. A user can click a marker to display its information window, and also to select the marker, if the marker's clickable property is set to true. A user can drag the marker to a new location if the marker's draggable property is set to true.

Scripting

The Google Maps API is a full-featured, client-side JavaScript API, and is fully accessible for use with the CAF Google Maps controls. For more information, refer to Google documenation about Google Maps API.

To access the GMarker object (the Google Maps API marker object) associated with this control, use the getOverlay() method of the control's CAF client-side model object. The following example looks up the GMarker object of the Map Marker control model with an ID of "myMarker", and uses the Google Maps API to hide the marker:

var marker = CAF.model("#{caf:cid("myMarker")}")
   .getOverlay();
marker.hide();

Client-Side Model

The CAF client-side model object for this control extends from the CAF.Table.Row.Model object. For more information, see information about the client-side model in the webMethods CAF Development Help.

The object's value is the marker's ID. You can get the coordinates of the marker's location, in string form (for example, 37.0625;-95.677068) by using the getCoords() method of the client-side model. The following script gets the coordinates of the marker with an ID of "myMarker":

var coords = CAF.model("#{caf:cid("myMarker")}").getCoords();

The CAF.GMap.stringToGLatLng() and CAF.GMap.gLatLngToString() functions convert string coordinates to and from a GLatLng object (the Google Maps API coordinates object). To set the coordinates, you must change the marker model's coordinates setting using the model's setCoords() method and then update the marker group with the changed marker model using the marker group model's set() method. The following script sets the marker with an ID of "myMarker" in a marker group with an ID of "myMarkerGroup":

CAF.model("#{caf:cid("myMarkerGroup")}")
   .set(CAF.model("#{caf:cid("myMarker")}")
   .setCoords("37.0625;-95.677068"));

You can use the CAF client-side model to set a marker's location with a natural-language address. The following script sets the location of the marker with an ID of "myMap":

CAF.model("#{caf:cid("myMarkerGroup")}")
   .set(CAF.model("#{caf:cid("myMarker")}")
   .setAddress("600 108th Ave NE,
      Bellevue, WA 98004"));

Script Controls

You can use the standard script-type controls like Return Value Script or Invoke Script to manipulate the marker a marker with the standard client-side actions such as getValue. You can also use the custom Return Map Value Script and Invoke Map Script controls to access special map-only properties and actions such as getLatitude or setAddress. Additionally, the Return Map Coords Script control enables specifying the latitude and longitude coordinates when invoking the setValue or setCoords action.

Children

Any. Composite Application Framework renders children as the content of the marker's information, bubble, window.

A control that adds a navigation control to a Google map created using the Google Map control. The following types are supported:

• GSmallMapControl: a condensed set of buttons for navigation and zoom
• GLargeMapControl: full-size navigation and zoom buttons
• GSmallZoomControl: zoom-in and zoom-out buttons
• GScaleControl: a geographic scale indicator
• GMapTypeControl: map-type buttons
• GOverviewMapControl: a mini-map cut-out that displays a zoomed-out version of the main map view

A client-side JavaScript function that returns values to a Google Map control from client-side JavaScript control models. Typical use for this client-side JavaScript is to define value for the following script controls:

• Parameter control
• Invoke Script control
• Invoke Map Script control

The following standard actions are available:

• isDisabled: true if the control is disabled; false if the control is enabled.
• isVisible: true if the control is visible; false if the control is hidden.
• getValue: gets the control's value.

• getCoords: (map or marker) gets the map's center or the marker's location as a string coordinate pair (for example, "37.0625;-95.677068").
• getLatitude: (map or marker) gets the latitude of the map's center or the marker's location as a floating-point number (for example, 37.0625).
• getLongitude: (map or marker) gets the longitude of the map's center or the marker's location as a floating-point number (for example, -95.677068).
• getZoom: (map-only) gets the map's zoom level.
• getMapType: (map-only) gets the map-type.
• getLabel: (marker-only) gets the marker's ToolTip.
• getDescription: (marker-only) gets the contents of the marker's information (bubble) window
• isSelected: (marker-only) true if the marker is selected; false if the marker is not selected.

Children

You can use the Control Reference control to specify multiple controls to get the value of.

Includes the contents of an HTML file into the current page, as specified by the control's value attribute. The value attribute must reference an HTML file in the current Web application, relative to the web application's WebContent directory. For example, the HTML file myfile.html, located in the files subdirectory of the WebContent directory, can be referenced by specifying a value of /files/myfile.html.

If the file is in the current web application and you set the evaluate attribute to true, JSF expressions embedded in the file are evaluated on every request.

Includes an external JavaScript file in the page, as defined in the control's value attribute. Valid values include the URL of an external script file, such as http://mycompany.com/car.js, or when the value property begins with a slash(/), it can reference a JavaScript file in the current Web application, relative to the web application's WebContent directory.

For example, when the file myfile.js script located in the myfolder subdirectory of the WebContent directory, you can reference the script using the value/myfolder/myfile.js. If the script is in the current Web application and you set the evaluate attribute to true, the JSF expressions embedded in the file are evaluated on every request.

A text input control with an auto-complete popup menu. The Autocomplete Text Input control's behavior is equivalent to other single-select controls, such as a Dropdown. Selection options are defined by specifying javax.faces.SelectItem or javax.faces.SelectItems as children of this control. For more information, see the control documentation for the standard JSF controls Option and Option Group.

If the control has a single Option Group bound to a provider that implements com.webmethods.caf.faces.data.IFilterableSelectItemGroupProvider, and the provider's isFilterable() method returns a value of true, filtering the list of auto-complete values is done on the server by the provider, using the provider's filter attribute to sort and select from the collection of items returned by its getSelectItemContentProviders() method. The default ISelectItemGroupProvider, which is com.webmethods.caf.faces.data.object.DefaultSelectItemContentProvider, implements the IFilterableSelectItemGroupProvider. However, the default returns false for the isFilterable()method.

If the control is not bound to a provider that implements IFilterableSelectItemGroupProvider, then auto-completion is done only on the client, using the standard common search keyword rules such as * = wildcard, space = and, quotes = exact phrase.

You can set the default filter for this control using the filter attribute.

You can only use this control in a Form control.

Children

javax.faces.SelectItem (JSF Option control) and javax.faces.SelectItems (JSF Option Group control).

A control that inputs a calendar date range. Define the value property of the Date Range control as a com.webmethods.caf.faces.data.object.DateRange object. A Date Range object has three properties, fixedRange, relativeRange, and date. Use these attributes to specify one of the following:

• A fixed start and end date such as 2000-01-01 to 2000-02-01:
• fixedRange = A period of time in milliseconds
• relativeRange = DateRange.FIXED
• date = A start date, for a positive period of time, or an end date, for a negative period of time.
• A fixed period of time, relative to the current date such as the last thirty days:
• fixedRange = A period of time in milliseconds
• relativeRange = DateRange.FIXED
• date = Null
• A relative period time, relative to the current date such as this month:
• fixedRange = 0
• relativeRange = A period of time (an enumerated value) OR DateRange.FIXED
• date = Null

The Date Range object supports the following relativeRange property values:

• DateRange.FIXED: Not a relative-range, specified in milliseconds by fixedRange property.
• DateRange.THIS_DAY: Midnight this morning to the second before midnight tonight.
• DateRange.PREVIOUS_DAY: Midnight yesterday morning to the second before midnight last night.
• DateRange.NEXT_DAY: Midnight tomorrow morning to the second before midnight tomorrow night.
• DateRange.THIS_WEEK: Midnight on the first morning of the week such as Sunday in the US to the second before midnight on the last night of the week such as Saturday in the US.
• DateRange.PREVIOUS_WEEK: Midnight on the first morning of the previous week such as Sunday in the US to the second before midnight on the last night of the previous week such as Saturday in the US.
• DateRange.NEXT_WEEK: Midnight on the first morning of next week such as Sunday in the US to the second before midnight on the last night of next week such as Saturday in the US.
• DateRange.THIS_MONTH: Midnight on the first of the month to the second before midnight on the last night of the month such as 28th, 29th, 30th, or 31st.
• DateRange.PREVIOUS_MONTH: Midnight on the first of the previous month to the second before midnight on the last night of previous month such as 28th, 29th, 30th, or 31st.
• DateRange.NEXT_MONTH: Midnight on the first of next month to the second before midnight on the last night of next month such as 28th, 29th, 30th, or 31st.
• DateRange.THIS_YEAR: Midnight on January 1 of this year to the second before midnight on December 31 of this year.
• DateRange.PREVIOUS_YEAR: Midnight on January 1 of the previous year to the second before midnight on December 31 of the previous year.
• DateRange.NEXT_YEAR: Midnight on January 1 of next year to the second before midnight on December 31 of next year.

A Date Range object can calculate the appropriate start and end dates for its date-range, using its calculateStart() and calculateEnd() methods. For an infinite range, calculateStart() and calculateEnd() return null. The calculateStart() method is less than or equal to the calculateEnd() returned value.

You can only use this control in a Form control.

Specifies a single-select list box that displays icons and extra-wide titles and descriptions. Selection options are defined by specifying javax.faces.SelectItem or javax.faces.SelectItems as children of this control. For more information, see the control documentation for the standard JSF controls Option and Option Group.

You can only use this control in a Form control.

Children

javax.faces.SelectItem (JSF Option control) and javax.faces.SelectItems (JSF Option Group control).

A standard input control for filtering a specified select or table control. You can only use this control in a Form control.

Select Filtering

The following select controls are filterable:

• Autocomplete Text Input
• Combobox
• Extended Select-Many Listbox
• Extended Select-One Listbox
• Swapbox

Because the Combobox and the Auto-complete Text Input controls enable users to type in an auto-completed value, you should not use these controls with a Filter Input control. However, you could use an IFilterableSelectItemGroupProvider provider with these controls.

If a select control has a single Option Group bound to a provider that implements com.webmethods.caf.faces.data.IFilterableSelectItemGroupProvider, and the provider's isFilterable() method returns a value of true, then the filtering is done on the server, by the provider, using the provider's filter property value to filter the collection of items returned by its getSelectItemContentProviders() method.

The default ISelectItemGroupProvider, which is com.webmethods.caf.faces.data.object.DefaultSelectItemContentProvider, implements IFilterableSelectItemGroupProvider, but by default returns a value of false for the isFilterable()method.

If a select control is not bound to a provider that implements IFilterableSelectItemGroupProvider, the filtering is done on the client, using the standard common search keyword rules such as * = wildcard, space = and, quotes = exact phrase.

Table Filtering

If a table control is bound to com.webmethods.caf.faces.data.IFilterableTableContentProvider, and the provider's isFilterable() method returns a value of true, the filtering is done on the server, by the provider, using the provider's filter property value to filter the rows over which the provider can iterate.

With the default IFilterableTableContentProvider implementations (com.webmethods.caf.faces.data.object.FilterableListTableContentProvider and com.webmethods.caf.faces.data.object.FilterableSelectableListTableContentProvider), you must initialize the provider with a binding expression to use to calculate the value to filter on for each row. For example, you might use a filter value binding of #{row.title} #{row.description} to filter on the title and description fields of each row.

If a table control is not bound to an IFilterableTableContentProvider that is filterable, then filtering is done on the client, over the entire textual content of the row, using the standard common search keyword rules such as * = wildcard, space = and, quotes = exact phrase.

Select and Table Filtering

You can set the default filter for a table or select control by means of the select control's filter property value.

Children

javax.faces.SelectItem (JSF Option control) and javax.faces.SelectItems (JSF Option Group control).

A single-line text input that is displayed like a static text output until clicked by the user. You can only use this control in a Form control.

A simple schedule input control that enables the user to input a date/time interval. Use the com.webmethods.caf.faces.data.object.Schedule object as the value property of this control. The Schedule model allows for an interval of time, expressed by a com.webmethods.rtl.date.DateFields object, plus a relative starting date, defined in the at attribute as a DateFields object.

The DateFields object has the same fields as a java.util.Calendar object, such as Calendar.DAY_OF_YEAR, Calendar.HOUR_OF_DAY, and Calendar.MINUTE. However, unlike the Calendar object, the DateFields object allows setting the fields independently from each other. The parse() and format() methods of DateFields allow the fields to be converted to and from a string representation. For example, the string representation for 5 days is represented as 5D and the string representation for 12:30 AM is 00:30.

You can represent a schedule that executes every 5th day at 12:30 AM using a Schedule object with an interval of 5D and an at attribute of 00:30. You can represent a schedule that executes every 5th day, without a specific start time, by using a Schedule object with an interval of 5D and no at attribute value.

The simple schedule input control enables a user to configure only the day (Calendar.DAY_OF_YEAR or nD), hour (Calendar.HOUR_OF_DAY or hh:00), and minute (Calendar.MINUTE or 00:mm) fields of the schedule interval, and only the hour (Calendar.HOUR_OF_DAY or hh:00) and minute (Calendar.MINUTE or 00:mm) fields of the schedule at attribute.

You can only use this control in a Form control.

A single-line text input. You can only use a Text Input control in a Form control.

Message output for a component. This is an enhanced variation of the standard h:message control.

A control that encapsulates the style and behavior of a modal dialog. A modal dialog forces the user to choose an option in the dialog, usually by clicking a button, before the user can do anything outside of the dialog. Compare to a Modeless Dialog control where the user can perform actions outside the dialog before interacting with the Modeless Dialog control.

The Modal Dialog control is initially hidden. When toggled visible, the Modal dialog disables all other controls on the page until it is changed to hidden.

Like other hideable controls, this control can be toggled between visible and hidden through client-side JavaScript code. Toggle controls encapsulate this code within controls that can be created and configured visually within CAF. For more information, see the topics "Hideable Controls" and "Toggle Controls" in the section "User Interface Controls Concepts" in the webMethods CAF Development Help.

This control has four facets: title, submit, cancel, and other. The last three facets encapsulate the default layout for the submit, cancel, and various other buttons. For example, if you place a cancel button in the cancel facet, and an OK button in the submit facet, by default the modal dialog places the cancel button in the bottom-right corner of the dialog, with the OK button directly to its left. The title facet displays a title for the dialog.

Children

Any. Children of this control are displayed as the dialog's content.

A control that displays the entries of a syndicated feed, Really Simple Syndication (RSS) or Atom syndication format.

A check box that toggles the client-side visibility of a single control, or the server-side rendered property of a single control. For more information, see information about toggle controls in the webMethods CAF Development Help.

For more information about hiding controls, see information about concealable controls in webMethods CAF Development Help.

Children

Any. Children are displayed as a check box label after the content of the value property.

A control that draws a simple HTML button. This control is used to load a URL or to invoke client-side actions using com.webmethods.caf.faces.portleturl.PortletUrlScript children controls.

When used as an alternative to the Link control, loads the URL specified by this control's value parameter. Add the javax.faces.Parameter to parameterized the URL.

Children

Add javax.faces.Parameter children as request parameters to the link.

Use com.webmethods.caf.faces.portleturl.PortletUrlScript children to hook into client-side javascript events such as onclick.

Displays an HTML section header such as heading levels H1-H6. The header's level (1-6) is specified using the control's level attribute. The value attribute specifies the heading text, which is displayed before the control's children (if any).

Children

Command, Graphic, or Output controls (displayed after the text specified in the value attribute).

An icon, wrapped by an optional basic navigation link to a URL specified by the control's value attribute. The URL may be parameterized by adding javax.faces.Parameter children.

Children

Any. Children are displayed as the icon label, after the icon.

javax.faces.Parameter children are added as request parameters to the link.

com.webmethods.caf.faces.portleturl (Portlet URL control) children can be used to hook into client-side JavaScript events such as onClick.

A link to a URL specified by this control's value attribute. The URL may be parameterized by adding javax.faces.Parameter children.

Children

Any. Children are displayed as link label, after value of label property.

javax.faces.Parameter children are added as request parameters to the link.

com.webmethods.caf.faces.portleturl.PortletUrlScript children can hook into client-side javascript events such as onClick.

Defines a variation of the Output Text control that truncates the text at the specified length and appends '...'. The full string is rendered as the title attribute (tooltip) if no title attribute is specified.

Displays contents of the panel in a block-level HTML div element. Controls placed in the left edge facet are rendered and docked to the left edge of the panel. Controls placed in the right edge facet are rendered and docked to the right edge of the panel.

Children

Any.

A block panel that a user can switch from visible to hidden and back to visible. You must use JavaScript code with the toggle controls encapsulated in the code. For more information, see the topics "Hideable Controls" and "Toggle Controls" in the section "User Interface Controls Concepts" in the webMethods CAF Development Help.

Children

Any.

A panel that lays on top of another panel or the entire page when toggled visible using client-side JavaScript. For more information, see the topics "Concealable Controls" and "Toggle Controls" in the CAF Development Help.

Children

Any.

A panel that appears as a pop up when the user clicks a second control. Specify the control that opens the pop up panel in the for attribute.

The suggested value for the CSS Class attribute for this control is portlet-menu. To make a vertical list of links look more like a pop up menu, set the CSS Class to caf-popup-menu.

A label and content container for a form field. Displays its contents on one line with a label and optional extended description, such as on a properties page. If the property-line contains a control that has generated some error or informational messages, the property-line displays those messages.

A block panel with a fixed width or height that scrolls to accommodate overflowing content. You must specify the height to scroll vertically, and the width to scroll horizontally.

A panel that renders only one of its children components. The Stack Panel's value property specifies the ID of the child to render. If child ID is not specified, the first child component is rendered.

Children

Any.

A static grid row, divided by Static Cell control.

Children

Static Cell control

A panel placed around a tabs control that visually merges the set of tabs with the Page Group label directly above them.

A panel that displays a progress indicator.

Raises a specified command when the value of the target control is changed.

An icon that asynchronously refreshes the content of a specified control.

Children

Any. Children are displayed as the icon label (after the icon).

A link that asynchronously refreshes the content of a specified control.

Children

Any. Children are displayed as a link label (after the value of the label attribute).

A control used to specify multiple controls with which the Invoke Script control operates. The Control Reference is specified as a child to the Invoke Script control.

A control that connects a standard client-side JavasScript control-model action to a parent control's or specified for control's client-side event. The following actions are available:

• raise activates the command control specified by the control property.
• setDisabled enables or disables the input control specified by the control property, based on the value of the value property or value facet; true to disable, false to enable.
• setValue sets the value of the control specified by the control property to the value of the value property or value facet.
• setVisible shows or hides the control specified by the control property, based on the value of the value property or value facet; true to show, false to hide.
• toggle shows the control specified by the control property if the control is hidden, hides the control specified by the control property if the control is visible.

Other script controls are nested inside the value facet of this script control to provide a value for actions that require a value.

Children

com.webmethods.caf.faces.script.ControlReference is used to specify multiple controls to invoke a client-side model action. For more information, see the Control Reference control.

Standard Facets

Defines the value used to specify an action returned from another script or defined as a ScriptParameter. Drop the following controls into the value facet:

• com.webmethods.caf.faces.script.ScriptParameter For more information, see the Parameter control.
• com.webmethods.caf.faces.script.CustomScript For more information, see the Custom Script control.
• com.webmethods.caf.faces.script.GetValueScript For more information, see the Return Value Script control.

A control that enables a client-side JavaScript function that returns values from the control client-side model. Usually this script is used to define value for:

• com.webmethods.caf.faces.script.ScriptParameter For more information, see the Parameter control.
• com.webmethods.caf.faces.script.InvokeScript For more information, see the Invoke Script control.

A single radio button. Typically, two or more controls are used together, grouped with the name attribute. The model is java.lang.Boolean (true if checked).

You can only use this control in a Form control.

A multi-select list box. Selection options are defined by specifying javax.faces.SelectItem or javax.faces.SelectItems as children of this control. For more information, see the control documentation for the standard JSF controls Option and Option Group. The control's value attribute (the current selection values) is expressed as an array of values.

You can only use the Select-Many Listbox control in a Form control.

Children

• javax.faces.SelectItem, Option control
• javax.faces.SelectItems, Option Group control)

A single-select combination dropdown and text-input control that enables a user to type a selection value. The control also allows icons and extra-wide titles/descriptions. Selection options are defined by specifying javax.faces.SelectItem or javax.faces.SelectItems as children of this control. For more information, see the control documentation for the standard JSF controls Option and Option Group.

You can only use a Combobox control in a Form control.

Children

• javax.faces.SelectItem, Option control
• javax.faces.SelectItems, JSF Option Group control

A single-select list box that is a standard JavaServer Faces control. The selection options are specified using javax.faces.SelectItem, Option and javax.faces.SelectItems Option Group children.

You can only use the Select-One Listbox control in a Form control.

Children

• javax.faces.SelectItem, Option control
• javax.faces.SelectItems, Option Group control).

Specifies text output that uses the select-one model dialog control. Model options are defined by the following children:

• The Option input control - javax.faces.SelectItem()
• The Option Group input control - javax.faces.SelectItems()

The selected item is the item with a value that matches this control's value attribute. The selected item is the item displayed in the user interface.

A tab control that behaves like a select-one group. Selection options are defined by specifying javax.faces.SelectItem or javax.faces.SelectItems as children of this control. For more information, see the control documentation for the standard JSF controls Option and Option Group.

You can only use this control in a Form control.

Children

javax.faces.SelectItem (JSF Option control) and javax.faces.SelectItems (JSF Option Group control).

Displays messages for specific components, such as validation messages, with a fixed or specialized format.

Web application top-level navigation control and optional second-level and third-level pages as a list of links. If this control's depth property is set to 1, only the toplevel links are displayed. If this control's depth property is set to 2, the top-level links are displayed, and if the current page is one of the top-level pages or a descendent of one of the top-level pages, the children of that top-level page are displayed as the second-level links. If this control's depth property is set to 3, the top-level and second-level links are displayed the same way as a depth of 2, and if the current page is one of the second-level pages or a descendent of one of the second-level pages, the children of that second-level page are displayed as the third-level links.

A button that toggles the client-side visibility of a group of controls, or the server-side rendered property of a group of non-hideable controls. Only the selected control from the group specified in the Toggle Button control's value property is visible. For more information, see information about toggle controls in the webMethods CAF Development Help.

For more information about hiding controls, see information about concealable controls in webMethods CAF Development Help.

The selection options are specified using the javax.faces.SelectItem or javax.faces.SelectItems by value specifying a control ID. For more information, see the Option conrol or the Option Group control.

Children

• javax.faces.SelectItem, Option control
• javax.faces.SelectItems, JSF Option Group control

A Link that toggles the client-side visibility of a group of concealable controls, or the server-side rendered property of a group of non-concealable controls. For more information, see information about toggle controls in webMethods CAF Development Help.

For more information about hiding controls, see information about concealable controls in webMethods CAF Development Help.

Specify the selection options using javax.faces.SelectItem and javax.faces.SelectItems with each value specifying a control ID. Selecting an option whose value does not specify a control ID hides all controls in the group. For more information, see the Option control or the Option Group control.

Children

• javax.faces.SelectItem, Option control
• javax.faces.SelectItems, Option Group control

A Web application top-level navigation control as a list of links. Selecting or hovering over one of the top-level links displays the children of that page as a list of second-level links.

A control with tabs that toggles the client-side visibility of a group of concealable controls, or the server-side rendered property of a group of non-concealable controls. Only the selected control from this group specified by the value property of the Toggle Tabs control is visible. For more information, see information about toggle controls in webMethods CAF Development Help.

For more information about hiding controls, see information about concealable controls in webMethods CAF Development Help.

Specify the selection options using javax.faces.SelectItem and javax.faces.SelectItems with each value specifying a control ID. Selecting an option whose value does not specify a control ID hides all controls in the group. For more information, see the Option control or the Option Group control.

Children

• javax.faces.SelectItem, Option control
• javax.faces.SelectItems, Option Group control