Project Documentation
Foundation

Summary

Tag name: <s:message>
UIComponent class: org.apache.myfaces.custom.inputAjax.HtmlMessage
Tag class: org.apache.myfaces.custom.inputAjax.HtmlMessageTag
Component type: org.apache.myfaces.MessageSandbox
Component family: javax.faces.Message
Renderer type: org.apache.myfaces.MessageSandbox
Renderer class: org.apache.myfaces.custom.inputAjax.HtmlMessageRenderer

MyFaces extension to the standard messages tag: see summaryDetailSeparator attribute

Attributes

Name Type Supports EL? Description
binding org.apache.myfaces.custom.inputAjax.HtmlMessage Only EL Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
detailFormat String Yes If present, instead of rendering the message detail, a MessageFormat with this attribute as pattern is created. The format method of this MessageFormat is called with the message detail as the first argument and the label of the associated component (if any) as the second argument. Example: "The input in field {1} is wrong: {0}"
dir String Yes HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
enabledOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
errorClass String Yes CSS class to be used for messages with severity "ERROR".
errorStyle String Yes CSS style to be used for messages with severity "ERROR".
fatalClass String Yes CSS class to be used for messages with severity "FATAL".
fatalStyle String Yes CSS style to be used for messages with severity "FATAL".
for String Yes The ID of the component whose attached FacesMessage object (if present) should be diplayed by this component.

This is a required property on the component.

forceId boolean No If true, this component will force the use of the specified id when rendering.
forceIdIndex boolean No If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
forceSpan boolean Yes If set to true, an empty span element is rendered. Useful if there is an inputAjax field and the corresponding error message is displayed there.
id String Yes Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view.
infoClass String Yes CSS class to be used for messages with severity "INFO".
infoStyle String Yes CSS style to be used for messages with severity "INFO".
lang String Yes HTML: The base language of this document.
onclick String Yes HTML: Script to be invoked when the element is clicked.
ondblclick String Yes HTML: Script to be invoked when the element is double-clicked.
onkeydown String Yes HTML: Script to be invoked when a key is pressed down over this element.
onkeypress String Yes HTML: Script to be invoked when a key is pressed over this element.
onkeyup String Yes HTML: Script to be invoked when a key is released over this element.
onmousedown String Yes HTML: Script to be invoked when the pointing device is pressed over this element.
onmousemove String Yes HTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseout String Yes HTML: Script to be invoked when the pointing device is moves out of this element.
onmouseover String Yes HTML: Script to be invoked when the pointing device is moved into this element.
onmouseup String Yes HTML: Script to be invoked when the pointing device is released over this element.
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
replaceIdWithLabel boolean Yes If present, all occurrences of the id of the component for which the message is rendered will be replaced by the label. Default: true.
showDetail boolean Yes Specifies whether the detailed information from the message should be shown. Default to true.
showSummary boolean Yes Specifies whether the summary information from the message should be shown. Defaults to false.
style String Yes HTML: CSS styling instructions.
styleClass String Yes The CSS class for this element. Corresponds to the HTML 'class' attribute.
summaryFormat String Yes If present, instead of rendering the message summary, a MessageFormat with this attribute as pattern is created. The format method of this MessageFormat is called with the message summary as the first argument and the label of the associated component (if any) as the second argument. Example: "{0}:"
title String Yes HTML: An advisory title for this element. Often used by the user agent as a tooltip.
tooltip boolean Yes If true, the message summary will be rendered as a tooltip (i.e. HTML title attribute).
visibleOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
warnClass String Yes CSS class to be used for messages with severity "WARN".
warnStyle String Yes CSS style to be used for messages with severity "WARN".