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

[Peter Muir]

  User: pmuir   
  Date: 07/01/29 19:06:01

  Modified:    doc/reference/en/modules  controls.xml
  Log:
  JBSEAM-709 Add doc for s:selectItems
  
  Revision  Changes    Path
  1.15      +42 -0     jboss-seam/doc/reference/en/modules/controls.xml
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: controls.xml
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/controls.xml,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -b -r1.14 -r1.15
  --- controls.xml	28 Jan 2007 22:23:07 -0000	1.14
  +++ controls.xml	30 Jan 2007 00:06:01 -0000	1.15
  @@ -8,6 +8,10 @@
           recommend the use of the Tomahawk tag library.
       </para>
       
  +    <para>
  +    	The ui example demonstrates the use of a number of these tags.
  +    </para>
  +    
       <variablelist>
          <varlistentry>
              <term><literal>&lt;s:validate&gt;</literal></term>
  @@ -74,6 +78,44 @@
              </listitem>
          </varlistentry>   
          <varlistentry>
  +           <term><literal>&lt;s:selectItem&gt;</literal></term>
  +           <listitem>
  +               <para>
  +                   Creates a  <literal>List&lt;SelectItem&gt;</literal> from a List, Set, DataModel or Array.
  +               </para>
  +                              <itemizedlist>
  +                   <listitem>
  +                   <para>
  +                       <literal>value</literal> &mdash; an EL expression specifying the data that backs the <literal>List&lt;SelectItem&gt;</literal>
  +                   </para>
  +                   </listitem>
  +                    <listitem>
  +                   <para>
  +                       <literal>var</literal> &mdash; defines the name of the local variable that holds the current object during iteration
  +                   </para>
  +                   </listitem>
  +                   <listitem>
  +                   <para>
  +                       <literal>label</literal> &mdash; the label to be used when rendering the <literal>SelectItem</literal>.  Can reference 
  +                       the <literal>var</literal> variable
  +                   </para>
  +                   </listitem>
  +                   <listitem>
  +                   <para>
  +                       <literal>noSelectionLabel</literal> &mdash; specifies the (optional) label to place at the top of list (if 
  +                       <literal>required="true"</literal> is also specified then selecting this value will cause a validation error)
  +                   </para>
  +                   </listitem>
  +                    <listitem>
  +                   <para>
  +                       <literal>hideNoSelectionLabel</literal> &mdash; if true, the <literal>noSelectionLabel</literal> will be hidden
  +                       when a value is selected
  +                   </para>
  +                   </listitem>
  +                   </itemizedlist>                        
  +           </listitem>
  +       </varlistentry>
  +       <varlistentry>
              <term><literal>&lt;s:decorate&gt;</literal></term>
              <listitem>
                  <para>