Send your remarks, comments or wishes to doc team
Subject:
Message:
Your name:
Your email:

JBoss.org Community Documentation

- Prev
- Next

## 6.67. < rich:message >

### 6.67.1. Description

The component is used for rendering a single message for a specific component.

Figure 6.185. <rich:message> component

### 6.67.2. Key Features

- Highly customizable look and feel

- Tracking both traditional and Ajax based requests

- Optional toolTip to display the detail portion of the message

- Additionally customizable with attributes and facets

- Additionally provides two parts to be optionally defined: marker and label

Table 6.344. rich : message attributes

Attribute Name | Description
--- | ---
ajaxRendered | Define, must be (or not) content of this component will be included in AJAX response created by parent AJAX Container, even if not forced by reRender list of ajax action. Ignored if component marked to output by some Ajax action component.
binding | The attribute takes a value-binding expression for a component property of a backing bean
errorClass | CSS style class to apply to any message with a severity class of "ERROR"
errorLabelClass | CSS style class to apply to any message label with a severity class of "ERROR"
errorMarkerClass | CSS style class to apply to any message marker with a severity class of "ERROR"
fatalClass | CSS style class to apply to any message with a severity class of "FATAL"
fatalLabelClass | CSS style class to apply to any message label with a severity class of "FATAL"
fatalMarkerClass | CSS style class to apply to any message marker with a severity class of "FATAL"
for | Client identifier of the component for which to display messages
id | Every component may have a unique id that is automatically created if omitted
infoClass | CSS style class to apply to any message with a severity class of "INFO"
infoLabelClass | CSS style class to apply to any message label with a severity class of "INFO"
infoMarkerClass | CSS style class to apply to any message marker with a severity class of "INFO"
labelClass | CSS style class to apply to label
level | A comma-separated list of messages categories which should be displayed. Default value is "ALL".
markerClass | CSS style class to apply to marker
markerStyle | CSS style(s) is/are to be applied to marker when this component is rendered
passedLabel | Attribute should define the label to be displayed when no message appears
rendered | If "false", this component is not rendered
showDetail | Flag indicating whether detailed information of a displayed messages should be included. Default value is "true".
showSummary | Flag indicating whether the summary portion of displayed messages should be included. Default value is "false".
style | The CSS style for message
styleClass | 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
title | Advisory title information about markup elements generated for this component
tooltip | Flag indicating whether the detail portion of the message should be displayed as a tooltip. Default value is "false".
warnClass | CSS style class to apply to any message with a severity class of "WARN"
warnLabelClass | CSS style class to apply to any message label with a severity class of "WARN"
warnMarkerClass | CSS style class to apply any message marker with a severity class of "WARN"

Table 6.345. Component identification parameters

Name | Value
--- | ---
component-type | org.richfaces.component.RichMessage
component-class | org.richfaces.component.html.HtmlRichMessage
component-family | org.richfaces.component.RichMessage
renderer-type | org.richfaces.renderkit.html.RichMessagesHtmlBaseRenderer
tag-class | org.richfaces.taglib.RichMessageTag

### 6.67.3. Creating the Component with a Page Tag

To create the simplest variant of message on a page, use the following syntax:

Example:

    ...

        <rich:message for="id"/>

    ...

### 6.67.4. Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.HtmlRichMessage;

    ...

    HtmlRichMessage myMessage = new HtmlRichMessage();

    ...

### 6.67.5. Details of Usage

The component has the same behavior as standard <h:message> component except next two features:

- It's ajaxRendered. It means that the component is reRendered after Ajax request automatically without outputPanel usage

- The component optionally provides "passed" state which will be shown if no message is displayed

- Provides possibility to add some marker to message. By default a marker element isn't shown

A set of facets which can be used for marker defining:

- "passedMarker" . This facet is provided to allow setting a marker to display if there is no message

- "errorMarker" . This facet is provided to allow setting a marker to display if there is a message with a severity class of "ERROR"

- "fatalMarker" . This facet is provided to allow setting a marker to display if there is a message with a severity class of "FATAL"

- "infoMarker" . This facet is provided to allow setting a marker to display if there is a message with a severity class of "INFO"

- "warnMarker" . This facet is provided to allow setting a marker to display if there is a message with a severity class of "WARN"

The following example shows different variants for component customization. The attribute "passedLabel" is used for definition of the label to display when no message appears. But the message component doesn't appear before the form submission even when state is defined as passed (on initial rendering). Boolean attribute "showSummary" defines possibility to display summary portion of displayed messages. The facets "errorMarker" and "passedMarker" set corresponding images for markers.

Example:

    ...

    <rich:message for="id" passedLabel="No errors" showSummary="true">

          <f:facet name="errorMarker">

                <h:graphicImage url="/image/error.png"/>

          </f:facet>

          <f:facet name="passedMarker">

                <h:graphicImage url="/image/passed.png"/>

          </f:facet>

    </rich:message>

    ...

### 6.67.6. Facets

Table 6.346. Facets

Facet | Description
--- | ---
errorMarker | Redefines the content for the marker if there is message with a severity class of "ERROR"
fatalError | Redefines the content for the marker if there is message with a severity class of "FATAL"
infoError | Redefines the content for the marker if there is message with a severity class of "INFO"
warnError | Redefines the content for the marker if there is message with a severity class of "WARN"
passedError | Redefines the content for the marker if there is no message

### 6.67.7. Look-and-Feel Customization

For skinnability implementation, the components use a style class redefinition method.

There are no skin parameters and default predefined values. To redefine the appearance of all <rich:message> components at once, you should only add to your style sheets style classes used by a <rich:message> component.

### 6.67.8. Definition of Custom Style Classes

On the screenshot there are classes names that define styles for component elements.

Figure 6.186. Classes names

Table 6.347. Classes names that define a component appearance

Class name | Description
--- | ---
rich-message | Defines styles for a wrapper element
rich-message-marker | Defines styles for a marker
rich-message-label | Defines styles for a label

In order to redefine styles for all <rich:message> components on a page using CSS, it's enough to create classes with the same names (possible classes could be found in the tables above) and define necessary properties in them.

Example:

    ...

    .rich-message-label{

        font-style:italic

    }

    ...

This is a result:

Figure 6.187. Redefinition styles with predefined classes

In the example the font style for message was changed.

Also it's possible to change styles of particular <rich:message> component. In this case you should create own style classes and use them in corresponding <rich:message> styleClass attributes. An example is placed below:

Example:

    ...

    .myClass{

        font-weight:bold;

    }

    ...

The "styleClass" attribute for <rich:message> is defined as it's shown in the example below:

Example:

    <rich:message ... styleClass="myClass"/>

This is a result:

Figure 6.188. Redefinition styles with own classes and styleClass attributes

As it could be seen on the picture above, the font weight for message was changed.

### 6.67.9. Relevant Resources Links

Here you can see the example of <rich:message> usage and sources for the given example.

- Prev6.66. < rich:listShuttle >
- Top of page
- Front page
- Next6.68. < rich:messages >