Create new RichFaces Documentation Jira issue

This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.orgCommunity Documentation

6.14.5.  < rich:hotKey > available since 3.2.2

  • Includes all features of the Javascript jQuery Hotkeys Plugin

  • Hot key registration by request through JavaScript API

  • Possibility to attach <rich:hotKey> to a whole page or to a particular element using "selector" attribute

  • Hot key registration timing

  • Enabling/disabling the <rich:hotKey> using JavaScript API

There are two ways to register <rich:hotKey> :

The "key" attribute defines the hot key itself which is processed by the component.

After the hot key has been registered and defined you could set the "handler" attribute which determines a JavaScript function to be called every time when corresponding keys are pressed.


<rich:listShuttle var="cap" sourceValue="#{capitalsBean.capitals}" id="ls">
        <f:facet name="header">
            <h:outputText value="State flag"/>
        <h:graphicImage value="#{cap.stateFlag}"/>
        <f:facet name="header">
            <h:outputText value="State name"/>
        <h:outputText value="#{}"/>
<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()"/>

In the example above the "selector" attribute is used. So the keys work only if <rich:listShuttle> component is focused.

You could press Right or Left keys in order to move some selected items between lists. You could press Home or End buttons in order to move all items between lists.

With the help of the "timing" attribute you could manage <rich:hotKey> registration timing. There are three possible values of this attribute:

  • "immediate" - the component is rendered in browser immediately (by default)

  • "onload" - the component is rendered after the page is fully loaded

  • "onregistercall" - the component is rendered only after JavaScript API for the key registration is used.

The "type" attribute defines the type of keyboard event. Possible values are: "onkeyup", "onkeypress" and "onkeydown".

The "disableInInput" attribute disables the <rich:hotKey> if it is activated on input elements and the value of this attribute is "true".

The "checkParent" attribute defines the hotkey handling of events generated by child components nested into the parent component to which the <rich:hotKey> is attached.

The <rich:hotKey> component also provides a number of JavaScript API functions. There is an example below.


<h:form id="myForm">
    <rich:hotKey id="myKey" key="ctrl+g" handler="alert('Ctrl+G is pressed')" />
    <button onclick="${rich:component('myKey')}.enable(); return false;">Turn Ctrl+G On</button>
    <button onclick="${rich:component('myKey')}.disable(); return false;">Turn Ctrl+G Off</button>

In the example above the Ctrl+G is registered as a global hotkey, so if you press this key combination the alert window with the "Ctrl+G is pressed" text appears. With the help of enable(), disable() JavaScript API fucntions you could enable or disable registered hotkey.

On RichFaces LiveDemo page you can see an example of <rich:hotKey> usage and sources for the given example.