selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
22 lines (16 loc) • 17.4 kB
HTML
<meta charset="UTF-8"><meta http-equiv="Content-Language" content="en" /><title>goog.events.KeyCodes</title><link href="dossier.css" rel="stylesheet" type="text/css"><div id="main-wrapper"><input type="checkbox" id="sidenav-toggle" /><main><header><h1>Enum goog.events.KeyCodes</h1><a class="source" href="source/lib/goog/events/keycodes.js.src.html#l35">code »</a><dl><dt>Type: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code></dl></header><section><p>Key codes for common characters.
This list is not localized and therefore some of the key codes are not
correct for non US keyboard layouts. See comments below.<h2>Values and Descriptions</h2><div class="type-summary"><dl class="public"><dt><a class="enum member" name="goog.events.KeyCodes.A">A</a><dt><a class="enum member" name="goog.events.KeyCodes.ALT">ALT</a><dt><a class="enum member" name="goog.events.KeyCodes.APOSTROPHE">APOSTROPHE</a><dt><a class="enum member" name="goog.events.KeyCodes.B">B</a><dt><a class="enum member" name="goog.events.KeyCodes.BACKSLASH">BACKSLASH</a><dt><a class="enum member" name="goog.events.KeyCodes.BACKSPACE">BACKSPACE</a><dt><a class="enum member" name="goog.events.KeyCodes.C">C</a><dt><a class="enum member" name="goog.events.KeyCodes.CAPS_LOCK">CAPS_LOCK</a><dt><a class="enum member" name="goog.events.KeyCodes.CLOSE_SQUARE_BRACKET">CLOSE_SQUARE_BRACKET</a><dt><a class="enum member" name="goog.events.KeyCodes.COMMA">COMMA</a><dt><a class="enum member" name="goog.events.KeyCodes.CONTEXT_MENU">CONTEXT_MENU</a><dt><a class="enum member" name="goog.events.KeyCodes.CTRL">CTRL</a><dt><a class="enum member" name="goog.events.KeyCodes.D">D</a><dt><a class="enum member" name="goog.events.KeyCodes.DASH">DASH</a><dt><a class="enum member" name="goog.events.KeyCodes.DELETE">DELETE</a><dt><a class="enum member" name="goog.events.KeyCodes.DOWN">DOWN</a><dt><a class="enum member" name="goog.events.KeyCodes.E">E</a><dt><a class="enum member" name="goog.events.KeyCodes.EIGHT">EIGHT</a><dt><a class="enum member" name="goog.events.KeyCodes.END">END</a><dt><a class="enum member" name="goog.events.KeyCodes.ENTER">ENTER</a><dt><a class="enum member" name="goog.events.KeyCodes.EQUALS">EQUALS</a><dt><a class="enum member" name="goog.events.KeyCodes.ESC">ESC</a><dt><a class="enum member" name="goog.events.KeyCodes.F">F</a><dt><a class="enum member" name="goog.events.KeyCodes.F1">F1</a><dt><a class="enum member" name="goog.events.KeyCodes.F10">F10</a><dt><a class="enum member" name="goog.events.KeyCodes.F11">F11</a><dt><a class="enum member" name="goog.events.KeyCodes.F12">F12</a><dt><a class="enum member" name="goog.events.KeyCodes.F2">F2</a><dt><a class="enum member" name="goog.events.KeyCodes.F3">F3</a><dt><a class="enum member" name="goog.events.KeyCodes.F4">F4</a><dt><a class="enum member" name="goog.events.KeyCodes.F5">F5</a><dt><a class="enum member" name="goog.events.KeyCodes.F6">F6</a><dt><a class="enum member" name="goog.events.KeyCodes.F7">F7</a><dt><a class="enum member" name="goog.events.KeyCodes.F8">F8</a><dt><a class="enum member" name="goog.events.KeyCodes.F9">F9</a><dt><a class="enum member" name="goog.events.KeyCodes.FF_DASH">FF_DASH</a><dt><a class="enum member" name="goog.events.KeyCodes.FF_EQUALS">FF_EQUALS</a><dt><a class="enum member" name="goog.events.KeyCodes.FF_SEMICOLON">FF_SEMICOLON</a><dt><a class="enum member" name="goog.events.KeyCodes.FIRST_MEDIA_KEY">FIRST_MEDIA_KEY</a><dt><a class="enum member" name="goog.events.KeyCodes.FIVE">FIVE</a><dt><a class="enum member" name="goog.events.KeyCodes.FOUR">FOUR</a><dt><a class="enum member" name="goog.events.KeyCodes.G">G</a><dt><a class="enum member" name="goog.events.KeyCodes.H">H</a><dt><a class="enum member" name="goog.events.KeyCodes.HOME">HOME</a><dt><a class="enum member" name="goog.events.KeyCodes.I">I</a><dt><a class="enum member" name="goog.events.KeyCodes.INSERT">INSERT</a><dt><a class="enum member" name="goog.events.KeyCodes.J">J</a><dt><a class="enum member" name="goog.events.KeyCodes.K">K</a><dt><a class="enum member" name="goog.events.KeyCodes.L">L</a><dt><a class="enum member" name="goog.events.KeyCodes.LAST_MEDIA_KEY">LAST_MEDIA_KEY</a><dt><a class="enum member" name="goog.events.KeyCodes.LEFT">LEFT</a><dt><a class="enum member" name="goog.events.KeyCodes.M">M</a><dt><a class="enum member" name="goog.events.KeyCodes.MAC_ENTER">MAC_ENTER</a><dt><a class="enum member" name="goog.events.KeyCodes.MAC_FF_META">MAC_FF_META</a><dt><a class="enum member" name="goog.events.KeyCodes.MAC_WK_CMD_LEFT">MAC_WK_CMD_LEFT</a><dt><a class="enum member" name="goog.events.KeyCodes.MAC_WK_CMD_RIGHT">MAC_WK_CMD_RIGHT</a><dt><a class="enum member" name="goog.events.KeyCodes.META">META</a><dt><a class="enum member" name="goog.events.KeyCodes.N">N</a><dt><a class="enum member" name="goog.events.KeyCodes.NINE">NINE</a><dt><a class="enum member" name="goog.events.KeyCodes.NUMLOCK">NUMLOCK</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_CENTER">NUM_CENTER</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_DIVISION">NUM_DIVISION</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_EIGHT">NUM_EIGHT</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_FIVE">NUM_FIVE</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_FOUR">NUM_FOUR</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_MINUS">NUM_MINUS</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_MULTIPLY">NUM_MULTIPLY</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_NINE">NUM_NINE</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_ONE">NUM_ONE</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_PERIOD">NUM_PERIOD</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_PLUS">NUM_PLUS</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_SEVEN">NUM_SEVEN</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_SIX">NUM_SIX</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_THREE">NUM_THREE</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_TWO">NUM_TWO</a><dt><a class="enum member" name="goog.events.KeyCodes.NUM_ZERO">NUM_ZERO</a><dt><a class="enum member" name="goog.events.KeyCodes.O">O</a><dt><a class="enum member" name="goog.events.KeyCodes.ONE">ONE</a><dt><a class="enum member" name="goog.events.KeyCodes.OPEN_SQUARE_BRACKET">OPEN_SQUARE_BRACKET</a><dt><a class="enum member" name="goog.events.KeyCodes.P">P</a><dt><a class="enum member" name="goog.events.KeyCodes.PAGE_DOWN">PAGE_DOWN</a><dt><a class="enum member" name="goog.events.KeyCodes.PAGE_UP">PAGE_UP</a><dt><a class="enum member" name="goog.events.KeyCodes.PAUSE">PAUSE</a><dt><a class="enum member" name="goog.events.KeyCodes.PERIOD">PERIOD</a><dt><a class="enum member" name="goog.events.KeyCodes.PHANTOM">PHANTOM</a><dt><a class="enum member" name="goog.events.KeyCodes.PRINT_SCREEN">PRINT_SCREEN</a><dt><a class="enum member" name="goog.events.KeyCodes.Q">Q</a><dt><a class="enum member" name="goog.events.KeyCodes.QUESTION_MARK">QUESTION_MARK</a><dt><a class="enum member" name="goog.events.KeyCodes.R">R</a><dt><a class="enum member" name="goog.events.KeyCodes.RIGHT">RIGHT</a><dt><a class="enum member" name="goog.events.KeyCodes.S">S</a><dt><a class="enum member" name="goog.events.KeyCodes.SCROLL_LOCK">SCROLL_LOCK</a><dt><a class="enum member" name="goog.events.KeyCodes.SEMICOLON">SEMICOLON</a><dt><a class="enum member" name="goog.events.KeyCodes.SEVEN">SEVEN</a><dt><a class="enum member" name="goog.events.KeyCodes.SHIFT">SHIFT</a><dt><a class="enum member" name="goog.events.KeyCodes.SINGLE_QUOTE">SINGLE_QUOTE</a><dt><a class="enum member" name="goog.events.KeyCodes.SIX">SIX</a><dt><a class="enum member" name="goog.events.KeyCodes.SLASH">SLASH</a><dt><a class="enum member" name="goog.events.KeyCodes.SPACE">SPACE</a><dt><a class="enum member" name="goog.events.KeyCodes.T">T</a><dt><a class="enum member" name="goog.events.KeyCodes.TAB">TAB</a><dt><a class="enum member" name="goog.events.KeyCodes.THREE">THREE</a><dt><a class="enum member" name="goog.events.KeyCodes.TILDE">TILDE</a><dt><a class="enum member" name="goog.events.KeyCodes.TWO">TWO</a><dt><a class="enum member" name="goog.events.KeyCodes.U">U</a><dt><a class="enum member" name="goog.events.KeyCodes.UP">UP</a><dt><a class="enum member" name="goog.events.KeyCodes.V">V</a><dt><a class="enum member" name="goog.events.KeyCodes.W">W</a><dt><a class="enum member" name="goog.events.KeyCodes.WIN_IME">WIN_IME</a><dt><a class="enum member" name="goog.events.KeyCodes.WIN_KEY">WIN_KEY</a><dt><a class="enum member" name="goog.events.KeyCodes.WIN_KEY_FF_LINUX">WIN_KEY_FF_LINUX</a><dt><a class="enum member" name="goog.events.KeyCodes.WIN_KEY_RIGHT">WIN_KEY_RIGHT</a><dt><a class="enum member" name="goog.events.KeyCodes.X">X</a><dt><a class="enum member" name="goog.events.KeyCodes.Y">Y</a><dt><a class="enum member" name="goog.events.KeyCodes.Z">Z</a><dt><a class="enum member" name="goog.events.KeyCodes.ZERO">ZERO</a></dl></div></section><div id="visibility-controls"><b>Show:</b><label for="show-public"><span><input type="checkbox" id="show-public" checked/></span>Public</label><label for="show-protected"><span><input type="checkbox" id="show-protected"/></span>Protected</label><label for="show-private"><span><input type="checkbox" id="show-private"/></span>Private</label></div><section id="static-functions"><h2>Global Functions</h2><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/events/keycodes.js.src.html#l243">code »</a><span class="member"><a name="goog.events.KeyCodes.firesKeyPressEvent">goog.events.KeyCodes.firesKeyPressEvent</a> <span class="args">( keyCode, opt_heldKeyCode, opt_shiftKey, opt_ctrlKey, opt_altKey )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Returns true if the key fires a keypress event in the current browser.
Accoridng to MSDN [1] IE only fires keypress events for the following keys:
- Letters: A - Z (uppercase and lowercase)
- Numerals: 0 - 9
- Symbols: ! @ # $ % ^ & * ( ) _ - + = < [ ] { } , . / ? \ | ' ` " ~
- System: ESC, SPACEBAR, ENTER
That's not entirely correct though, for instance there's no distinction
between upper and lower case letters.
[1] http://msdn2.microsoft.com/en-us/library/ms536939(VS.85).aspx)
Safari is similar to IE, but does not fire keypress for ESC.
Additionally, IE6 does not fire keydown or keypress events for letters when
the control or alt keys are held down and the shift key is not. IE7 does
fire keydown in these cases, though, but not keypress.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>keyCode: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd>A key code.<dt>opt_heldKeyCode: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>=</code><dd>Key code of a currently-held key.<dt>opt_shiftKey: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>=</code><dd>Whether the shift key is held down.<dt>opt_ctrlKey: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>=</code><dd>Whether the control key is held down.<dt>opt_altKey: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a>=</code><dd>Whether the alt key is held down.</dl><tr><th>Returns<tr><td><dl>Whether it's a key that fires a keypress event.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/events/keycodes.js.src.html#l316">code »</a><span class="member"><a name="goog.events.KeyCodes.isCharacterKey">goog.events.KeyCodes.isCharacterKey</a> <span class="args">( keyCode )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Returns true if the key produces a character.
This does not cover characters on non-US keyboards (Russian, Hebrew, etc.).</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>keyCode: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd>A key code.</dl><tr><th>Returns<tr><td><dl>Whether it's a character key.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/events/keycodes.js.src.html#l169">code »</a><span class="member"><a name="goog.events.KeyCodes.isTextModifyingKeyEvent">goog.events.KeyCodes.isTextModifyingKeyEvent</a> <span class="args">( e )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></span></div><p>Returns true if the event contains a text modifying key.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>e: <code class="type"><a href="class_goog_events_BrowserEvent.html">goog.events.BrowserEvent</a></code><dd>A key event.</dl><tr><th>Returns<tr><td><dl>Whether it's a text modifying key.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/events/keycodes.js.src.html#l385">code »</a><span class="member"><a name="goog.events.KeyCodes.normalizeGeckoKeyCode">goog.events.KeyCodes.normalizeGeckoKeyCode</a> <span class="args">( keyCode )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code></span></div><p>Normalizes key codes from their Gecko-specific value to the general one.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>keyCode: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd>The native key code.</dl><tr><th>Returns<tr><td><dl>The normalized key code.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/events/keycodes.js.src.html#l369">code »</a><span class="member"><a name="goog.events.KeyCodes.normalizeKeyCode">goog.events.KeyCodes.normalizeKeyCode</a> <span class="args">( keyCode )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code></span></div><p>Normalizes key codes from OS/Browser-specific value to the general one.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>keyCode: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd>The native key code.</dl><tr><th>Returns<tr><td><dl>The normalized key code.</dl></table></div></details></div></div><div class="wrap-details public"><div><details class="function"><summary><div><a class="source" href="source/lib/goog/events/keycodes.js.src.html#l408">code »</a><span class="member"><a name="goog.events.KeyCodes.normalizeMacWebKitKeyCode">goog.events.KeyCodes.normalizeMacWebKitKeyCode</a> <span class="args">( keyCode )</span> ⇒ <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code></span></div><p>Normalizes key codes from their Mac WebKit-specific value to the general one.</summary><div class="info"><table><tbody><tr><th>Parameters<tr><td><dl><dt>keyCode: <code class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code><dd>The native key code.</dl><tr><th>Returns<tr><td><dl>The normalized key code.</dl></table></div></details></div></div></section></main><nav id="topnav"><div><div id="menubutton"><label for="sidenav-toggle">Menu</label></div><form id="searchbox"><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></nav><nav id="sidenav"><input type="checkbox" id="sidenav-types-ctrl" /><input type="checkbox" id="sidenav-files-ctrl" /><input type="checkbox" id="sidenav-modules-ctrl" /><a id="sidenav-overview"><div><h4>Overview</h4></div></a><div id="sidenav-types"><label for="sidenav-types-ctrl"><h4>Types</h4></label><i>Loading</i></div><div id="sidenav-modules"><label for="sidenav-modules-ctrl"><h4>Modules</h4></label><i>Loading</i></div><div id="sidenav-files"><label for="sidenav-files-ctrl"><h4>Files</h4></label><i>Loading</i></div><a href="license.html"><div><h4>License</h4></div></a></nav><div id="push-footer"></div></div><footer><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></footer><script src="types.js"></script><script src="dossier.js"></script>