[richfaces-svn-commits] JBoss Rich Faces SVN: r3003 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Wed Sep 19 12:40:12 EDT 2007
Author: vkorluzhenko
Date: 2007-09-19 12:40:12 -0400 (Wed, 19 Sep 2007)
New Revision: 3003
Modified:
trunk/docs/userguide/en/src/main/docbook/included/effect.xml
Log:
http://jira.jboss.com/jira/browse/RF-396 - added link
Modified: trunk/docs/userguide/en/src/main/docbook/included/effect.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/effect.xml 2007-09-19 16:23:45 UTC (rev 3002)
+++ trunk/docs/userguide/en/src/main/docbook/included/effect.xml 2007-09-19 16:40:12 UTC (rev 3003)
@@ -71,17 +71,15 @@
<section>
<title>Details of Usage</title>
-<para>
- It is possible to use <property><rich:effect></property> in two modes:
-<itemizedlist>
+ <para> It is possible to use <property><rich:effect></property> in two modes: <itemizedlist>
<listitem>attached to the JSF components or html tags and triggered by a particular event.
- Wiring effect with JSF components might occur on the server or client.
- Wiring with html tag is possible only on the client side </listitem>
- <listitem>invoking from the JavaScript code by an effect name.
- During the rendering, <property>rich:effect</property> generates the JavaScript function with defined name. When the function is called,
- the effect is applied </listitem>
-</itemizedlist>
-</para>
+ Wiring effect with JSF components might occur on the server or client. Wiring with html
+ tag is possible only on the client side </listitem>
+ <listitem>invoking from the JavaScript code by an effect name. During the rendering,
+ <property>rich:effect</property> generates the JavaScript function with defined name.
+ When the function is called, the effect is applied </listitem>
+ </itemizedlist>
+ </para>
<para>
<emphasis role="bold">Those a the typical variants of using:</emphasis>
</para>
@@ -118,8 +116,8 @@
</imageobject>
</mediaobject>
</figure>
-
- <figure>
+
+ <figure>
<title>When the mouse cursor is over:</title>
<mediaobject>
@@ -129,42 +127,66 @@
</mediaobject>
</figure>
-<para>
-<emphasis><property>"name"</property></emphasis> attribute defines a name of the JavaScript function that is
-be generated on a page when the component is rendered. You can invoke this function to activate the effect. The function accesses one parameter.
-It is a set of effect options in JSON format.
-</para>
+ <para>
+ <emphasis>
+ <property>"name"</property>
+ </emphasis> attribute defines a name of the JavaScript function that is be generated on a page
+ when the component is rendered. You can invoke this function to activate the effect. The
+ function accesses one parameter. It is a set of effect options in JSON format. </para>
-<para>
-<emphasis><property>"type"</property></emphasis> attribute defines the type of an effect. For example, "Fade", "Blind", "Opacity". Have a look at <ulink url="http://script.aculo.us">scriptaculous documentation</ulink> for set of available effect.
-</para>
+ <para>
+ <emphasis>
+ <property>"type"</property>
+ </emphasis> attribute defines the type of an effect. For example, "Fade", "Blind", "Opacity".
+ Have a look at <ulink url="http://script.aculo.us">scriptaculous documentation</ulink> for set
+ of available effect. </para>
-<para>
-<emphasis><property>"for"</property></emphasis> attribute defines the id of the component or html tag, the effect will be attached to.
-Richfaces converts the <emphasis><property>"for"</property></emphasis> attribute value to the client id of the component if such component is found. If not, the value is left as is for possible
-wiring with on the DOM element's id on the client side.
-By default, the target of the effect is the same element that effect pointed to. However, the target element
-is might be overridden with <emphasis><property>"effectId"</property></emphasis> option passed with <emphasis><property>"params"</property></emphasis>
-attribute of with function paramenter.
-</para>
+ <para>
+ <emphasis>
+ <property>"for"</property>
+ </emphasis> attribute defines the id of the component or html tag, the effect will be attached
+ to. Richfaces converts the <emphasis>
+ <property>"for"</property>
+ </emphasis> attribute value to the client id of the component if such component is found. If
+ not, the value is left as is for possible wiring with on the DOM element's id on the client
+ side. By default, the target of the effect is the same element that effect pointed to.
+ However, the target element is might be overridden with <emphasis>
+ <property>"effectId"</property>
+ </emphasis> option passed with <emphasis>
+ <property>"params"</property>
+ </emphasis> attribute of with function paramenter. </para>
-<para>
-<emphasis><property>"params"</property></emphasis> attribute allows to define the set of options possible for particurar effect.
-For example, 'duration', 'delay', 'from', 'to'. Additionally to the options used by the effect itself, there are two option that might override
-the <property>rich:effect</property> attribute. Those are:
-<itemizedlist>
- <listitem><emphasis><property>"effectId"</property></emphasis> allows to re-define the target of effect.
- The option is override the value of <emphasis><property>"for"</property></emphasis> attribute</listitem>
- <listitem><emphasis><property>"effectType"</property></emphasis> defines the effect type.
- The option is override the value of <emphasis><property>"type"</property></emphasis> attribute</listitem>
-</itemizedlist>
-</para>
-
- </section>
- <section>
+ <para>
+ <emphasis>
+ <property>"params"</property>
+ </emphasis> attribute allows to define the set of options possible for particurar effect. For
+ example, 'duration', 'delay', 'from', 'to'. Additionally to the options used by the effect
+ itself, there are two option that might override the <property>rich:effect</property>
+ attribute. Those are: <itemizedlist>
+ <listitem><emphasis>
+ <property>"effectId"</property>
+ </emphasis> allows to re-define the target of effect. The option is override the value of <emphasis>
+ <property>"for"</property>
+ </emphasis> attribute</listitem>
+ <listitem><emphasis>
+ <property>"effectType"</property>
+ </emphasis> defines the effect type. The option is override the value of <emphasis>
+ <property>"type"</property>
+ </emphasis> attribute</listitem>
+ </itemizedlist>
+ </para>
+
+ </section>
+ <section>
<title>Relevant resources links</title>
<para>
- <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/effect.jsf?c=effect">Here</ulink>
- you can see the example of <emphasis role="bold"><rich:effect></emphasis> usage. </para>
+ <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/effect.jsf?c=effect"
+ >Here</ulink> you can see the example of <emphasis role="bold"
+ ><rich:effect></emphasis> usage. </para>
+ <para>How to save <emphasis role="bold">
+ <property><rich:effect></property>
+ </emphasis>status see on the <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewtopic&t=118833"
+ >RichFaces Users Forum</ulink>.</para>
</section>
</section>
More information about the richfaces-svn-commits
mailing list