hotkey (PrimeFaces VDL Documentation)

Description:

HotKey is a generic key binding component that can bind any formation of keys to javascript event handlers or ajax calls.

Component Information
Info	Value
Component Type	`org.primefaces.component.Hotkey`
Handler Class	None
Renderer Type	`org.primefaces.component.HotkeyRenderer`
Description	None

Attributes
Name	Required	Type	Description
`action`	`false`	`jakarta.el.ValueExpression` (must evaluate to `javax.el.MethodExpression`)	A method expression that'd be processed in the partial request caused by uiajax.
`actionListener`	`false`	`jakarta.el.ValueExpression` (must evaluate to `javax.faces.event.ActionListener`)	An actionlistener that'd be processed in the partial request caused by uiajax.
`async`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When set to true, ajax requests are not queued. Default is false.
`bind`	`true`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	The key binding. Required.
`binding`	`false`	`jakarta.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An el expression referring to a server side UIComponent instance in a backing bean.
`bindMac`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	An alternative key binding for macOS.
`delay`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	If less than delay milliseconds elapses between calls to request() only the most recent one is sent and all other requests are discarded. The default value of this option is null. If the value of delay is the literal string 'none' without the quotes or the default, no delay is used.
`form`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Form to serialize for an ajax request. Default is the enclosing form.
`global`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Global ajax requests are listened by ajaxStatus component, setting global to false will not trigger ajaxStatus. Default is true.
`handler`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript event handler to be executed when the key binding is pressed.
`id`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Unique identifier of the component in a namingContainer.
`ignoreAutoUpdate`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	If true, components which autoUpdate="true" will not be updated for this request. If not specified, or the value is false, no such indication is made.
`ignoreComponentNotFound`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	If true, unresolvable components referenced in the update/process attribute are ignored. Default is 'false' and therefore a ComponentNotFoundException will be thrown.
`immediate`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Boolean value that determines the phaseId, when true actions are processed at apply_request_values, when false at invoke_application phase.
`oncomplete`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript handler to execute when ajax request is completed.
`onerror`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript handler to execute when ajax request fails.
`onstart`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript handler to execute before ajax request begins.
`onsuccess`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript handler to execute when ajax request succeeds.
`partialSubmit`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When enabled, only values related to partially processed components would be serialized for ajax instead of whole form.
`partialSubmitFilter`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Selector to use when partial submit is on, default is ":input" to select all descendant inputs of a partially processed components.
`process`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Component id(s) to process partially instead of whole view.
`rendered`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Boolean value to specify the rendering of the component, when set to false component will not be rendered.
`resetValues`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	If true, indicate that this particular Ajax transaction is a value reset transaction. This will cause resetValue() to be called on any EditableValueHolder instances encountered as a result of this ajax transaction. If not specified, or the value is false, no such indication is made.
`timeout`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Integer`)	Defines the timeout for the ajax request.
`update`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side id of the component(s) to be updated after async partial submit request.

p

Tag hotkey