From richfaces-svn-commits at lists.jboss.org Thu Sep 3 13:36:22 2009 Content-Type: multipart/mixed; boundary="===============7870131361700708709==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r15453 - branches/community/3.3.X/docs/userguide/en/src/main/docbook/included. Date: Thu, 03 Sep 2009 13:36:22 -0400 Message-ID: <200909031736.n83HaM5W019572@svn01.web.mwc.hst.phx2.redhat.com> --===============7870131361700708709== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: atsebro Date: 2009-09-03 13:36:22 -0400 (Thu, 03 Sep 2009) New Revision: 15453 Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ric= h_message.xml Log: RF-7756: Rich Miscellaneous component group description review --> rich:mes= sage Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/inclu= ded/rich_message.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ri= ch_message.xml 2009-09-03 15:33:27 UTC (rev 15452) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/ri= ch_message.xml 2009-09-03 17:36:22 UTC (rev 15453) @@ -17,121 +17,104 @@ - -
- Key Features - - - Highly customizable look and feel - - - Tracking both traditional and Ajax based requests - - - Optional toolTip to display the detail portion of the me= ssage - - - Additionally customizable with attributes and facets - - - Additionally provides two parts to be optionally defined= : marker and - label - - -
-
+
+ = +
+ Key Features + + + Consists of two parts to be defined optional= ly: marker (pictogram) and label (text message) + + + Provides set of facets for marker customizat= ion + + + Supports tooltip to display extra portion of= message + + + Tracks both traditional and Ajax requests + + + Customizable look and feel + + +
+ = +
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 reR= endered after Ajax request - automatically without outputPanel usage + + The component has the same behavior as standard <h:message> component. = + Besides some extra features: + + + auto rerendering after Ajax request without = help of <h:outputPanel><= /emphasis>; + + + providing passed message after = validation has been passed (optional); - The component optionally provides "passed" state whic= h will be shown if no message is displayed + possibility to add marker to a message. - - Provides possibility to add some marker to message. B= y default a marker element - isn't shown - - = - - - The following example shows different variants for component = customization. The - attribute - "passedLabel" - is used for definition of the label to display when n= o message - appears. But the message component doesn't appear before the form su= bmission 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: + The <rich:message> appears on page after form is submitted. = + Even for "passed" state. + The "passedLabel" attribute is used for definition of the label when validation is pa= ssed. + Boolean attribute "showSummary" defines possibility to display summary portion of displayed mes= sages. - ... -<rich:message for=3D"id" passedLabel=3D"No errors" showSummary=3D"true"= > + + <rich:message for=3D"id" passe= dLabel=3D"No errors" showSummary=3D"true"> <f:facet name=3D"errorMarker"> <h:graphicImage url=3D"/image/error.png"/> </f:facet> <f:facet name=3D"passedMarker"> <h:graphicImage url=3D"/image/passed.png"/> </f:facet> = -</rich:message> = -... - +</rich:message> =
-
- Reference Data - - Table of = - <rich:message> = - attributes. - - - 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.RichMessagesHtmlBase= Renderer - - - tag-class - org.richfaces.taglib.RichMessageTag - - - -
- + = +
+ Reference Data + + Table of <ri= ch:message> attributes. + + = +
+ Component Identification Parameters + + + + Name + Value + + + + + component-type + org.richfaces.component.RichMes= sage + + + component-class + org.richfaces.component.html.Ht= mlRichMessage + + + component-family + org.richfaces.component.RichMes= sage + + + renderer-type + org.richfaces.RichMessageRender= er + + + tag-class + org.richfaces.taglib.RichMessag= eTag + + + +
+ = Facets @@ -169,48 +152,38 @@ = =
- 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 - - - - + Classes names that define a component appearance + + + + Class name + Description + + + + + rich-message + Defines styles for a wrapper element<= /entry> + + + rich-message-marker + Defines styles for a marker + + + rich-message-label + Defines styles for a label + + +
- You can find all necessary information about style classes redefini= tion in = - Definition of Custom Style Classes = - section. -
+ = + You can find all necessary information about style class= es redefinition in Definition of Custom Styl= e Classes section. + + =
Relevant Resources Links - On the component LiveDemo page you can se= e the example of - <rich:message> - usage and sources for the given example. + Visit the Message page at RichFaces Li= veDemo for examples of component usage and their sources. +
\ No newline at end of file --===============7870131361700708709==--