Author: vkukharchuk
Date: 2007-09-05 10:44:27 -0400 (Wed, 05 Sep 2007)
New Revision: 2773
Added:
trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.xml
trunk/docs/userguide/en/src/main/docbook/included/dragListener.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/dragListener.xml
trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.xml
Log:
http://jira.jboss.com/jira/browse/RF-808
http://jira.jboss.com/jira/browse/RF-811
http://jira.jboss.com/jira/browse/RF-810
Added: trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.desc.xml
(rev 0)
+++
trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.desc.xml 2007-09-05
14:44:27 UTC (rev 2773)
@@ -0,0 +1,22 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<section>
+ <sectioninfo>
+ <keywordset>
+ <keyword>changeExpandListener</keyword>
+ </keywordset>
+ </sectioninfo>
+
+ <section>
+ <title>Description</title>
+ <para>The <emphasis
role="bold"><property><rich:changeExpandListener></property></emphasis>
+ represents an action listener method that will be notified on expand/collapse event on
the node.
+ </para>
+ </section>
+
+ <section>
+ <title>Key Features</title>
+ <itemizedlist>
+ <listitem>Allows to define some "changeExpand" listeners for
component</listitem>
+ </itemizedlist>
+ </section>
+</section>
Added: trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.xml
(rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/changeExpandListener.xml 2007-09-05
14:44:27 UTC (rev 2773)
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter>
+ <table>
+ <title>Component identification parameters </title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Value</entry>
+ </row>
+ </thead>
+ <tbody>
+
+ <row>
+ <entry>listener-class</entry>
+ <entry>org.richfaces.event.NodeExpandedListener</entry>
+ </row>
+ <row>
+ <entry>event-class</entry>
+ <entry>org.richfaces.event.NodeExpandedEvent</entry>
+ </row>
+
+ <row>
+ <entry>tag-class</entry>
+ <entry>org.richfaces.taglib.ChangeExpandListenerTag</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+
+ <section>
+ <title>Creating on a page</title>
+ <para>Simple Component definition on a page:</para>
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+
+ <programlisting role="XML"><![CDATA[...
+ <rich:changeExpandListener type="demo.Bean"/>
+...
+]]></programlisting>
+ </section>
+
+ <section>
+ <title>Dynamical creation of a component from Java code</title>
+ <para>
+ <emphasis role="bold">Example:</emphasis></para>
+ <programlisting role="JAVA"><![CDATA[package demo;
+
+public class ImplBean implements org.richfaces.event.NodeExpandedListener{
+ ...
+}
+]]></programlisting>
+
+ <programlisting role="JAVA"><![CDATA[
+import demo.ImplBean;
+...
+ImplBean myListener = new ImplBean();
+...
+]]></programlisting>
+
+ </section>
+
+ <section>
+ <title>Key attributes and ways of usage</title>
+
+<para>
+The <property><rich:changeExpandListener></property> is used as
nested tag with <property><rich:tree></property>
+and <property><rich:treeNode></property> components.
+</para>
+<para>
+Attribute
<emphasis><property>"type"</property></emphasis>
defines the fully qualified Java class name for listener.
+This class should implement org.richfaces.event.NodeExpandedListener interface.
+</para>
+
+ <para>
+ <emphasis role="bold">The typical variant of
using:</emphasis>
+ </para>
+
+ <programlisting role="XML"><![CDATA[...
+<rich:tree switchType="server" value="#{project.data}"
var="item" nodeFace="#{item.type}">
+ <rich:changeExpandListener type="demo.ListenerBean"/>
+ ...
+ <!-- Tree nodes -->
+ ...
+</rich:tree>
+...
+]]></programlisting>
+
+ <para>
+ <emphasis role="bold">Java bean source:</emphasis>
+ </para>
+
+ <programlisting role="JAVA"><![CDATA[package demo;
+
+import org.richfaces.event.NodeExpandedEvent;
+
+public class ListenerBean implements org.richfaces.event.NodeExpandedListener{
+...
+ public void processExpansion(NodeExpandedEvent arg0){
+ //Custom Developer Code
+ }
+...
+}
+]]></programlisting>
+ </section>
+
+</chapter>
\ No newline at end of file
Added: trunk/docs/userguide/en/src/main/docbook/included/dragListener.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dragListener.desc.xml
(rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/dragListener.desc.xml 2007-09-05
14:44:27 UTC (rev 2773)
@@ -0,0 +1,22 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<section>
+ <sectioninfo>
+ <keywordset>
+ <keyword>dragListener</keyword>
+ </keywordset>
+ </sectioninfo>
+
+ <section>
+ <title>Description</title>
+ <para>The <emphasis
role="bold"><property><rich:dragListener></property></emphasis>
+ represents an action listener method that will be notified after drag operation.
+ </para>
+ </section>
+
+ <section>
+ <title>Key Features</title>
+ <itemizedlist>
+ <listitem>Allows to define some drag listeners for components with "Drag
and Drop" support</listitem>
+ </itemizedlist>
+ </section>
+</section>
Added: trunk/docs/userguide/en/src/main/docbook/included/dragListener.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dragListener.xml
(rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/dragListener.xml 2007-09-05 14:44:27
UTC (rev 2773)
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter>
+ <table>
+ <title>Component identification parameters </title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Value</entry>
+ </row>
+ </thead>
+ <tbody>
+
+ <row>
+ <entry>listener-class</entry>
+ <entry>org.richfaces.event.DragListener</entry>
+ </row>
+ <row>
+ <entry>event-class</entry>
+ <entry>org.richfaces.event.DragEvent</entry>
+ </row>
+
+ <row>
+ <entry>tag-class</entry>
+ <entry>org.richfaces.taglib.DragListenerTag</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+
+ <section>
+ <title>Creating on a page</title>
+ <para>Simple Component definition on a page:</para>
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+
+ <programlisting role="XML"><![CDATA[...
+ <rich:dragListener type="demo.Bean"/>
+...
+]]></programlisting>
+ </section>
+
+ <section>
+ <title>Dynamical creation of a component from Java code</title>
+ <para>
+ <emphasis role="bold">Example:</emphasis></para>
+ <programlisting role="JAVA"><![CDATA[package demo;
+
+public class ImplBean implements org.richfaces.event.DragListener{
+ ...
+}
+]]></programlisting>
+
+ <programlisting role="JAVA"><![CDATA[
+import demo.ImplBean;
+...
+ImplBean myDragListener = new ImplBean();
+...
+]]></programlisting>
+
+ </section>
+
+ <section>
+ <title>Key attributes and ways of usage</title>
+
+<para>
+The <property><rich:dragListener></property> is used as nested
tag with components like
+<property><rich:dragSupport></property>,
<property><rich:tree></property> and
<property><rich:treeNode></property>.
+</para>
+<para>
+Attribute
<emphasis><property>"type"</property></emphasis>
defines the fully qualified Java class name for listener.
+This class should implement org.richfaces.event.DragListener interface.
+</para>
+
+ <para>
+ <emphasis role="bold">The typical variant of
using:</emphasis>
+ </para>
+
+ <programlisting role="XML"><![CDATA[...
+<h:panelGrid id="dragPanel">
+ <rich:dragSupport dragType="item">
+ <rich:dragListener type="demo.ListenerBean"/>
+ </rich:dragSupport>
+ <!--Some content to be dragged-->
+</h:panelGrid>
+...
+]]></programlisting>
+
+ <para>
+ <emphasis role="bold">Java bean source:</emphasis>
+ </para>
+
+ <programlisting role="JAVA"><![CDATA[package demo;
+
+import org.richfaces.event.DragEvent;
+
+public class ListenerBean implements org.richfaces.event.DragListener{
+...
+ public void processDrag(DragEvent arg0){
+ //Custom Developer Code
+ }
+...
+}
+]]></programlisting>
+ </section>
+
+</chapter>
\ No newline at end of file
Added: trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.desc.xml
(rev 0)
+++
trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.desc.xml 2007-09-05
14:44:27 UTC (rev 2773)
@@ -0,0 +1,22 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<section>
+ <sectioninfo>
+ <keywordset>
+ <keyword>nodeSelectListener</keyword>
+ </keywordset>
+ </sectioninfo>
+
+ <section>
+ <title>Description</title>
+ <para>The <emphasis
role="bold"><property><rich:nodeSelectListener></property></emphasis>
+ represents an action listener method that will be notified after selection of node.
+ </para>
+ </section>
+
+ <section>
+ <title>Key Features</title>
+ <itemizedlist>
+ <listitem>Allows to define some "nodeSelect" listeners for
component</listitem>
+ </itemizedlist>
+ </section>
+</section>
Added: trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.xml
(rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/nodeSelectListener.xml 2007-09-05
14:44:27 UTC (rev 2773)
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter>
+ <table>
+ <title>Component identification parameters </title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Value</entry>
+ </row>
+ </thead>
+ <tbody>
+
+ <row>
+ <entry>listener-class</entry>
+ <entry>org.richfaces.event.NodeSelectedListener</entry>
+ </row>
+ <row>
+ <entry>event-class</entry>
+ <entry>org.richfaces.event.NodeSelectedEvent</entry>
+ </row>
+
+ <row>
+ <entry>tag-class</entry>
+ <entry>org.richfaces.taglib.NodeSelectListenerTag</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+
+ <section>
+ <title>Creating on a page</title>
+ <para>Simple Component definition on a page:</para>
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+
+ <programlisting role="XML"><![CDATA[...
+ <rich:nodeSelectListener type="demo.Bean"/>
+...
+]]></programlisting>
+ </section>
+
+ <section>
+ <title>Dynamical creation of a component from Java code</title>
+ <para>
+ <emphasis role="bold">Example:</emphasis></para>
+ <programlisting role="JAVA"><![CDATA[package demo;
+
+public class ImplBean implements org.richfaces.event.NodeSelectListener{
+ ...
+}
+]]></programlisting>
+
+ <programlisting role="JAVA"><![CDATA[
+import demo.ImplBean;
+...
+ImplBean myListener = new ImplBean();
+...
+]]></programlisting>
+
+ </section>
+
+ <section>
+ <title>Key attributes and ways of usage</title>
+
+<para>
+The <property><rich:nodeSelectListener></property> is used as
nested tag with <property><rich:tree></property>
+and <property><rich:treeNode></property> components.
+</para>
+<para>
+Attribute
<emphasis><property>"type"</property></emphasis>
defines the fully qualified Java class name for listener.
+This class should implement org.richfaces.event.NodeSelectedListener interface.
+</para>
+
+ <para>
+ <emphasis role="bold">The typical variant of
using:</emphasis>
+ </para>
+
+ <programlisting role="XML"><![CDATA[...
+<rich:tree switchType="server" value="#{project.data}"
var="item" nodeFace="#{item.type}">
+ <rich:nodeSelectListener type="demo.ListenerBean"/>
+ ...
+ <!-- Tree nodes -->
+ ...
+</rich:tree>
+...
+]]></programlisting>
+
+ <para>
+ <emphasis role="bold">Java bean source:</emphasis>
+ </para>
+
+ <programlisting role="JAVA"><![CDATA[package demo;
+
+import org.richfaces.event.NodeSelectedEvent;
+
+public class ListenerBean implements org.richfaces.event.NodeSelectedListener{
+...
+ public void processSelection(NodeSelectedEvent arg0){
+ //Custom Developer Code
+ }
+...
+}
+]]></programlisting>
+ </section>
+
+</chapter>
\ No newline at end of file