Tagname Description
includeStyles

Renders the necessary CSS stylesheet includes for the Spring Faces components.

Use of this tag in the head section of a page that contains the Spring Faces components is recommended as a browser performance optimization in keeping with the Yahoo performance guidelines. If this tag is not included, the stylesheet includes will be rendered inline with the first instance of a Spring Faces component that requires them.

Attributes:
Name Required Type Description
themefalsejava.lang.String

The dojo theme to include when importing the CSS stylesheets.

This can be either one of the pre-packaged Dojo themes or it can be a completely custom one that follows the necessary Dojo conventions.

themePathfalsejava.lang.String

The path to the Dojo theme to include when importing the CSS stylesheets. Defaults to /dijit/themes/

Note that the theme name will be appended to any specified path. For example, if you have a modified version of the Dojo Tundra theme located at the path /customTheme/tundra/, the proper value of the themePath attribute would be "/customTheme/".

includeScripts

Renders the necessary JavaScript file includes for the Spring Faces components.

Use of this tag in the head section of a page that contains the Spring Faces components is recommended as a browser performance optimization in keeping with the Yahoo performance guidelines. If this tag is not included, the script includes will be rendered inline with the first instance of a Spring Faces component that requires theme.

resource

Renders a resource include that will route through the ResourceServlet .

The included resource can be either CSS or JavaScript. The type of include to render will be determined from the resource's file extension. The ResourceServlet will set the proper response headers for aggressive caching of the resource by the browser and will gzip the resource if the client browser supports it. These optimizations are in line with the Yahoo performance guidelines. See the javadocs of the ResourceServlet for more information.

Attributes:
Name Required Type Description
pathtruejava.lang.String The local path to the resource. This path can be either relative to the root of the web application, or relative to the META-INF directory of a jar file on the classpath. See the javadocs of the ResourceServlet for more detail on the resolution algorithm.
resourceGroup

Renders a special resource include that will combine any child resource includes into one HTTP request.

The child resource components must all be of the same resource type. This is especially useful when combining modularized CSS files for a site. Reducing the number of HTTP requests when a page loads is one of the Yahoo performance guidelines.

clientTextValidator

Applies client-side text validation behavior to a child inputText component.

Attributes:
Name Required Type Description
invalidMessagefalsejava.lang.StringThe message to display if value is invalid.
lowercasefalsebooleanConverts all characters to lowercase if true. Defaults to false.
promptMessagefalsejava.lang.StringA hint message to be displayed to the user when entering the text field.
propercasefalsebooleanConverts the first character of each word to uppercase if true. Defaults to false.
regExpfalsejava.lang.StringJavaScript regular expression string used to validate the input.
requiredfalsebooleanIf true, the field must be non-empty to pass client-side validation.
uppercasefalsebooleanConverts all characters to uppercase if true. Defaults to false.
clientNumberValidator

Applies client-side numeric validation behavior to a child inputText component.

Attributes:
Name Required Type Description
invalidMessagefalsejava.lang.StringThe message to display if value is invalid.
lowercasefalsebooleanConverts all characters to lowercase if true. Defaults to false.
promptMessagefalsejava.lang.StringA hint message to be displayed to the user when entering the text field.
propercasefalsebooleanConverts the first character of each word to uppercase if true. Defaults to false.
rangeMessagefalsejava.lang.StringThe message to display if value is out-of-range.
regExpfalsejava.lang.StringJavaScript regular expression string used to validate the input.
requiredfalsebooleanIf true, the field must be non-empty to pass client-side validation.
uppercasefalsebooleanConverts all characters to uppercase if true. Defaults to false.
clientCurrencyValidator

Applies client-side currency validation behavior to a child inputText component.

Attributes:
Name Required Type Description
currencyfalsejava.lang.StringThe ISO4217 currency code, a three letter sequence like "USD".
invalidMessagefalsejava.lang.StringThe message to display if value is invalid.
lowercasefalsebooleanConverts all characters to lowercase if true. Defaults to false.
promptMessagefalsejava.lang.StringA hint message to be displayed to the user when entering the text field.
propercasefalsebooleanConverts the first character of each word to uppercase if true. Defaults to false.
regExpfalsejava.lang.StringJavaScript regular expression string used to validate the input.
requiredfalsebooleanIf true, the field must be non-empty to pass client-side validation.
uppercasefalsebooleanConverts all characters to uppercase if true. Defaults to false.
clientDateValidator

Applies client-side date validation behavior to a child inputText component. Field will display a popup calendar when entered.

Attributes:
Name Required Type Description
invalidMessagefalsejava.lang.StringThe message to display if value is invalid.
lowercasefalsebooleanConverts all characters to lowercase if true. Defaults to false.
promptMessagefalsejava.lang.StringA hint message to be displayed to the user when entering the text field.
propercasefalseboolean Converts the first character of each word to uppercase if true. Defaults to false.
regExpfalsejava.lang.StringJavaScript regular expression string used to validate the input.
requiredfalsebooleanIf true, the field must be non-empty to pass client-side validation. Defaults to false.
uppercasefalsebooleanConverts all characters to uppercase if true. Defaults to false.
validateAllOnClick

Fires all client-side validators when a child component's onclick event is fired and suppresses propagation of the event if validation fails.

commandButton

Renders a gracefully degrading Ajax submit button.

This button will submit the parent form using an Ajax request by default. The component is progressively enhanced so that the submit will still function with a full page refresh if JavaScript is unavailable on the client.

The processing of the JSF component tree can be customized through use of the processIds attribute. By default only the button itself will be processed during the postback lifecycle.

The content to render is determined on the server side by using a render action in the flow definition that processes the request. When updating the existing page, the rendered content must be a replacement for an existing identifiable DOM node in the page.

The component is capable of driving transitions to another view with an Ajax request. In that case, a client-side redirect to the new view will occur so that browser history and normal back button behavior is still preserved.

Attributes:
Name Required Type Description
action false MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a public method that takes no parameters, and returns an Object (the toString() of which is called to derive the logical outcome) which is passed to the flow definition as the event to be signaled. The most common usage pattern is to supply a literal String and handle any custom processing of the event in the flow definition.
actionListener false MethodExpression representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.
ajaxEnabledfalseboolean Controls whether the button will use an Ajax request or a normal form submit. Default is true.
id false The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediate false boolean Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase. This flag can also be controlled through used of the bind attribute in the corresponding transition element in the flow definition. Setting bind="false" on the transition is equivalent to setting immediate="true"
rendered false boolean Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
value false java.lang.Object The current value of this component. Controls the text that will be displayed on the button.
accesskey false java.lang.String Access key that, when pressed, transfers focus to this element.
alt false java.lang.String Alternate textual description of the element rendered by this component.
binding false javax.faces.component.UIComponent The ValueExpression linking this component to a property in a backing bean
dir false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
disabled false boolean Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled".
image false java.lang.String Absolute or relative URL of the image to be displayed for this button. If specified, this "input" element will be of type "image". Otherwise, it will be of the type specified by the "type" property with a label specified by the "value" property.
label false java.lang.String A localized user presentable name for this component.
lang false java.lang.String Code describing the language used in the generated markup for this component.
onblur false java.lang.String Javascript code executed when this element loses focus.
onchange false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus.
onclick false java.lang.String Javascript code executed when a pointer button is clicked over this element.
ondblclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element.
onfocus false java.lang.String Javascript code executed when this element receives focus.
onkeydown false java.lang.String Javascript code executed when a key is pressed down over this element.
onkeypress false java.lang.String Javascript code executed when a key is pressed and released over this element.
onkeyup false java.lang.String Javascript code executed when a key is released over this element.
onmousedown false java.lang.String Javascript code executed when a pointer button is pressed down over this element.
onmousemove false java.lang.String Javascript code executed when a pointer button is moved within this element.
onmouseout false java.lang.String Javascript code executed when a pointer button is moved away from this element.
onmouseover false java.lang.String Javascript code executed when a pointer button is moved onto this element.
onmouseup false java.lang.String Javascript code executed when a pointer button is released over this element.
onselect false java.lang.String Javascript code executed when text within this element is selected by the user.
processIdsfalsejava.lang.String A comma-delimited list of fully-qualified (i.e., formId:componentId) JSF clientIds for the components that should serve as the root node of a subtree to be processed by the JSF lifecycle. If omitted, only the component itself will be processed. May be set to a special value of "*" if the entire component tree should be processed.
readonly false boolean Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly".
style false java.lang.String CSS style(s) to be applied when this component is rendered.
styleClass false java.lang.String Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
tabindex false java.lang.String Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
title false java.lang.String Advisory title information about markup elements generated for this component.
type false java.lang.String Type of button to create. Valid values are "submit" and "reset". If not specified, or not a valid value, the default value is "submit".
commandLink

Renders a gracefully degrading Ajax link.

This link will submit the parent form using an Ajax request by default. The component is progressively enhanced so that the submit will still function with a full page refresh if JavaScript is unavailable on the client. To achieve this, an HTML button will be rendered initially, and replaced with a JavaScript enhanced link. The button is rendered with a special "progressiveLink" CSS class so that its look can be customized as desired.

The processing of the JSF component tree can be customized through use of the processIds attribute. By default only the button itself will be processed during the postback lifecycle.

The content to render is determined on the server side by using a render action in the flow definition that processes the request. When updating the existing page, the rendered content must be a replacement for an existing identifiable DOM node in the page.

The component is capable of driving transitions to another view with an Ajax request. In that case, a client-side redirect to the new view will occur so that browser history and normal back button behavior is still preserved.

Attributes:
Name Required Type Description
action false MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a public method that takes no parameters, and returns an Object (the toString() of which is called to derive the logical outcome) which is passed to the flow definition as the event to be signaled. The most common usage pattern is to supply a literal String and handle any custom processing of the event in the flow definition.
actionListener false MethodExpression representing an action listener method that will be notified when this component is activated by the user. The expression must evaluate to a public method that takes an ActionEvent parameter, with a return type of void.
ajaxEnabledfalseboolean Controls whether the button will use an Ajax request or a normal form submit. Default is true.
binding false javax.faces.component.UIComponent The ValueExpression linking this component to a property in a backing bean
id false The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediate false boolean Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase. This flag can also be controlled through used of the bind attribute in the corresponding transition element in the flow definition. Setting bind="false" on the transition is equivalent to setting immediate="true"
rendered false boolean Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
value false java.lang.Object The current value of this component.
accesskey false java.lang.String Access key that, when pressed, transfers focus to this element.
charset false java.lang.String The character encoding of the resource designated by this hyperlink.
coords false java.lang.String The position and shape of the hot spot on the screen (for use in client-side image maps).
dir false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).
disabled false boolean Flag indicating that this element must never receive focus or be included in a subsequent submit.
hreflang false java.lang.String The language code of the resource designated by this hyperlink.
lang false java.lang.String Code describing the language used in the generated markup for this component.
onblur false java.lang.String Javascript code executed when this element loses focus.
onclick false java.lang.String Javascript code executed when a pointer button is clicked over this element.
ondblclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element.
onfocus false java.lang.String Javascript code executed when this element receives focus.
onkeydown false java.lang.String Javascript code executed when a key is pressed down over this element.
onkeypress false java.lang.String Javascript code executed when a key is pressed and released over this element.
onkeyup false java.lang.String Javascript code executed when a key is released over this element.
onmousedown false java.lang.String Javascript code executed when a pointer button is pressed down over this element.
onmousemove false java.lang.String Javascript code executed when a pointer button is moved within this element.
onmouseout false java.lang.String Javascript code executed when a pointer button is moved away from this element.
onmouseover false java.lang.String Javascript code executed when a pointer button is moved onto this element.
onmouseup false java.lang.String Javascript code executed when a pointer button is released over this element.
processIdsfalsejava.lang.String A comma-delimited list of fully-qualified (i.e., formId:componentId) JSF clientIds for the components that should serve as the root node of a subtree to be processed by the JSF lifecycle. If omitted, only the component itself will be processed. May be set to a special value of "*" if the entire component tree should be processed.
rel false 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.
rev false 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 java.lang.String The shape of the hot spot on the screen (for use in client-side image maps). Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region).
style false java.lang.String CSS style(s) to be applied when this component is rendered.
styleClass false java.lang.String Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
tabindex false java.lang.String Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
target false java.lang.String Name of a frame where the resource retrieved via this hyperlink is to be displayed.
title false java.lang.String Advisory title information about markup elements generated for this component.
type false java.lang.String The content type of the resource designated by this hyperlink.
ajaxEvent

Creates a JavaScript event listener for one of the child component's events that will trigger an Ajax submit of the parent form.

The installed JavaScript listener will submit the parent form using an Ajax request. This component is purely JavaScript based and should only be used in an environment where the availability of JavaScript on the client is not a concern.

The processing of the JSF component tree can be customized through use of the processIds attribute. By default only the button itself will be processed during the postback lifecycle.

The content to render is determined on the server side by using a render action in the flow definition that processes the request. When updating the existing page, the rendered content must be a replacement for an existing identifiable DOM node in the page.

The component is capable of driving transitions to another view with an Ajax request. In that case, a client-side redirect to the new view will occur so that browser history and normal back button behavior is still preserved.

Attributes:
Name Required Type Description
actionfalse MethodExpression representing the application action to invoke when this component is activated by the user. The expression must evaluate to a public method that takes no parameters, and returns an Object (the toString() of which is called to derive the logical outcome) which is passed to the flow definition as the event to be signaled. The most common usage pattern is to supply a literal String and handle any custom processing of the event in the flow definition.
eventThe event to listen to on the child component that will trigger the Ajax request. For example, event="onchange" will fire an Ajax event when the child component's value changes.
processIdsfalsejava.lang.String A comma-delimited list of fully-qualified (i.e., formId:componentId) JSF clientIds for the components that should serve as the root node of a subtree to be processed by the JSF lifecycle. If omitted, only the component itself will be processed. May be set to a special value of "*" if the entire component tree should be processed.