Author: atsebro Date: 2009-08-19 12:40:58 -0400 (Wed, 19 Aug 2009) New Revision: 15224 Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_dndParam.xml Log: RF-7691: rich_dndParam component description review Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_dndParam.xml =================================================================== --- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_dndParam.xml 2009-08-19 15:50:10 UTC (rev 15223) +++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_dndParam.xml 2009-08-19 16:40:58 UTC (rev 15224) @@ -1,48 +1,35 @@ <section role="NotInToc" id="rich_dndParam"> - <title> - &lt; - rich:dndParam - &gt; - <emphasis role="since"> - <superscript> available since <emphasis role="version">3.0.0</emphasis> - </superscript> - </emphasis> - </title> - <section> - <title>Description</title> - <para>This component is used for passing parameters during drag-and-drop - operations.</para> - </section> - <section> - <title>Details of Usage</title> + <title> + &lt;rich:dndParam&gt; <emphasis role="since"><superscript> available since <emphasis role="version">3.0.0</emphasis></superscript></emphasis> + </title> + <section> + <title>Description</title> + <para> + The component is used for passing parameters during drag-and-drop operations. + </para> + </section> + <section> + <title>Details of Usage</title> + <para> + The <emphasis role="bold"><property>&lt;rich:dndParam&gt;</property></emphasis> is used during drag-and-drop operations for passing parameters to an indicator. + To use the component it is necessary to set <property>&quot;type&quot;</property> attribute that specifies what kind of functionality the component will provide: dragging or dropping. + Attributes <property>&quot;name&quot;</property> and <property>&quot;value&quot;</property> are also should be defiend. + Instead of the <property>&quot;value&quot;</property> attribute definition it is possible to define value of the component using nested contents. + </para> + <para>Variants of usage:</para> + <itemizedlist> + <listitem> + <para> + Passing parameters for indicator's drag icon. + The <emphasis role="bold"><property>&lt;rich:dndParam&gt;</property></emphasis> can define the indicator's drag icon that will be used during dragging instead of indicator's default icon. + For example, a drag icon may be represented with a minimized image of a dragged element. + In this case <code>type=&quot;drag&quot;</code>: + </para> + </listitem> + </itemizedlist> - <para> - <property>dndParam</property> is used during drag-and-drop - operations to pass parameters to an indicator. At first, a parameter type - is defined with the type attribute (to specify parameter functionality), - then a parameter name could be defined with the name and value attribute. - Although, it's possible to use nested content defined inside - <property>dndParam</property> for value definition, instead of the - attribute.</para> - - <para>Variants of usage:</para> - - <itemizedlist> - <listitem> - <para>Parameters passing for a drag icon when an indicator is in - drag.</para> - </listitem> - </itemizedlist> - - <para>In this case, <property>dndParam</property> is of a drag type - and is defined in the following way:</para> - - - <para> - <emphasis role="bold">Example:</emphasis> - </para> - <programlisting role="XML">... -&lt;rich:dragSupport ... &gt; + <programlisting role="XML">... + &lt;rich:dragSupport ... &gt; &lt;rich:dndParam type="drag" name="dragging"&gt; &lt;h:graphicImage value="/img/product1_small.png"/&gt; &lt;/rich:dndParam&gt; @@ -50,25 +37,17 @@ &lt;/rich:dragSupport&gt; ... </programlisting> + + <itemizedlist> + <listitem> + <para> + Passing parameters for indicator's informational part. + The <emphasis role="bold"><property>&lt;rich:dndParam&gt;</property></emphasis> can transmit it's value into indicator's. + In this case <code>type=&quot;drag&quot;</code>: + </para> + </listitem> + </itemizedlist> - <para>Here <property>dndParam</property> defines an icon that is used by - an indicator when a drag is on the place of a default icon (e.g. a - minimized image of a draggable element)</para> - - <itemizedlist> - <listitem> - <para>Parameters passing for an indicator informational part during - a drag.</para> - </listitem> - </itemizedlist> - - <para>In this case <property>dndParam</property> is of a drag type - and is defined in the following way:</para> - - - <para> - <emphasis role="bold">Example:</emphasis> - </para> <programlisting role="XML">... &lt;rich:dragSupport ... &gt; &lt;rich:dndParam type="drag" name="label" value="#{msg.subj}"/&gt; @@ -76,26 +55,16 @@ &lt;/rich:dragSupport&gt; ... </programlisting> - - <para>The parameter is transmitted into an indicator for usage in an - informational part of the <property>dragIndicator</property> component (inside an indicator a - call to {label} happens)</para> - <itemizedlist> - <listitem> - <para>Parameters passing happens when dragged content is brought - onto some zone with <property>dropSupport</property> - </para> - </listitem> + <listitem> + <para> + Passing parameters to a component that supports drop after drop happens. + The <emphasis role="bold"><property>&lt;rich:dndParam&gt;</property></emphasis> can pass icons into an indicator, if dragged content of a comp type is above the given drop zone that processes it on the next drop event. + In this case <code>type=&quot;drop&quot;</code>: + </para> + </listitem> </itemizedlist> - <para>In this case <property>dndParam</property> is of a drop type and is - defined in the following way:</para> - - - <para> - <emphasis role="bold">Example:</emphasis> - </para> <programlisting role="XML">... &lt;rich:dropSupport ... &gt; &lt;rich:dndParam type="drop" name="comp" &gt; @@ -105,50 +74,38 @@ &lt;/rich:dropSupport &gt; ... </programlisting> +</section> + <section> + <title>Reference Data</title> + <para> + <ulink url="&tlddoc;rich/dndParam.html">Table of &lt;rich:dndParam&gt; attributes</ulink>. + </para> - <para>Here, <property>dndParam</property> passes icons into an indicator, - if dragged content of a comp type is above the given drop zone that - processes it on the next drop event.</para> - </section> - <section> - <title>Reference Data</title> - <para> - <ulink url="&tlddoc;rich/dndParam.html">Table of - &lt;rich:dndParam&gt; - attributes</ulink>. - </para> - <table> - <title>Component Identification Parameters</title> - - <tgroup cols="2"> - <thead> - <row> - <entry>Name</entry> - - <entry>Value</entry> - </row> - </thead> - - <tbody> - <row> - <entry>component-type</entry> - - <entry>org.richfaces.DndParam</entry> - </row> - - <row> - <entry>component-class</entry> - - <entry>org.richfaces.component.html.HtmlDndParam</entry> - </row> - - <row> - <entry>tag-class</entry> - - <entry>org.richfaces.taglib.DndParamTag</entry> - </row> - </tbody> - </tgroup> - </table> - </section> + <table> + <title>Component Identification Parameters</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Value</entry> + </row> + </thead> + + <tbody> + <row> + <entry>component-type</entry> + <entry>org.richfaces.DndParam</entry> + </row> + <row> + <entry>component-class</entry> + <entry>org.richfaces.component.html.HtmlDndParam</entry> + </row> + <row> + <entry>tag-class</entry> + <entry>org.richfaces.taglib.DndParamTag</entry> + </row> + </tbody> + </tgroup> + </table> + </section> </section> \ No newline at end of file