Author: artdaw
Date: 2008-07-02 09:53:47 -0400 (Wed, 02 Jul 2008)
New Revision: 9407
Modified:
trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml
Log:
http://jira.jboss.com/jira/browse/RF-3783 - Details of Usage
Modified: trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml 2008-07-02 13:49:57 UTC
(rev 9406)
+++ trunk/docs/userguide/en/src/main/docbook/included/hotKey.xml 2008-07-02 13:53:47 UTC
(rev 9407)
@@ -67,10 +67,10 @@
There are two ways to register <emphasis
role="bold"><property><rich:hotKey></property></emphasis>:
</para>
<itemizedlist>
- <listitem>
- <para>
- by attaching it to the whole page (<property>html[0]
element</property>). This is default scenario.
- </para>
+ <listitem>
+ <para>
+ by attaching it to the whole page (<property>html[0]
element</property>). This is default scenario.
+ </para>
</listitem>
<listitem>
<para>
@@ -81,19 +81,51 @@
</para>
</listitem>
</itemizedlist>
- <para>
+ <para>
The
<emphasis><property>"key"</property></emphasis>
attribute defines the hot key itself
- which is processed by the component.
+ which is processed by the component.
</para>
- <para>
+ <para>
After the hot key has been registered and defined you could set the
<emphasis><property>"handler"</property></emphasis>
- attribute which determines a JavaScript function to be called every time when
corresponding keys are pressed.
+ attribute which determines a JavaScript function to be called every time when
corresponding keys are pressed.
</para>
-
- <para>
+ <para>
+ <emphasis role="bold">
+ Example:
+ </emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+<rich:listShuttle var="cap" sourceValue="#{capitalsBean.capitals}"
id="ls">
+ <rich:column>
+ <f:facet name="header">
+ <h:outputText value="State flag"/>
+ </f:facet>
+ <h:graphicImage value="#{cap.stateFlag}"/>
+ </rich:column>
+ <rich:column>
+ <f:facet name="header">
+ <h:outputText value="State name"/>
+ </f:facet>
+ <h:outputText value="#{cap.name}"/>
+ </rich:column>
+</rich:listShuttle>
+<rich:hotKey selector="#ls" key="right"
handler="#{rich:component('ls')}.copy()"/>
+<rich:hotKey selector="#ls" key="left"
handler="#{rich:component('ls')}.remove()"/>
+<rich:hotKey selector="#ls" key="end"
handler="#{rich:component('ls')}.copyAll()"/>
+<rich:hotKey selector="#ls" key="home"
handler="#{rich:component('ls')}.removeAll()"/>
+...]]></programlisting>
+ <para>
+ In the example above the
<emphasis><property>"selector"</property></emphasis>
attribute is used.
+ So the keys work only if <emphasis
role="bold"><property><rich:listShuttle></property></emphasis>
component is focused.
+ </para>
+ <para>
+ You could press <property>Right</property> or
<property>Left</property> keys in order to move some selected items between
lists.
+ You could press <property>Home</property> or
<property>End</property> buttons in order to move all items between lists.
+ </para>
+ <para>
With the help of the
<emphasis><property>"timing"</property></emphasis>
attribute
you could manage <emphasis
role="bold"><property><rich:hotKey></property></emphasis>
registration timing.
- There are three possible values of this attribute:
+ There are three possible values of this attribute:
</para>
<itemizedlist>
<listitem>
@@ -112,6 +144,17 @@
</para>
</listitem>
</itemizedlist>
+ <para>
+ The
<emphasis><property>"type"</property></emphasis>
attribute defines the type of keyboard event. Possible values are:
+ "onkeyup", "onkeypress" and
"onkeydown".
+ </para>
+<!--EXAMPLE -->
+ <para>
+ The
<emphasis><property>"disableInInput"</property></emphasis>
attribute disables the <emphasis
role="bold"><property><rich:hotKey></property></emphasis>
if it is activated on input elements and the value of this attribute is
"true".
+ </para>
+ <para>
+ The
<emphasis><property>"checkParent"</property></emphasis>
attribute defines the hotkey handling of events generated by child components nested into
the parent component to which the <emphasis
role="bold"><property><rich:hotKey></property></emphasis>
is attached.
+ </para>
</section>
<section>
<title>JavaScript API</title>