19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.view; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1967e2ae86396c6d0f989285275cbf908dee5e71f7Aurimas Liutikasimport android.hardware.input.InputManager; 209f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brownimport android.os.Parcel; 219f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brownimport android.os.Parcelable; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.text.method.MetaKeyKeyListener; 236b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brownimport android.util.AndroidRuntimeException; 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.SparseIntArray; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 26c3643b901308289132269aa3af9a738cd2b60f08Jeff Brownimport java.text.Normalizer; 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 28c5ed5910c9ef066cec6a13bbb404ec57b1e92637Jeff Brown/** 296b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Describes the keys provided by a keyboard device and their associated labels. 30c5ed5910c9ef066cec6a13bbb404ec57b1e92637Jeff Brown */ 319f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brownpublic class KeyCharacterMap implements Parcelable { 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The id of the device's primary built in keyboard is always 0. 341f2451007c660091b7b090c1ea332f9044515d2dJeff Brown * 351f2451007c660091b7b090c1ea332f9044515d2dJeff Brown * @deprecated This constant should no longer be used because there is no 361f2451007c660091b7b090c1ea332f9044515d2dJeff Brown * guarantee that a device has a built-in keyboard that can be used for 371f2451007c660091b7b090c1ea332f9044515d2dJeff Brown * typing text. There might not be a built-in keyboard, the built-in keyboard 381f2451007c660091b7b090c1ea332f9044515d2dJeff Brown * might be a {@link #NUMERIC} or {@link #SPECIAL_FUNCTION} keyboard, or there 391f2451007c660091b7b090c1ea332f9044515d2dJeff Brown * might be multiple keyboards installed including external keyboards. 401f2451007c660091b7b090c1ea332f9044515d2dJeff Brown * When interpreting key presses received from the framework, applications should 4146a5ae6dd747d4169c7328df3c2a3c4c26f4bd26Jeff Brown * use the device id specified in the {@link KeyEvent} received. 421f2451007c660091b7b090c1ea332f9044515d2dJeff Brown * When synthesizing key presses for delivery elsewhere or when translating key presses 431f2451007c660091b7b090c1ea332f9044515d2dJeff Brown * from unknown keyboards, applications should use the special {@link #VIRTUAL_KEYBOARD} 441f2451007c660091b7b090c1ea332f9044515d2dJeff Brown * device id. 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 461f2451007c660091b7b090c1ea332f9044515d2dJeff Brown @Deprecated 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int BUILT_IN_KEYBOARD = 0; 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 496b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 506b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * The id of a generic virtual keyboard with a full layout that can be used to 516b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * synthesize key events. Typically used with {@link #getEvents}. 526b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 536b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public static final int VIRTUAL_KEYBOARD = -1; 546b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 556b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 566b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * A numeric (12-key) keyboard. 576b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 586b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * A numeric keyboard supports text entry using a multi-tap approach. 596b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * It may be necessary to tap a key multiple times to generate the desired letter 606b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * or symbol. 616b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p><p> 626b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * This type of keyboard is generally designed for thumb typing. 636b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 646b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int NUMERIC = 1; 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 676b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 686b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * A keyboard with all the letters, but with more than one letter per key. 696b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 706b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * This type of keyboard is generally designed for thumb typing. 716b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 726b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int PREDICTIVE = 2; 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 756b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 766b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * A keyboard with all the letters, and maybe some numbers. 776b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 786b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * An alphabetic keyboard supports text entry directly but may have a condensed 796b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * layout with a small form factor. In contrast to a {@link #FULL full keyboard}, some 806b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * symbols may only be accessible using special on-screen character pickers. 816b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * In addition, to improve typing speed and accuracy, the framework provides 826b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * special affordances for alphabetic keyboards such as auto-capitalization 836b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * and toggled / locked shift and alt keys. 846b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p><p> 856b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * This type of keyboard is generally designed for thumb typing. 866b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 876b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int ALPHA = 3; 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 916b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * A full PC-style keyboard. 926b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 936b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * A full keyboard behaves like a PC keyboard. All symbols are accessed directly 946b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * by pressing keys on the keyboard without on-screen support or affordances such 956b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * as auto-capitalization. 966b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p><p> 976b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * This type of keyboard is generally designed for full two hand typing. 986b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 996b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 1006b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public static final int FULL = 4; 1016b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 1026b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 1036b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * A keyboard that is only used to control special functions rather than for typing. 1046b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 1056b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * A special function keyboard consists only of non-printing keys such as 1066b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * HOME and POWER that are not actually used for typing. 1076b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 1086b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 1096b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public static final int SPECIAL_FUNCTION = 5; 1106b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 1116b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This private-use character is used to trigger Unicode character 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * input by hex digits. 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final char HEX_INPUT = '\uEF00'; 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This private-use character is used to bring up a character picker for 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * miscellaneous symbols. 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final char PICKER_DIALOG_INPUT = '\uEF01'; 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1236b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 1246b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Modifier keys may be chorded with character keys. 1256b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 1266b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @see {#link #getModifierBehavior()} for more details. 1276b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 1286b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public static final int MODIFIER_BEHAVIOR_CHORDED = 0; 1296b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 1306b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 1316b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Modifier keys may be chorded with character keys or they may toggle 1326b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * into latched or locked states when pressed independently. 1336b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 1346b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @see {#link #getModifierBehavior()} for more details. 1356b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 1366b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public static final int MODIFIER_BEHAVIOR_CHORDED_OR_TOGGLED = 1; 1376b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 138accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown /* 139accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown * This bit will be set in the return value of {@link #get(int, int)} if the 140accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown * key is a "dead key." 141accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown */ 142accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown public static final int COMBINING_ACCENT = 0x80000000; 143accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown 144accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown /** 145accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown * Mask the return value from {@link #get(int, int)} with this value to get 146accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown * a printable representation of the accent character of a "dead key." 147accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown */ 148accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown public static final int COMBINING_ACCENT_MASK = 0x7FFFFFFF; 149accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown 150accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown /* Characters used to display placeholders for dead keys. */ 151accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown private static final int ACCENT_ACUTE = '\u00B4'; 152c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_BREVE = '\u02D8'; 153c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_CARON = '\u02C7'; 154c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_CEDILLA = '\u00B8'; 15569b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown private static final int ACCENT_CIRCUMFLEX = '\u02C6'; 156c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_COMMA_ABOVE = '\u1FBD'; 157c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_COMMA_ABOVE_RIGHT = '\u02BC'; 158c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_DOT_ABOVE = '\u02D9'; 15969b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown private static final int ACCENT_DOT_BELOW = '.'; // approximate 160c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_DOUBLE_ACUTE = '\u02DD'; 161accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown private static final int ACCENT_GRAVE = '\u02CB'; 16269b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown private static final int ACCENT_HOOK_ABOVE = '\u02C0'; 16369b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown private static final int ACCENT_HORN = '\''; // approximate 164c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_MACRON = '\u00AF'; 165c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_MACRON_BELOW = '\u02CD'; 166c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_OGONEK = '\u02DB'; 167c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_REVERSED_COMMA_ABOVE = '\u02BD'; 168c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_RING_ABOVE = '\u02DA'; 16969b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown private static final int ACCENT_STROKE = '-'; // approximate 170accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown private static final int ACCENT_TILDE = '\u02DC'; 171c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final int ACCENT_TURNED_COMMA_ABOVE = '\u02BB'; 172accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown private static final int ACCENT_UMLAUT = '\u00A8'; 17369b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown private static final int ACCENT_VERTICAL_LINE_ABOVE = '\u02C8'; 17469b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown private static final int ACCENT_VERTICAL_LINE_BELOW = '\u02CC'; 175accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown 176accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown /* Legacy dead key display characters used in previous versions of the API. 177accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown * We still support these characters by mapping them to their non-legacy version. */ 178accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown private static final int ACCENT_GRAVE_LEGACY = '`'; 179accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown private static final int ACCENT_CIRCUMFLEX_LEGACY = '^'; 180accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown private static final int ACCENT_TILDE_LEGACY = '~'; 181accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown 182548655045a9c9791bd33e77a823afea5846228abJean Chalard private static final int CHAR_SPACE = ' '; 183548655045a9c9791bd33e77a823afea5846228abJean Chalard 184accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown /** 185c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown * Maps Unicode combining diacritical to display-form dead key. 186accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown */ 187c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final SparseIntArray sCombiningToAccent = new SparseIntArray(); 188c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final SparseIntArray sAccentToCombining = new SparseIntArray(); 189accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown static { 190c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0300', ACCENT_GRAVE); 191c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0301', ACCENT_ACUTE); 192c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0302', ACCENT_CIRCUMFLEX); 193c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0303', ACCENT_TILDE); 194c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0304', ACCENT_MACRON); 195c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0306', ACCENT_BREVE); 196c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0307', ACCENT_DOT_ABOVE); 197c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0308', ACCENT_UMLAUT); 19869b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addCombining('\u0309', ACCENT_HOOK_ABOVE); 199c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u030A', ACCENT_RING_ABOVE); 200c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u030B', ACCENT_DOUBLE_ACUTE); 201c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u030C', ACCENT_CARON); 20269b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addCombining('\u030D', ACCENT_VERTICAL_LINE_ABOVE); 203c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown //addCombining('\u030E', ACCENT_DOUBLE_VERTICAL_LINE_ABOVE); 204c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown //addCombining('\u030F', ACCENT_DOUBLE_GRAVE); 205c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown //addCombining('\u0310', ACCENT_CANDRABINDU); 206c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown //addCombining('\u0311', ACCENT_INVERTED_BREVE); 207c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0312', ACCENT_TURNED_COMMA_ABOVE); 208c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0313', ACCENT_COMMA_ABOVE); 209c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0314', ACCENT_REVERSED_COMMA_ABOVE); 210c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0315', ACCENT_COMMA_ABOVE_RIGHT); 21169b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addCombining('\u031B', ACCENT_HORN); 21269b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addCombining('\u0323', ACCENT_DOT_BELOW); 213c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown //addCombining('\u0326', ACCENT_COMMA_BELOW); 214c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0327', ACCENT_CEDILLA); 215c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0328', ACCENT_OGONEK); 21669b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addCombining('\u0329', ACCENT_VERTICAL_LINE_BELOW); 217c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown addCombining('\u0331', ACCENT_MACRON_BELOW); 21869b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addCombining('\u0335', ACCENT_STROKE); 219c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown //addCombining('\u0342', ACCENT_PERISPOMENI); 220c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown //addCombining('\u0344', ACCENT_DIALYTIKA_TONOS); 221c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown //addCombining('\u0345', ACCENT_YPOGEGRAMMENI); 222c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown 223c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown // One-way mappings to equivalent preferred accents. 224c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sCombiningToAccent.append('\u0340', ACCENT_GRAVE); 225c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sCombiningToAccent.append('\u0341', ACCENT_ACUTE); 226c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sCombiningToAccent.append('\u0343', ACCENT_COMMA_ABOVE); 227c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown 228c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown // One-way legacy mappings to preserve compatibility with older applications. 229c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sAccentToCombining.append(ACCENT_GRAVE_LEGACY, '\u0300'); 230c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sAccentToCombining.append(ACCENT_CIRCUMFLEX_LEGACY, '\u0302'); 231c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sAccentToCombining.append(ACCENT_TILDE_LEGACY, '\u0303'); 232c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown } 233c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown 234c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static void addCombining(int combining, int accent) { 235c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sCombiningToAccent.append(combining, accent); 236c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sAccentToCombining.append(accent, combining); 237accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown } 238accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown 239accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown /** 240c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown * Maps combinations of (display-form) combining key and second character 241accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown * to combined output character. 242c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown * These mappings are derived from the Unicode NFC tables as needed. 243accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown */ 244c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final SparseIntArray sDeadKeyCache = new SparseIntArray(); 245c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown private static final StringBuilder sDeadKeyBuilder = new StringBuilder(); 24669b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown static { 24769b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown // Non-standard decompositions. 24869b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown // Stroke modifier for Finnish multilingual keyboard and others. 24969b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'D', '\u0110'); 25069b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'G', '\u01e4'); 25169b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'H', '\u0126'); 25269b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'I', '\u0197'); 25369b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'L', '\u0141'); 25469b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'O', '\u00d8'); 25569b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'T', '\u0166'); 25669b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'd', '\u0111'); 25769b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'g', '\u01e5'); 25869b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'h', '\u0127'); 25969b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'i', '\u0268'); 26069b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'l', '\u0142'); 26169b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 'o', '\u00f8'); 26269b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown addDeadKey(ACCENT_STROKE, 't', '\u0167'); 26369b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown } 26469b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown 26569b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown private static void addDeadKey(int accent, int c, int result) { 26669b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown final int combining = sAccentToCombining.get(accent); 26769b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown if (combining == 0) { 26869b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown throw new IllegalStateException("Invalid dead key declaration."); 26969b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown } 27069b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown final int combination = (combining << 16) | c; 27169b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown sDeadKeyCache.put(combination, result); 27269b2be163d6ba00fead46c2e01ec775d8487e777Jeff Brown } 273accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown 2749f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown public static final Parcelable.Creator<KeyCharacterMap> CREATOR = 2759f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown new Parcelable.Creator<KeyCharacterMap>() { 2769f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown public KeyCharacterMap createFromParcel(Parcel in) { 2779f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown return new KeyCharacterMap(in); 2789f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown } 2799f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown public KeyCharacterMap[] newArray(int size) { 2809f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown return new KeyCharacterMap[size]; 2819f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown } 2829f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown }; 2836b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 2840c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private long mPtr; 2856b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 2860c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private static native long nativeReadFromParcel(Parcel in); 2870c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private static native void nativeWriteToParcel(long ptr, Parcel out); 2880c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private static native void nativeDispose(long ptr); 2896b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 2900c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private static native char nativeGetCharacter(long ptr, int keyCode, int metaState); 2910c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private static native boolean nativeGetFallbackAction(long ptr, int keyCode, int metaState, 29249ed71db425c5054e3ad9526496a7e116c89556bJeff Brown FallbackAction outFallbackAction); 2930c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private static native char nativeGetNumber(long ptr, int keyCode); 2940c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private static native char nativeGetMatch(long ptr, int keyCode, char[] chars, int metaState); 2950c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private static native char nativeGetDisplayLabel(long ptr, int keyCode); 2960c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private static native int nativeGetKeyboardType(long ptr); 2970c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private static native KeyEvent[] nativeGetEvents(long ptr, char[] chars); 2989f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown 2999f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown private KeyCharacterMap(Parcel in) { 3009f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown if (in == null) { 3019f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown throw new IllegalArgumentException("parcel must not be null"); 3029f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown } 3039f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown mPtr = nativeReadFromParcel(in); 3049f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown if (mPtr == 0) { 3059f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown throw new RuntimeException("Could not read KeyCharacterMap from parcel."); 3069f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown } 3079f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown } 3086b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 3099f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown // Called from native 3100c3f9210166a861fe568ac15994a0d7a42f7e28aAshok Bhat private KeyCharacterMap(long ptr) { 3116b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown mPtr = ptr; 3126b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown } 3136b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 3146b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown @Override 3156b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown protected void finalize() throws Throwable { 3166b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown if (mPtr != 0) { 3176b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown nativeDispose(mPtr); 3186b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown mPtr = 0; 3196b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown } 3206b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown } 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 322c5ed5910c9ef066cec6a13bbb404ec57b1e92637Jeff Brown /** 323c5ed5910c9ef066cec6a13bbb404ec57b1e92637Jeff Brown * Loads the key character maps for the keyboard with the specified device id. 3246b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 3256b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param deviceId The device id of the keyboard. 326c5ed5910c9ef066cec6a13bbb404ec57b1e92637Jeff Brown * @return The associated key character map. 3277e1e21fdc5e8a9bb870b1f030658a67d2bf43207Jeff Brown * @throws {@link UnavailableException} if the key character map 3286b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * could not be loaded because it was malformed or the default key character map 3296b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * is missing from the system. 330c5ed5910c9ef066cec6a13bbb404ec57b1e92637Jeff Brown */ 3316b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public static KeyCharacterMap load(int deviceId) { 3329f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown final InputManager im = InputManager.getInstance(); 3339f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown InputDevice inputDevice = im.getInputDevice(deviceId); 3349f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown if (inputDevice == null) { 3359f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown inputDevice = im.getInputDevice(VIRTUAL_KEYBOARD); 3369f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown if (inputDevice == null) { 3379f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown throw new UnavailableException( 3389f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown "Could not load key character map for device " + deviceId); 3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3419f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown return inputDevice.getKeyCharacterMap(); 3429df6e7a926ce480baf70e97ee1b9ea387193f6adJeff Brown } 3439df6e7a926ce480baf70e97ee1b9ea387193f6adJeff Brown 3449df6e7a926ce480baf70e97ee1b9ea387193f6adJeff Brown /** 3456b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Gets the Unicode character generated by the specified key and meta 3466b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * key state combination. 3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the Unicode character that the specified key would produce 3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when the specified meta bits (see {@link MetaKeyKeyListener}) 3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * were active. 3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </p><p> 3529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns 0 if the key is not one that is used to type Unicode 3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * characters. 3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </p><p> 3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If the return value has bit {@link #COMBINING_ACCENT} set, the 3569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * key is a "dead key" that should be combined with another to 3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * actually produce a character -- see {@link #getDeadChar} -- 3589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * after masking with {@link #COMBINING_ACCENT_MASK}. 3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </p> 3606b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 3616b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param keyCode The key code. 3626b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param metaState The meta key modifier state. 3636b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return The associated character or combining accent, or 0 if none. 3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3656b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public int get(int keyCode, int metaState) { 36628cbf4bd5c204f0493a6fa448a259ec056dcc29eJeff Brown metaState = KeyEvent.normalizeMetaState(metaState); 3676b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown char ch = nativeGetCharacter(mPtr, keyCode, metaState); 36849ed71db425c5054e3ad9526496a7e116c89556bJeff Brown 369c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown int map = sCombiningToAccent.get(ch); 3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (map != 0) { 371accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown return map | COMBINING_ACCENT; 3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 3736b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown return ch; 3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 37849ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * Gets the fallback action to perform if the application does not 37949ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * handle the specified key. 38049ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * <p> 38149ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * When an application does not handle a particular key, the system may 38249ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * translate the key to an alternate fallback key (specified in the 38349ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * fallback action) and dispatch it to the application. 38449ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * The event containing the fallback key is flagged 38549ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * with {@link KeyEvent#FLAG_FALLBACK}. 38649ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * </p> 38749ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * 38849ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * @param keyCode The key code. 38949ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * @param metaState The meta key modifier state. 390fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown * @return The fallback action, or null if none. Remember to recycle the fallback action. 39149ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * 39249ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * @hide 39349ed71db425c5054e3ad9526496a7e116c89556bJeff Brown */ 394fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown public FallbackAction getFallbackAction(int keyCode, int metaState) { 395fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown FallbackAction action = FallbackAction.obtain(); 39628cbf4bd5c204f0493a6fa448a259ec056dcc29eJeff Brown metaState = KeyEvent.normalizeMetaState(metaState); 397fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown if (nativeGetFallbackAction(mPtr, keyCode, metaState, action)) { 398fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown action.metaState = KeyEvent.normalizeMetaState(action.metaState); 399fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown return action; 400fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown } 401fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown action.recycle(); 402fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown return null; 40349ed71db425c5054e3ad9526496a7e116c89556bJeff Brown } 40449ed71db425c5054e3ad9526496a7e116c89556bJeff Brown 40549ed71db425c5054e3ad9526496a7e116c89556bJeff Brown /** 4066b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Gets the number or symbol associated with the key. 4076b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 4086b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * The character value is returned, not the numeric value. 4096b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * If the key is not a number, but is a symbol, the symbol is retuned. 4106b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p><p> 4116b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * This method is intended to to support dial pads and other numeric or 4126b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * symbolic entry on keyboards where certain keys serve dual function 4136b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * as alphabetic and symbolic keys. This method returns the number 4146b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * or symbol associated with the key independent of whether the user 4156b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * has pressed the required modifier. 4166b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p><p> 4176b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * For example, on one particular keyboard the keys on the top QWERTY row generate 4186b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * numbers when ALT is pressed such that ALT-Q maps to '1'. So for that keyboard 4196b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * when {@link #getNumber} is called with {@link KeyEvent#KEYCODE_Q} it returns '1' 4206b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * so that the user can type numbers without pressing ALT when it makes sense. 4216b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 4226b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 4236b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param keyCode The key code. 4246b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return The associated numeric or symbolic character, or 0 if none. 4259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4266b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public char getNumber(int keyCode) { 4276b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown return nativeGetNumber(mPtr, keyCode); 4289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4316b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Gets the first character in the character array that can be generated 4326b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * by the specified key code. 4336b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 4346b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * This is a convenience function that returns the same value as 4356b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * {@link #getMatch(int,char[],int) getMatch(keyCode, chars, 0)}. 4366b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 4376b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 4386b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param keyCode The keycode. 4396b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param chars The array of matching characters to consider. 4406b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return The matching associated character, or 0 if none. 441f2c2ae09dac03f5c08e3a04bfab8ee75c1ce8ce9Kirill Grouchnikov * @throws {@link IllegalArgumentException} if the passed array of characters is null. 4429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4436b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public char getMatch(int keyCode, char[] chars) { 4449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return getMatch(keyCode, chars, 0); 4459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4486b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Gets the first character in the character array that can be generated 4496b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * by the specified key code. If there are multiple choices, prefers 4506b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * the one that would be generated with the specified meta key modifier state. 4516b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 4526b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param keyCode The key code. 4536b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param chars The array of matching characters to consider. 4546b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param metaState The preferred meta key modifier state. 4556b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return The matching associated character, or 0 if none. 456f2c2ae09dac03f5c08e3a04bfab8ee75c1ce8ce9Kirill Grouchnikov * @throws {@link IllegalArgumentException} if the passed array of characters is null. 4576b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 4586b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public char getMatch(int keyCode, char[] chars, int metaState) { 4599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (chars == null) { 4606b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown throw new IllegalArgumentException("chars must not be null."); 4619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 46249ed71db425c5054e3ad9526496a7e116c89556bJeff Brown 46328cbf4bd5c204f0493a6fa448a259ec056dcc29eJeff Brown metaState = KeyEvent.normalizeMetaState(metaState); 4646b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown return nativeGetMatch(mPtr, keyCode, chars, metaState); 4659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4686b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Gets the primary character for this key. 4696b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * In other words, the label that is physically printed on it. 4706b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 4716b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param keyCode The key code. 4726b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return The display label character, or 0 if none (eg. for non-printing keys). 4739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4746b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public char getDisplayLabel(int keyCode) { 4756b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown return nativeGetDisplayLabel(mPtr, keyCode); 4769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 4779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 479548655045a9c9791bd33e77a823afea5846228abJean Chalard * Get the character that is produced by combining the dead key producing accent 480548655045a9c9791bd33e77a823afea5846228abJean Chalard * with the key producing character c. 4819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * For example, getDeadChar('`', 'e') returns è. 482548655045a9c9791bd33e77a823afea5846228abJean Chalard * getDeadChar('^', ' ') returns '^' and getDeadChar('^', '^') returns '^'. 4836b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 4846b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param accent The accent character. eg. '`' 4856b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param c The basic character. 4866b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return The combined character, or 0 if the characters cannot be combined. 4879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4886b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public static int getDeadChar(int accent, int c) { 489548655045a9c9791bd33e77a823afea5846228abJean Chalard if (c == accent || CHAR_SPACE == c) { 490548655045a9c9791bd33e77a823afea5846228abJean Chalard // The same dead character typed twice or a dead character followed by a 491548655045a9c9791bd33e77a823afea5846228abJean Chalard // space should both produce the non-combining version of the combining char. 492548655045a9c9791bd33e77a823afea5846228abJean Chalard // In this case we don't even need to compute the combining character. 493548655045a9c9791bd33e77a823afea5846228abJean Chalard return accent; 494548655045a9c9791bd33e77a823afea5846228abJean Chalard } 495548655045a9c9791bd33e77a823afea5846228abJean Chalard 496c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown int combining = sAccentToCombining.get(accent); 497c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown if (combining == 0) { 498c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown return 0; 499accce945e5f51436f3aa22a0e1a85e6059232dedJeff Brown } 500c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown 501c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown final int combination = (combining << 16) | c; 502c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown int combined; 503c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown synchronized (sDeadKeyCache) { 504c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown combined = sDeadKeyCache.get(combination, -1); 505c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown if (combined == -1) { 506c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sDeadKeyBuilder.setLength(0); 507c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sDeadKeyBuilder.append((char)c); 508c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sDeadKeyBuilder.append((char)combining); 509c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown String result = Normalizer.normalize(sDeadKeyBuilder, Normalizer.Form.NFC); 510548655045a9c9791bd33e77a823afea5846228abJean Chalard combined = result.codePointCount(0, result.length()) == 1 511548655045a9c9791bd33e77a823afea5846228abJean Chalard ? result.codePointAt(0) : 0; 512c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown sDeadKeyCache.put(combination, combined); 513c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown } 514c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown } 515c3643b901308289132269aa3af9a738cd2b60f08Jeff Brown return combined; 5169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5186b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 5196b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Describes the character mappings associated with a key. 5206b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 5216b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @deprecated instead use {@link KeyCharacterMap#getDisplayLabel(int)}, 5226b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * {@link KeyCharacterMap#getNumber(int)} and {@link KeyCharacterMap#get(int, int)}. 5236b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 5246b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown @Deprecated 5259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static class KeyData { 5269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int META_LENGTH = 4; 5279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The display label (see {@link #getDisplayLabel}). 5309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public char displayLabel; 5329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The "number" value (see {@link #getNumber}). 5349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public char number; 5369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The character that will be generated in various meta states 5389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (the same ones used for {@link #get} and defined as 5399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link KeyEvent#META_SHIFT_ON} and {@link KeyEvent#META_ALT_ON}). 5409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <table> 5419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><th>Index</th><th align="left">Value</th></tr> 5429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><td>0</td><td>no modifiers</td></tr> 5439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><td>1</td><td>caps</td></tr> 5449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><td>2</td><td>alt</td></tr> 5459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr><td>3</td><td>caps + alt</td></tr> 5469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </table> 5479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public char[] meta = new char[META_LENGTH]; 5499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5506b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 5519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5526b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Get the character conversion data for a given key code. 5539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5546b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param keyCode The keyCode to query. 5556b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param results A {@link KeyData} instance that will be filled with the results. 5566b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return True if the key was mapped. If the key was not mapped, results is not modified. 5579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 5586b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @deprecated instead use {@link KeyCharacterMap#getDisplayLabel(int)}, 5596b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * {@link KeyCharacterMap#getNumber(int)} or {@link KeyCharacterMap#get(int, int)}. 5609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 5616b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown @Deprecated 5626b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public boolean getKeyData(int keyCode, KeyData results) { 5636b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown if (results.meta.length < KeyData.META_LENGTH) { 5646b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown throw new IndexOutOfBoundsException( 5656b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown "results.meta.length must be >= " + KeyData.META_LENGTH); 5666b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown } 5676b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 5686b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown char displayLabel = nativeGetDisplayLabel(mPtr, keyCode); 5696b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown if (displayLabel == 0) { 5706b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown return false; 5719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5726b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 5736b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown results.displayLabel = displayLabel; 5746b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown results.number = nativeGetNumber(mPtr, keyCode); 5756b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown results.meta[0] = nativeGetCharacter(mPtr, keyCode, 0); 5766b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown results.meta[1] = nativeGetCharacter(mPtr, keyCode, KeyEvent.META_SHIFT_ON); 5776b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown results.meta[2] = nativeGetCharacter(mPtr, keyCode, KeyEvent.META_ALT_ON); 5786b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown results.meta[3] = nativeGetCharacter(mPtr, keyCode, 5796b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown KeyEvent.META_ALT_ON | KeyEvent.META_SHIFT_ON); 5806b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown return true; 5819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 5829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 5839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 5849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get an array of KeyEvent objects that if put into the input stream 5859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * could plausibly generate the provided sequence of characters. It is 5869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * not guaranteed that the sequence is the only way to generate these 5879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * events or that it is optimal. 5886b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 5896b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * This function is primarily offered for instrumentation and testing purposes. 5906b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * It may fail to map characters to key codes. In particular, the key character 5916b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * map for the {@link #BUILT_IN_KEYBOARD built-in keyboard} device id may be empty. 5926b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Consider using the key character map associated with the 5936b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * {@link #VIRTUAL_KEYBOARD virtual keyboard} device id instead. 5946b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p><p> 5956b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * For robust text entry, do not use this function. Instead construct a 5966b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * {@link KeyEvent} with action code {@link KeyEvent#ACTION_MULTIPLE} that contains 5976b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * the desired string using {@link KeyEvent#KeyEvent(long, String, int, int)}. 5986b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 5996b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 6006b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param chars The sequence of characters to generate. 6016b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return An array of {@link KeyEvent} objects, or null if the given char array 6029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can not be generated using the current key character map. 603f2c2ae09dac03f5c08e3a04bfab8ee75c1ce8ce9Kirill Grouchnikov * @throws {@link IllegalArgumentException} if the passed array of characters is null. 6049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6056b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public KeyEvent[] getEvents(char[] chars) { 6069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (chars == null) { 6076b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown throw new IllegalArgumentException("chars must not be null."); 6089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6099f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown return nativeGetEvents(mPtr, chars); 6109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6136b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Returns true if the specified key produces a glyph. 6146b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 6156b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param keyCode The key code. 6166b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return True if the key is a printing key. 6179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6186b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public boolean isPrintingKey(int keyCode) { 6196b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown int type = Character.getType(nativeGetDisplayLabel(mPtr, keyCode)); 6209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project switch (type) 6229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 6239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case Character.SPACE_SEPARATOR: 6249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case Character.LINE_SEPARATOR: 6259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case Character.PARAGRAPH_SEPARATOR: 6269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case Character.CONTROL: 6279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project case Character.FORMAT: 6289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return false; 6299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project default: 6309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 6319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6346b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 6356b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Gets the keyboard type. 6369df6e7a926ce480baf70e97ee1b9ea387193f6adJeff Brown * Returns {@link #NUMERIC}, {@link #PREDICTIVE}, {@link #ALPHA}, {@link #FULL} 6379df6e7a926ce480baf70e97ee1b9ea387193f6adJeff Brown * or {@link #SPECIAL_FUNCTION}. 6386b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 6396b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Different keyboard types have different semantics. Refer to the documentation 6406b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * associated with the keyboard type constants for details. 6416b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 6426b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 6436b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return The keyboard type. 6446b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 6456b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public int getKeyboardType() { 6466b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown return nativeGetKeyboardType(mPtr); 6479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6506b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Gets a constant that describes the behavior of this keyboard's modifier keys 6516b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * such as {@link KeyEvent#KEYCODE_SHIFT_LEFT}. 6526b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 6536b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Currently there are two behaviors that may be combined: 6546b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 6556b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <ul> 6566b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <li>Chorded behavior: When the modifier key is pressed together with one or more 6576b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * character keys, the keyboard inserts the modified keys and 6586b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * then resets the modifier state when the modifier key is released.</li> 6596b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <li>Toggled behavior: When the modifier key is pressed and released on its own 6606b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * it first toggles into a latched state. When latched, the modifier will apply 6616b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * to next character key that is pressed and will then reset itself to the initial state. 6626b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * If the modifier is already latched and the modifier key is pressed and release on 6636b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * its own again, then it toggles into a locked state. When locked, the modifier will 6646b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * apply to all subsequent character keys that are pressed until unlocked by pressing 6656b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * the modifier key on its own one more time to reset it to the initial state. 6666b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Toggled behavior is useful for small profile keyboards designed for thumb typing. 6676b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </ul> 6686b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * <p> 6696b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * This function currently returns {@link #MODIFIER_BEHAVIOR_CHORDED} when the 6706b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * {@link #getKeyboardType() keyboard type} is {@link #FULL} or {@link #SPECIAL_FUNCTION} and 6716b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * {@link #MODIFIER_BEHAVIOR_CHORDED_OR_TOGGLED} otherwise. 6726b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * In the future, the function may also take into account global keyboard 6736b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * accessibility settings, other user preferences, or new device capabilities. 6746b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * </p> 6756b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 6766b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return The modifier behavior for this keyboard. 6776b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 67854de77470de4f605eef7f4b4e01718b301fe275eElliot Waite * @see #MODIFIER_BEHAVIOR_CHORDED 67954de77470de4f605eef7f4b4e01718b301fe275eElliot Waite * @see #MODIFIER_BEHAVIOR_CHORDED_OR_TOGGLED 6809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6816b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown public int getModifierBehavior() { 6826b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown switch (getKeyboardType()) { 6836b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown case FULL: 6846b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown case SPECIAL_FUNCTION: 6856b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown return MODIFIER_BEHAVIOR_CHORDED; 6866b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown default: 6876b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown return MODIFIER_BEHAVIOR_CHORDED_OR_TOGGLED; 6886b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown } 6899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 6909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 6919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 6929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Queries the framework about whether any physical keys exist on the 6936b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * any keyboard attached to the device that are capable of producing the given key code. 6946b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 6956b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param keyCode The key code to query. 6966b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return True if at least one attached keyboard supports the specified key code. 6979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 6989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static boolean deviceHasKey(int keyCode) { 6999f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown return InputManager.getInstance().deviceHasKeys(new int[] { keyCode })[0]; 7009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7016b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown 7026b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 7036b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Queries the framework about whether any physical keys exist on the 7046b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * any keyboard attached to the device that are capable of producing the given 7056b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * array of key codes. 7066b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * 7076b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @param keyCodes The array of key codes to query. 7086b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * @return A new array of the same size as the key codes array whose elements 7096b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * are set to true if at least one attached keyboard supports the corresponding key code 7106b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * at the same index in the key codes array. 7116b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 7129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static boolean[] deviceHasKeys(int[] keyCodes) { 7139f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown return InputManager.getInstance().deviceHasKeys(keyCodes); 7149f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown } 7159f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown 7169f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown @Override 7179f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown public void writeToParcel(Parcel out, int flags) { 7189f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown if (out == null) { 7199f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown throw new IllegalArgumentException("parcel must not be null"); 7209f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown } 7219f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown nativeWriteToParcel(mPtr, out); 7229f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown } 7239f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown 7249f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown @Override 7259f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown public int describeContents() { 7269f25b7fdf216c9ef0bd2322cd223eeaf0d60f77fJeff Brown return 0; 7279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 7289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 7296b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown /** 7306b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown * Thrown by {@link KeyCharacterMap#load} when a key character map could not be loaded. 7316b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown */ 7327e1e21fdc5e8a9bb870b1f030658a67d2bf43207Jeff Brown public static class UnavailableException extends AndroidRuntimeException { 7337e1e21fdc5e8a9bb870b1f030658a67d2bf43207Jeff Brown public UnavailableException(String msg) { 7346b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown super(msg); 7356b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown } 7366b53e8daa69cba1a2a5a7c95a01e37ce9c53226cJeff Brown } 73749ed71db425c5054e3ad9526496a7e116c89556bJeff Brown 73849ed71db425c5054e3ad9526496a7e116c89556bJeff Brown /** 73949ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * Specifies a substitute key code and meta state as a fallback action 74049ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * for an unhandled key. 74149ed71db425c5054e3ad9526496a7e116c89556bJeff Brown * @hide 74249ed71db425c5054e3ad9526496a7e116c89556bJeff Brown */ 74349ed71db425c5054e3ad9526496a7e116c89556bJeff Brown public static final class FallbackAction { 744fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown private static final int MAX_RECYCLED = 10; 745fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown private static final Object sRecycleLock = new Object(); 746fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown private static FallbackAction sRecycleBin; 747fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown private static int sRecycledCount; 748fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown 749fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown private FallbackAction next; 750fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown 75149ed71db425c5054e3ad9526496a7e116c89556bJeff Brown public int keyCode; 75249ed71db425c5054e3ad9526496a7e116c89556bJeff Brown public int metaState; 753fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown 754fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown private FallbackAction() { 755fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown } 756fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown 757fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown public static FallbackAction obtain() { 758fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown final FallbackAction target; 759fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown synchronized (sRecycleLock) { 760fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown if (sRecycleBin == null) { 761fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown target = new FallbackAction(); 762fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown } else { 763fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown target = sRecycleBin; 764fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown sRecycleBin = target.next; 765fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown sRecycledCount--; 766fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown target.next = null; 767fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown } 768fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown } 769fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown return target; 770fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown } 771fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown 772fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown public void recycle() { 773fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown synchronized (sRecycleLock) { 774fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown if (sRecycledCount < MAX_RECYCLED) { 775fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown next = sRecycleBin; 776fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown sRecycleBin = this; 777fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown sRecycledCount += 1; 778fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown } else { 779fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown next = null; 780fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown } 781fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown } 782fd23e3ed976b22b9a92ddb2cb3a46f9d2a0ce23fJeff Brown } 78349ed71db425c5054e3ad9526496a7e116c89556bJeff Brown } 7849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 785