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

[Peter Muir]

  User: pmuir   
  Date: 07/03/04 17:22:53

  Modified:    doc/reference/en/modules  controls.xml
  Log:
  Docs and update seamspace to use s:graphicImage
  
  Revision  Changes    Path
  1.23      +39 -1     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.22
  retrieving revision 1.23
  diff -u -b -r1.22 -r1.23
  --- controls.xml	24 Feb 2007 22:14:00 -0000	1.22
  +++ controls.xml	4 Mar 2007 22:22:53 -0000	1.23
  @@ -122,6 +122,44 @@
              </listitem>
          </varlistentry>
          <varlistentry>
  +           <term><literal>&lt;s:graphicImage&gt;</literal></term>
  +           <listitem>
  +               <para>
  +                   Extends <literal>&lt;h:graphicImage&gt;</literal> so that the image can be created in a Seam Component.
  +                   All attributes for <literal>&lt;h:graphicImage&gt;</literal> are supported, as well as:
  +               </para>
  +               <itemizedlist>
  +                   <listitem>
  +                   <para>
  +                       <literal>value</literal> &mdash; image to display.  Can be a path <literal>String</literal> 
  +                       (loaded from the classpath), a <literal>byte[]</literal>, a <literal>java.io.File</literal>,
  +                       a <literal>java.io.InputStream</literal> or a <literal>java.net.URL</literal>.  Currently supported
  +                       image formats are <literal>image/png</literal>, <literal>image/jpeg</literal> and <literal>image/gif</literal>.
  +                   </para>
  +                   </listitem>
  +                    <listitem>
  +                   <para>
  +                       <literal>maintainRatio</literal> &mdash; if a <literal>width</literal> or a 
  +                       <literal>height</literal> are specfied, the image will be scaled whilst maintaining
  +                       the aspect ratio.
  +                   </para>
  +                   </listitem>
  +                   <listitem>
  +                   <para>
  +                       <literal>contentType</literal> &mdash; the output MimeType of the image.  
  +                       Currently supported are <literal>image/png</literal> and <literal>image/jpeg</literal>.
  +                   </para>
  +                   </listitem>
  +                    <listitem>
  +                   <para>
  +                       <literal>fileName</literal> &mdash; if not specified the served image will have a file name
  +                       generated.  If you want to name your file, you should specify a (unique) fileName here.
  +                   </para>
  +                   </listitem>
  +               </itemizedlist>                        
  +           </listitem>
  +       </varlistentry>
  +       <varlistentry>
              <term><literal>&lt;s:decorate&gt;</literal></term>
              <listitem>
                  <para>