[jboss-cvs] jboss-seam/doc/reference/en/modules ...

[Peter Muir]

  User: pmuir   
  Date: 07/05/04 11:55:27

  Modified:    doc/reference/en/modules  annotations.xml
  Log:
  JBSEAM-1248
  
  Revision  Changes    Path
  1.60      +119 -68   jboss-seam/doc/reference/en/modules/annotations.xml
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: annotations.xml
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/annotations.xml,v
  retrieving revision 1.59
  retrieving revision 1.60
  diff -u -b -r1.59 -r1.60
  --- annotations.xml	4 May 2007 11:31:35 -0000	1.59
  +++ annotations.xml	4 May 2007 15:55:27 -0000	1.60
  @@ -982,7 +982,57 @@
       </section>
   
       <section>
  -        <title>Annotations for use with JSF <literal>dataTable</literal></title>
  +    	<title>Annotations for use with JSF</title>
  +    		<para> 
  +    			The following annotations make working with JSF easier.
  +	        </para>
  +	        
  +	        <variablelist spacing="compact">
  +	            <varlistentry>
  +	                <term>
  +	                    <literal>@Converter</literal>
  +	                </term>
  +	                <listitem>
  +	                    <para>
  +	                    	Allows a Seam component to act as a JSF converter. The annotated class must be a Seam
  +	                    	component, and must implement <literal>javax.faces.convert.Converter</literal>.
  +	                    </para>
  +	                    <itemizedlist>
  +	                        <listitem>
  +	                            <para>
  +	                                <literal>id</literal> &mdash; the JSF converter id. Defaults to the component name.
  +	                            </para>
  +	                        </listitem>
  +	                        <listitem>
  +	                            <para>
  +	                                <literal>forClass</literal> &mdash; if specified, register this component as the default converter for a type.
  +	                            </para>
  +	                        </listitem>
  +	                    </itemizedlist>
  +	                </listitem>
  +	            </varlistentry>
  +	            <varlistentry>
  +	                <term>
  +	                    <literal>@Validator</literal>
  +	                </term>
  +	                <listitem>
  +	                    <para>
  +	                    	Allows a Seam component to act as a JSF validator. The annotated class must be a Seam 
  +	                    	component, and must implement <literal>javax.faces.validator.Validator</literal>.
  +	                    </para>
  +	                    <itemizedlist>
  +	                        <listitem>
  +	                            <para>
  +	                                <literal>id</literal> &mdash; the JSF validator id. Defaults to the component name.
  +	                            </para>
  +	                        </listitem>
  +	                    </itemizedlist>
  +	                </listitem>
  +	            </varlistentry>
  +	        </variablelist>
  +    	
  +    	<section>
  +	        <title>Annotations for use with <literal>dataTable</literal></title>
           <para> The following annotations make it easy to implement clickable lists backed by a stateful session bean.
               They appear on attributes. </para>
   
  @@ -1050,6 +1100,7 @@
           </variablelist>
   
       </section>
  +	</section>
   
       <section>
           <title>Meta-annotations for databinding</title>