Author: artdaw
Date: 2008-06-27 05:54:05 -0400 (Fri, 27 Jun 2008)
New Revision: 9266
Added:
trunk/docs/userguide/en/src/main/docbook/included/hotKey.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml
Modified:
trunk/docs/userguide/en/src/main/docbook/master.xml
trunk/docs/userguide/pom.xml
Log:
http://jira.jboss.com/jira/browse/RF-3783 - Description, Key Features, Component
identification parameters, Look-and-Feel Customization were added.
Added: trunk/docs/userguide/en/src/main/docbook/included/hotKey.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/hotKey.desc.xml
(rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/hotKey.desc.xml 2008-06-27 09:54:05
UTC (rev 9266)
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section>
+ <sectioninfo>
+ <keywordset>
+ <keyword>hotKey</keyword>
+ <keyword>rich:hotKey</keyword>
+ </keywordset>
+ </sectioninfo>
+ <section>
+ <title>Description</title>
+ <para>The <emphasis role="bold">
+ <property><rich:hotKey></property>
+ </emphasis> component allows to register hot keys for the page or particular
elements and to define client side processing functions for these keys.
+ </para>
+ </section>
+<section>
+ <title>Key Features</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Hot key registration by request through JavaScript API
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Possibility to attach <emphasis
role="bold"><property><rich:hotKey></property></emphasis>
to a whole page or
+ to a particular element using
<emphasis><property>"selector"</property></emphasis>
attribute
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Hot key registration timing
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Enabling/disabling the <emphasis
role="bold"><property><rich:hotKey></property></emphasis>
using JavaScript API
+ </para>
+ </listitem>
+ </itemizedlist>
+</section>
+</section>
+
\ No newline at end of file
Added: trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml
(rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml 2008-06-27 09:54:05 UTC
(rev 9266)
@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section>
+ <sectioninfo>
+ <keywordset>
+ <keyword>rich:hotKey</keyword>
+ <keyword>hotKey</keyword>
+ </keywordset>
+ </sectioninfo>
+ <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.HotKey</entry>
+ </row>
+ <row>
+ <entry>component-class</entry>
+ <entry>org.richfaces.component.html.HtmlHotKey</entry>
+ </row>
+ <row>
+ <entry>component-family</entry>
+ <entry>org.richfaces.HotKey</entry>
+ </row>
+ <row>
+ <entry>renderer-type</entry>
+ <entry>org.richfaces.HotKeyRenderer</entry>
+ </row>
+ <!--row>
+ <entry>tag-class</entry>
+ <entry></entry>
+ </row-->
+ </tbody>
+ </tgroup>
+ </table>
+ <section>
+ <title>Creating the Component with a Page Tag</title>
+ <para>To create the simplest variant on a page use the following
syntax:</para>
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+<rich:hotKey key="alt+a" handler="alert('alt+A is
pressed')" />
+...]]></programlisting>
+ </section>
+ <section>
+ <title>Creating the Component Dynamically Using Java</title>
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="JAVA"><![CDATA[import
org.richfaces.component.html.HtmlHotKey;
+...
+HtmlHotKey myHotKey = new HtmlHotKey();
+...]]></programlisting>
+ </section>
+ <section>
+ <title>Details of Usage</title>
+ <para>
+
+ </para>
+ </section>
+
+ <section>
+ <title>Look-and-Feel Customization</title>
+ <para><emphasis role="bold">
+ <property><rich:hotKey></property>
+ </emphasis> has no skin parameters and custom <property>style
classes</property>, as the
+ component isn't visual.</para>
+ </section>
+
+ <section>
+ <title>Relevant Resources Links</title>
+ <para>
+ <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/hotKey.jsf?...
you can see an example of
+ <emphasis
role="bold"><property><rich:hotKey></property></emphasis>
usage and sources for the given example.
+ </para>
+ </section>
+</section>
\ No newline at end of file
Modified: trunk/docs/userguide/en/src/main/docbook/master.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/master.xml 2008-06-27 09:49:37 UTC (rev
9265)
+++ trunk/docs/userguide/en/src/main/docbook/master.xml 2008-06-27 09:54:05 UTC (rev
9266)
@@ -53,6 +53,7 @@
<!ENTITY inplaceInput_table SYSTEM
"../../../target/generated/inplaceInput.xml">
<!ENTITY inplaceSelect_table SYSTEM
"../../../target/generated/inplaceSelect.xml">
<!ENTITY fileUpload_table SYSTEM
"../../../target/generated/fileUpload.xml">
+ <!ENTITY hotKey_table SYSTEM "../../../target/generated/hotKey.xml">
<!ENTITY coreComponents_table SYSTEM
"../../../target/generated/a4j.xml">
]>
<book>
@@ -99,6 +100,7 @@
&fileUpload_table;
&gmap_table;
&virtualEarth_table;
+&hotKey_table;
&inplaceInput_table;
&inplaceSelect_table;
&inputNumberSlider_table;
Modified: trunk/docs/userguide/pom.xml
===================================================================
--- trunk/docs/userguide/pom.xml 2008-06-27 09:49:37 UTC (rev 9265)
+++ trunk/docs/userguide/pom.xml 2008-06-27 09:54:05 UTC (rev 9266)
@@ -138,6 +138,17 @@
</version>
</artifactItem>
+ <artifactItem>
+ <groupId>
+ org.richfaces.ui
+ </groupId>
+ <artifactId>
+ hotKey
+ </artifactId>
+ <version>
+ ${project.version}
+ </version>
+ </artifactItem>
<artifactItem>