KeyboardEvent

This object is available to unprivileged JavaScript. It implements the following interfaces:

Constants

The current event phase is the capturing phase.
short CAPTURING_PHASE = 1
The event is currently being evaluated at the target EventTarget.
short AT_TARGET = 2
The current event phase is the bubbling phase.
short BUBBLING_PHASE = 3
int DOM_VK_CANCEL = 3
int DOM_VK_HELP = 6
int DOM_VK_BACK_SPACE = 8
int DOM_VK_TAB = 9
int DOM_VK_CLEAR = 12
int DOM_VK_RETURN = 13
int DOM_VK_ENTER = 14
int DOM_VK_SHIFT = 16
int DOM_VK_CONTROL = 17
int DOM_VK_ALT = 18
int DOM_VK_PAUSE = 19
int DOM_VK_CAPS_LOCK = 20
int DOM_VK_ESCAPE = 27
int DOM_VK_SPACE = 32
int DOM_VK_PAGE_UP = 33
int DOM_VK_PAGE_DOWN = 34
int DOM_VK_END = 35
int DOM_VK_HOME = 36
int DOM_VK_LEFT = 37
int DOM_VK_UP = 38
int DOM_VK_RIGHT = 39
int DOM_VK_DOWN = 40
int DOM_VK_PRINTSCREEN = 44
int DOM_VK_INSERT = 45
int DOM_VK_DELETE = 46
int DOM_VK_0 = 48
int DOM_VK_1 = 49
int DOM_VK_2 = 50
int DOM_VK_3 = 51
int DOM_VK_4 = 52
int DOM_VK_5 = 53
int DOM_VK_6 = 54
int DOM_VK_7 = 55
int DOM_VK_8 = 56
int DOM_VK_9 = 57
int DOM_VK_SEMICOLON = 59
int DOM_VK_EQUALS = 61
int DOM_VK_A = 65
int DOM_VK_B = 66
int DOM_VK_C = 67
int DOM_VK_D = 68
int DOM_VK_E = 69
int DOM_VK_F = 70
int DOM_VK_G = 71
int DOM_VK_H = 72
int DOM_VK_I = 73
int DOM_VK_J = 74
int DOM_VK_K = 75
int DOM_VK_L = 76
int DOM_VK_M = 77
int DOM_VK_N = 78
int DOM_VK_O = 79
int DOM_VK_P = 80
int DOM_VK_Q = 81
int DOM_VK_R = 82
int DOM_VK_S = 83
int DOM_VK_T = 84
int DOM_VK_U = 85
int DOM_VK_V = 86
int DOM_VK_W = 87
int DOM_VK_X = 88
int DOM_VK_Y = 89
int DOM_VK_Z = 90
int DOM_VK_CONTEXT_MENU = 93
int DOM_VK_NUMPAD0 = 96
int DOM_VK_NUMPAD1 = 97
int DOM_VK_NUMPAD2 = 98
int DOM_VK_NUMPAD3 = 99
int DOM_VK_NUMPAD4 = 100
int DOM_VK_NUMPAD5 = 101
int DOM_VK_NUMPAD6 = 102
int DOM_VK_NUMPAD7 = 103
int DOM_VK_NUMPAD8 = 104
int DOM_VK_NUMPAD9 = 105
int DOM_VK_MULTIPLY = 106
int DOM_VK_ADD = 107
int DOM_VK_SEPARATOR = 108
int DOM_VK_SUBTRACT = 109
int DOM_VK_DECIMAL = 110
int DOM_VK_DIVIDE = 111
int DOM_VK_F1 = 112
int DOM_VK_F2 = 113
int DOM_VK_F3 = 114
int DOM_VK_F4 = 115
int DOM_VK_F5 = 116
int DOM_VK_F6 = 117
int DOM_VK_F7 = 118
int DOM_VK_F8 = 119
int DOM_VK_F9 = 120
int DOM_VK_F10 = 121
int DOM_VK_F11 = 122
int DOM_VK_F12 = 123
int DOM_VK_F13 = 124
int DOM_VK_F14 = 125
int DOM_VK_F15 = 126
int DOM_VK_F16 = 127
int DOM_VK_F17 = 128
int DOM_VK_F18 = 129
int DOM_VK_F19 = 130
int DOM_VK_F20 = 131
int DOM_VK_F21 = 132
int DOM_VK_F22 = 133
int DOM_VK_F23 = 134
int DOM_VK_F24 = 135
int DOM_VK_NUM_LOCK = 144
int DOM_VK_SCROLL_LOCK = 145
int DOM_VK_COMMA = 188
int DOM_VK_PERIOD = 190
int DOM_VK_SLASH = 191
int DOM_VK_BACK_QUOTE = 192
int DOM_VK_OPEN_BRACKET = 219
int DOM_VK_BACK_SLASH = 220
int DOM_VK_CLOSE_BRACKET = 221
int DOM_VK_QUOTE = 222
int DOM_VK_META = 224
PRInt32 MOUSEDOWN = 1
PRInt32 MOUSEUP = 2
PRInt32 MOUSEOVER = 4
PRInt32 MOUSEOUT = 8
PRInt32 MOUSEMOVE = 16
PRInt32 MOUSEDRAG = 32
PRInt32 CLICK = 64
PRInt32 DBLCLICK = 128
PRInt32 KEYDOWN = 256
PRInt32 KEYUP = 512
PRInt32 KEYPRESS = 1024
PRInt32 DRAGDROP = 2048
PRInt32 FOCUS = 4096
PRInt32 BLUR = 8192
PRInt32 SELECT = 16384
PRInt32 CHANGE = 32768
PRInt32 RESET = 65536
PRInt32 SUBMIT = 131072
PRInt32 SCROLL = 262144
PRInt32 LOAD = 524288
PRInt32 UNLOAD = 1048576
PRInt32 XFER_DONE = 2097152
PRInt32 ABORT = 4194304
PRInt32 ERROR = 8388608
PRInt32 LOCATE = 16777216
PRInt32 MOVE = 33554432
PRInt32 RESIZE = 67108864
PRInt32 FORWARD = 134217728
PRInt32 HELP = 268435456
PRInt32 BACK = 536870912
PRInt32 TEXT = 1073741824
PRInt32 ALT_MASK = 1
PRInt32 CONTROL_MASK = 2
PRInt32 SHIFT_MASK = 4
PRInt32 META_MASK = 8
PRInt32 SCROLL_PAGE_UP = -32768
PRInt32 SCROLL_PAGE_DOWN = 32768

Properties

readonly boolean altKey

readonly boolean bubbles

Used to indicate whether or not an event is a bubbling event. If the event can bubble the value is true, else the value is false.

readonly boolean cancelable

Used to indicate whether or not an event can have its default action prevented. If the default action can be prevented the value is true, else the value is false.

boolean cancelBubble

readonly int charCode

readonly boolean ctrlKey

readonly EventTarget currentTarget

Used to indicate the EventTarget whose EventListeners are currently being processed. This is particularly useful during capturing and bubbling.

readonly PRInt32 detail

readonly short eventPhase

Used to indicate which phase of event flow is currently being evaluated.

readonly EventTarget explicitOriginalTarget

The explicit original target of the event. If the event was retargeted for some reason other than an anonymous boundary crossing, this will be set to the target before the retargeting occurs. For example, mouse events are retargeted to their parent node when they happen over text nodes (bug 185889), and in that case .target will show the parent and .explicitOriginalTarget will show the text node. .explicitOriginalTarget differs from .originalTarget in that it will never contain anonymous content.

readonly boolean isChar

readonly boolean isTrusted

readonly int keyCode

readonly PRInt32 layerX

readonly PRInt32 layerY

readonly boolean metaKey

readonly EventTarget originalTarget

readonly PRInt32 pageX

readonly PRInt32 pageY

readonly PRInt32 rangeOffset

readonly Node rangeParent

readonly boolean shiftKey

readonly EventTarget target

Used to indicate the EventTarget to which the event was originally dispatched.

readonly DOMTimeStamp timeStamp

Used to specify the time (in milliseconds relative to the epoch) at which the event was created. Due to the fact that some systems may not provide this information the value of timeStamp may be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970.

readonly EventTarget tmpRealOriginalTarget

readonly String type

The name of the event (case-insensitive). The name must be an XML name.

readonly AbstractView view

readonly int which


Methods

boolean getPreventDefault ( ) void initEvent ( String eventTypeArg , boolean canBubbleArg , boolean cancelableArg ) void initKeyEvent ( String typeArg , boolean canBubbleArg , boolean cancelableArg , AbstractView viewArg , boolean ctrlKeyArg , boolean altKeyArg , boolean shiftKeyArg , boolean metkeyArg , int keyCodeArg , int charCodeArg ) void initUIEvent ( String typeArg , boolean canBubbleArg , boolean cancelableArg , AbstractView viewArg , PRInt32 detailArg ) void preventBubble ( ) void preventCapture ( ) void preventDefault ( ) void stopPropagation ( )

boolean getPreventDefault ( )


void initEvent ( String eventTypeArg , boolean canBubbleArg , boolean cancelableArg )

The initEvent method is used to initialize the value of an Event created through the DocumentEvent interface. This method may only be called before the Event has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times the final invocation takes precedence. If called from a subclass of Event interface only the values specified in the initEvent method are modified, all other attributes are left unchanged.

Arguments:
eventTypeArg: Specifies the event type. This type may be any event type currently defined in this specification or a new event type.. The string must be an XML name. Any new event type must not begin with any upper, lower, or mixed case version of the string "DOM". This prefix is reserved for future DOM event sets. It is also strongly recommended that third parties adding their own events use their own prefix to avoid confusion and lessen the probability of conflicts with other new events.
canBubbleArg: Specifies whether or not the event can bubble.
cancelableArg: Specifies whether or not the event's default action can be prevented.

void initKeyEvent ( String typeArg , boolean canBubbleArg , boolean cancelableArg , AbstractView viewArg , boolean ctrlKeyArg , boolean altKeyArg , boolean shiftKeyArg , boolean metkeyArg , int keyCodeArg , int charCodeArg )

Arguments:
typeArg
canBubbleArg
cancelableArg
viewArg
ctrlKeyArg
altKeyArg
shiftKeyArg
metkeyArg
keyCodeArg
charCodeArg

void initUIEvent ( String typeArg , boolean canBubbleArg , boolean cancelableArg , AbstractView viewArg , PRInt32 detailArg )

Arguments:
typeArg
canBubbleArg
cancelableArg
viewArg
detailArg

void preventBubble ( )


void preventCapture ( )


void preventDefault ( )

If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur. If, during any stage of event flow, the preventDefault method is called the event is canceled. Any default action associated with the event will not occur. Calling this method for a non-cancelable event has no effect. Once preventDefault has been called it will remain in effect throughout the remainder of the event's propagation. This method may be used during any stage of event flow.


void stopPropagation ( )

The stopPropagation method is used prevent further propagation of an event during event flow. If this method is called by any EventListener the event will cease propagating through the tree. The event will complete dispatch to all listeners on the current EventTarget before event flow stops. This method may be used during any stage of event flow.

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com