1 /* 2 * Copyright (C) 2006 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package android.view; 18 19 import android.os.Parcel; 20 import android.os.Parcelable; 21 import android.text.method.MetaKeyKeyListener; 22 import android.util.Log; 23 import android.util.SparseIntArray; 24 import android.view.KeyCharacterMap; 25 import android.view.KeyCharacterMap.KeyData; 26 27 /** 28 * Object used to report key and button events. 29 * <p> 30 * Each key press is described by a sequence of key events. A key press 31 * starts with a key event with {@link #ACTION_DOWN}. If the key is held 32 * sufficiently long that it repeats, then the initial down is followed 33 * additional key events with {@link #ACTION_DOWN} and a non-zero value for 34 * {@link #getRepeatCount()}. The last key event is a {@link #ACTION_UP} 35 * for the key up. If the key press is canceled, the key up event will have the 36 * {@link #FLAG_CANCELED} flag set. 37 * </p><p> 38 * Key events are generally accompanied by a key code ({@link #getKeyCode()}), 39 * scan code ({@link #getScanCode()}) and meta state ({@link #getMetaState()}). 40 * Key code constants are defined in this class. Scan code constants are raw 41 * device-specific codes obtained from the OS and so are not generally meaningful 42 * to applications unless interpreted using the {@link KeyCharacterMap}. 43 * Meta states describe the pressed state of key modifiers 44 * such as {@link #META_SHIFT_ON} or {@link #META_ALT_ON}. 45 * </p><p> 46 * Key codes typically correspond one-to-one with individual keys on an input device. 47 * Many keys and key combinations serve quite different functions on different 48 * input devices so care must be taken when interpreting them. Always use the 49 * {@link KeyCharacterMap} associated with the input device when mapping keys 50 * to characters. Be aware that there may be multiple key input devices active 51 * at the same time and each will have its own key character map. 52 * </p><p> 53 * As soft input methods can use multiple and inventive ways of inputting text, 54 * there is no guarantee that any key press on a soft keyboard will generate a key 55 * event: this is left to the IME's discretion, and in fact sending such events is 56 * discouraged. You should never rely on receiving KeyEvents for any key on a soft 57 * input method. In particular, the default software keyboard will never send any 58 * key event to any application targetting Jelly Bean or later, and will only send 59 * events for some presses of the delete and return keys to applications targetting 60 * Ice Cream Sandwich or earlier. Be aware that other software input methods may 61 * never send key events regardless of the version. Consider using editor actions 62 * like {@link android.view.inputmethod.EditorInfo#IME_ACTION_DONE} if you need 63 * specific interaction with the software keyboard, as it gives more visibility to 64 * the user as to how your application will react to key presses. 65 * </p><p> 66 * When interacting with an IME, the framework may deliver key events 67 * with the special action {@link #ACTION_MULTIPLE} that either specifies 68 * that single repeated key code or a sequence of characters to insert. 69 * </p><p> 70 * In general, the framework cannot guarantee that the key events it delivers 71 * to a view always constitute complete key sequences since some events may be dropped 72 * or modified by containing views before they are delivered. The view implementation 73 * should be prepared to handle {@link #FLAG_CANCELED} and should tolerate anomalous 74 * situations such as receiving a new {@link #ACTION_DOWN} without first having 75 * received an {@link #ACTION_UP} for the prior key press. 76 * </p><p> 77 * Refer to {@link InputDevice} for more information about how different kinds of 78 * input devices and sources represent keys and buttons. 79 * </p> 80 */ 81 public class KeyEvent extends InputEvent implements Parcelable { 82 /** Key code constant: Unknown key code. */ 83 public static final int KEYCODE_UNKNOWN = 0; 84 /** Key code constant: Soft Left key. 85 * Usually situated below the display on phones and used as a multi-function 86 * feature key for selecting a software defined function shown on the bottom left 87 * of the display. */ 88 public static final int KEYCODE_SOFT_LEFT = 1; 89 /** Key code constant: Soft Right key. 90 * Usually situated below the display on phones and used as a multi-function 91 * feature key for selecting a software defined function shown on the bottom right 92 * of the display. */ 93 public static final int KEYCODE_SOFT_RIGHT = 2; 94 /** Key code constant: Home key. 95 * This key is handled by the framework and is never delivered to applications. */ 96 public static final int KEYCODE_HOME = 3; 97 /** Key code constant: Back key. */ 98 public static final int KEYCODE_BACK = 4; 99 /** Key code constant: Call key. */ 100 public static final int KEYCODE_CALL = 5; 101 /** Key code constant: End Call key. */ 102 public static final int KEYCODE_ENDCALL = 6; 103 /** Key code constant: '0' key. */ 104 public static final int KEYCODE_0 = 7; 105 /** Key code constant: '1' key. */ 106 public static final int KEYCODE_1 = 8; 107 /** Key code constant: '2' key. */ 108 public static final int KEYCODE_2 = 9; 109 /** Key code constant: '3' key. */ 110 public static final int KEYCODE_3 = 10; 111 /** Key code constant: '4' key. */ 112 public static final int KEYCODE_4 = 11; 113 /** Key code constant: '5' key. */ 114 public static final int KEYCODE_5 = 12; 115 /** Key code constant: '6' key. */ 116 public static final int KEYCODE_6 = 13; 117 /** Key code constant: '7' key. */ 118 public static final int KEYCODE_7 = 14; 119 /** Key code constant: '8' key. */ 120 public static final int KEYCODE_8 = 15; 121 /** Key code constant: '9' key. */ 122 public static final int KEYCODE_9 = 16; 123 /** Key code constant: '*' key. */ 124 public static final int KEYCODE_STAR = 17; 125 /** Key code constant: '#' key. */ 126 public static final int KEYCODE_POUND = 18; 127 /** Key code constant: Directional Pad Up key. 128 * May also be synthesized from trackball motions. */ 129 public static final int KEYCODE_DPAD_UP = 19; 130 /** Key code constant: Directional Pad Down key. 131 * May also be synthesized from trackball motions. */ 132 public static final int KEYCODE_DPAD_DOWN = 20; 133 /** Key code constant: Directional Pad Left key. 134 * May also be synthesized from trackball motions. */ 135 public static final int KEYCODE_DPAD_LEFT = 21; 136 /** Key code constant: Directional Pad Right key. 137 * May also be synthesized from trackball motions. */ 138 public static final int KEYCODE_DPAD_RIGHT = 22; 139 /** Key code constant: Directional Pad Center key. 140 * May also be synthesized from trackball motions. */ 141 public static final int KEYCODE_DPAD_CENTER = 23; 142 /** Key code constant: Volume Up key. 143 * Adjusts the speaker volume up. */ 144 public static final int KEYCODE_VOLUME_UP = 24; 145 /** Key code constant: Volume Down key. 146 * Adjusts the speaker volume down. */ 147 public static final int KEYCODE_VOLUME_DOWN = 25; 148 /** Key code constant: Power key. */ 149 public static final int KEYCODE_POWER = 26; 150 /** Key code constant: Camera key. 151 * Used to launch a camera application or take pictures. */ 152 public static final int KEYCODE_CAMERA = 27; 153 /** Key code constant: Clear key. */ 154 public static final int KEYCODE_CLEAR = 28; 155 /** Key code constant: 'A' key. */ 156 public static final int KEYCODE_A = 29; 157 /** Key code constant: 'B' key. */ 158 public static final int KEYCODE_B = 30; 159 /** Key code constant: 'C' key. */ 160 public static final int KEYCODE_C = 31; 161 /** Key code constant: 'D' key. */ 162 public static final int KEYCODE_D = 32; 163 /** Key code constant: 'E' key. */ 164 public static final int KEYCODE_E = 33; 165 /** Key code constant: 'F' key. */ 166 public static final int KEYCODE_F = 34; 167 /** Key code constant: 'G' key. */ 168 public static final int KEYCODE_G = 35; 169 /** Key code constant: 'H' key. */ 170 public static final int KEYCODE_H = 36; 171 /** Key code constant: 'I' key. */ 172 public static final int KEYCODE_I = 37; 173 /** Key code constant: 'J' key. */ 174 public static final int KEYCODE_J = 38; 175 /** Key code constant: 'K' key. */ 176 public static final int KEYCODE_K = 39; 177 /** Key code constant: 'L' key. */ 178 public static final int KEYCODE_L = 40; 179 /** Key code constant: 'M' key. */ 180 public static final int KEYCODE_M = 41; 181 /** Key code constant: 'N' key. */ 182 public static final int KEYCODE_N = 42; 183 /** Key code constant: 'O' key. */ 184 public static final int KEYCODE_O = 43; 185 /** Key code constant: 'P' key. */ 186 public static final int KEYCODE_P = 44; 187 /** Key code constant: 'Q' key. */ 188 public static final int KEYCODE_Q = 45; 189 /** Key code constant: 'R' key. */ 190 public static final int KEYCODE_R = 46; 191 /** Key code constant: 'S' key. */ 192 public static final int KEYCODE_S = 47; 193 /** Key code constant: 'T' key. */ 194 public static final int KEYCODE_T = 48; 195 /** Key code constant: 'U' key. */ 196 public static final int KEYCODE_U = 49; 197 /** Key code constant: 'V' key. */ 198 public static final int KEYCODE_V = 50; 199 /** Key code constant: 'W' key. */ 200 public static final int KEYCODE_W = 51; 201 /** Key code constant: 'X' key. */ 202 public static final int KEYCODE_X = 52; 203 /** Key code constant: 'Y' key. */ 204 public static final int KEYCODE_Y = 53; 205 /** Key code constant: 'Z' key. */ 206 public static final int KEYCODE_Z = 54; 207 /** Key code constant: ',' key. */ 208 public static final int KEYCODE_COMMA = 55; 209 /** Key code constant: '.' key. */ 210 public static final int KEYCODE_PERIOD = 56; 211 /** Key code constant: Left Alt modifier key. */ 212 public static final int KEYCODE_ALT_LEFT = 57; 213 /** Key code constant: Right Alt modifier key. */ 214 public static final int KEYCODE_ALT_RIGHT = 58; 215 /** Key code constant: Left Shift modifier key. */ 216 public static final int KEYCODE_SHIFT_LEFT = 59; 217 /** Key code constant: Right Shift modifier key. */ 218 public static final int KEYCODE_SHIFT_RIGHT = 60; 219 /** Key code constant: Tab key. */ 220 public static final int KEYCODE_TAB = 61; 221 /** Key code constant: Space key. */ 222 public static final int KEYCODE_SPACE = 62; 223 /** Key code constant: Symbol modifier key. 224 * Used to enter alternate symbols. */ 225 public static final int KEYCODE_SYM = 63; 226 /** Key code constant: Explorer special function key. 227 * Used to launch a browser application. */ 228 public static final int KEYCODE_EXPLORER = 64; 229 /** Key code constant: Envelope special function key. 230 * Used to launch a mail application. */ 231 public static final int KEYCODE_ENVELOPE = 65; 232 /** Key code constant: Enter key. */ 233 public static final int KEYCODE_ENTER = 66; 234 /** Key code constant: Backspace key. 235 * Deletes characters before the insertion point, unlike {@link #KEYCODE_FORWARD_DEL}. */ 236 public static final int KEYCODE_DEL = 67; 237 /** Key code constant: '`' (backtick) key. */ 238 public static final int KEYCODE_GRAVE = 68; 239 /** Key code constant: '-'. */ 240 public static final int KEYCODE_MINUS = 69; 241 /** Key code constant: '=' key. */ 242 public static final int KEYCODE_EQUALS = 70; 243 /** Key code constant: '[' key. */ 244 public static final int KEYCODE_LEFT_BRACKET = 71; 245 /** Key code constant: ']' key. */ 246 public static final int KEYCODE_RIGHT_BRACKET = 72; 247 /** Key code constant: '\' key. */ 248 public static final int KEYCODE_BACKSLASH = 73; 249 /** Key code constant: ';' key. */ 250 public static final int KEYCODE_SEMICOLON = 74; 251 /** Key code constant: ''' (apostrophe) key. */ 252 public static final int KEYCODE_APOSTROPHE = 75; 253 /** Key code constant: '/' key. */ 254 public static final int KEYCODE_SLASH = 76; 255 /** Key code constant: '@' key. */ 256 public static final int KEYCODE_AT = 77; 257 /** Key code constant: Number modifier key. 258 * Used to enter numeric symbols. 259 * This key is not Num Lock; it is more like {@link #KEYCODE_ALT_LEFT} and is 260 * interpreted as an ALT key by {@link android.text.method.MetaKeyKeyListener}. */ 261 public static final int KEYCODE_NUM = 78; 262 /** Key code constant: Headset Hook key. 263 * Used to hang up calls and stop media. */ 264 public static final int KEYCODE_HEADSETHOOK = 79; 265 /** Key code constant: Camera Focus key. 266 * Used to focus the camera. */ 267 public static final int KEYCODE_FOCUS = 80; // *Camera* focus 268 /** Key code constant: '+' key. */ 269 public static final int KEYCODE_PLUS = 81; 270 /** Key code constant: Menu key. */ 271 public static final int KEYCODE_MENU = 82; 272 /** Key code constant: Notification key. */ 273 public static final int KEYCODE_NOTIFICATION = 83; 274 /** Key code constant: Search key. */ 275 public static final int KEYCODE_SEARCH = 84; 276 /** Key code constant: Play/Pause media key. */ 277 public static final int KEYCODE_MEDIA_PLAY_PAUSE= 85; 278 /** Key code constant: Stop media key. */ 279 public static final int KEYCODE_MEDIA_STOP = 86; 280 /** Key code constant: Play Next media key. */ 281 public static final int KEYCODE_MEDIA_NEXT = 87; 282 /** Key code constant: Play Previous media key. */ 283 public static final int KEYCODE_MEDIA_PREVIOUS = 88; 284 /** Key code constant: Rewind media key. */ 285 public static final int KEYCODE_MEDIA_REWIND = 89; 286 /** Key code constant: Fast Forward media key. */ 287 public static final int KEYCODE_MEDIA_FAST_FORWARD = 90; 288 /** Key code constant: Mute key. 289 * Mutes the microphone, unlike {@link #KEYCODE_VOLUME_MUTE}. */ 290 public static final int KEYCODE_MUTE = 91; 291 /** Key code constant: Page Up key. */ 292 public static final int KEYCODE_PAGE_UP = 92; 293 /** Key code constant: Page Down key. */ 294 public static final int KEYCODE_PAGE_DOWN = 93; 295 /** Key code constant: Picture Symbols modifier key. 296 * Used to switch symbol sets (Emoji, Kao-moji). */ 297 public static final int KEYCODE_PICTSYMBOLS = 94; // switch symbol-sets (Emoji,Kao-moji) 298 /** Key code constant: Switch Charset modifier key. 299 * Used to switch character sets (Kanji, Katakana). */ 300 public static final int KEYCODE_SWITCH_CHARSET = 95; // switch char-sets (Kanji,Katakana) 301 /** Key code constant: A Button key. 302 * On a game controller, the A button should be either the button labeled A 303 * or the first button on the bottom row of controller buttons. */ 304 public static final int KEYCODE_BUTTON_A = 96; 305 /** Key code constant: B Button key. 306 * On a game controller, the B button should be either the button labeled B 307 * or the second button on the bottom row of controller buttons. */ 308 public static final int KEYCODE_BUTTON_B = 97; 309 /** Key code constant: C Button key. 310 * On a game controller, the C button should be either the button labeled C 311 * or the third button on the bottom row of controller buttons. */ 312 public static final int KEYCODE_BUTTON_C = 98; 313 /** Key code constant: X Button key. 314 * On a game controller, the X button should be either the button labeled X 315 * or the first button on the upper row of controller buttons. */ 316 public static final int KEYCODE_BUTTON_X = 99; 317 /** Key code constant: Y Button key. 318 * On a game controller, the Y button should be either the button labeled Y 319 * or the second button on the upper row of controller buttons. */ 320 public static final int KEYCODE_BUTTON_Y = 100; 321 /** Key code constant: Z Button key. 322 * On a game controller, the Z button should be either the button labeled Z 323 * or the third button on the upper row of controller buttons. */ 324 public static final int KEYCODE_BUTTON_Z = 101; 325 /** Key code constant: L1 Button key. 326 * On a game controller, the L1 button should be either the button labeled L1 (or L) 327 * or the top left trigger button. */ 328 public static final int KEYCODE_BUTTON_L1 = 102; 329 /** Key code constant: R1 Button key. 330 * On a game controller, the R1 button should be either the button labeled R1 (or R) 331 * or the top right trigger button. */ 332 public static final int KEYCODE_BUTTON_R1 = 103; 333 /** Key code constant: L2 Button key. 334 * On a game controller, the L2 button should be either the button labeled L2 335 * or the bottom left trigger button. */ 336 public static final int KEYCODE_BUTTON_L2 = 104; 337 /** Key code constant: R2 Button key. 338 * On a game controller, the R2 button should be either the button labeled R2 339 * or the bottom right trigger button. */ 340 public static final int KEYCODE_BUTTON_R2 = 105; 341 /** Key code constant: Left Thumb Button key. 342 * On a game controller, the left thumb button indicates that the left (or only) 343 * joystick is pressed. */ 344 public static final int KEYCODE_BUTTON_THUMBL = 106; 345 /** Key code constant: Right Thumb Button key. 346 * On a game controller, the right thumb button indicates that the right 347 * joystick is pressed. */ 348 public static final int KEYCODE_BUTTON_THUMBR = 107; 349 /** Key code constant: Start Button key. 350 * On a game controller, the button labeled Start. */ 351 public static final int KEYCODE_BUTTON_START = 108; 352 /** Key code constant: Select Button key. 353 * On a game controller, the button labeled Select. */ 354 public static final int KEYCODE_BUTTON_SELECT = 109; 355 /** Key code constant: Mode Button key. 356 * On a game controller, the button labeled Mode. */ 357 public static final int KEYCODE_BUTTON_MODE = 110; 358 /** Key code constant: Escape key. */ 359 public static final int KEYCODE_ESCAPE = 111; 360 /** Key code constant: Forward Delete key. 361 * Deletes characters ahead of the insertion point, unlike {@link #KEYCODE_DEL}. */ 362 public static final int KEYCODE_FORWARD_DEL = 112; 363 /** Key code constant: Left Control modifier key. */ 364 public static final int KEYCODE_CTRL_LEFT = 113; 365 /** Key code constant: Right Control modifier key. */ 366 public static final int KEYCODE_CTRL_RIGHT = 114; 367 /** Key code constant: Caps Lock key. */ 368 public static final int KEYCODE_CAPS_LOCK = 115; 369 /** Key code constant: Scroll Lock key. */ 370 public static final int KEYCODE_SCROLL_LOCK = 116; 371 /** Key code constant: Left Meta modifier key. */ 372 public static final int KEYCODE_META_LEFT = 117; 373 /** Key code constant: Right Meta modifier key. */ 374 public static final int KEYCODE_META_RIGHT = 118; 375 /** Key code constant: Function modifier key. */ 376 public static final int KEYCODE_FUNCTION = 119; 377 /** Key code constant: System Request / Print Screen key. */ 378 public static final int KEYCODE_SYSRQ = 120; 379 /** Key code constant: Break / Pause key. */ 380 public static final int KEYCODE_BREAK = 121; 381 /** Key code constant: Home Movement key. 382 * Used for scrolling or moving the cursor around to the start of a line 383 * or to the top of a list. */ 384 public static final int KEYCODE_MOVE_HOME = 122; 385 /** Key code constant: End Movement key. 386 * Used for scrolling or moving the cursor around to the end of a line 387 * or to the bottom of a list. */ 388 public static final int KEYCODE_MOVE_END = 123; 389 /** Key code constant: Insert key. 390 * Toggles insert / overwrite edit mode. */ 391 public static final int KEYCODE_INSERT = 124; 392 /** Key code constant: Forward key. 393 * Navigates forward in the history stack. Complement of {@link #KEYCODE_BACK}. */ 394 public static final int KEYCODE_FORWARD = 125; 395 /** Key code constant: Play media key. */ 396 public static final int KEYCODE_MEDIA_PLAY = 126; 397 /** Key code constant: Pause media key. */ 398 public static final int KEYCODE_MEDIA_PAUSE = 127; 399 /** Key code constant: Close media key. 400 * May be used to close a CD tray, for example. */ 401 public static final int KEYCODE_MEDIA_CLOSE = 128; 402 /** Key code constant: Eject media key. 403 * May be used to eject a CD tray, for example. */ 404 public static final int KEYCODE_MEDIA_EJECT = 129; 405 /** Key code constant: Record media key. */ 406 public static final int KEYCODE_MEDIA_RECORD = 130; 407 /** Key code constant: F1 key. */ 408 public static final int KEYCODE_F1 = 131; 409 /** Key code constant: F2 key. */ 410 public static final int KEYCODE_F2 = 132; 411 /** Key code constant: F3 key. */ 412 public static final int KEYCODE_F3 = 133; 413 /** Key code constant: F4 key. */ 414 public static final int KEYCODE_F4 = 134; 415 /** Key code constant: F5 key. */ 416 public static final int KEYCODE_F5 = 135; 417 /** Key code constant: F6 key. */ 418 public static final int KEYCODE_F6 = 136; 419 /** Key code constant: F7 key. */ 420 public static final int KEYCODE_F7 = 137; 421 /** Key code constant: F8 key. */ 422 public static final int KEYCODE_F8 = 138; 423 /** Key code constant: F9 key. */ 424 public static final int KEYCODE_F9 = 139; 425 /** Key code constant: F10 key. */ 426 public static final int KEYCODE_F10 = 140; 427 /** Key code constant: F11 key. */ 428 public static final int KEYCODE_F11 = 141; 429 /** Key code constant: F12 key. */ 430 public static final int KEYCODE_F12 = 142; 431 /** Key code constant: Num Lock key. 432 * This is the Num Lock key; it is different from {@link #KEYCODE_NUM}. 433 * This key alters the behavior of other keys on the numeric keypad. */ 434 public static final int KEYCODE_NUM_LOCK = 143; 435 /** Key code constant: Numeric keypad '0' key. */ 436 public static final int KEYCODE_NUMPAD_0 = 144; 437 /** Key code constant: Numeric keypad '1' key. */ 438 public static final int KEYCODE_NUMPAD_1 = 145; 439 /** Key code constant: Numeric keypad '2' key. */ 440 public static final int KEYCODE_NUMPAD_2 = 146; 441 /** Key code constant: Numeric keypad '3' key. */ 442 public static final int KEYCODE_NUMPAD_3 = 147; 443 /** Key code constant: Numeric keypad '4' key. */ 444 public static final int KEYCODE_NUMPAD_4 = 148; 445 /** Key code constant: Numeric keypad '5' key. */ 446 public static final int KEYCODE_NUMPAD_5 = 149; 447 /** Key code constant: Numeric keypad '6' key. */ 448 public static final int KEYCODE_NUMPAD_6 = 150; 449 /** Key code constant: Numeric keypad '7' key. */ 450 public static final int KEYCODE_NUMPAD_7 = 151; 451 /** Key code constant: Numeric keypad '8' key. */ 452 public static final int KEYCODE_NUMPAD_8 = 152; 453 /** Key code constant: Numeric keypad '9' key. */ 454 public static final int KEYCODE_NUMPAD_9 = 153; 455 /** Key code constant: Numeric keypad '/' key (for division). */ 456 public static final int KEYCODE_NUMPAD_DIVIDE = 154; 457 /** Key code constant: Numeric keypad '*' key (for multiplication). */ 458 public static final int KEYCODE_NUMPAD_MULTIPLY = 155; 459 /** Key code constant: Numeric keypad '-' key (for subtraction). */ 460 public static final int KEYCODE_NUMPAD_SUBTRACT = 156; 461 /** Key code constant: Numeric keypad '+' key (for addition). */ 462 public static final int KEYCODE_NUMPAD_ADD = 157; 463 /** Key code constant: Numeric keypad '.' key (for decimals or digit grouping). */ 464 public static final int KEYCODE_NUMPAD_DOT = 158; 465 /** Key code constant: Numeric keypad ',' key (for decimals or digit grouping). */ 466 public static final int KEYCODE_NUMPAD_COMMA = 159; 467 /** Key code constant: Numeric keypad Enter key. */ 468 public static final int KEYCODE_NUMPAD_ENTER = 160; 469 /** Key code constant: Numeric keypad '=' key. */ 470 public static final int KEYCODE_NUMPAD_EQUALS = 161; 471 /** Key code constant: Numeric keypad '(' key. */ 472 public static final int KEYCODE_NUMPAD_LEFT_PAREN = 162; 473 /** Key code constant: Numeric keypad ')' key. */ 474 public static final int KEYCODE_NUMPAD_RIGHT_PAREN = 163; 475 /** Key code constant: Volume Mute key. 476 * Mutes the speaker, unlike {@link #KEYCODE_MUTE}. 477 * This key should normally be implemented as a toggle such that the first press 478 * mutes the speaker and the second press restores the original volume. */ 479 public static final int KEYCODE_VOLUME_MUTE = 164; 480 /** Key code constant: Info key. 481 * Common on TV remotes to show additional information related to what is 482 * currently being viewed. */ 483 public static final int KEYCODE_INFO = 165; 484 /** Key code constant: Channel up key. 485 * On TV remotes, increments the television channel. */ 486 public static final int KEYCODE_CHANNEL_UP = 166; 487 /** Key code constant: Channel down key. 488 * On TV remotes, decrements the television channel. */ 489 public static final int KEYCODE_CHANNEL_DOWN = 167; 490 /** Key code constant: Zoom in key. */ 491 public static final int KEYCODE_ZOOM_IN = 168; 492 /** Key code constant: Zoom out key. */ 493 public static final int KEYCODE_ZOOM_OUT = 169; 494 /** Key code constant: TV key. 495 * On TV remotes, switches to viewing live TV. */ 496 public static final int KEYCODE_TV = 170; 497 /** Key code constant: Window key. 498 * On TV remotes, toggles picture-in-picture mode or other windowing functions. */ 499 public static final int KEYCODE_WINDOW = 171; 500 /** Key code constant: Guide key. 501 * On TV remotes, shows a programming guide. */ 502 public static final int KEYCODE_GUIDE = 172; 503 /** Key code constant: DVR key. 504 * On some TV remotes, switches to a DVR mode for recorded shows. */ 505 public static final int KEYCODE_DVR = 173; 506 /** Key code constant: Bookmark key. 507 * On some TV remotes, bookmarks content or web pages. */ 508 public static final int KEYCODE_BOOKMARK = 174; 509 /** Key code constant: Toggle captions key. 510 * Switches the mode for closed-captioning text, for example during television shows. */ 511 public static final int KEYCODE_CAPTIONS = 175; 512 /** Key code constant: Settings key. 513 * Starts the system settings activity. */ 514 public static final int KEYCODE_SETTINGS = 176; 515 /** Key code constant: TV power key. 516 * On TV remotes, toggles the power on a television screen. */ 517 public static final int KEYCODE_TV_POWER = 177; 518 /** Key code constant: TV input key. 519 * On TV remotes, switches the input on a television screen. */ 520 public static final int KEYCODE_TV_INPUT = 178; 521 /** Key code constant: Set-top-box power key. 522 * On TV remotes, toggles the power on an external Set-top-box. */ 523 public static final int KEYCODE_STB_POWER = 179; 524 /** Key code constant: Set-top-box input key. 525 * On TV remotes, switches the input mode on an external Set-top-box. */ 526 public static final int KEYCODE_STB_INPUT = 180; 527 /** Key code constant: A/V Receiver power key. 528 * On TV remotes, toggles the power on an external A/V Receiver. */ 529 public static final int KEYCODE_AVR_POWER = 181; 530 /** Key code constant: A/V Receiver input key. 531 * On TV remotes, switches the input mode on an external A/V Receiver. */ 532 public static final int KEYCODE_AVR_INPUT = 182; 533 /** Key code constant: Red "programmable" key. 534 * On TV remotes, acts as a contextual/programmable key. */ 535 public static final int KEYCODE_PROG_RED = 183; 536 /** Key code constant: Green "programmable" key. 537 * On TV remotes, actsas a contextual/programmable key. */ 538 public static final int KEYCODE_PROG_GREEN = 184; 539 /** Key code constant: Yellow "programmable" key. 540 * On TV remotes, acts as a contextual/programmable key. */ 541 public static final int KEYCODE_PROG_YELLOW = 185; 542 /** Key code constant: Blue "programmable" key. 543 * On TV remotes, acts as a contextual/programmable key. */ 544 public static final int KEYCODE_PROG_BLUE = 186; 545 /** Key code constant: App switch key. 546 * Should bring up the application switcher dialog. */ 547 public static final int KEYCODE_APP_SWITCH = 187; 548 /** Key code constant: Generic Game Pad Button #1.*/ 549 public static final int KEYCODE_BUTTON_1 = 188; 550 /** Key code constant: Generic Game Pad Button #2.*/ 551 public static final int KEYCODE_BUTTON_2 = 189; 552 /** Key code constant: Generic Game Pad Button #3.*/ 553 public static final int KEYCODE_BUTTON_3 = 190; 554 /** Key code constant: Generic Game Pad Button #4.*/ 555 public static final int KEYCODE_BUTTON_4 = 191; 556 /** Key code constant: Generic Game Pad Button #5.*/ 557 public static final int KEYCODE_BUTTON_5 = 192; 558 /** Key code constant: Generic Game Pad Button #6.*/ 559 public static final int KEYCODE_BUTTON_6 = 193; 560 /** Key code constant: Generic Game Pad Button #7.*/ 561 public static final int KEYCODE_BUTTON_7 = 194; 562 /** Key code constant: Generic Game Pad Button #8.*/ 563 public static final int KEYCODE_BUTTON_8 = 195; 564 /** Key code constant: Generic Game Pad Button #9.*/ 565 public static final int KEYCODE_BUTTON_9 = 196; 566 /** Key code constant: Generic Game Pad Button #10.*/ 567 public static final int KEYCODE_BUTTON_10 = 197; 568 /** Key code constant: Generic Game Pad Button #11.*/ 569 public static final int KEYCODE_BUTTON_11 = 198; 570 /** Key code constant: Generic Game Pad Button #12.*/ 571 public static final int KEYCODE_BUTTON_12 = 199; 572 /** Key code constant: Generic Game Pad Button #13.*/ 573 public static final int KEYCODE_BUTTON_13 = 200; 574 /** Key code constant: Generic Game Pad Button #14.*/ 575 public static final int KEYCODE_BUTTON_14 = 201; 576 /** Key code constant: Generic Game Pad Button #15.*/ 577 public static final int KEYCODE_BUTTON_15 = 202; 578 /** Key code constant: Generic Game Pad Button #16.*/ 579 public static final int KEYCODE_BUTTON_16 = 203; 580 /** Key code constant: Language Switch key. 581 * Toggles the current input language such as switching between English and Japanese on 582 * a QWERTY keyboard. On some devices, the same function may be performed by 583 * pressing Shift+Spacebar. */ 584 public static final int KEYCODE_LANGUAGE_SWITCH = 204; 585 /** Key code constant: Manner Mode key. 586 * Toggles silent or vibrate mode on and off to make the device behave more politely 587 * in certain settings such as on a crowded train. On some devices, the key may only 588 * operate when long-pressed. */ 589 public static final int KEYCODE_MANNER_MODE = 205; 590 /** Key code constant: 3D Mode key. 591 * Toggles the display between 2D and 3D mode. */ 592 public static final int KEYCODE_3D_MODE = 206; 593 /** Key code constant: Contacts special function key. 594 * Used to launch an address book application. */ 595 public static final int KEYCODE_CONTACTS = 207; 596 /** Key code constant: Calendar special function key. 597 * Used to launch a calendar application. */ 598 public static final int KEYCODE_CALENDAR = 208; 599 /** Key code constant: Music special function key. 600 * Used to launch a music player application. */ 601 public static final int KEYCODE_MUSIC = 209; 602 /** Key code constant: Calculator special function key. 603 * Used to launch a calculator application. */ 604 public static final int KEYCODE_CALCULATOR = 210; 605 /** Key code constant: Japanese full-width / half-width key. */ 606 public static final int KEYCODE_ZENKAKU_HANKAKU = 211; 607 /** Key code constant: Japanese alphanumeric key. */ 608 public static final int KEYCODE_EISU = 212; 609 /** Key code constant: Japanese non-conversion key. */ 610 public static final int KEYCODE_MUHENKAN = 213; 611 /** Key code constant: Japanese conversion key. */ 612 public static final int KEYCODE_HENKAN = 214; 613 /** Key code constant: Japanese katakana / hiragana key. */ 614 public static final int KEYCODE_KATAKANA_HIRAGANA = 215; 615 /** Key code constant: Japanese Yen key. */ 616 public static final int KEYCODE_YEN = 216; 617 /** Key code constant: Japanese Ro key. */ 618 public static final int KEYCODE_RO = 217; 619 /** Key code constant: Japanese kana key. */ 620 public static final int KEYCODE_KANA = 218; 621 /** Key code constant: Assist key. 622 * Launches the global assist activity. Not delivered to applications. */ 623 public static final int KEYCODE_ASSIST = 219; 624 /** Key code constant: Brightness Down key. 625 * Adjusts the screen brightness down. */ 626 public static final int KEYCODE_BRIGHTNESS_DOWN = 220; 627 /** Key code constant: Brightness Up key. 628 * Adjusts the screen brightness up. */ 629 public static final int KEYCODE_BRIGHTNESS_UP = 221; 630 /** Key code constant: Audio Track key. 631 * Switches the audio tracks. */ 632 public static final int KEYCODE_MEDIA_AUDIO_TRACK = 222; 633 /** Key code constant: Sleep key. 634 * Puts the device to sleep. Behaves somewhat like {@link #KEYCODE_POWER} but it 635 * has no effect if the device is already asleep. */ 636 public static final int KEYCODE_SLEEP = 223; 637 /** Key code constant: Wakeup key. 638 * Wakes up the device. Behaves somewhat like {@link #KEYCODE_POWER} but it 639 * has no effect if the device is already awake. */ 640 public static final int KEYCODE_WAKEUP = 224; 641 /** Key code constant: Pairing key. 642 * Initiates peripheral pairing mode. Useful for pairing remote control 643 * devices or game controllers, especially if no other input mode is 644 * available. */ 645 public static final int KEYCODE_PAIRING = 225; 646 /** Key code constant: Media Top Menu key. 647 * Goes to the top of media menu. */ 648 public static final int KEYCODE_MEDIA_TOP_MENU = 226; 649 /** Key code constant: '11' key. */ 650 public static final int KEYCODE_11 = 227; 651 /** Key code constant: '12' key. */ 652 public static final int KEYCODE_12 = 228; 653 /** Key code constant: Last Channel key. 654 * Goes to the last viewed channel. */ 655 public static final int KEYCODE_LAST_CHANNEL = 229; 656 /** Key code constant: TV data service key. 657 * Displays data services like weather, sports. */ 658 public static final int KEYCODE_TV_DATA_SERVICE = 230; 659 /** Key code constant: Voice Assist key. 660 * Launches the global voice assist activity. Not delivered to applications. */ 661 public static final int KEYCODE_VOICE_ASSIST = 231; 662 /** Key code constant: Radio key. 663 * Toggles TV service / Radio service. */ 664 public static final int KEYCODE_TV_RADIO_SERVICE = 232; 665 /** Key code constant: Teletext key. 666 * Displays Teletext service. */ 667 public static final int KEYCODE_TV_TELETEXT = 233; 668 /** Key code constant: Number entry key. 669 * Initiates to enter multi-digit channel nubmber when each digit key is assigned 670 * for selecting separate channel. Corresponds to Number Entry Mode (0x1D) of CEC 671 * User Control Code. */ 672 public static final int KEYCODE_TV_NUMBER_ENTRY = 234; 673 /** Key code constant: Analog Terrestrial key. 674 * Switches to analog terrestrial broadcast service. */ 675 public static final int KEYCODE_TV_TERRESTRIAL_ANALOG = 235; 676 /** Key code constant: Digital Terrestrial key. 677 * Switches to digital terrestrial broadcast service. */ 678 public static final int KEYCODE_TV_TERRESTRIAL_DIGITAL = 236; 679 /** Key code constant: Satellite key. 680 * Switches to digital satellite broadcast service. */ 681 public static final int KEYCODE_TV_SATELLITE = 237; 682 /** Key code constant: BS key. 683 * Switches to BS digital satellite broadcasting service available in Japan. */ 684 public static final int KEYCODE_TV_SATELLITE_BS = 238; 685 /** Key code constant: CS key. 686 * Switches to CS digital satellite broadcasting service available in Japan. */ 687 public static final int KEYCODE_TV_SATELLITE_CS = 239; 688 /** Key code constant: BS/CS key. 689 * Toggles between BS and CS digital satellite services. */ 690 public static final int KEYCODE_TV_SATELLITE_SERVICE = 240; 691 /** Key code constant: Toggle Network key. 692 * Toggles selecting broacast services. */ 693 public static final int KEYCODE_TV_NETWORK = 241; 694 /** Key code constant: Antenna/Cable key. 695 * Toggles broadcast input source between antenna and cable. */ 696 public static final int KEYCODE_TV_ANTENNA_CABLE = 242; 697 /** Key code constant: HDMI #1 key. 698 * Switches to HDMI input #1. */ 699 public static final int KEYCODE_TV_INPUT_HDMI_1 = 243; 700 /** Key code constant: HDMI #2 key. 701 * Switches to HDMI input #2. */ 702 public static final int KEYCODE_TV_INPUT_HDMI_2 = 244; 703 /** Key code constant: HDMI #3 key. 704 * Switches to HDMI input #3. */ 705 public static final int KEYCODE_TV_INPUT_HDMI_3 = 245; 706 /** Key code constant: HDMI #4 key. 707 * Switches to HDMI input #4. */ 708 public static final int KEYCODE_TV_INPUT_HDMI_4 = 246; 709 /** Key code constant: Composite #1 key. 710 * Switches to composite video input #1. */ 711 public static final int KEYCODE_TV_INPUT_COMPOSITE_1 = 247; 712 /** Key code constant: Composite #2 key. 713 * Switches to composite video input #2. */ 714 public static final int KEYCODE_TV_INPUT_COMPOSITE_2 = 248; 715 /** Key code constant: Component #1 key. 716 * Switches to component video input #1. */ 717 public static final int KEYCODE_TV_INPUT_COMPONENT_1 = 249; 718 /** Key code constant: Component #2 key. 719 * Switches to component video input #2. */ 720 public static final int KEYCODE_TV_INPUT_COMPONENT_2 = 250; 721 /** Key code constant: VGA #1 key. 722 * Switches to VGA (analog RGB) input #1. */ 723 public static final int KEYCODE_TV_INPUT_VGA_1 = 251; 724 /** Key code constant: Audio description key. 725 * Toggles audio description off / on. */ 726 public static final int KEYCODE_TV_AUDIO_DESCRIPTION = 252; 727 /** Key code constant: Audio description mixing volume up key. 728 * Louden audio description volume as compared with normal audio volume. */ 729 public static final int KEYCODE_TV_AUDIO_DESCRIPTION_MIX_UP = 253; 730 /** Key code constant: Audio description mixing volume down key. 731 * Lessen audio description volume as compared with normal audio volume. */ 732 public static final int KEYCODE_TV_AUDIO_DESCRIPTION_MIX_DOWN = 254; 733 /** Key code constant: Zoom mode key. 734 * Changes Zoom mode (Normal, Full, Zoom, Wide-zoom, etc.) */ 735 public static final int KEYCODE_TV_ZOOM_MODE = 255; 736 /** Key code constant: Contents menu key. 737 * Goes to the title list. Corresponds to Contents Menu (0x0B) of CEC User Control 738 * Code */ 739 public static final int KEYCODE_TV_CONTENTS_MENU = 256; 740 /** Key code constant: Media context menu key. 741 * Goes to the context menu of media contents. Corresponds to Media Context-sensitive 742 * Menu (0x11) of CEC User Control Code. */ 743 public static final int KEYCODE_TV_MEDIA_CONTEXT_MENU = 257; 744 /** Key code constant: Timer programming key. 745 * Goes to the timer recording menu. Corresponds to Timer Programming (0x54) of 746 * CEC User Control Code. */ 747 public static final int KEYCODE_TV_TIMER_PROGRAMMING = 258; 748 /** Key code constant: Help key. */ 749 public static final int KEYCODE_HELP = 259; 750 /** Key code constant: Navigate to previous key. 751 * Goes backward by one item in an ordered collection of items. */ 752 public static final int KEYCODE_NAVIGATE_PREVIOUS = 260; 753 /** Key code constant: Navigate to next key. 754 * Advances to the next item in an ordered collection of items. */ 755 public static final int KEYCODE_NAVIGATE_NEXT = 261; 756 /** Key code constant: Navigate in key. 757 * Activates the item that currently has focus or expands to the next level of a navigation 758 * hierarchy. */ 759 public static final int KEYCODE_NAVIGATE_IN = 262; 760 /** Key code constant: Navigate out key. 761 * Backs out one level of a navigation hierarchy or collapses the item that currently has 762 * focus. */ 763 public static final int KEYCODE_NAVIGATE_OUT = 263; 764 /** Key code constant: Primary stem key for Wear 765 * Main power/reset button on watch. */ 766 public static final int KEYCODE_STEM_PRIMARY = 264; 767 /** Key code constant: Generic stem key 1 for Wear */ 768 public static final int KEYCODE_STEM_1 = 265; 769 /** Key code constant: Generic stem key 2 for Wear */ 770 public static final int KEYCODE_STEM_2 = 266; 771 /** Key code constant: Generic stem key 3 for Wear */ 772 public static final int KEYCODE_STEM_3 = 267; 773 /** Key code constant: Directional Pad Up-Left */ 774 public static final int KEYCODE_DPAD_UP_LEFT = 268; 775 /** Key code constant: Directional Pad Down-Left */ 776 public static final int KEYCODE_DPAD_DOWN_LEFT = 269; 777 /** Key code constant: Directional Pad Up-Right */ 778 public static final int KEYCODE_DPAD_UP_RIGHT = 270; 779 /** Key code constant: Directional Pad Down-Right */ 780 public static final int KEYCODE_DPAD_DOWN_RIGHT = 271; 781 /** Key code constant: Skip forward media key. */ 782 public static final int KEYCODE_MEDIA_SKIP_FORWARD = 272; 783 /** Key code constant: Skip backward media key. */ 784 public static final int KEYCODE_MEDIA_SKIP_BACKWARD = 273; 785 /** Key code constant: Step forward media key. 786 * Steps media forward, one frame at a time. */ 787 public static final int KEYCODE_MEDIA_STEP_FORWARD = 274; 788 /** Key code constant: Step backward media key. 789 * Steps media backward, one frame at a time. */ 790 public static final int KEYCODE_MEDIA_STEP_BACKWARD = 275; 791 /** Key code constant: put device to sleep unless a wakelock is held. */ 792 public static final int KEYCODE_SOFT_SLEEP = 276; 793 /** Key code constant: Cut key. */ 794 public static final int KEYCODE_CUT = 277; 795 /** Key code constant: Copy key. */ 796 public static final int KEYCODE_COPY = 278; 797 /** Key code constant: Paste key. */ 798 public static final int KEYCODE_PASTE = 279; 799 /** Key code constant: Consumed by the system for navigation up */ 800 public static final int KEYCODE_SYSTEM_NAVIGATION_UP = 280; 801 /** Key code constant: Consumed by the system for navigation down */ 802 public static final int KEYCODE_SYSTEM_NAVIGATION_DOWN = 281; 803 /** Key code constant: Consumed by the system for navigation left*/ 804 public static final int KEYCODE_SYSTEM_NAVIGATION_LEFT = 282; 805 /** Key code constant: Consumed by the system for navigation right */ 806 public static final int KEYCODE_SYSTEM_NAVIGATION_RIGHT = 283; 807 808 private static final int LAST_KEYCODE = KEYCODE_SYSTEM_NAVIGATION_RIGHT; 809 810 // NOTE: If you add a new keycode here you must also add it to: 811 // isSystem() 812 // isWakeKey() 813 // frameworks/native/include/android/keycodes.h 814 // frameworks/native/include/input/InputEventLabels.h 815 // frameworks/base/core/res/res/values/attrs.xml 816 // emulator? 817 // LAST_KEYCODE 818 // 819 // Also Android currently does not reserve code ranges for vendor- 820 // specific key codes. If you have new key codes to have, you 821 // MUST contribute a patch to the open source project to define 822 // those new codes. This is intended to maintain a consistent 823 // set of key code definitions across all Android devices. 824 825 // Symbolic names of all metakeys in bit order from least significant to most significant. 826 // Accordingly there are exactly 32 values in this table. 827 private static final String[] META_SYMBOLIC_NAMES = new String[] { 828 "META_SHIFT_ON", 829 "META_ALT_ON", 830 "META_SYM_ON", 831 "META_FUNCTION_ON", 832 "META_ALT_LEFT_ON", 833 "META_ALT_RIGHT_ON", 834 "META_SHIFT_LEFT_ON", 835 "META_SHIFT_RIGHT_ON", 836 "META_CAP_LOCKED", 837 "META_ALT_LOCKED", 838 "META_SYM_LOCKED", 839 "0x00000800", 840 "META_CTRL_ON", 841 "META_CTRL_LEFT_ON", 842 "META_CTRL_RIGHT_ON", 843 "0x00008000", 844 "META_META_ON", 845 "META_META_LEFT_ON", 846 "META_META_RIGHT_ON", 847 "0x00080000", 848 "META_CAPS_LOCK_ON", 849 "META_NUM_LOCK_ON", 850 "META_SCROLL_LOCK_ON", 851 "0x00800000", 852 "0x01000000", 853 "0x02000000", 854 "0x04000000", 855 "0x08000000", 856 "0x10000000", 857 "0x20000000", 858 "0x40000000", 859 "0x80000000", 860 }; 861 862 private static final String LABEL_PREFIX = "KEYCODE_"; 863 864 /** 865 * @deprecated There are now more than MAX_KEYCODE keycodes. 866 * Use {@link #getMaxKeyCode()} instead. 867 */ 868 @Deprecated 869 public static final int MAX_KEYCODE = 84; 870 871 /** 872 * {@link #getAction} value: the key has been pressed down. 873 */ 874 public static final int ACTION_DOWN = 0; 875 /** 876 * {@link #getAction} value: the key has been released. 877 */ 878 public static final int ACTION_UP = 1; 879 /** 880 * {@link #getAction} value: multiple duplicate key events have 881 * occurred in a row, or a complex string is being delivered. If the 882 * key code is not {#link {@link #KEYCODE_UNKNOWN} then the 883 * {#link {@link #getRepeatCount()} method returns the number of times 884 * the given key code should be executed. 885 * Otherwise, if the key code is {@link #KEYCODE_UNKNOWN}, then 886 * this is a sequence of characters as returned by {@link #getCharacters}. 887 */ 888 public static final int ACTION_MULTIPLE = 2; 889 890 /** 891 * SHIFT key locked in CAPS mode. 892 * Reserved for use by {@link MetaKeyKeyListener} for a published constant in its API. 893 * @hide 894 */ 895 public static final int META_CAP_LOCKED = 0x100; 896 897 /** 898 * ALT key locked. 899 * Reserved for use by {@link MetaKeyKeyListener} for a published constant in its API. 900 * @hide 901 */ 902 public static final int META_ALT_LOCKED = 0x200; 903 904 /** 905 * SYM key locked. 906 * Reserved for use by {@link MetaKeyKeyListener} for a published constant in its API. 907 * @hide 908 */ 909 public static final int META_SYM_LOCKED = 0x400; 910 911 /** 912 * Text is in selection mode. 913 * Reserved for use by {@link MetaKeyKeyListener} for a private unpublished constant 914 * in its API that is currently being retained for legacy reasons. 915 * @hide 916 */ 917 public static final int META_SELECTING = 0x800; 918 919 /** 920 * <p>This mask is used to check whether one of the ALT meta keys is pressed.</p> 921 * 922 * @see #isAltPressed() 923 * @see #getMetaState() 924 * @see #KEYCODE_ALT_LEFT 925 * @see #KEYCODE_ALT_RIGHT 926 */ 927 public static final int META_ALT_ON = 0x02; 928 929 /** 930 * <p>This mask is used to check whether the left ALT meta key is pressed.</p> 931 * 932 * @see #isAltPressed() 933 * @see #getMetaState() 934 * @see #KEYCODE_ALT_LEFT 935 */ 936 public static final int META_ALT_LEFT_ON = 0x10; 937 938 /** 939 * <p>This mask is used to check whether the right the ALT meta key is pressed.</p> 940 * 941 * @see #isAltPressed() 942 * @see #getMetaState() 943 * @see #KEYCODE_ALT_RIGHT 944 */ 945 public static final int META_ALT_RIGHT_ON = 0x20; 946 947 /** 948 * <p>This mask is used to check whether one of the SHIFT meta keys is pressed.</p> 949 * 950 * @see #isShiftPressed() 951 * @see #getMetaState() 952 * @see #KEYCODE_SHIFT_LEFT 953 * @see #KEYCODE_SHIFT_RIGHT 954 */ 955 public static final int META_SHIFT_ON = 0x1; 956 957 /** 958 * <p>This mask is used to check whether the left SHIFT meta key is pressed.</p> 959 * 960 * @see #isShiftPressed() 961 * @see #getMetaState() 962 * @see #KEYCODE_SHIFT_LEFT 963 */ 964 public static final int META_SHIFT_LEFT_ON = 0x40; 965 966 /** 967 * <p>This mask is used to check whether the right SHIFT meta key is pressed.</p> 968 * 969 * @see #isShiftPressed() 970 * @see #getMetaState() 971 * @see #KEYCODE_SHIFT_RIGHT 972 */ 973 public static final int META_SHIFT_RIGHT_ON = 0x80; 974 975 /** 976 * <p>This mask is used to check whether the SYM meta key is pressed.</p> 977 * 978 * @see #isSymPressed() 979 * @see #getMetaState() 980 */ 981 public static final int META_SYM_ON = 0x4; 982 983 /** 984 * <p>This mask is used to check whether the FUNCTION meta key is pressed.</p> 985 * 986 * @see #isFunctionPressed() 987 * @see #getMetaState() 988 */ 989 public static final int META_FUNCTION_ON = 0x8; 990 991 /** 992 * <p>This mask is used to check whether one of the CTRL meta keys is pressed.</p> 993 * 994 * @see #isCtrlPressed() 995 * @see #getMetaState() 996 * @see #KEYCODE_CTRL_LEFT 997 * @see #KEYCODE_CTRL_RIGHT 998 */ 999 public static final int META_CTRL_ON = 0x1000; 1000 1001 /** 1002 * <p>This mask is used to check whether the left CTRL meta key is pressed.</p> 1003 * 1004 * @see #isCtrlPressed() 1005 * @see #getMetaState() 1006 * @see #KEYCODE_CTRL_LEFT 1007 */ 1008 public static final int META_CTRL_LEFT_ON = 0x2000; 1009 1010 /** 1011 * <p>This mask is used to check whether the right CTRL meta key is pressed.</p> 1012 * 1013 * @see #isCtrlPressed() 1014 * @see #getMetaState() 1015 * @see #KEYCODE_CTRL_RIGHT 1016 */ 1017 public static final int META_CTRL_RIGHT_ON = 0x4000; 1018 1019 /** 1020 * <p>This mask is used to check whether one of the META meta keys is pressed.</p> 1021 * 1022 * @see #isMetaPressed() 1023 * @see #getMetaState() 1024 * @see #KEYCODE_META_LEFT 1025 * @see #KEYCODE_META_RIGHT 1026 */ 1027 public static final int META_META_ON = 0x10000; 1028 1029 /** 1030 * <p>This mask is used to check whether the left META meta key is pressed.</p> 1031 * 1032 * @see #isMetaPressed() 1033 * @see #getMetaState() 1034 * @see #KEYCODE_META_LEFT 1035 */ 1036 public static final int META_META_LEFT_ON = 0x20000; 1037 1038 /** 1039 * <p>This mask is used to check whether the right META meta key is pressed.</p> 1040 * 1041 * @see #isMetaPressed() 1042 * @see #getMetaState() 1043 * @see #KEYCODE_META_RIGHT 1044 */ 1045 public static final int META_META_RIGHT_ON = 0x40000; 1046 1047 /** 1048 * <p>This mask is used to check whether the CAPS LOCK meta key is on.</p> 1049 * 1050 * @see #isCapsLockOn() 1051 * @see #getMetaState() 1052 * @see #KEYCODE_CAPS_LOCK 1053 */ 1054 public static final int META_CAPS_LOCK_ON = 0x100000; 1055 1056 /** 1057 * <p>This mask is used to check whether the NUM LOCK meta key is on.</p> 1058 * 1059 * @see #isNumLockOn() 1060 * @see #getMetaState() 1061 * @see #KEYCODE_NUM_LOCK 1062 */ 1063 public static final int META_NUM_LOCK_ON = 0x200000; 1064 1065 /** 1066 * <p>This mask is used to check whether the SCROLL LOCK meta key is on.</p> 1067 * 1068 * @see #isScrollLockOn() 1069 * @see #getMetaState() 1070 * @see #KEYCODE_SCROLL_LOCK 1071 */ 1072 public static final int META_SCROLL_LOCK_ON = 0x400000; 1073 1074 /** 1075 * This mask is a combination of {@link #META_SHIFT_ON}, {@link #META_SHIFT_LEFT_ON} 1076 * and {@link #META_SHIFT_RIGHT_ON}. 1077 */ 1078 public static final int META_SHIFT_MASK = META_SHIFT_ON 1079 | META_SHIFT_LEFT_ON | META_SHIFT_RIGHT_ON; 1080 1081 /** 1082 * This mask is a combination of {@link #META_ALT_ON}, {@link #META_ALT_LEFT_ON} 1083 * and {@link #META_ALT_RIGHT_ON}. 1084 */ 1085 public static final int META_ALT_MASK = META_ALT_ON 1086 | META_ALT_LEFT_ON | META_ALT_RIGHT_ON; 1087 1088 /** 1089 * This mask is a combination of {@link #META_CTRL_ON}, {@link #META_CTRL_LEFT_ON} 1090 * and {@link #META_CTRL_RIGHT_ON}. 1091 */ 1092 public static final int META_CTRL_MASK = META_CTRL_ON 1093 | META_CTRL_LEFT_ON | META_CTRL_RIGHT_ON; 1094 1095 /** 1096 * This mask is a combination of {@link #META_META_ON}, {@link #META_META_LEFT_ON} 1097 * and {@link #META_META_RIGHT_ON}. 1098 */ 1099 public static final int META_META_MASK = META_META_ON 1100 | META_META_LEFT_ON | META_META_RIGHT_ON; 1101 1102 /** 1103 * This mask is set if the device woke because of this key event. 1104 * 1105 * @deprecated This flag will never be set by the system since the system 1106 * consumes all wake keys itself. 1107 */ 1108 @Deprecated 1109 public static final int FLAG_WOKE_HERE = 0x1; 1110 1111 /** 1112 * This mask is set if the key event was generated by a software keyboard. 1113 */ 1114 public static final int FLAG_SOFT_KEYBOARD = 0x2; 1115 1116 /** 1117 * This mask is set if we don't want the key event to cause us to leave 1118 * touch mode. 1119 */ 1120 public static final int FLAG_KEEP_TOUCH_MODE = 0x4; 1121 1122 /** 1123 * This mask is set if an event was known to come from a trusted part 1124 * of the system. That is, the event is known to come from the user, 1125 * and could not have been spoofed by a third party component. 1126 */ 1127 public static final int FLAG_FROM_SYSTEM = 0x8; 1128 1129 /** 1130 * This mask is used for compatibility, to identify enter keys that are 1131 * coming from an IME whose enter key has been auto-labelled "next" or 1132 * "done". This allows TextView to dispatch these as normal enter keys 1133 * for old applications, but still do the appropriate action when 1134 * receiving them. 1135 */ 1136 public static final int FLAG_EDITOR_ACTION = 0x10; 1137 1138 /** 1139 * When associated with up key events, this indicates that the key press 1140 * has been canceled. Typically this is used with virtual touch screen 1141 * keys, where the user can slide from the virtual key area on to the 1142 * display: in that case, the application will receive a canceled up 1143 * event and should not perform the action normally associated with the 1144 * key. Note that for this to work, the application can not perform an 1145 * action for a key until it receives an up or the long press timeout has 1146 * expired. 1147 */ 1148 public static final int FLAG_CANCELED = 0x20; 1149 1150 /** 1151 * This key event was generated by a virtual (on-screen) hard key area. 1152 * Typically this is an area of the touchscreen, outside of the regular 1153 * display, dedicated to "hardware" buttons. 1154 */ 1155 public static final int FLAG_VIRTUAL_HARD_KEY = 0x40; 1156 1157 /** 1158 * This flag is set for the first key repeat that occurs after the 1159 * long press timeout. 1160 */ 1161 public static final int FLAG_LONG_PRESS = 0x80; 1162 1163 /** 1164 * Set when a key event has {@link #FLAG_CANCELED} set because a long 1165 * press action was executed while it was down. 1166 */ 1167 public static final int FLAG_CANCELED_LONG_PRESS = 0x100; 1168 1169 /** 1170 * Set for {@link #ACTION_UP} when this event's key code is still being 1171 * tracked from its initial down. That is, somebody requested that tracking 1172 * started on the key down and a long press has not caused 1173 * the tracking to be canceled. 1174 */ 1175 public static final int FLAG_TRACKING = 0x200; 1176 1177 /** 1178 * Set when a key event has been synthesized to implement default behavior 1179 * for an event that the application did not handle. 1180 * Fallback key events are generated by unhandled trackball motions 1181 * (to emulate a directional keypad) and by certain unhandled key presses 1182 * that are declared in the key map (such as special function numeric keypad 1183 * keys when numlock is off). 1184 */ 1185 public static final int FLAG_FALLBACK = 0x400; 1186 1187 /** 1188 * Signifies that the key is being predispatched. 1189 * @hide 1190 */ 1191 public static final int FLAG_PREDISPATCH = 0x20000000; 1192 1193 /** 1194 * Private control to determine when an app is tracking a key sequence. 1195 * @hide 1196 */ 1197 public static final int FLAG_START_TRACKING = 0x40000000; 1198 1199 /** 1200 * Private flag that indicates when the system has detected that this key event 1201 * may be inconsistent with respect to the sequence of previously delivered key events, 1202 * such as when a key up event is sent but the key was not down. 1203 * 1204 * @hide 1205 * @see #isTainted 1206 * @see #setTainted 1207 */ 1208 public static final int FLAG_TAINTED = 0x80000000; 1209 1210 /** 1211 * Returns the maximum keycode. 1212 */ getMaxKeyCode()1213 public static int getMaxKeyCode() { 1214 return LAST_KEYCODE; 1215 } 1216 1217 /** 1218 * Get the character that is produced by putting accent on the character 1219 * c. 1220 * For example, getDeadChar('`', 'e') returns è. 1221 */ getDeadChar(int accent, int c)1222 public static int getDeadChar(int accent, int c) { 1223 return KeyCharacterMap.getDeadChar(accent, c); 1224 } 1225 1226 static final boolean DEBUG = false; 1227 static final String TAG = "KeyEvent"; 1228 1229 private static final int MAX_RECYCLED = 10; 1230 private static final Object gRecyclerLock = new Object(); 1231 private static int gRecyclerUsed; 1232 private static KeyEvent gRecyclerTop; 1233 1234 private KeyEvent mNext; 1235 1236 private int mDeviceId; 1237 private int mSource; 1238 private int mMetaState; 1239 private int mAction; 1240 private int mKeyCode; 1241 private int mScanCode; 1242 private int mRepeatCount; 1243 private int mFlags; 1244 private long mDownTime; 1245 private long mEventTime; 1246 private String mCharacters; 1247 1248 public interface Callback { 1249 /** 1250 * Called when a key down event has occurred. If you return true, 1251 * you can first call {@link KeyEvent#startTracking() 1252 * KeyEvent.startTracking()} to have the framework track the event 1253 * through its {@link #onKeyUp(int, KeyEvent)} and also call your 1254 * {@link #onKeyLongPress(int, KeyEvent)} if it occurs. 1255 * 1256 * @param keyCode The value in event.getKeyCode(). 1257 * @param event Description of the key event. 1258 * 1259 * @return If you handled the event, return true. If you want to allow 1260 * the event to be handled by the next receiver, return false. 1261 */ onKeyDown(int keyCode, KeyEvent event)1262 boolean onKeyDown(int keyCode, KeyEvent event); 1263 1264 /** 1265 * Called when a long press has occurred. If you return true, 1266 * the final key up will have {@link KeyEvent#FLAG_CANCELED} and 1267 * {@link KeyEvent#FLAG_CANCELED_LONG_PRESS} set. Note that in 1268 * order to receive this callback, someone in the event change 1269 * <em>must</em> return true from {@link #onKeyDown} <em>and</em> 1270 * call {@link KeyEvent#startTracking()} on the event. 1271 * 1272 * @param keyCode The value in event.getKeyCode(). 1273 * @param event Description of the key event. 1274 * 1275 * @return If you handled the event, return true. If you want to allow 1276 * the event to be handled by the next receiver, return false. 1277 */ onKeyLongPress(int keyCode, KeyEvent event)1278 boolean onKeyLongPress(int keyCode, KeyEvent event); 1279 1280 /** 1281 * Called when a key up event has occurred. 1282 * 1283 * @param keyCode The value in event.getKeyCode(). 1284 * @param event Description of the key event. 1285 * 1286 * @return If you handled the event, return true. If you want to allow 1287 * the event to be handled by the next receiver, return false. 1288 */ onKeyUp(int keyCode, KeyEvent event)1289 boolean onKeyUp(int keyCode, KeyEvent event); 1290 1291 /** 1292 * Called when multiple down/up pairs of the same key have occurred 1293 * in a row. 1294 * 1295 * @param keyCode The value in event.getKeyCode(). 1296 * @param count Number of pairs as returned by event.getRepeatCount(). 1297 * @param event Description of the key event. 1298 * 1299 * @return If you handled the event, return true. If you want to allow 1300 * the event to be handled by the next receiver, return false. 1301 */ onKeyMultiple(int keyCode, int count, KeyEvent event)1302 boolean onKeyMultiple(int keyCode, int count, KeyEvent event); 1303 } 1304 nativeKeyCodeToString(int keyCode)1305 private static native String nativeKeyCodeToString(int keyCode); nativeKeyCodeFromString(String keyCode)1306 private static native int nativeKeyCodeFromString(String keyCode); 1307 KeyEvent()1308 private KeyEvent() { 1309 } 1310 1311 /** 1312 * Create a new key event. 1313 * 1314 * @param action Action code: either {@link #ACTION_DOWN}, 1315 * {@link #ACTION_UP}, or {@link #ACTION_MULTIPLE}. 1316 * @param code The key code. 1317 */ KeyEvent(int action, int code)1318 public KeyEvent(int action, int code) { 1319 mAction = action; 1320 mKeyCode = code; 1321 mRepeatCount = 0; 1322 mDeviceId = KeyCharacterMap.VIRTUAL_KEYBOARD; 1323 } 1324 1325 /** 1326 * Create a new key event. 1327 * 1328 * @param downTime The time (in {@link android.os.SystemClock#uptimeMillis}) 1329 * at which this key code originally went down. 1330 * @param eventTime The time (in {@link android.os.SystemClock#uptimeMillis}) 1331 * at which this event happened. 1332 * @param action Action code: either {@link #ACTION_DOWN}, 1333 * {@link #ACTION_UP}, or {@link #ACTION_MULTIPLE}. 1334 * @param code The key code. 1335 * @param repeat A repeat count for down events (> 0 if this is after the 1336 * initial down) or event count for multiple events. 1337 */ KeyEvent(long downTime, long eventTime, int action, int code, int repeat)1338 public KeyEvent(long downTime, long eventTime, int action, 1339 int code, int repeat) { 1340 mDownTime = downTime; 1341 mEventTime = eventTime; 1342 mAction = action; 1343 mKeyCode = code; 1344 mRepeatCount = repeat; 1345 mDeviceId = KeyCharacterMap.VIRTUAL_KEYBOARD; 1346 } 1347 1348 /** 1349 * Create a new key event. 1350 * 1351 * @param downTime The time (in {@link android.os.SystemClock#uptimeMillis}) 1352 * at which this key code originally went down. 1353 * @param eventTime The time (in {@link android.os.SystemClock#uptimeMillis}) 1354 * at which this event happened. 1355 * @param action Action code: either {@link #ACTION_DOWN}, 1356 * {@link #ACTION_UP}, or {@link #ACTION_MULTIPLE}. 1357 * @param code The key code. 1358 * @param repeat A repeat count for down events (> 0 if this is after the 1359 * initial down) or event count for multiple events. 1360 * @param metaState Flags indicating which meta keys are currently pressed. 1361 */ KeyEvent(long downTime, long eventTime, int action, int code, int repeat, int metaState)1362 public KeyEvent(long downTime, long eventTime, int action, 1363 int code, int repeat, int metaState) { 1364 mDownTime = downTime; 1365 mEventTime = eventTime; 1366 mAction = action; 1367 mKeyCode = code; 1368 mRepeatCount = repeat; 1369 mMetaState = metaState; 1370 mDeviceId = KeyCharacterMap.VIRTUAL_KEYBOARD; 1371 } 1372 1373 /** 1374 * Create a new key event. 1375 * 1376 * @param downTime The time (in {@link android.os.SystemClock#uptimeMillis}) 1377 * at which this key code originally went down. 1378 * @param eventTime The time (in {@link android.os.SystemClock#uptimeMillis}) 1379 * at which this event happened. 1380 * @param action Action code: either {@link #ACTION_DOWN}, 1381 * {@link #ACTION_UP}, or {@link #ACTION_MULTIPLE}. 1382 * @param code The key code. 1383 * @param repeat A repeat count for down events (> 0 if this is after the 1384 * initial down) or event count for multiple events. 1385 * @param metaState Flags indicating which meta keys are currently pressed. 1386 * @param deviceId The device ID that generated the key event. 1387 * @param scancode Raw device scan code of the event. 1388 */ KeyEvent(long downTime, long eventTime, int action, int code, int repeat, int metaState, int deviceId, int scancode)1389 public KeyEvent(long downTime, long eventTime, int action, 1390 int code, int repeat, int metaState, 1391 int deviceId, int scancode) { 1392 mDownTime = downTime; 1393 mEventTime = eventTime; 1394 mAction = action; 1395 mKeyCode = code; 1396 mRepeatCount = repeat; 1397 mMetaState = metaState; 1398 mDeviceId = deviceId; 1399 mScanCode = scancode; 1400 } 1401 1402 /** 1403 * Create a new key event. 1404 * 1405 * @param downTime The time (in {@link android.os.SystemClock#uptimeMillis}) 1406 * at which this key code originally went down. 1407 * @param eventTime The time (in {@link android.os.SystemClock#uptimeMillis}) 1408 * at which this event happened. 1409 * @param action Action code: either {@link #ACTION_DOWN}, 1410 * {@link #ACTION_UP}, or {@link #ACTION_MULTIPLE}. 1411 * @param code The key code. 1412 * @param repeat A repeat count for down events (> 0 if this is after the 1413 * initial down) or event count for multiple events. 1414 * @param metaState Flags indicating which meta keys are currently pressed. 1415 * @param deviceId The device ID that generated the key event. 1416 * @param scancode Raw device scan code of the event. 1417 * @param flags The flags for this key event 1418 */ KeyEvent(long downTime, long eventTime, int action, int code, int repeat, int metaState, int deviceId, int scancode, int flags)1419 public KeyEvent(long downTime, long eventTime, int action, 1420 int code, int repeat, int metaState, 1421 int deviceId, int scancode, int flags) { 1422 mDownTime = downTime; 1423 mEventTime = eventTime; 1424 mAction = action; 1425 mKeyCode = code; 1426 mRepeatCount = repeat; 1427 mMetaState = metaState; 1428 mDeviceId = deviceId; 1429 mScanCode = scancode; 1430 mFlags = flags; 1431 } 1432 1433 /** 1434 * Create a new key event. 1435 * 1436 * @param downTime The time (in {@link android.os.SystemClock#uptimeMillis}) 1437 * at which this key code originally went down. 1438 * @param eventTime The time (in {@link android.os.SystemClock#uptimeMillis}) 1439 * at which this event happened. 1440 * @param action Action code: either {@link #ACTION_DOWN}, 1441 * {@link #ACTION_UP}, or {@link #ACTION_MULTIPLE}. 1442 * @param code The key code. 1443 * @param repeat A repeat count for down events (> 0 if this is after the 1444 * initial down) or event count for multiple events. 1445 * @param metaState Flags indicating which meta keys are currently pressed. 1446 * @param deviceId The device ID that generated the key event. 1447 * @param scancode Raw device scan code of the event. 1448 * @param flags The flags for this key event 1449 * @param source The input source such as {@link InputDevice#SOURCE_KEYBOARD}. 1450 */ KeyEvent(long downTime, long eventTime, int action, int code, int repeat, int metaState, int deviceId, int scancode, int flags, int source)1451 public KeyEvent(long downTime, long eventTime, int action, 1452 int code, int repeat, int metaState, 1453 int deviceId, int scancode, int flags, int source) { 1454 mDownTime = downTime; 1455 mEventTime = eventTime; 1456 mAction = action; 1457 mKeyCode = code; 1458 mRepeatCount = repeat; 1459 mMetaState = metaState; 1460 mDeviceId = deviceId; 1461 mScanCode = scancode; 1462 mFlags = flags; 1463 mSource = source; 1464 } 1465 1466 /** 1467 * Create a new key event for a string of characters. The key code, 1468 * action, repeat count and source will automatically be set to 1469 * {@link #KEYCODE_UNKNOWN}, {@link #ACTION_MULTIPLE}, 0, and 1470 * {@link InputDevice#SOURCE_KEYBOARD} for you. 1471 * 1472 * @param time The time (in {@link android.os.SystemClock#uptimeMillis}) 1473 * at which this event occured. 1474 * @param characters The string of characters. 1475 * @param deviceId The device ID that generated the key event. 1476 * @param flags The flags for this key event 1477 */ KeyEvent(long time, String characters, int deviceId, int flags)1478 public KeyEvent(long time, String characters, int deviceId, int flags) { 1479 mDownTime = time; 1480 mEventTime = time; 1481 mCharacters = characters; 1482 mAction = ACTION_MULTIPLE; 1483 mKeyCode = KEYCODE_UNKNOWN; 1484 mRepeatCount = 0; 1485 mDeviceId = deviceId; 1486 mFlags = flags; 1487 mSource = InputDevice.SOURCE_KEYBOARD; 1488 } 1489 1490 /** 1491 * Make an exact copy of an existing key event. 1492 */ KeyEvent(KeyEvent origEvent)1493 public KeyEvent(KeyEvent origEvent) { 1494 mDownTime = origEvent.mDownTime; 1495 mEventTime = origEvent.mEventTime; 1496 mAction = origEvent.mAction; 1497 mKeyCode = origEvent.mKeyCode; 1498 mRepeatCount = origEvent.mRepeatCount; 1499 mMetaState = origEvent.mMetaState; 1500 mDeviceId = origEvent.mDeviceId; 1501 mSource = origEvent.mSource; 1502 mScanCode = origEvent.mScanCode; 1503 mFlags = origEvent.mFlags; 1504 mCharacters = origEvent.mCharacters; 1505 } 1506 1507 /** 1508 * Copy an existing key event, modifying its time and repeat count. 1509 * 1510 * @deprecated Use {@link #changeTimeRepeat(KeyEvent, long, int)} 1511 * instead. 1512 * 1513 * @param origEvent The existing event to be copied. 1514 * @param eventTime The new event time 1515 * (in {@link android.os.SystemClock#uptimeMillis}) of the event. 1516 * @param newRepeat The new repeat count of the event. 1517 */ 1518 @Deprecated KeyEvent(KeyEvent origEvent, long eventTime, int newRepeat)1519 public KeyEvent(KeyEvent origEvent, long eventTime, int newRepeat) { 1520 mDownTime = origEvent.mDownTime; 1521 mEventTime = eventTime; 1522 mAction = origEvent.mAction; 1523 mKeyCode = origEvent.mKeyCode; 1524 mRepeatCount = newRepeat; 1525 mMetaState = origEvent.mMetaState; 1526 mDeviceId = origEvent.mDeviceId; 1527 mSource = origEvent.mSource; 1528 mScanCode = origEvent.mScanCode; 1529 mFlags = origEvent.mFlags; 1530 mCharacters = origEvent.mCharacters; 1531 } 1532 obtain()1533 private static KeyEvent obtain() { 1534 final KeyEvent ev; 1535 synchronized (gRecyclerLock) { 1536 ev = gRecyclerTop; 1537 if (ev == null) { 1538 return new KeyEvent(); 1539 } 1540 gRecyclerTop = ev.mNext; 1541 gRecyclerUsed -= 1; 1542 } 1543 ev.mNext = null; 1544 ev.prepareForReuse(); 1545 return ev; 1546 } 1547 1548 /** 1549 * Obtains a (potentially recycled) key event. 1550 * 1551 * @hide 1552 */ obtain(long downTime, long eventTime, int action, int code, int repeat, int metaState, int deviceId, int scancode, int flags, int source, String characters)1553 public static KeyEvent obtain(long downTime, long eventTime, int action, 1554 int code, int repeat, int metaState, 1555 int deviceId, int scancode, int flags, int source, String characters) { 1556 KeyEvent ev = obtain(); 1557 ev.mDownTime = downTime; 1558 ev.mEventTime = eventTime; 1559 ev.mAction = action; 1560 ev.mKeyCode = code; 1561 ev.mRepeatCount = repeat; 1562 ev.mMetaState = metaState; 1563 ev.mDeviceId = deviceId; 1564 ev.mScanCode = scancode; 1565 ev.mFlags = flags; 1566 ev.mSource = source; 1567 ev.mCharacters = characters; 1568 return ev; 1569 } 1570 1571 /** 1572 * Obtains a (potentially recycled) copy of another key event. 1573 * 1574 * @hide 1575 */ obtain(KeyEvent other)1576 public static KeyEvent obtain(KeyEvent other) { 1577 KeyEvent ev = obtain(); 1578 ev.mDownTime = other.mDownTime; 1579 ev.mEventTime = other.mEventTime; 1580 ev.mAction = other.mAction; 1581 ev.mKeyCode = other.mKeyCode; 1582 ev.mRepeatCount = other.mRepeatCount; 1583 ev.mMetaState = other.mMetaState; 1584 ev.mDeviceId = other.mDeviceId; 1585 ev.mScanCode = other.mScanCode; 1586 ev.mFlags = other.mFlags; 1587 ev.mSource = other.mSource; 1588 ev.mCharacters = other.mCharacters; 1589 return ev; 1590 } 1591 1592 /** @hide */ 1593 @Override copy()1594 public KeyEvent copy() { 1595 return obtain(this); 1596 } 1597 1598 /** 1599 * Recycles a key event. 1600 * Key events should only be recycled if they are owned by the system since user 1601 * code expects them to be essentially immutable, "tracking" notwithstanding. 1602 * 1603 * @hide 1604 */ 1605 @Override recycle()1606 public final void recycle() { 1607 super.recycle(); 1608 mCharacters = null; 1609 1610 synchronized (gRecyclerLock) { 1611 if (gRecyclerUsed < MAX_RECYCLED) { 1612 gRecyclerUsed++; 1613 mNext = gRecyclerTop; 1614 gRecyclerTop = this; 1615 } 1616 } 1617 } 1618 1619 /** @hide */ 1620 @Override recycleIfNeededAfterDispatch()1621 public final void recycleIfNeededAfterDispatch() { 1622 // Do nothing. 1623 } 1624 1625 /** 1626 * Create a new key event that is the same as the given one, but whose 1627 * event time and repeat count are replaced with the given value. 1628 * 1629 * @param event The existing event to be copied. This is not modified. 1630 * @param eventTime The new event time 1631 * (in {@link android.os.SystemClock#uptimeMillis}) of the event. 1632 * @param newRepeat The new repeat count of the event. 1633 */ changeTimeRepeat(KeyEvent event, long eventTime, int newRepeat)1634 public static KeyEvent changeTimeRepeat(KeyEvent event, long eventTime, 1635 int newRepeat) { 1636 return new KeyEvent(event, eventTime, newRepeat); 1637 } 1638 1639 /** 1640 * Create a new key event that is the same as the given one, but whose 1641 * event time and repeat count are replaced with the given value. 1642 * 1643 * @param event The existing event to be copied. This is not modified. 1644 * @param eventTime The new event time 1645 * (in {@link android.os.SystemClock#uptimeMillis}) of the event. 1646 * @param newRepeat The new repeat count of the event. 1647 * @param newFlags New flags for the event, replacing the entire value 1648 * in the original event. 1649 */ changeTimeRepeat(KeyEvent event, long eventTime, int newRepeat, int newFlags)1650 public static KeyEvent changeTimeRepeat(KeyEvent event, long eventTime, 1651 int newRepeat, int newFlags) { 1652 KeyEvent ret = new KeyEvent(event); 1653 ret.mEventTime = eventTime; 1654 ret.mRepeatCount = newRepeat; 1655 ret.mFlags = newFlags; 1656 return ret; 1657 } 1658 1659 /** 1660 * Copy an existing key event, modifying its action. 1661 * 1662 * @param origEvent The existing event to be copied. 1663 * @param action The new action code of the event. 1664 */ KeyEvent(KeyEvent origEvent, int action)1665 private KeyEvent(KeyEvent origEvent, int action) { 1666 mDownTime = origEvent.mDownTime; 1667 mEventTime = origEvent.mEventTime; 1668 mAction = action; 1669 mKeyCode = origEvent.mKeyCode; 1670 mRepeatCount = origEvent.mRepeatCount; 1671 mMetaState = origEvent.mMetaState; 1672 mDeviceId = origEvent.mDeviceId; 1673 mSource = origEvent.mSource; 1674 mScanCode = origEvent.mScanCode; 1675 mFlags = origEvent.mFlags; 1676 // Don't copy mCharacters, since one way or the other we'll lose it 1677 // when changing the action. 1678 } 1679 1680 /** 1681 * Create a new key event that is the same as the given one, but whose 1682 * action is replaced with the given value. 1683 * 1684 * @param event The existing event to be copied. This is not modified. 1685 * @param action The new action code of the event. 1686 */ changeAction(KeyEvent event, int action)1687 public static KeyEvent changeAction(KeyEvent event, int action) { 1688 return new KeyEvent(event, action); 1689 } 1690 1691 /** 1692 * Create a new key event that is the same as the given one, but whose 1693 * flags are replaced with the given value. 1694 * 1695 * @param event The existing event to be copied. This is not modified. 1696 * @param flags The new flags constant. 1697 */ changeFlags(KeyEvent event, int flags)1698 public static KeyEvent changeFlags(KeyEvent event, int flags) { 1699 event = new KeyEvent(event); 1700 event.mFlags = flags; 1701 return event; 1702 } 1703 1704 /** @hide */ 1705 @Override isTainted()1706 public final boolean isTainted() { 1707 return (mFlags & FLAG_TAINTED) != 0; 1708 } 1709 1710 /** @hide */ 1711 @Override setTainted(boolean tainted)1712 public final void setTainted(boolean tainted) { 1713 mFlags = tainted ? mFlags | FLAG_TAINTED : mFlags & ~FLAG_TAINTED; 1714 } 1715 1716 /** 1717 * Don't use in new code, instead explicitly check 1718 * {@link #getAction()}. 1719 * 1720 * @return If the action is ACTION_DOWN, returns true; else false. 1721 * 1722 * @deprecated 1723 * @hide 1724 */ isDown()1725 @Deprecated public final boolean isDown() { 1726 return mAction == ACTION_DOWN; 1727 } 1728 1729 /** Is this a system key? System keys can not be used for menu shortcuts. 1730 */ isSystem()1731 public final boolean isSystem() { 1732 return isSystemKey(mKeyCode); 1733 } 1734 1735 /** @hide */ isWakeKey()1736 public final boolean isWakeKey() { 1737 return isWakeKey(mKeyCode); 1738 } 1739 1740 /** 1741 * Returns true if the specified keycode is a gamepad button. 1742 * @return True if the keycode is a gamepad button, such as {@link #KEYCODE_BUTTON_A}. 1743 */ isGamepadButton(int keyCode)1744 public static final boolean isGamepadButton(int keyCode) { 1745 switch (keyCode) { 1746 case KeyEvent.KEYCODE_BUTTON_A: 1747 case KeyEvent.KEYCODE_BUTTON_B: 1748 case KeyEvent.KEYCODE_BUTTON_C: 1749 case KeyEvent.KEYCODE_BUTTON_X: 1750 case KeyEvent.KEYCODE_BUTTON_Y: 1751 case KeyEvent.KEYCODE_BUTTON_Z: 1752 case KeyEvent.KEYCODE_BUTTON_L1: 1753 case KeyEvent.KEYCODE_BUTTON_R1: 1754 case KeyEvent.KEYCODE_BUTTON_L2: 1755 case KeyEvent.KEYCODE_BUTTON_R2: 1756 case KeyEvent.KEYCODE_BUTTON_THUMBL: 1757 case KeyEvent.KEYCODE_BUTTON_THUMBR: 1758 case KeyEvent.KEYCODE_BUTTON_START: 1759 case KeyEvent.KEYCODE_BUTTON_SELECT: 1760 case KeyEvent.KEYCODE_BUTTON_MODE: 1761 case KeyEvent.KEYCODE_BUTTON_1: 1762 case KeyEvent.KEYCODE_BUTTON_2: 1763 case KeyEvent.KEYCODE_BUTTON_3: 1764 case KeyEvent.KEYCODE_BUTTON_4: 1765 case KeyEvent.KEYCODE_BUTTON_5: 1766 case KeyEvent.KEYCODE_BUTTON_6: 1767 case KeyEvent.KEYCODE_BUTTON_7: 1768 case KeyEvent.KEYCODE_BUTTON_8: 1769 case KeyEvent.KEYCODE_BUTTON_9: 1770 case KeyEvent.KEYCODE_BUTTON_10: 1771 case KeyEvent.KEYCODE_BUTTON_11: 1772 case KeyEvent.KEYCODE_BUTTON_12: 1773 case KeyEvent.KEYCODE_BUTTON_13: 1774 case KeyEvent.KEYCODE_BUTTON_14: 1775 case KeyEvent.KEYCODE_BUTTON_15: 1776 case KeyEvent.KEYCODE_BUTTON_16: 1777 return true; 1778 default: 1779 return false; 1780 } 1781 } 1782 1783 /** Whether key will, by default, trigger a click on the focused view. 1784 * @hide 1785 */ isConfirmKey(int keyCode)1786 public static final boolean isConfirmKey(int keyCode) { 1787 switch (keyCode) { 1788 case KeyEvent.KEYCODE_DPAD_CENTER: 1789 case KeyEvent.KEYCODE_ENTER: 1790 case KeyEvent.KEYCODE_SPACE: 1791 case KeyEvent.KEYCODE_NUMPAD_ENTER: 1792 return true; 1793 default: 1794 return false; 1795 } 1796 } 1797 1798 /** 1799 * Whether this key is a media key, which can be send to apps that are 1800 * interested in media key events. 1801 * 1802 * @hide 1803 */ isMediaKey(int keyCode)1804 public static final boolean isMediaKey(int keyCode) { 1805 switch (keyCode) { 1806 case KeyEvent.KEYCODE_MEDIA_PLAY: 1807 case KeyEvent.KEYCODE_MEDIA_PAUSE: 1808 case KeyEvent.KEYCODE_MEDIA_PLAY_PAUSE: 1809 case KeyEvent.KEYCODE_MUTE: 1810 case KeyEvent.KEYCODE_HEADSETHOOK: 1811 case KeyEvent.KEYCODE_MEDIA_STOP: 1812 case KeyEvent.KEYCODE_MEDIA_NEXT: 1813 case KeyEvent.KEYCODE_MEDIA_PREVIOUS: 1814 case KeyEvent.KEYCODE_MEDIA_REWIND: 1815 case KeyEvent.KEYCODE_MEDIA_RECORD: 1816 case KeyEvent.KEYCODE_MEDIA_FAST_FORWARD: 1817 return true; 1818 } 1819 return false; 1820 } 1821 1822 1823 /** Is this a system key? System keys can not be used for menu shortcuts. 1824 * @hide 1825 */ isSystemKey(int keyCode)1826 public static final boolean isSystemKey(int keyCode) { 1827 switch (keyCode) { 1828 case KeyEvent.KEYCODE_MENU: 1829 case KeyEvent.KEYCODE_SOFT_RIGHT: 1830 case KeyEvent.KEYCODE_HOME: 1831 case KeyEvent.KEYCODE_BACK: 1832 case KeyEvent.KEYCODE_CALL: 1833 case KeyEvent.KEYCODE_ENDCALL: 1834 case KeyEvent.KEYCODE_VOLUME_UP: 1835 case KeyEvent.KEYCODE_VOLUME_DOWN: 1836 case KeyEvent.KEYCODE_VOLUME_MUTE: 1837 case KeyEvent.KEYCODE_MUTE: 1838 case KeyEvent.KEYCODE_POWER: 1839 case KeyEvent.KEYCODE_HEADSETHOOK: 1840 case KeyEvent.KEYCODE_MEDIA_PLAY: 1841 case KeyEvent.KEYCODE_MEDIA_PAUSE: 1842 case KeyEvent.KEYCODE_MEDIA_PLAY_PAUSE: 1843 case KeyEvent.KEYCODE_MEDIA_STOP: 1844 case KeyEvent.KEYCODE_MEDIA_NEXT: 1845 case KeyEvent.KEYCODE_MEDIA_PREVIOUS: 1846 case KeyEvent.KEYCODE_MEDIA_REWIND: 1847 case KeyEvent.KEYCODE_MEDIA_RECORD: 1848 case KeyEvent.KEYCODE_MEDIA_FAST_FORWARD: 1849 case KeyEvent.KEYCODE_CAMERA: 1850 case KeyEvent.KEYCODE_FOCUS: 1851 case KeyEvent.KEYCODE_SEARCH: 1852 case KeyEvent.KEYCODE_BRIGHTNESS_DOWN: 1853 case KeyEvent.KEYCODE_BRIGHTNESS_UP: 1854 case KeyEvent.KEYCODE_MEDIA_AUDIO_TRACK: 1855 case KeyEvent.KEYCODE_SYSTEM_NAVIGATION_UP: 1856 case KeyEvent.KEYCODE_SYSTEM_NAVIGATION_DOWN: 1857 case KeyEvent.KEYCODE_SYSTEM_NAVIGATION_LEFT: 1858 case KeyEvent.KEYCODE_SYSTEM_NAVIGATION_RIGHT: 1859 return true; 1860 } 1861 1862 return false; 1863 } 1864 1865 /** @hide */ isWakeKey(int keyCode)1866 public static final boolean isWakeKey(int keyCode) { 1867 switch (keyCode) { 1868 case KeyEvent.KEYCODE_BACK: 1869 case KeyEvent.KEYCODE_MENU: 1870 case KeyEvent.KEYCODE_WAKEUP: 1871 case KeyEvent.KEYCODE_PAIRING: 1872 case KeyEvent.KEYCODE_STEM_1: 1873 case KeyEvent.KEYCODE_STEM_2: 1874 case KeyEvent.KEYCODE_STEM_3: 1875 return true; 1876 } 1877 return false; 1878 } 1879 1880 /** @hide */ isMetaKey(int keyCode)1881 public static final boolean isMetaKey(int keyCode) { 1882 return keyCode == KeyEvent.KEYCODE_META_LEFT || keyCode == KeyEvent.KEYCODE_META_RIGHT; 1883 } 1884 1885 /** @hide */ isAltKey(int keyCode)1886 public static final boolean isAltKey(int keyCode) { 1887 return keyCode == KeyEvent.KEYCODE_ALT_LEFT || keyCode == KeyEvent.KEYCODE_ALT_RIGHT; 1888 } 1889 1890 /** {@inheritDoc} */ 1891 @Override getDeviceId()1892 public final int getDeviceId() { 1893 return mDeviceId; 1894 } 1895 1896 /** {@inheritDoc} */ 1897 @Override getSource()1898 public final int getSource() { 1899 return mSource; 1900 } 1901 1902 /** {@inheritDoc} */ 1903 @Override setSource(int source)1904 public final void setSource(int source) { 1905 mSource = source; 1906 } 1907 1908 /** 1909 * <p>Returns the state of the meta keys.</p> 1910 * 1911 * @return an integer in which each bit set to 1 represents a pressed 1912 * meta key 1913 * 1914 * @see #isAltPressed() 1915 * @see #isShiftPressed() 1916 * @see #isSymPressed() 1917 * @see #isCtrlPressed() 1918 * @see #isMetaPressed() 1919 * @see #isFunctionPressed() 1920 * @see #isCapsLockOn() 1921 * @see #isNumLockOn() 1922 * @see #isScrollLockOn() 1923 * @see #META_ALT_ON 1924 * @see #META_ALT_LEFT_ON 1925 * @see #META_ALT_RIGHT_ON 1926 * @see #META_SHIFT_ON 1927 * @see #META_SHIFT_LEFT_ON 1928 * @see #META_SHIFT_RIGHT_ON 1929 * @see #META_SYM_ON 1930 * @see #META_FUNCTION_ON 1931 * @see #META_CTRL_ON 1932 * @see #META_CTRL_LEFT_ON 1933 * @see #META_CTRL_RIGHT_ON 1934 * @see #META_META_ON 1935 * @see #META_META_LEFT_ON 1936 * @see #META_META_RIGHT_ON 1937 * @see #META_CAPS_LOCK_ON 1938 * @see #META_NUM_LOCK_ON 1939 * @see #META_SCROLL_LOCK_ON 1940 * @see #getModifiers 1941 */ getMetaState()1942 public final int getMetaState() { 1943 return mMetaState; 1944 } 1945 1946 /** 1947 * Returns the state of the modifier keys. 1948 * <p> 1949 * For the purposes of this function, {@link #KEYCODE_CAPS_LOCK}, 1950 * {@link #KEYCODE_SCROLL_LOCK}, and {@link #KEYCODE_NUM_LOCK} are 1951 * not considered modifier keys. Consequently, this function specifically masks out 1952 * {@link #META_CAPS_LOCK_ON}, {@link #META_SCROLL_LOCK_ON} and {@link #META_NUM_LOCK_ON}. 1953 * </p><p> 1954 * The value returned consists of the meta state (from {@link #getMetaState}) 1955 * normalized using {@link #normalizeMetaState(int)} and then masked with 1956 * {@link #getModifierMetaStateMask} so that only valid modifier bits are retained. 1957 * </p> 1958 * 1959 * @return An integer in which each bit set to 1 represents a pressed modifier key. 1960 * @see #getMetaState 1961 */ getModifiers()1962 public final int getModifiers() { 1963 return normalizeMetaState(mMetaState) & META_MODIFIER_MASK; 1964 } 1965 1966 /** 1967 * Returns the flags for this key event. 1968 * 1969 * @see #FLAG_WOKE_HERE 1970 */ getFlags()1971 public final int getFlags() { 1972 return mFlags; 1973 } 1974 1975 // Mask of all modifier key meta states. Specifically excludes locked keys like caps lock. 1976 private static final int META_MODIFIER_MASK = 1977 META_SHIFT_ON | META_SHIFT_LEFT_ON | META_SHIFT_RIGHT_ON 1978 | META_ALT_ON | META_ALT_LEFT_ON | META_ALT_RIGHT_ON 1979 | META_CTRL_ON | META_CTRL_LEFT_ON | META_CTRL_RIGHT_ON 1980 | META_META_ON | META_META_LEFT_ON | META_META_RIGHT_ON 1981 | META_SYM_ON | META_FUNCTION_ON; 1982 1983 // Mask of all lock key meta states. 1984 private static final int META_LOCK_MASK = 1985 META_CAPS_LOCK_ON | META_NUM_LOCK_ON | META_SCROLL_LOCK_ON; 1986 1987 // Mask of all valid meta states. 1988 private static final int META_ALL_MASK = META_MODIFIER_MASK | META_LOCK_MASK; 1989 1990 // Mask of all synthetic meta states that are reserved for API compatibility with 1991 // historical uses in MetaKeyKeyListener. 1992 private static final int META_SYNTHETIC_MASK = 1993 META_CAP_LOCKED | META_ALT_LOCKED | META_SYM_LOCKED | META_SELECTING; 1994 1995 // Mask of all meta states that are not valid use in specifying a modifier key. 1996 // These bits are known to be used for purposes other than specifying modifiers. 1997 private static final int META_INVALID_MODIFIER_MASK = 1998 META_LOCK_MASK | META_SYNTHETIC_MASK; 1999 2000 /** 2001 * Gets a mask that includes all valid modifier key meta state bits. 2002 * <p> 2003 * For the purposes of this function, {@link #KEYCODE_CAPS_LOCK}, 2004 * {@link #KEYCODE_SCROLL_LOCK}, and {@link #KEYCODE_NUM_LOCK} are 2005 * not considered modifier keys. Consequently, the mask specifically excludes 2006 * {@link #META_CAPS_LOCK_ON}, {@link #META_SCROLL_LOCK_ON} and {@link #META_NUM_LOCK_ON}. 2007 * </p> 2008 * 2009 * @return The modifier meta state mask which is a combination of 2010 * {@link #META_SHIFT_ON}, {@link #META_SHIFT_LEFT_ON}, {@link #META_SHIFT_RIGHT_ON}, 2011 * {@link #META_ALT_ON}, {@link #META_ALT_LEFT_ON}, {@link #META_ALT_RIGHT_ON}, 2012 * {@link #META_CTRL_ON}, {@link #META_CTRL_LEFT_ON}, {@link #META_CTRL_RIGHT_ON}, 2013 * {@link #META_META_ON}, {@link #META_META_LEFT_ON}, {@link #META_META_RIGHT_ON}, 2014 * {@link #META_SYM_ON}, {@link #META_FUNCTION_ON}. 2015 */ getModifierMetaStateMask()2016 public static int getModifierMetaStateMask() { 2017 return META_MODIFIER_MASK; 2018 } 2019 2020 /** 2021 * Returns true if this key code is a modifier key. 2022 * <p> 2023 * For the purposes of this function, {@link #KEYCODE_CAPS_LOCK}, 2024 * {@link #KEYCODE_SCROLL_LOCK}, and {@link #KEYCODE_NUM_LOCK} are 2025 * not considered modifier keys. Consequently, this function return false 2026 * for those keys. 2027 * </p> 2028 * 2029 * @return True if the key code is one of 2030 * {@link #KEYCODE_SHIFT_LEFT} {@link #KEYCODE_SHIFT_RIGHT}, 2031 * {@link #KEYCODE_ALT_LEFT}, {@link #KEYCODE_ALT_RIGHT}, 2032 * {@link #KEYCODE_CTRL_LEFT}, {@link #KEYCODE_CTRL_RIGHT}, 2033 * {@link #KEYCODE_META_LEFT}, or {@link #KEYCODE_META_RIGHT}, 2034 * {@link #KEYCODE_SYM}, {@link #KEYCODE_NUM}, {@link #KEYCODE_FUNCTION}. 2035 */ isModifierKey(int keyCode)2036 public static boolean isModifierKey(int keyCode) { 2037 switch (keyCode) { 2038 case KEYCODE_SHIFT_LEFT: 2039 case KEYCODE_SHIFT_RIGHT: 2040 case KEYCODE_ALT_LEFT: 2041 case KEYCODE_ALT_RIGHT: 2042 case KEYCODE_CTRL_LEFT: 2043 case KEYCODE_CTRL_RIGHT: 2044 case KEYCODE_META_LEFT: 2045 case KEYCODE_META_RIGHT: 2046 case KEYCODE_SYM: 2047 case KEYCODE_NUM: 2048 case KEYCODE_FUNCTION: 2049 return true; 2050 default: 2051 return false; 2052 } 2053 } 2054 2055 /** 2056 * Normalizes the specified meta state. 2057 * <p> 2058 * The meta state is normalized such that if either the left or right modifier meta state 2059 * bits are set then the result will also include the universal bit for that modifier. 2060 * </p><p> 2061 * If the specified meta state contains {@link #META_ALT_LEFT_ON} then 2062 * the result will also contain {@link #META_ALT_ON} in addition to {@link #META_ALT_LEFT_ON} 2063 * and the other bits that were specified in the input. The same is process is 2064 * performed for shift, control and meta. 2065 * </p><p> 2066 * If the specified meta state contains synthetic meta states defined by 2067 * {@link MetaKeyKeyListener}, then those states are translated here and the original 2068 * synthetic meta states are removed from the result. 2069 * {@link MetaKeyKeyListener#META_CAP_LOCKED} is translated to {@link #META_CAPS_LOCK_ON}. 2070 * {@link MetaKeyKeyListener#META_ALT_LOCKED} is translated to {@link #META_ALT_ON}. 2071 * {@link MetaKeyKeyListener#META_SYM_LOCKED} is translated to {@link #META_SYM_ON}. 2072 * </p><p> 2073 * Undefined meta state bits are removed. 2074 * </p> 2075 * 2076 * @param metaState The meta state. 2077 * @return The normalized meta state. 2078 */ normalizeMetaState(int metaState)2079 public static int normalizeMetaState(int metaState) { 2080 if ((metaState & (META_SHIFT_LEFT_ON | META_SHIFT_RIGHT_ON)) != 0) { 2081 metaState |= META_SHIFT_ON; 2082 } 2083 if ((metaState & (META_ALT_LEFT_ON | META_ALT_RIGHT_ON)) != 0) { 2084 metaState |= META_ALT_ON; 2085 } 2086 if ((metaState & (META_CTRL_LEFT_ON | META_CTRL_RIGHT_ON)) != 0) { 2087 metaState |= META_CTRL_ON; 2088 } 2089 if ((metaState & (META_META_LEFT_ON | META_META_RIGHT_ON)) != 0) { 2090 metaState |= META_META_ON; 2091 } 2092 if ((metaState & MetaKeyKeyListener.META_CAP_LOCKED) != 0) { 2093 metaState |= META_CAPS_LOCK_ON; 2094 } 2095 if ((metaState & MetaKeyKeyListener.META_ALT_LOCKED) != 0) { 2096 metaState |= META_ALT_ON; 2097 } 2098 if ((metaState & MetaKeyKeyListener.META_SYM_LOCKED) != 0) { 2099 metaState |= META_SYM_ON; 2100 } 2101 return metaState & META_ALL_MASK; 2102 } 2103 2104 /** 2105 * Returns true if no modifiers keys are pressed according to the specified meta state. 2106 * <p> 2107 * For the purposes of this function, {@link #KEYCODE_CAPS_LOCK}, 2108 * {@link #KEYCODE_SCROLL_LOCK}, and {@link #KEYCODE_NUM_LOCK} are 2109 * not considered modifier keys. Consequently, this function ignores 2110 * {@link #META_CAPS_LOCK_ON}, {@link #META_SCROLL_LOCK_ON} and {@link #META_NUM_LOCK_ON}. 2111 * </p><p> 2112 * The meta state is normalized prior to comparison using {@link #normalizeMetaState(int)}. 2113 * </p> 2114 * 2115 * @param metaState The meta state to consider. 2116 * @return True if no modifier keys are pressed. 2117 * @see #hasNoModifiers() 2118 */ metaStateHasNoModifiers(int metaState)2119 public static boolean metaStateHasNoModifiers(int metaState) { 2120 return (normalizeMetaState(metaState) & META_MODIFIER_MASK) == 0; 2121 } 2122 2123 /** 2124 * Returns true if only the specified modifier keys are pressed according to 2125 * the specified meta state. Returns false if a different combination of modifier 2126 * keys are pressed. 2127 * <p> 2128 * For the purposes of this function, {@link #KEYCODE_CAPS_LOCK}, 2129 * {@link #KEYCODE_SCROLL_LOCK}, and {@link #KEYCODE_NUM_LOCK} are 2130 * not considered modifier keys. Consequently, this function ignores 2131 * {@link #META_CAPS_LOCK_ON}, {@link #META_SCROLL_LOCK_ON} and {@link #META_NUM_LOCK_ON}. 2132 * </p><p> 2133 * If the specified modifier mask includes directional modifiers, such as 2134 * {@link #META_SHIFT_LEFT_ON}, then this method ensures that the 2135 * modifier is pressed on that side. 2136 * If the specified modifier mask includes non-directional modifiers, such as 2137 * {@link #META_SHIFT_ON}, then this method ensures that the modifier 2138 * is pressed on either side. 2139 * If the specified modifier mask includes both directional and non-directional modifiers 2140 * for the same type of key, such as {@link #META_SHIFT_ON} and {@link #META_SHIFT_LEFT_ON}, 2141 * then this method throws an illegal argument exception. 2142 * </p> 2143 * 2144 * @param metaState The meta state to consider. 2145 * @param modifiers The meta state of the modifier keys to check. May be a combination 2146 * of modifier meta states as defined by {@link #getModifierMetaStateMask()}. May be 0 to 2147 * ensure that no modifier keys are pressed. 2148 * @return True if only the specified modifier keys are pressed. 2149 * @throws IllegalArgumentException if the modifiers parameter contains invalid modifiers 2150 * @see #hasModifiers 2151 */ metaStateHasModifiers(int metaState, int modifiers)2152 public static boolean metaStateHasModifiers(int metaState, int modifiers) { 2153 // Note: For forward compatibility, we allow the parameter to contain meta states 2154 // that we do not recognize but we explicitly disallow meta states that 2155 // are not valid modifiers. 2156 if ((modifiers & META_INVALID_MODIFIER_MASK) != 0) { 2157 throw new IllegalArgumentException("modifiers must not contain " 2158 + "META_CAPS_LOCK_ON, META_NUM_LOCK_ON, META_SCROLL_LOCK_ON, " 2159 + "META_CAP_LOCKED, META_ALT_LOCKED, META_SYM_LOCKED, " 2160 + "or META_SELECTING"); 2161 } 2162 2163 metaState = normalizeMetaState(metaState) & META_MODIFIER_MASK; 2164 metaState = metaStateFilterDirectionalModifiers(metaState, modifiers, 2165 META_SHIFT_ON, META_SHIFT_LEFT_ON, META_SHIFT_RIGHT_ON); 2166 metaState = metaStateFilterDirectionalModifiers(metaState, modifiers, 2167 META_ALT_ON, META_ALT_LEFT_ON, META_ALT_RIGHT_ON); 2168 metaState = metaStateFilterDirectionalModifiers(metaState, modifiers, 2169 META_CTRL_ON, META_CTRL_LEFT_ON, META_CTRL_RIGHT_ON); 2170 metaState = metaStateFilterDirectionalModifiers(metaState, modifiers, 2171 META_META_ON, META_META_LEFT_ON, META_META_RIGHT_ON); 2172 return metaState == modifiers; 2173 } 2174 metaStateFilterDirectionalModifiers(int metaState, int modifiers, int basic, int left, int right)2175 private static int metaStateFilterDirectionalModifiers(int metaState, 2176 int modifiers, int basic, int left, int right) { 2177 final boolean wantBasic = (modifiers & basic) != 0; 2178 final int directional = left | right; 2179 final boolean wantLeftOrRight = (modifiers & directional) != 0; 2180 2181 if (wantBasic) { 2182 if (wantLeftOrRight) { 2183 throw new IllegalArgumentException("modifiers must not contain " 2184 + metaStateToString(basic) + " combined with " 2185 + metaStateToString(left) + " or " + metaStateToString(right)); 2186 } 2187 return metaState & ~directional; 2188 } else if (wantLeftOrRight) { 2189 return metaState & ~basic; 2190 } else { 2191 return metaState; 2192 } 2193 } 2194 2195 /** 2196 * Returns true if no modifier keys are pressed. 2197 * <p> 2198 * For the purposes of this function, {@link #KEYCODE_CAPS_LOCK}, 2199 * {@link #KEYCODE_SCROLL_LOCK}, and {@link #KEYCODE_NUM_LOCK} are 2200 * not considered modifier keys. Consequently, this function ignores 2201 * {@link #META_CAPS_LOCK_ON}, {@link #META_SCROLL_LOCK_ON} and {@link #META_NUM_LOCK_ON}. 2202 * </p><p> 2203 * The meta state is normalized prior to comparison using {@link #normalizeMetaState(int)}. 2204 * </p> 2205 * 2206 * @return True if no modifier keys are pressed. 2207 * @see #metaStateHasNoModifiers 2208 */ hasNoModifiers()2209 public final boolean hasNoModifiers() { 2210 return metaStateHasNoModifiers(mMetaState); 2211 } 2212 2213 /** 2214 * Returns true if only the specified modifiers keys are pressed. 2215 * Returns false if a different combination of modifier keys are pressed. 2216 * <p> 2217 * For the purposes of this function, {@link #KEYCODE_CAPS_LOCK}, 2218 * {@link #KEYCODE_SCROLL_LOCK}, and {@link #KEYCODE_NUM_LOCK} are 2219 * not considered modifier keys. Consequently, this function ignores 2220 * {@link #META_CAPS_LOCK_ON}, {@link #META_SCROLL_LOCK_ON} and {@link #META_NUM_LOCK_ON}. 2221 * </p><p> 2222 * If the specified modifier mask includes directional modifiers, such as 2223 * {@link #META_SHIFT_LEFT_ON}, then this method ensures that the 2224 * modifier is pressed on that side. 2225 * If the specified modifier mask includes non-directional modifiers, such as 2226 * {@link #META_SHIFT_ON}, then this method ensures that the modifier 2227 * is pressed on either side. 2228 * If the specified modifier mask includes both directional and non-directional modifiers 2229 * for the same type of key, such as {@link #META_SHIFT_ON} and {@link #META_SHIFT_LEFT_ON}, 2230 * then this method throws an illegal argument exception. 2231 * </p> 2232 * 2233 * @param modifiers The meta state of the modifier keys to check. May be a combination 2234 * of modifier meta states as defined by {@link #getModifierMetaStateMask()}. May be 0 to 2235 * ensure that no modifier keys are pressed. 2236 * @return True if only the specified modifier keys are pressed. 2237 * @throws IllegalArgumentException if the modifiers parameter contains invalid modifiers 2238 * @see #metaStateHasModifiers 2239 */ hasModifiers(int modifiers)2240 public final boolean hasModifiers(int modifiers) { 2241 return metaStateHasModifiers(mMetaState, modifiers); 2242 } 2243 2244 /** 2245 * <p>Returns the pressed state of the ALT meta key.</p> 2246 * 2247 * @return true if the ALT key is pressed, false otherwise 2248 * 2249 * @see #KEYCODE_ALT_LEFT 2250 * @see #KEYCODE_ALT_RIGHT 2251 * @see #META_ALT_ON 2252 */ isAltPressed()2253 public final boolean isAltPressed() { 2254 return (mMetaState & META_ALT_ON) != 0; 2255 } 2256 2257 /** 2258 * <p>Returns the pressed state of the SHIFT meta key.</p> 2259 * 2260 * @return true if the SHIFT key is pressed, false otherwise 2261 * 2262 * @see #KEYCODE_SHIFT_LEFT 2263 * @see #KEYCODE_SHIFT_RIGHT 2264 * @see #META_SHIFT_ON 2265 */ isShiftPressed()2266 public final boolean isShiftPressed() { 2267 return (mMetaState & META_SHIFT_ON) != 0; 2268 } 2269 2270 /** 2271 * <p>Returns the pressed state of the SYM meta key.</p> 2272 * 2273 * @return true if the SYM key is pressed, false otherwise 2274 * 2275 * @see #KEYCODE_SYM 2276 * @see #META_SYM_ON 2277 */ isSymPressed()2278 public final boolean isSymPressed() { 2279 return (mMetaState & META_SYM_ON) != 0; 2280 } 2281 2282 /** 2283 * <p>Returns the pressed state of the CTRL meta key.</p> 2284 * 2285 * @return true if the CTRL key is pressed, false otherwise 2286 * 2287 * @see #KEYCODE_CTRL_LEFT 2288 * @see #KEYCODE_CTRL_RIGHT 2289 * @see #META_CTRL_ON 2290 */ isCtrlPressed()2291 public final boolean isCtrlPressed() { 2292 return (mMetaState & META_CTRL_ON) != 0; 2293 } 2294 2295 /** 2296 * <p>Returns the pressed state of the META meta key.</p> 2297 * 2298 * @return true if the META key is pressed, false otherwise 2299 * 2300 * @see #KEYCODE_META_LEFT 2301 * @see #KEYCODE_META_RIGHT 2302 * @see #META_META_ON 2303 */ isMetaPressed()2304 public final boolean isMetaPressed() { 2305 return (mMetaState & META_META_ON) != 0; 2306 } 2307 2308 /** 2309 * <p>Returns the pressed state of the FUNCTION meta key.</p> 2310 * 2311 * @return true if the FUNCTION key is pressed, false otherwise 2312 * 2313 * @see #KEYCODE_FUNCTION 2314 * @see #META_FUNCTION_ON 2315 */ isFunctionPressed()2316 public final boolean isFunctionPressed() { 2317 return (mMetaState & META_FUNCTION_ON) != 0; 2318 } 2319 2320 /** 2321 * <p>Returns the locked state of the CAPS LOCK meta key.</p> 2322 * 2323 * @return true if the CAPS LOCK key is on, false otherwise 2324 * 2325 * @see #KEYCODE_CAPS_LOCK 2326 * @see #META_CAPS_LOCK_ON 2327 */ isCapsLockOn()2328 public final boolean isCapsLockOn() { 2329 return (mMetaState & META_CAPS_LOCK_ON) != 0; 2330 } 2331 2332 /** 2333 * <p>Returns the locked state of the NUM LOCK meta key.</p> 2334 * 2335 * @return true if the NUM LOCK key is on, false otherwise 2336 * 2337 * @see #KEYCODE_NUM_LOCK 2338 * @see #META_NUM_LOCK_ON 2339 */ isNumLockOn()2340 public final boolean isNumLockOn() { 2341 return (mMetaState & META_NUM_LOCK_ON) != 0; 2342 } 2343 2344 /** 2345 * <p>Returns the locked state of the SCROLL LOCK meta key.</p> 2346 * 2347 * @return true if the SCROLL LOCK key is on, false otherwise 2348 * 2349 * @see #KEYCODE_SCROLL_LOCK 2350 * @see #META_SCROLL_LOCK_ON 2351 */ isScrollLockOn()2352 public final boolean isScrollLockOn() { 2353 return (mMetaState & META_SCROLL_LOCK_ON) != 0; 2354 } 2355 2356 /** 2357 * Retrieve the action of this key event. May be either 2358 * {@link #ACTION_DOWN}, {@link #ACTION_UP}, or {@link #ACTION_MULTIPLE}. 2359 * 2360 * @return The event action: ACTION_DOWN, ACTION_UP, or ACTION_MULTIPLE. 2361 */ getAction()2362 public final int getAction() { 2363 return mAction; 2364 } 2365 2366 /** 2367 * For {@link #ACTION_UP} events, indicates that the event has been 2368 * canceled as per {@link #FLAG_CANCELED}. 2369 */ isCanceled()2370 public final boolean isCanceled() { 2371 return (mFlags&FLAG_CANCELED) != 0; 2372 } 2373 2374 /** 2375 * Set {@link #FLAG_CANCELED} flag for the key event. 2376 * 2377 * @hide 2378 */ 2379 @Override cancel()2380 public final void cancel() { 2381 mFlags |= FLAG_CANCELED; 2382 } 2383 2384 /** 2385 * Call this during {@link Callback#onKeyDown} to have the system track 2386 * the key through its final up (possibly including a long press). Note 2387 * that only one key can be tracked at a time -- if another key down 2388 * event is received while a previous one is being tracked, tracking is 2389 * stopped on the previous event. 2390 */ startTracking()2391 public final void startTracking() { 2392 mFlags |= FLAG_START_TRACKING; 2393 } 2394 2395 /** 2396 * For {@link #ACTION_UP} events, indicates that the event is still being 2397 * tracked from its initial down event as per 2398 * {@link #FLAG_TRACKING}. 2399 */ isTracking()2400 public final boolean isTracking() { 2401 return (mFlags&FLAG_TRACKING) != 0; 2402 } 2403 2404 /** 2405 * For {@link #ACTION_DOWN} events, indicates that the event has been 2406 * canceled as per {@link #FLAG_LONG_PRESS}. 2407 */ isLongPress()2408 public final boolean isLongPress() { 2409 return (mFlags&FLAG_LONG_PRESS) != 0; 2410 } 2411 2412 /** 2413 * Retrieve the key code of the key event. This is the physical key that 2414 * was pressed, <em>not</em> the Unicode character. 2415 * 2416 * @return The key code of the event. 2417 */ getKeyCode()2418 public final int getKeyCode() { 2419 return mKeyCode; 2420 } 2421 2422 /** 2423 * For the special case of a {@link #ACTION_MULTIPLE} event with key 2424 * code of {@link #KEYCODE_UNKNOWN}, this is a raw string of characters 2425 * associated with the event. In all other cases it is null. 2426 * 2427 * @return Returns a String of 1 or more characters associated with 2428 * the event. 2429 */ getCharacters()2430 public final String getCharacters() { 2431 return mCharacters; 2432 } 2433 2434 /** 2435 * Retrieve the hardware key id of this key event. These values are not 2436 * reliable and vary from device to device. 2437 * 2438 * {@more} 2439 * Mostly this is here for debugging purposes. 2440 */ getScanCode()2441 public final int getScanCode() { 2442 return mScanCode; 2443 } 2444 2445 /** 2446 * Retrieve the repeat count of the event. For both key up and key down 2447 * events, this is the number of times the key has repeated with the first 2448 * down starting at 0 and counting up from there. For multiple key 2449 * events, this is the number of down/up pairs that have occurred. 2450 * 2451 * @return The number of times the key has repeated. 2452 */ getRepeatCount()2453 public final int getRepeatCount() { 2454 return mRepeatCount; 2455 } 2456 2457 /** 2458 * Retrieve the time of the most recent key down event, 2459 * in the {@link android.os.SystemClock#uptimeMillis} time base. If this 2460 * is a down event, this will be the same as {@link #getEventTime()}. 2461 * Note that when chording keys, this value is the down time of the 2462 * most recently pressed key, which may <em>not</em> be the same physical 2463 * key of this event. 2464 * 2465 * @return Returns the most recent key down time, in the 2466 * {@link android.os.SystemClock#uptimeMillis} time base 2467 */ getDownTime()2468 public final long getDownTime() { 2469 return mDownTime; 2470 } 2471 2472 /** 2473 * Retrieve the time this event occurred, 2474 * in the {@link android.os.SystemClock#uptimeMillis} time base. 2475 * 2476 * @return Returns the time this event occurred, 2477 * in the {@link android.os.SystemClock#uptimeMillis} time base. 2478 */ 2479 @Override getEventTime()2480 public final long getEventTime() { 2481 return mEventTime; 2482 } 2483 2484 /** 2485 * Retrieve the time this event occurred, 2486 * in the {@link android.os.SystemClock#uptimeMillis} time base but with 2487 * nanosecond (instead of millisecond) precision. 2488 * <p> 2489 * The value is in nanosecond precision but it may not have nanosecond accuracy. 2490 * </p> 2491 * 2492 * @return Returns the time this event occurred, 2493 * in the {@link android.os.SystemClock#uptimeMillis} time base but with 2494 * nanosecond (instead of millisecond) precision. 2495 * 2496 * @hide 2497 */ 2498 @Override getEventTimeNano()2499 public final long getEventTimeNano() { 2500 return mEventTime * 1000000L; 2501 } 2502 2503 /** 2504 * Renamed to {@link #getDeviceId}. 2505 * 2506 * @hide 2507 * @deprecated use {@link #getDeviceId()} instead. 2508 */ 2509 @Deprecated getKeyboardDevice()2510 public final int getKeyboardDevice() { 2511 return mDeviceId; 2512 } 2513 2514 /** 2515 * Gets the {@link KeyCharacterMap} associated with the keyboard device. 2516 * 2517 * @return The associated key character map. 2518 * @throws {@link KeyCharacterMap.UnavailableException} if the key character map 2519 * could not be loaded because it was malformed or the default key character map 2520 * is missing from the system. 2521 * 2522 * @see KeyCharacterMap#load 2523 */ getKeyCharacterMap()2524 public final KeyCharacterMap getKeyCharacterMap() { 2525 return KeyCharacterMap.load(mDeviceId); 2526 } 2527 2528 /** 2529 * Gets the primary character for this key. 2530 * In other words, the label that is physically printed on it. 2531 * 2532 * @return The display label character, or 0 if none (eg. for non-printing keys). 2533 */ getDisplayLabel()2534 public char getDisplayLabel() { 2535 return getKeyCharacterMap().getDisplayLabel(mKeyCode); 2536 } 2537 2538 /** 2539 * Gets the Unicode character generated by the specified key and meta 2540 * key state combination. 2541 * <p> 2542 * Returns the Unicode character that the specified key would produce 2543 * when the specified meta bits (see {@link MetaKeyKeyListener}) 2544 * were active. 2545 * </p><p> 2546 * Returns 0 if the key is not one that is used to type Unicode 2547 * characters. 2548 * </p><p> 2549 * If the return value has bit {@link KeyCharacterMap#COMBINING_ACCENT} set, the 2550 * key is a "dead key" that should be combined with another to 2551 * actually produce a character -- see {@link KeyCharacterMap#getDeadChar} -- 2552 * after masking with {@link KeyCharacterMap#COMBINING_ACCENT_MASK}. 2553 * </p> 2554 * 2555 * @return The associated character or combining accent, or 0 if none. 2556 */ getUnicodeChar()2557 public int getUnicodeChar() { 2558 return getUnicodeChar(mMetaState); 2559 } 2560 2561 /** 2562 * Gets the Unicode character generated by the specified key and meta 2563 * key state combination. 2564 * <p> 2565 * Returns the Unicode character that the specified key would produce 2566 * when the specified meta bits (see {@link MetaKeyKeyListener}) 2567 * were active. 2568 * </p><p> 2569 * Returns 0 if the key is not one that is used to type Unicode 2570 * characters. 2571 * </p><p> 2572 * If the return value has bit {@link KeyCharacterMap#COMBINING_ACCENT} set, the 2573 * key is a "dead key" that should be combined with another to 2574 * actually produce a character -- see {@link KeyCharacterMap#getDeadChar} -- 2575 * after masking with {@link KeyCharacterMap#COMBINING_ACCENT_MASK}. 2576 * </p> 2577 * 2578 * @param metaState The meta key modifier state. 2579 * @return The associated character or combining accent, or 0 if none. 2580 */ getUnicodeChar(int metaState)2581 public int getUnicodeChar(int metaState) { 2582 return getKeyCharacterMap().get(mKeyCode, metaState); 2583 } 2584 2585 /** 2586 * Get the character conversion data for a given key code. 2587 * 2588 * @param results A {@link KeyCharacterMap.KeyData} instance that will be 2589 * filled with the results. 2590 * @return True if the key was mapped. If the key was not mapped, results is not modified. 2591 * 2592 * @deprecated instead use {@link #getDisplayLabel()}, 2593 * {@link #getNumber()} or {@link #getUnicodeChar(int)}. 2594 */ 2595 @Deprecated getKeyData(KeyData results)2596 public boolean getKeyData(KeyData results) { 2597 return getKeyCharacterMap().getKeyData(mKeyCode, results); 2598 } 2599 2600 /** 2601 * Gets the first character in the character array that can be generated 2602 * by the specified key code. 2603 * <p> 2604 * This is a convenience function that returns the same value as 2605 * {@link #getMatch(char[],int) getMatch(chars, 0)}. 2606 * </p> 2607 * 2608 * @param chars The array of matching characters to consider. 2609 * @return The matching associated character, or 0 if none. 2610 */ getMatch(char[] chars)2611 public char getMatch(char[] chars) { 2612 return getMatch(chars, 0); 2613 } 2614 2615 /** 2616 * Gets the first character in the character array that can be generated 2617 * by the specified key code. If there are multiple choices, prefers 2618 * the one that would be generated with the specified meta key modifier state. 2619 * 2620 * @param chars The array of matching characters to consider. 2621 * @param metaState The preferred meta key modifier state. 2622 * @return The matching associated character, or 0 if none. 2623 */ getMatch(char[] chars, int metaState)2624 public char getMatch(char[] chars, int metaState) { 2625 return getKeyCharacterMap().getMatch(mKeyCode, chars, metaState); 2626 } 2627 2628 /** 2629 * Gets the number or symbol associated with the key. 2630 * <p> 2631 * The character value is returned, not the numeric value. 2632 * If the key is not a number, but is a symbol, the symbol is retuned. 2633 * </p><p> 2634 * This method is intended to to support dial pads and other numeric or 2635 * symbolic entry on keyboards where certain keys serve dual function 2636 * as alphabetic and symbolic keys. This method returns the number 2637 * or symbol associated with the key independent of whether the user 2638 * has pressed the required modifier. 2639 * </p><p> 2640 * For example, on one particular keyboard the keys on the top QWERTY row generate 2641 * numbers when ALT is pressed such that ALT-Q maps to '1'. So for that keyboard 2642 * when {@link #getNumber} is called with {@link KeyEvent#KEYCODE_Q} it returns '1' 2643 * so that the user can type numbers without pressing ALT when it makes sense. 2644 * </p> 2645 * 2646 * @return The associated numeric or symbolic character, or 0 if none. 2647 */ getNumber()2648 public char getNumber() { 2649 return getKeyCharacterMap().getNumber(mKeyCode); 2650 } 2651 2652 /** 2653 * Returns true if this key produces a glyph. 2654 * 2655 * @return True if the key is a printing key. 2656 */ isPrintingKey()2657 public boolean isPrintingKey() { 2658 return getKeyCharacterMap().isPrintingKey(mKeyCode); 2659 } 2660 2661 /** 2662 * @deprecated Use {@link #dispatch(Callback, DispatcherState, Object)} instead. 2663 */ 2664 @Deprecated dispatch(Callback receiver)2665 public final boolean dispatch(Callback receiver) { 2666 return dispatch(receiver, null, null); 2667 } 2668 2669 /** 2670 * Deliver this key event to a {@link Callback} interface. If this is 2671 * an ACTION_MULTIPLE event and it is not handled, then an attempt will 2672 * be made to deliver a single normal event. 2673 * 2674 * @param receiver The Callback that will be given the event. 2675 * @param state State information retained across events. 2676 * @param target The target of the dispatch, for use in tracking. 2677 * 2678 * @return The return value from the Callback method that was called. 2679 */ dispatch(Callback receiver, DispatcherState state, Object target)2680 public final boolean dispatch(Callback receiver, DispatcherState state, 2681 Object target) { 2682 switch (mAction) { 2683 case ACTION_DOWN: { 2684 mFlags &= ~FLAG_START_TRACKING; 2685 if (DEBUG) Log.v(TAG, "Key down to " + target + " in " + state 2686 + ": " + this); 2687 boolean res = receiver.onKeyDown(mKeyCode, this); 2688 if (state != null) { 2689 if (res && mRepeatCount == 0 && (mFlags&FLAG_START_TRACKING) != 0) { 2690 if (DEBUG) Log.v(TAG, " Start tracking!"); 2691 state.startTracking(this, target); 2692 } else if (isLongPress() && state.isTracking(this)) { 2693 try { 2694 if (receiver.onKeyLongPress(mKeyCode, this)) { 2695 if (DEBUG) Log.v(TAG, " Clear from long press!"); 2696 state.performedLongPress(this); 2697 res = true; 2698 } 2699 } catch (AbstractMethodError e) { 2700 } 2701 } 2702 } 2703 return res; 2704 } 2705 case ACTION_UP: 2706 if (DEBUG) Log.v(TAG, "Key up to " + target + " in " + state 2707 + ": " + this); 2708 if (state != null) { 2709 state.handleUpEvent(this); 2710 } 2711 return receiver.onKeyUp(mKeyCode, this); 2712 case ACTION_MULTIPLE: 2713 final int count = mRepeatCount; 2714 final int code = mKeyCode; 2715 if (receiver.onKeyMultiple(code, count, this)) { 2716 return true; 2717 } 2718 if (code != KeyEvent.KEYCODE_UNKNOWN) { 2719 mAction = ACTION_DOWN; 2720 mRepeatCount = 0; 2721 boolean handled = receiver.onKeyDown(code, this); 2722 if (handled) { 2723 mAction = ACTION_UP; 2724 receiver.onKeyUp(code, this); 2725 } 2726 mAction = ACTION_MULTIPLE; 2727 mRepeatCount = count; 2728 return handled; 2729 } 2730 return false; 2731 } 2732 return false; 2733 } 2734 2735 /** 2736 * Use with {@link KeyEvent#dispatch(Callback, DispatcherState, Object)} 2737 * for more advanced key dispatching, such as long presses. 2738 */ 2739 public static class DispatcherState { 2740 int mDownKeyCode; 2741 Object mDownTarget; 2742 SparseIntArray mActiveLongPresses = new SparseIntArray(); 2743 2744 /** 2745 * Reset back to initial state. 2746 */ reset()2747 public void reset() { 2748 if (DEBUG) Log.v(TAG, "Reset: " + this); 2749 mDownKeyCode = 0; 2750 mDownTarget = null; 2751 mActiveLongPresses.clear(); 2752 } 2753 2754 /** 2755 * Stop any tracking associated with this target. 2756 */ reset(Object target)2757 public void reset(Object target) { 2758 if (mDownTarget == target) { 2759 if (DEBUG) Log.v(TAG, "Reset in " + target + ": " + this); 2760 mDownKeyCode = 0; 2761 mDownTarget = null; 2762 } 2763 } 2764 2765 /** 2766 * Start tracking the key code associated with the given event. This 2767 * can only be called on a key down. It will allow you to see any 2768 * long press associated with the key, and will result in 2769 * {@link KeyEvent#isTracking} return true on the long press and up 2770 * events. 2771 * 2772 * <p>This is only needed if you are directly dispatching events, rather 2773 * than handling them in {@link Callback#onKeyDown}. 2774 */ startTracking(KeyEvent event, Object target)2775 public void startTracking(KeyEvent event, Object target) { 2776 if (event.getAction() != ACTION_DOWN) { 2777 throw new IllegalArgumentException( 2778 "Can only start tracking on a down event"); 2779 } 2780 if (DEBUG) Log.v(TAG, "Start trackingt in " + target + ": " + this); 2781 mDownKeyCode = event.getKeyCode(); 2782 mDownTarget = target; 2783 } 2784 2785 /** 2786 * Return true if the key event is for a key code that is currently 2787 * being tracked by the dispatcher. 2788 */ isTracking(KeyEvent event)2789 public boolean isTracking(KeyEvent event) { 2790 return mDownKeyCode == event.getKeyCode(); 2791 } 2792 2793 /** 2794 * Keep track of the given event's key code as having performed an 2795 * action with a long press, so no action should occur on the up. 2796 * <p>This is only needed if you are directly dispatching events, rather 2797 * than handling them in {@link Callback#onKeyLongPress}. 2798 */ performedLongPress(KeyEvent event)2799 public void performedLongPress(KeyEvent event) { 2800 mActiveLongPresses.put(event.getKeyCode(), 1); 2801 } 2802 2803 /** 2804 * Handle key up event to stop tracking. This resets the dispatcher state, 2805 * and updates the key event state based on it. 2806 * <p>This is only needed if you are directly dispatching events, rather 2807 * than handling them in {@link Callback#onKeyUp}. 2808 */ handleUpEvent(KeyEvent event)2809 public void handleUpEvent(KeyEvent event) { 2810 final int keyCode = event.getKeyCode(); 2811 if (DEBUG) Log.v(TAG, "Handle key up " + event + ": " + this); 2812 int index = mActiveLongPresses.indexOfKey(keyCode); 2813 if (index >= 0) { 2814 if (DEBUG) Log.v(TAG, " Index: " + index); 2815 event.mFlags |= FLAG_CANCELED | FLAG_CANCELED_LONG_PRESS; 2816 mActiveLongPresses.removeAt(index); 2817 } 2818 if (mDownKeyCode == keyCode) { 2819 if (DEBUG) Log.v(TAG, " Tracking!"); 2820 event.mFlags |= FLAG_TRACKING; 2821 mDownKeyCode = 0; 2822 mDownTarget = null; 2823 } 2824 } 2825 } 2826 2827 @Override toString()2828 public String toString() { 2829 StringBuilder msg = new StringBuilder(); 2830 msg.append("KeyEvent { action=").append(actionToString(mAction)); 2831 msg.append(", keyCode=").append(keyCodeToString(mKeyCode)); 2832 msg.append(", scanCode=").append(mScanCode); 2833 if (mCharacters != null) { 2834 msg.append(", characters=\"").append(mCharacters).append("\""); 2835 } 2836 msg.append(", metaState=").append(metaStateToString(mMetaState)); 2837 msg.append(", flags=0x").append(Integer.toHexString(mFlags)); 2838 msg.append(", repeatCount=").append(mRepeatCount); 2839 msg.append(", eventTime=").append(mEventTime); 2840 msg.append(", downTime=").append(mDownTime); 2841 msg.append(", deviceId=").append(mDeviceId); 2842 msg.append(", source=0x").append(Integer.toHexString(mSource)); 2843 msg.append(" }"); 2844 return msg.toString(); 2845 } 2846 2847 /** 2848 * Returns a string that represents the symbolic name of the specified action 2849 * such as "ACTION_DOWN", or an equivalent numeric constant such as "35" if unknown. 2850 * 2851 * @param action The action. 2852 * @return The symbolic name of the specified action. 2853 * @hide 2854 */ actionToString(int action)2855 public static String actionToString(int action) { 2856 switch (action) { 2857 case ACTION_DOWN: 2858 return "ACTION_DOWN"; 2859 case ACTION_UP: 2860 return "ACTION_UP"; 2861 case ACTION_MULTIPLE: 2862 return "ACTION_MULTIPLE"; 2863 default: 2864 return Integer.toString(action); 2865 } 2866 } 2867 2868 /** 2869 * Returns a string that represents the symbolic name of the specified keycode 2870 * such as "KEYCODE_A", "KEYCODE_DPAD_UP", or an equivalent numeric constant 2871 * such as "1001" if unknown. 2872 * 2873 * @param keyCode The key code. 2874 * @return The symbolic name of the specified keycode. 2875 * 2876 * @see KeyCharacterMap#getDisplayLabel 2877 */ keyCodeToString(int keyCode)2878 public static String keyCodeToString(int keyCode) { 2879 String symbolicName = nativeKeyCodeToString(keyCode); 2880 return symbolicName != null ? LABEL_PREFIX + symbolicName : Integer.toString(keyCode); 2881 } 2882 2883 /** 2884 * Gets a keycode by its symbolic name such as "KEYCODE_A" or an equivalent 2885 * numeric constant such as "1001". 2886 * 2887 * @param symbolicName The symbolic name of the keycode. 2888 * @return The keycode or {@link #KEYCODE_UNKNOWN} if not found. 2889 * @see #keycodeToString(int) 2890 */ keyCodeFromString(String symbolicName)2891 public static int keyCodeFromString(String symbolicName) { 2892 if (symbolicName.startsWith(LABEL_PREFIX)) { 2893 symbolicName = symbolicName.substring(LABEL_PREFIX.length()); 2894 int keyCode = nativeKeyCodeFromString(symbolicName); 2895 if (keyCode > 0) { 2896 return keyCode; 2897 } 2898 } 2899 try { 2900 return Integer.parseInt(symbolicName, 10); 2901 } catch (NumberFormatException ex) { 2902 return KEYCODE_UNKNOWN; 2903 } 2904 } 2905 2906 /** 2907 * Returns a string that represents the symbolic name of the specified combined meta 2908 * key modifier state flags such as "0", "META_SHIFT_ON", 2909 * "META_ALT_ON|META_SHIFT_ON" or an equivalent numeric constant such as "0x10000000" 2910 * if unknown. 2911 * 2912 * @param metaState The meta state. 2913 * @return The symbolic name of the specified combined meta state flags. 2914 * @hide 2915 */ metaStateToString(int metaState)2916 public static String metaStateToString(int metaState) { 2917 if (metaState == 0) { 2918 return "0"; 2919 } 2920 StringBuilder result = null; 2921 int i = 0; 2922 while (metaState != 0) { 2923 final boolean isSet = (metaState & 1) != 0; 2924 metaState >>>= 1; // unsigned shift! 2925 if (isSet) { 2926 final String name = META_SYMBOLIC_NAMES[i]; 2927 if (result == null) { 2928 if (metaState == 0) { 2929 return name; 2930 } 2931 result = new StringBuilder(name); 2932 } else { 2933 result.append('|'); 2934 result.append(name); 2935 } 2936 } 2937 i += 1; 2938 } 2939 return result.toString(); 2940 } 2941 2942 public static final Parcelable.Creator<KeyEvent> CREATOR 2943 = new Parcelable.Creator<KeyEvent>() { 2944 @Override 2945 public KeyEvent createFromParcel(Parcel in) { 2946 in.readInt(); // skip token, we already know this is a KeyEvent 2947 return KeyEvent.createFromParcelBody(in); 2948 } 2949 2950 @Override 2951 public KeyEvent[] newArray(int size) { 2952 return new KeyEvent[size]; 2953 } 2954 }; 2955 2956 /** @hide */ createFromParcelBody(Parcel in)2957 public static KeyEvent createFromParcelBody(Parcel in) { 2958 return new KeyEvent(in); 2959 } 2960 KeyEvent(Parcel in)2961 private KeyEvent(Parcel in) { 2962 mDeviceId = in.readInt(); 2963 mSource = in.readInt(); 2964 mAction = in.readInt(); 2965 mKeyCode = in.readInt(); 2966 mRepeatCount = in.readInt(); 2967 mMetaState = in.readInt(); 2968 mScanCode = in.readInt(); 2969 mFlags = in.readInt(); 2970 mDownTime = in.readLong(); 2971 mEventTime = in.readLong(); 2972 } 2973 2974 @Override writeToParcel(Parcel out, int flags)2975 public void writeToParcel(Parcel out, int flags) { 2976 out.writeInt(PARCEL_TOKEN_KEY_EVENT); 2977 2978 out.writeInt(mDeviceId); 2979 out.writeInt(mSource); 2980 out.writeInt(mAction); 2981 out.writeInt(mKeyCode); 2982 out.writeInt(mRepeatCount); 2983 out.writeInt(mMetaState); 2984 out.writeInt(mScanCode); 2985 out.writeInt(mFlags); 2986 out.writeLong(mDownTime); 2987 out.writeLong(mEventTime); 2988 } 2989 } 2990