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

[Gavin King]

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

  Modified:    doc/reference/en/modules  components.xml
  Log:
  make pageflow a user-visible component
  
  Revision  Changes    Path
  1.39      +34 -9     jboss-seam/doc/reference/en/modules/components.xml
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: components.xml
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/doc/reference/en/modules/components.xml,v
  retrieving revision 1.38
  retrieving revision 1.39
  diff -u -b -r1.38 -r1.39
  --- components.xml	24 Jul 2006 16:21:10 -0000	1.38
  +++ components.xml	4 Aug 2006 14:52:29 -0000	1.39
  @@ -587,6 +587,40 @@
           
           <variablelist spacing="compact">
               <varlistentry>
  +                <term><literal>pageflow</literal></term>
  +                <listitem>
  +                    <para>
  +                        API control of Seam pageflows.
  +                    </para>
  +                    <itemizedlist>
  +                        <listitem>
  +                        <para>
  +                            <literal>isInProcess()</literal> &mdash; returns <literal>true</literal>
  +                            if there is currently a pageflow in process
  +                        </para>
  +                        </listitem>
  +                        <listitem>
  +                        <para>
  +                            <literal>getProcessInstance()</literal> &mdash; returns jBPM
  +                            <literal>ProcessInstance</literal> for the current pageflow
  +                        </para>
  +                        </listitem>
  +                        <listitem>
  +                        <para>
  +                            <literal>begin(String pageflowName)</literal> &mdash; begin a pageflow
  +                            in the context of the current conversation
  +                        </para>
  +                        </listitem>
  +                        <listitem>
  +                        <para>
  +                            <literal>reposition(String nodeName)</literal> &mdash; reposition the
  +                            current pageflow to a particular node
  +                        </para>
  +                        </listitem>
  +                    </itemizedlist>
  +                </listitem>
  +            </varlistentry>
  +            <varlistentry>
                   <term><literal>actor</literal></term>
                   <listitem>
                       <para>
  @@ -872,15 +906,6 @@
                   </listitem>
               </varlistentry>
               <varlistentry>
  -                <term><literal>org.jboss.seam.core.pageflow</literal></term>
  -                <listitem>
  -                    <para>
  -                        Internal component for Seam pageflow management. Installed whenever
  -                        <literal>org.jboss.seam.core.jbpm</literal> is installed.
  -                    </para>
  -                </listitem>
  -            </varlistentry>
  -            <varlistentry>
                   <term><literal>org.jboss.seam.core.pages</literal></term>
                   <listitem>
                       <para>