Author: atsebro Date: 2009-09-04 10:18:15 -0400 (Fri, 04 Sep 2009) New Revision: 15463 Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_message.xml branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_messages.xml Log: Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_message.xml =================================================================== --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_message.xml 2009-09-04 13:36:44 UTC (rev 15462) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_message.xml 2009-09-04 14:18:15 UTC (rev 15463) @@ -47,14 +47,17 @@ Besides some extra features: <itemizedlist> <listitem> - <para>auto rerendering after Ajax request without help of <emphasis role="bold"><property>&lt;h:outputPanel&gt;</property></emphasis>;</para> + <para>auto rerendering after Ajax request without help of <emphasis role="bold"><property>&lt;a4j:outputPanel&gt;</property></emphasis>;</para> </listitem> <listitem> <para>providing <code>passed</code> message after validation has been passed (optional);</para> </listitem> <listitem> - <para>possibility to add marker to a message.</para> + <para>possibility to add marker to a message;</para> </listitem> + <listitem> + <para>set of predefined CSS classes for customizing messages appearance.</para> + </listitem> </itemizedlist> </para> <para> @@ -127,23 +130,23 @@ <tbody> <row> <entry>errorMarker</entry> - <entry>Defines pictogram for message with <property>error</property> severity class</entry> + <entry>Defines pictogram for message with <emphasis>error</emphasis> severity class</entry> </row> <row> <entry>fatalMarker</entry> - <entry>Defines pictogram for message with <property>fatal</property> severity class</entry> + <entry>Defines pictogram for message with <emphasis>fatal</emphasis> severity class</entry> </row> <row> <entry>infoMarker</entry> - <entry>Defines pictogram for message with <property>info</property> severity class</entry> + <entry>Defines pictogram for message with <emphasis>info</emphasis> severity class</entry> </row> <row> <entry>passedMarker</entry> - <entry>Defines pictogram if there is no <property>fatal</property>, <property>error</property>, <property>warn</property> or <property>info</property> message</entry> + <entry>Defines pictogram if there is no <emphasis>fatal</emphasis>, <emphasis>error</emphasis>, <emphasis>warn</emphasis> or <emphasis>info</emphasis> message</entry> </row> <row> <entry>warnMarker</entry> - <entry>Defines pictogram for message with <property>warn</property> severity class</entry> + <entry>Defines pictogram for message with <emphasis>warn</emphasis> severity class</entry> </row> </tbody> </tgroup> Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_messages.xml =================================================================== --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_messages.xml 2009-09-04 13:36:44 UTC (rev 15462) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_messages.xml 2009-09-04 14:18:15 UTC (rev 15463) @@ -1,116 +1,70 @@ <section role="NotInToc" id="rich_messages"> <title> - &lt; - rich:messages - &gt; - <emphasis role="since"> - <superscript> available since <emphasis role="version">3.1.0</emphasis> - </superscript> - </emphasis> + &lt;rich:messages&gt; <emphasis role="since"><superscript> available since <emphasis role="version">3.1.0</emphasis></superscript></emphasis> </title> + <section> + <title>Description</title> + <para> + The <emphasis role="bold"><property>&lt;rich:messages&gt;</property></emphasis> component is similar to <emphasis role="bold"><property>&lt;rich:message&gt;</property></emphasis> component but used for rendering all messages for the components. + </para> + <figure> + <title><emphasis role="bold"><property>&lt;rich:messages&gt;</property></emphasis> component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/messages_init.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Key Features</title> + <itemizedlist> + <listitem> + <para>Consists of three parts to be defined optionally: marker (pictogram), label (text message) and header</para> + </listitem> + <listitem> + <para>Provides set of facets for marker customization</para> + </listitem> + <listitem> + <para>Supports tooltip to display extra portion of message</para> + </listitem> + <listitem> + <para>Tracks both traditional and Ajax requests</para> + </listitem> + <listitem> + <para>Customizable look and feel </para> + </listitem> + </itemizedlist> + </section> + <section> - <title>Description</title> - <para>The <emphasis role="bold"> - <property>&lt;rich:messages&gt;</property> - </emphasis> component is similar to <emphasis role="bold"> - <property>&lt;rich:message&gt;</property> - </emphasis> component but used for rendering all messages for the components.</para> - <figure> - <title> - <emphasis role="bold"> - <property>&lt;rich:messages&gt;</property> - </emphasis> component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/messages_init.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section> - <title>Key Features</title> - <itemizedlist> - <listitem> - <para>Highly customizable look and feel</para> - </listitem> - <listitem> - <para>Track both traditional and Ajax based requests</para> - </listitem> - <listitem> - <para>Optional ToolTip to display a detailed part of the messages</para> - </listitem> - <listitem> - <para>Additionally customizable via attributes and facets</para> - </listitem> - <listitem> - <para>Additionally provides of three parts to be optionally defined: marker, label and header</para> - </listitem> - </itemizedlist> - </section> - <section> <title>Details of Usage</title> - <para>The <emphasis role="bold"> - <property>&lt;rich:messages&gt;</property> - </emphasis> component is considered as JSF HTML <emphasis role="bold"> - <property>&lt;h:messages&gt;</property> - </emphasis>, - extended with following features: - <itemizedlist> - <listitem> - <para>Ajax support (the component does not require to be wrapped in <emphasis role="bold"> - <property>&lt;a4j:outputPanel&gt;</property> - </emphasis> in order to be rendered during Ajax requests);</para> - </listitem> - <listitem> - <para>possibilty to add graphical markers (pictograms) to reinforce a message for both "passed" or "failed" states;</para> - </listitem> - <listitem> - <para>set of predefined CSS classes for customizing messages appearance.</para> - </listitem> - </itemizedlist> - </para> - <para>There are two optional parts that could be defined for every message: marker and text label. The set of facets, which can be used for a marker definition, is shown below:</para> - - <table> - <title>Facets</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Facet</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>errorMarker</entry> - <entry>Defines marker for "Error" message severity class</entry> - </row> - <row> - <entry>fatalMarker</entry> - <entry>Defines marker for "Fatal" message severity class</entry> - </row> - <row> - <entry>infoMarker</entry> - <entry>Defines marker for "Info" message severity class</entry> - </row> - <row> - <entry>warnMarker</entry> - <entry>Defines marker for "Warn" message severity class</entry> - </row> - <!--row> - <entry>passedMarker</entry> - <entry>Defines marker if there is no message</entry> - </row--> - </tbody> - </tgroup> - </table> + + <para> + The component has the same behavior as standard <emphasis role="bold"><property>&lt;h:message&gt;</property></emphasis> component. + Besides some extra features: + </para> + <itemizedlist> + <listitem> + <para>auto rerendering after Ajax request without help of <emphasis role="bold"><property>&lt;a4j:outputPanel&gt;</property></emphasis>;</para> + </listitem> + <listitem> + <para>providing <code>passed</code> message after validation has been passed (optional);</para> + </listitem> + <listitem> + <para>possibility to add marker to a message;</para> + </listitem> + <listitem> + <para>set of predefined CSS classes for customizing messages appearance.</para> + </listitem> + </itemizedlist> + + <para>The following example shows different variants of customization of the component.</para> - <para> - <emphasis role="bold">Example:</emphasis> - </para> - <programlisting role="XML">&lt;rich:messages layout="table" tooltip="true" showDetail="false" showSummary="true"&gt; + <programlisting role="XML">&lt;rich:messages layout="table" tooltip="true" showDetail="false" showSummary="true"&gt; &lt;f:facet name="errorMarker"&gt; &lt;h:graphicImage url="/image/error.png"/&gt; &lt;/f:facet&gt; @@ -143,60 +97,61 @@ <tbody> <row> <entry>component-type</entry> - <entry>org.richfaces.component.RichMessages</entry> + <entry>org.richfaces.component.RichMessages</entry> </row> <row> <entry>component-class</entry> - <entry>org.richfaces.component.html.HtmlRichMessages</entry> + <entry>org.richfaces.component.html.HtmlRichMessages</entry> </row> <row> <entry>component-family</entry> - <entry>org.richfaces.component.RichMessages</entry> + <entry>org.richfaces.component.RichMessages</entry> </row> <row> <entry>renderer-type</entry> - <entry>org.richfaces.renderkit.html.HtmlRichMessagesRendere</entry> + <entry>org.richfaces.RichMessagesRenderer</entry> </row> <row> <entry>tag-class</entry> - <entry>org.richfaces.taglib.RichMessagesTag</entry> + <entry>org.richfaces.taglib.RichMessagesTag</entry> </row> </tbody> </tgroup> </table> - <table> - <title>Facets</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Facet</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>errorMarker</entry> - <entry>Defines marker for "Error" message severity class</entry> - </row> - <row> - <entry>fatalMarker</entry> - <entry>Defines marker for "Fatal" message severity class</entry> - </row> - <row> - <entry>infoMarker</entry> - <entry>Defines marker for "Info" message severity class</entry> - </row> - <row> - <entry>warnMarker</entry> - <entry>Defines marker for "Warn" message severity class</entry> - </row> - <!--row> - <entry>passedMarker</entry> - <entry>Defines marker if there is no message</entry> - </row--> - </tbody> - </tgroup> - </table> + + <title>Facets</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Facet</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>errorMarker</entry> + <entry>Defines pictogram for message with <emphasis>error</emphasis> severity class</entry> + </row> + <row> + <entry>fatalMarker</entry> + <entry>Defines pictogram for message with <emphasis>fatal</emphasis> severity class</entry> + </row> + <row> + <entry>infoMarker</entry> + <entry>Defines pictogram for message with <emphasis>info</emphasis> severity class</entry> + </row> + <row> + <entry>passedMarker</entry> + <entry>Defines pictogram if there is no <emphasis>fatal</emphasis>, <emphasis>error</emphasis>, <emphasis>warn</emphasis> or <emphasis>info</emphasis> message</entry> + </row> + <row> + <entry>warnMarker</entry> + <entry>Defines pictogram for message with <emphasis>warn</emphasis> severity class</entry> + </row> + </tbody> + </tgroup> + </table> + <table id="tab_msC"> <title>Classes names that define a component appearance</title> @@ -240,9 +195,9 @@ </section> <section> <title>Relevant Resources Links</title> - <para> - <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/messages.js... the component LiveDemo page</ulink> you can see the example of <emphasis role="bold"> - <property>&lt;rich:messages&gt;</property> - </emphasis> usage and sources for the given example. </para> + <para> + Visit the <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/messages.js... page</ulink> at RichFaces LiveDemo for examples of component usage and their sources. + </para> + </section> </section> \ No newline at end of file