View Source

h2. Overview
_Since 3.3_

The messages component renders all Faces messages, all Faces messages for a specific component, or all Faces messages not associated with any component.

{tip}See the ICEfaces Showcase [Live Demo|http://icefaces-showcase.icesoft.org/showcase.jsf?grp=aceMenu&exp=messagesBean] of this component, complete with source code.{tip}


Styling is done by predefined jQuery classes in theme stylesheets:

# Info: ui-icon-notice w/ ui-state-highlight css
# Warn: ui-icon-info w/ ui-state-highlight css
# Error: ui-icon-alert w/ ui-state-error css
# Fatal: ui-icon-alert w/ ui-state-error css

You can use the style and styleClass attributes to override the styles.

h2. Getting Started
{panel}
{code:xml|borderStyle=dashed}<ace:messages id="allMsgs"/>
{code}
{panel}
h2. Attributes

{tip:title=TagLib Documentation}This section covers attributes involved in the typical use-cases for this component. For reference, the complete taglib documentation for this component is available [here|http://www.icefaces.org/docs/v4_latest/ace/tld/ace/messages.html].{tip}
{panel}
*for*: Identifier of the component for which to render error messages. Leave out or use "@all" to output global messages. To show messages for only those components in the view, use @inView.
{panel}
{panel}
*globalOnly*: Flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered.
{panel}
{panel}
*style*: CSS style(s) to be applied when this component is rendered.
{panel}
{panel}
*styleClass*: Space-separated list of CSS style class(es) to be applied when this element is rendered.
{panel}
h2. Event Listeners

h2. Client Behavior Events

h2. JavaScript API

h4. ICEfaces 3.x

The client side component object is exposed through the global variable name specified in the *widgetVar* attribute.

h4. ICEfaces 4+

The "widgetVar" attribute on the ACE components has been removed in ICEfaces 4 and in its place a new "ice.ace.instance()" client JavaScript object lookup API has been introduced. The reason for this change is to enable lazy-initialization of the ACE component JavaScript objects to improve runtime performance and reduce browser memory use.

{code}var widget = ice.ace.instance('frm:componentId);{code}

{tip}The _ice.ace.instance_ function requires the _full_ client id of the component to be specified, such as "j_idt77:componentId" instead of just "componentId". To reduce the complexity of working with complete IDs with this function it may be preferable in some cases to use {{prependId="false"}} in the enclosing form (e.g. _<h:form prependId="false">_).{tip}

{info}This component doesn't have a client-side API made specifically to be used by application developers. However, the component's internal methods and variables can be accessed in this way, including the underlying jQuery object and objects from underlying Javascript libraries (if applicable), and can be used for whatever purpose a developer might have in mind.
{info}

h2. Keyboard and ARIA Support

The following ARIA roles are supported: alert.

h2. CSS Classes

The following markup represents the basic HTML structure of the component and the CSS classes it uses.

{code:xml}
<!-- Root container -->
<div class="ui-faces-messages ui-widget [user defined classes]" style="[user defined styles]">
<!-- First message -->
<div class="ui-corner-all [ui-state-highlight | ui-state-error]">
<span class="ui-icon ui-icon-info"></span>Message
</div>
<!-- More messages... -->
</div>
{code}
h2. Known Issues

None.

h2. Additional Resources