Tag Documentation

Description:

An icon 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 the icon label after the icon. Control Parameter children are added as request parameters to the submitted form when the icon is clicked.

Component Information
Info	Value
Component Type	`com.webmethods.caf.faces.command.Icon`
Handler Class	None
Renderer Type	`com.webmethods.caf.faces.command.Icon`
Description	Icon that executes an action
Palette Location	`CAF Html/Control/Command/Command Icon`
Client-Side Model	`CAF.Command.Model`

Attributes
Name	Required	Type	Description
`accesskey`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Keyboard shortcut letter
`action`	`false`	`javax.el.MethodExpression` (signature must match `java.lang.String action()`)	Action method binding
`actionListener`	`false`	`javax.el.MethodExpression` (signature must match `void actionListener(javax.faces.event.ActionEvent)`)	Action listener method binding
`alt`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Text to display in place of image, when image cannot be viewed
`charset`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The character encoding of the resource designated by this hyperlink
`coords`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The position and shape of the hot spot on the screen (for use in client-side image maps)
`dir`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the directionality of the flow of the content for the current element Valid values are: LTR RTL
`disabled`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True if control is grayed-out and un-modifiable If not specified, the default value is "false".
`forms`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Id of form to submit (defaults to entire form); separate multiple control ids with commas
`hreflang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The language code of the resource designated by this hyperlink
`id`	`false`	`java.lang.String`	Control identifier
`immediate`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	True to process action listeners in the Apply Request Values phase; false to process in the Invoke Application phase If not specified, the default value is "false".
`lang`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the language of the enclosed content
`onblur`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onblur" event handler
`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
`onfocus`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	JavaScript "onfocus" 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
`rel`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The relationship from the current document to the anchor specified by this hyperlink. The value of this attribute is a space-separated list of link types
`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".
`rev`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A reverse link from the anchor specified by this hyperlink to the current document. The value of this attribute is a space-separated list of link types.
`shape`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The shape of the hot spot on the screen (for use in client-side image maps) Valid values are: default rect circle poly
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML "style" attribute value
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML "class" attribute value Valid values are: portlet-font portlet-font-dim portlet-msg-status portlet-msg-info portlet-msg-error portlet-msg-alert portlet-msg-success portlet-section-header portlet-section-body portlet-section-alternate portlet-section-selected portlet-section-subheader portlet-section-footer portlet-section-text portlet-form-label portlet-form-input-field portlet-form-button portlet-icon-label portlet-dlg-icon-label portlet-form-field-label portlet-form-field portlet-menu portlet-menu-item portlet-menu-item-selected portlet-menu-item-hover portlet-menu-item-hover-selected portlet-menu-cascade-item portlet-menu-cascade-item-selected portlet-menu-description portlet-menu-caption [any_other_value]
`tabindex`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Order in tab (key) sequence, from 1 to n. Zero adds control to tab sequence, negative integer removes control.
`target`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of a frame where the resource retrieved via this hyperlink is to be displayed Valid values are: _blank _self _parent _top [any_other_value]
`title`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML "title" attribute value (often displayed as a tooltip)
`type`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The content type of the resource designated by this hyperlink
`url`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	URL of (base) image source
`urlMousedown`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	(optional) URL of image source to use when mouse is down over image
`urlMouseover`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	(optional) URL of image source to use when mouse is up over image
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	Control value

Command Icon - caf_h:commandIcon