BiKeyboardEvent

This class describes event object used in keyboard events.

All keyboard events bubble by default. This means that once all the event listeners have been notified the event propagates to the parent BiComponent. To prevent the event to bubble to the parent call stopPropagation() on the event object.

The currently supported keyboard events by BiComponent are:

keydown
keypress
keyup

This object should not be created by the user. It is created as needed by the event system.

This class extends BiEvent and therefore all methods and fields available for BiEvent are also available for BiKeyboardEvent .

Constructor

new BiKeyboardEvent ( sType,oEvent )

Parameters

NameTypeOptionalDefaultDescripton
sTypeStringThe type (name) of the event
oEventObjectThis is the internal browser event object.

Properties

NameTypegetsetDescripton
altKeyBooleancheckedWhether the alt key is pressed
ctrlKeyBooleancheckedWhether the ctrl key is pressed
keyCodeNumbercheckedA number representing the key used
metaKeyBooleancheckedWhether the meta key is pressed. The meta key is platform specific. On Mac it's the command key.
shiftKeyBooleancheckedWhether the shift key is pressed

Methods

None.

Events

None.

Static Methods

None.

Static Fields

NameTypeDescripton
ALTNumberThe key code used for the ALT key.
BACKSPACENumberThe key code used for the BACKSPACE key.
CONTROLNumberThe key code used for the CONTROL key. Same as CTRL
CTRLNumberThe key code used for the CTRL key.
DELNumberThe key code used for the DEL key.
DELETENumberThe key code used for the DELETE key. Same as DEL
DOWNNumberThe key code used for the DOWN key.
ENDNumberThe key code used for the END key.
ENTERNumberThe key code used for the ENTER key.
ESCNumberThe key code used for the ESC key.
F1NumberThe key code used for the F1 key.
F10NumberThe key code used for the F10 key.
F11NumberThe key code used for the F11 key.
F12NumberThe key code used for the F12 key.
F2NumberThe key code used for the F2 key.
F3NumberThe key code used for the F3 key.
F4NumberThe key code used for the F4 key.
F5NumberThe key code used for the F5 key.
F6NumberThe key code used for the F6 key.
F7NumberThe key code used for the F7 key.
F8NumberThe key code used for the F8 key.
F9NumberThe key code used for the F9 key.
HOMENumberThe key code used for the HOME key.
INSERTNumberThe key code used for the INSERT key.
LEFTNumberThe key code used for the LEFT key.
NUM_LOCKNumberThe key code used for the NUM_LOCK key.
NUMPAD_DIVIDENumberdescription="The key code used for the NUMPAD_DIVIDE key."
NUMPAD_MINUSNumberThe key code used for the NUMPAD_MINUS key.
NUMPAD_MULTIPLYNumberdescription="The key code used for the NUMPAD_MULTIPLY key."
NUMPAD_PLUSNumberThe key code used for the NUMPAD_PLUS key.
NUMPAD0NumberThe key code used for the NUMPAD0 key.
NUMPAD1NumberThe key code used for the NUMPAD1 key.
NUMPAD2NumberThe key code used for the NUMPAD2 key.
NUMPAD3NumberThe key code used for the NUMPAD3 key.
NUMPAD4NumberThe key code used for the NUMPAD4 key.
NUMPAD5NumberThe key code used for the NUMPAD5 key.
NUMPAD6NumberThe key code used for the NUMPAD6 key.
NUMPAD7NumberThe key code used for the NUMPAD7 key.
NUMPAD8NumberThe key code used for the NUMPAD8 key.
NUMPAD9NumberThe key code used for the NUMPAD9 key.
PAGE_DOWNNumberThe key code used for the PAGE_DOWN key.
PAGE_UPNumberThe key code used for the PAGE_UP key.
RIGHTNumberThe key code used for the RIGHT key.
SHIFTNumberThe key code used for the SHIFT key.
SPACENumberThe key code used for the SPACE key.
TABNumberThe key code used for the TAB key.
UPNumberThe key code used for the UP key.

Remarks

This object should not be created by the user. It is created as needed by the event system.