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

[Gavin King]

  User: gavin   
  Date: 06/08/04 10:52:09

  Modified:    doc/reference/en/modules  annotations.xml
  Log:
  @Render
  
  Revision  Changes    Path
  1.41      +39 -2     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.40
  retrieving revision 1.41
  diff -u -b -r1.40 -r1.41
  --- annotations.xml	25 Jul 2006 19:55:52 -0000	1.40
  +++ annotations.xml	4 Aug 2006 14:52:09 -0000	1.41
  @@ -852,7 +852,7 @@
               <varlistentry id="redirect-annotation">
                   <term><literal>@Redirect</literal></term>
                   <listitem>
  -                    <programlisting><![CDATA[@Redirect]]></programlisting>
  +                    <programlisting><![CDATA[@Redirect(viewId="error.jsp")]]></programlisting>
                       <para>
                           Specifies that the annotated exception causes a browser redirect
                           to a specified view id.
  @@ -864,13 +864,44 @@
                               to redirect to.
                           </para>
                           </listitem>
  +                        <listitem>
  +                        <para>
  +                            <literal>message</literal> &mdash; a message to be displayed,
  +                            default to the exception message.
  +                        </para>
  +                        </listitem>
  +                    </itemizedlist>
  +                </listitem>
  +            </varlistentry>
  +            <varlistentry id="redirect-annotation">
  +                <term><literal>@Render</literal></term>
  +                <listitem>
  +                    <programlisting><![CDATA[@Render(viewId="error.jsp")]]></programlisting>
  +                    <para>
  +                        Specifies that the annotated exception causes immediate rendering
  +                        of the view. This annotation is ignored unless the exception is
  +                        thrown during the JSF INVOKE_APPLICATION phase.
  +                    </para>
  +                    <itemizedlist>
  +                        <listitem>
  +                        <para>
  +                            <literal>viewId</literal> &mdash; specifies the JSF view id
  +                            to redirect to.
  +                        </para>
  +                        </listitem>
  +                        <listitem>
  +                        <para>
  +                            <literal>message</literal> &mdash; a message to be displayed,
  +                            default to the exception message.
  +                        </para>
  +                        </listitem>
                       </itemizedlist>
                   </listitem>
               </varlistentry>
               <varlistentry id="httperror-annotation">
                   <term><literal>@HttpError</literal></term>
                   <listitem>
  -                    <programlisting><![CDATA[@HttpError]]></programlisting>
  +                    <programlisting><![CDATA[@HttpError(errorCode=404)]]></programlisting>
                       <para>
                           Specifies that the annotated exception causes a HTTP error
                           to be sent.
  @@ -882,6 +913,12 @@
                               default to <literal>500</literal>.
                           </para>
                           </listitem>
  +                        <listitem>
  +                        <para>
  +                            <literal>message</literal> &mdash; a message to be sent
  +                            with the HTTP error, default to the exception message.
  +                        </para>
  +                        </listitem>
                       </itemizedlist>
                   </listitem>
               </varlistentry>