Key Listener (ref)

(part of package 'Key Listener')

You can access it in code via: plugins.keyListener

Properties

API

addKeyListener

Registers the listener on the components which have the "keylistener" attribute with the given callbackKey value, to call the given callback when a key is pressed.

@param callbackKey {string} The key for which the listener will be added. This key has to match value of "keylistener" attribute in component. @param callback {Function} The callback function to be called when a key is pressed. @param [clearPreviousCallback] {boolean} If true a removeKeyListener will be called for this key before adding the new one. Default value is false. @param [delay] {int} Number of milliseconds to wait before callback method is called. Default value is 1000. @param [regexPattern] {string} Javascript regular expression string to modify current value of the component. @param [regexReplacement] {string} The value that is used to replace the regular expression with in the current value of the component. @example

plugins.keyListener.addKeyListener('test', onKey)

Parameters:

callbackKey string callback function clearCB boolean (optional) delay int (optional) regexPattern string (optional) regexReplacement string (optional)

---

removeKeyListener

Removes the listener associated to the given callback key. Returns true if the listener was removed.

@param callbackKey {string} The key listener to remove. @return {boolean} succes of removal @example

plugins.keyListener.removeKeyListener('test')

Parameters:

callbackKey string

Returns: boolean

---

Types

callback

scripting type: CustomType<keyListener.callback>

• callback

  • Type: function

• callbackKey

  • Type: string

• delay

  • Type: int

• isRunning

  • Type: int

• regexPattern

  • Type: string

• regexReplacement

  • Type: string

---