[jboss-cvs] jboss-seam/doc/reference/en/modules ...
Gavin King
gavin.king at jboss.com
Wed Jul 12 22:33:44 EDT 2006
User: gavin
Date: 06/07/12 22:33:44
Modified: doc/reference/en/modules annotations.xml components.xml
Log:
updated components list
Revision Changes Path
1.38 +4 -36 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.37
retrieving revision 1.38
diff -u -b -r1.37 -r1.38
--- annotations.xml 13 Jul 2006 02:02:35 -0000 1.37
+++ annotations.xml 13 Jul 2006 02:33:44 -0000 1.38
@@ -490,38 +490,6 @@
</para>
</listitem>
<listitem>
- <programlisting><![CDATA[@Begin(ifOutcome={"success", "continue"})]]></programlisting>
- <para>
- Specifies that a long-running conversation begins when this
- action listener method returns with one of the given outcomes.
- </para>
- </listitem>
- <listitem>
- <programlisting><![CDATA[@Begin(join=true)]]></programlisting>
- <para>
- Specifies that if a long-running conversation is already in progress,
- the conversation context is simply propagated.
- </para>
- </listitem>
- <listitem>
- <programlisting><![CDATA[@Begin(nested=true)]]></programlisting>
- <para>
- Specifies that if a long-running conversation is already in progress,
- a new <emphasis>nested</emphasis> conversation context begins. The
- nested conversation will end when the next <literal>@End</literal>
- is encountered, and the outer conversation will resume. It is
- perfectly legal for multiple nested conversations to exist
- concurrently in the same outer conversation.
- </para>
- </listitem>
- <listitem>
- <programlisting><![CDATA[@Begin(pageflow="process definition name")]]></programlisting>
- <para>
- Specifies a jBPM process definition name that defines the pageflow
- for this conversation.
- </para>
- </listitem>
- <listitem>
<programlisting><![CDATA[@Begin(flushMode=FlushModeType.MANUAL)]]></programlisting>
<para>
Specify the flush mode of any Seam-managed persistence contexts.
@@ -616,7 +584,7 @@
<varlistentry id="starttask-annotation">
<term><literal>@StartTask</literal></term>
<listitem>
- <programlisting><![CDATA[@StartTask(taskIdParameter="taskId")]]></programlisting>
+ <programlisting><![CDATA[@StartTask]]></programlisting>
<para>
"Starts" a jBPM task. Specifies that a long-running
conversation begins when this method returns a non-null outcome
@@ -655,7 +623,7 @@
<varlistentry id="begintask-annotation">
<term><literal>@BeginTask</literal></term>
<listitem>
- <programlisting><![CDATA[@BeginTask(taskIdParameter="taskId")]]></programlisting>
+ <programlisting><![CDATA[@BeginTask]]></programlisting>
<para>
Resumes work on an incomplete jBPM task. Specifies that a long-running
conversation begins when this method returns a non-null outcome without
@@ -954,9 +922,9 @@
<variablelist spacing="compact">
<varlistentry id="webremote-annotation">
- <term><literal>@WebRemote(exclude = {path.to.exclude})</literal></term>
+ <term><literal>@WebRemote</literal></term>
<listitem>
- <programlisting><![CDATA[@WebRemote]]></programlisting>
+ <programlisting><![CDATA[@WebRemote(exclude="path.to.exclude")]]></programlisting>
<para>
Indicates that the annotated method may be called from client-side
JavaScript. The <literal>exclude</literal> property is optional and
1.34 +82 -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.33
retrieving revision 1.34
diff -u -b -r1.33 -r1.34
--- components.xml 12 Jul 2006 23:14:33 -0000 1.33
+++ components.xml 13 Jul 2006 02:33:44 -0000 1.34
@@ -170,6 +170,13 @@
</listitem>
<listitem>
<para>
+ <literal>redirect.conversationPropagationEnabled</literal> —
+ determines whether the conversation will propagate across the
+ redirect.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
<literal>redirect.parameters</literal> — a map of
request parameter name to value, to be passed in the redirect
request.
@@ -259,6 +266,23 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><literal>renderParameters</literal></term>
+ <listitem>
+ <para>
+ Allows JSF form controls to be bound to a "render parameter"
+ which will be accessible via <literal>@RequestParameter</literal>
+ during the subsequent render phase even if a browser redirect
+ occurs.
+ </para>
+ <para>
+ For example, the value entered in this input field:
+ <literal><inputText value="#{renderParameters.searchString}"/></literal>
+ will be available via <literal>@RequestParameter("searchString")</literal>
+ when the form is submitted.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><literal>uiComponent</literal></term>
<listitem>
<para>
@@ -550,6 +574,48 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><literal>businessProcess</literal></term>
+ <listitem>
+ <para>
+ API for programmatic control of the association between the
+ conversation and business process.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal>businessProcess.taskId</literal> — the id of the task
+ associated with the current conversation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>businessProcess.processId</literal> — the id of the process
+ associated with the current conversation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>createProcess(String name)</literal> — create an
+ instance of the named process definition and associate it with
+ the current conversation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>startTask()</literal> — start the task
+ associated with the current conversation.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>endTask(String transitionName)</literal> — end the task
+ associated with the current conversation.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><literal>taskInstance</literal></term>
<listitem>
<para>
@@ -737,15 +803,6 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>businessProcess</literal></term>
- <listitem>
- <para>
- Internal component for Seam process management. Installed whenever
- <literal>org.jboss.seam.core.jbpm</literal> is installed.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><literal>org.jboss.seam.core.pageflow</literal></term>
<listitem>
<para>
@@ -996,6 +1053,22 @@
</itemizedlist>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><literal><emphasis><alias></emphasis></literal></term>
+ <listitem>
+ <para>
+ An "alias" (a second name) for a component.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <literal><emphasis><alias></emphasis>.name</literal>
+ — the name of the component to be aliased.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
</variablelist>
</section>
More information about the jboss-cvs-commits
mailing list