Tag hotKey

The <rich:hotKey> component allows registering hot keys on the page or particular elements and defining client side processing functions for these keys.

@author ilya_shaikovsky @author Lukas Fryc

Tag Information
Component type org.richfaces.HotKey
Tag Name rich:hotKey
Renderer Type org.richfaces.HotKeyRenderer
Handler Class None

Name Required Type Description
binding false javax.faces.component.UIComponent The value binding expression used to wire up this component to a component property of a JavaBean class
enabledInInput false boolean The switch which enables handling events coming from input
id false java.lang.String The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
key true java.lang.String The key sequence to be pressed, single keys separated by + (e.g. 'ctrl+a'), more key sequences separated by space. Special keys are accepted as follows: backspace, tab, return, shift, ctrl, alt, pause, capslock, esc, space, pageup, pagedown, end, home, left, up, right, down, insert, del, numlock, scroll, meta, f1, f2, ..., f12
onkeydown false java.lang.String Event handler to be fired when registered key sequence is pressed down
onkeyup false java.lang.String Event handler to be fired when registered key sequence is pressed up
preventDefault false boolean The switch which prevents native browser actions (prevents default) to be taken and stops event propagation up to the tree
rendered false boolean Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
selector false java.lang.String The jQuery selector (subset of CSS selectors defined by W3C) of the DOM root from which key events should be handled. When no value provided, events are handled for whole document. ID selectors starting with hash sign (#) will be expanded from componentId to clientId form. (e.g. #component is expanded to #form:component in case that component is nested in form)

Output Generated by Tag Library Documentation Generator.