[richfaces-svn-commits] JBoss Rich Faces SVN: r9268 - trunk/docs/userguide/en/src/main/docbook/included.

[richfaces-svn-commits at lists.jboss.org]

Author: artdaw
Date: 2008-06-27 06:52:20 -0400 (Fri, 27 Jun 2008)
New Revision: 9268

Modified:
   trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml
Log:
http://jira.jboss.com/jira/browse/RF-3783 - JavaScript API was added.

Modified: trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml	2008-06-27 10:51:35 UTC (rev 9267)
+++ trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml	2008-06-27 10:52:20 UTC (rev 9268)
@@ -67,7 +67,40 @@
 
 		</para>
 	</section>
-
+    <section>
+        <title>JavaScript API</title>
+        <table>
+            <title>JavaScript API</title>
+            <tgroup cols="2">
+                <thead>
+                    <row>
+                        <entry>Function</entry>
+                        <entry>Description</entry>
+                    </row>
+                </thead>
+                <tbody>
+                    <row>
+                        <entry>add(selector, key, handler)</entry>
+                        <entry>
+							Adds the hotkey(from key param) for elements targeted by selector. Assigns handler function to the key.
+						</entry>
+                    </row>
+                    <row>
+                        <entry>remove()</entry>
+                        <entry>Removes hotkey registration</entry>
+                    </row>
+                    <row>
+                        <entry>enable()</entry>
+                        <entry>Enables registered hotkey</entry>
+                    </row>
+                    <row>
+                        <entry>disable()</entry>
+                        <entry>Disables registered hotkey</entry>
+                    </row>
+                </tbody>
+            </tgroup>
+        </table>
+    </section>
   <section>
     <title>Look-and-Feel Customization</title>
     <para><emphasis role="bold">