IT. Expert System.

Android Reference

KeyCharacterMap

android.view

Class KeyCharacterMap

java.lang.Object
- android.view.KeyCharacterMap

All Implemented Interfaces:

Parcelable
```
public class KeyCharacterMap
extends Object
implements Parcelable
```
Describes the keys provided by a keyboard device and their associated labels.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`KeyCharacterMap.FallbackAction` Specifies a substitute key code and meta state as a fallback action for an unhandled key.
`static class`	`KeyCharacterMap.KeyData` Deprecated. instead use `getDisplayLabel(int)`, `getNumber(int)` and `get(int, int)`.
`static class`	`KeyCharacterMap.UnavailableException` Thrown by `load(int)` when a key character map could not be loaded.

Nested classes/interfaces inherited from interface android.os.Parcelable
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALPHA` A keyboard with all the letters, and maybe some numbers.
`static int`	`BUILT_IN_KEYBOARD` Deprecated. This constant should no longer be used because there is no guarantee that a device has a built-in keyboard that can be used for typing text. There might not be a built-in keyboard, the built-in keyboard might be a `NUMERIC` or `SPECIAL_FUNCTION` keyboard, or there might be multiple keyboards installed including external keyboards. When interpreting key presses received from the framework, applications should use the device id specified in the `KeyEvent` received. When synthesizing key presses for delivery elsewhere or when translating key presses from unknown keyboards, applications should use the special `VIRTUAL_KEYBOARD` device id.
`static int`	`COMBINING_ACCENT`
`static int`	`COMBINING_ACCENT_MASK` Mask the return value from `get(int, int)` with this value to get a printable representation of the accent character of a "dead key."
`static Parcelable.Creator<KeyCharacterMap>`	`CREATOR`
`static int`	`FULL` A full PC-style keyboard.
`static char`	`HEX_INPUT` This private-use character is used to trigger Unicode character input by hex digits.
`static int`	`MODIFIER_BEHAVIOR_CHORDED` Modifier keys may be chorded with character keys.
`static int`	`MODIFIER_BEHAVIOR_CHORDED_OR_TOGGLED` Modifier keys may be chorded with character keys or they may toggle into latched or locked states when pressed independently.
`static int`	`NUMERIC` A numeric (12-key) keyboard.
`static char`	`PICKER_DIALOG_INPUT` This private-use character is used to bring up a character picker for miscellaneous symbols.
`static int`	`PREDICTIVE` A keyboard with all the letters, but with more than one letter per key.
`static int`	`SPECIAL_FUNCTION` A keyboard that is only used to control special functions rather than for typing.
`static int`	`VIRTUAL_KEYBOARD` The id of a generic virtual keyboard with a full layout that can be used to synthesize key events.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable's marshalled representation.
`static boolean`	`deviceHasKey(int keyCode)` Queries the framework about whether any physical keys exist on the any keyboard attached to the device that are capable of producing the given key code.
`static boolean[]`	`deviceHasKeys(int[] keyCodes)` Queries the framework about whether any physical keys exist on the any keyboard attached to the device that are capable of producing the given array of key codes.
`protected void`	`finalize()` Invoked when the garbage collector has detected that this instance is no longer reachable.
`int`	`get(int keyCode, int metaState)` Gets the Unicode character generated by the specified key and meta key state combination.
`static int`	`getDeadChar(int accent, int c)` Get the character that is produced by putting accent on the character c.
`char`	`getDisplayLabel(int keyCode)` Gets the primary character for this key.
`KeyEvent[]`	`getEvents(char[] chars)` Get an array of KeyEvent objects that if put into the input stream could plausibly generate the provided sequence of characters.
`KeyCharacterMap.FallbackAction`	`getFallbackAction(int keyCode, int metaState)` Gets the fallback action to perform if the application does not handle the specified key.
`int`	`getKeyboardType()` Gets the keyboard type.
`boolean`	`getKeyData(int keyCode, KeyCharacterMap.KeyData results)` Deprecated. instead use `getDisplayLabel(int)`, `getNumber(int)` or `get(int, int)`.
`char`	`getMatch(int keyCode, char[] chars)` Gets the first character in the character array that can be generated by the specified key code.
`char`	`getMatch(int keyCode, char[] chars, int metaState)` Gets the first character in the character array that can be generated by the specified key code.
`int`	`getModifierBehavior()` Gets a constant that describes the behavior of this keyboard's modifier keys such as `KeyEvent.KEYCODE_SHIFT_LEFT`.
`char`	`getNumber(int keyCode)` Gets the number or symbol associated with the key.
`boolean`	`isPrintingKey(int keyCode)` Returns true if the specified key produces a glyph.
`static KeyCharacterMap`	`load(int deviceId)` Loads the key character maps for the keyboard with the specified device id.
`void`	`writeToParcel(Parcel out, int flags)` Flatten this object in to a Parcel.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BUILT_IN_KEYBOARD
```
@Deprecated
public static final int BUILT_IN_KEYBOARD
```
    Deprecated. This constant should no longer be used because there is no guarantee that a device has a built-in keyboard that can be used for typing text. There might not be a built-in keyboard, the built-in keyboard might be a NUMERIC or SPECIAL_FUNCTION keyboard, or there might be multiple keyboards installed including external keyboards. When interpreting key presses received from the framework, applications should use the device id specified in the KeyEvent received. When synthesizing key presses for delivery elsewhere or when translating key presses from unknown keyboards, applications should use the special VIRTUAL_KEYBOARD device id.
    
    The id of the device's primary built in keyboard is always 0.
    
    See Also:
    Constant Field Values
  - VIRTUAL_KEYBOARD
```
public static final int VIRTUAL_KEYBOARD
```
    The id of a generic virtual keyboard with a full layout that can be used to synthesize key events. Typically used with getEvents(char[]).
    
    See Also:
    Constant Field Values
  - NUMERIC
```
public static final int NUMERIC
```
    A numeric (12-key) keyboard.
    A numeric keyboard supports text entry using a multi-tap approach. It may be necessary to tap a key multiple times to generate the desired letter or symbol.
    This type of keyboard is generally designed for thumb typing.
    
    See Also:
    Constant Field Values
  - PREDICTIVE
```
public static final int PREDICTIVE
```
    A keyboard with all the letters, but with more than one letter per key.
    This type of keyboard is generally designed for thumb typing.
    
    See Also:
    Constant Field Values
  - ALPHA
```
public static final int ALPHA
```
    A keyboard with all the letters, and maybe some numbers.
    An alphabetic keyboard supports text entry directly but may have a condensed layout with a small form factor. In contrast to a full keyboard, some symbols may only be accessible using special on-screen character pickers. In addition, to improve typing speed and accuracy, the framework provides special affordances for alphabetic keyboards such as auto-capitalization and toggled / locked shift and alt keys.
    This type of keyboard is generally designed for thumb typing.
    
    See Also:
    Constant Field Values
  - FULL
```
public static final int FULL
```
    A full PC-style keyboard.
    A full keyboard behaves like a PC keyboard. All symbols are accessed directly by pressing keys on the keyboard without on-screen support or affordances such as auto-capitalization.
    This type of keyboard is generally designed for full two hand typing.
    
    See Also:
    Constant Field Values
  - SPECIAL_FUNCTION
```
public static final int SPECIAL_FUNCTION
```
    A keyboard that is only used to control special functions rather than for typing.
    A special function keyboard consists only of non-printing keys such as HOME and POWER that are not actually used for typing.
    
    See Also:
    Constant Field Values
  - HEX_INPUT
```
public static final char HEX_INPUT
```
    This private-use character is used to trigger Unicode character input by hex digits.
    
    See Also:
    Constant Field Values
  - PICKER_DIALOG_INPUT
```
public static final char PICKER_DIALOG_INPUT
```
    This private-use character is used to bring up a character picker for miscellaneous symbols.
    
    See Also:
    Constant Field Values
  - MODIFIER_BEHAVIOR_CHORDED
```
public static final int MODIFIER_BEHAVIOR_CHORDED
```
    Modifier keys may be chorded with character keys.
    
    See Also:
    #getModifierBehavior()} for more details., Constant Field Values
  - MODIFIER_BEHAVIOR_CHORDED_OR_TOGGLED
```
public static final int MODIFIER_BEHAVIOR_CHORDED_OR_TOGGLED
```
    Modifier keys may be chorded with character keys or they may toggle into latched or locked states when pressed independently.
    
    See Also:
    #getModifierBehavior()} for more details., Constant Field Values
  - COMBINING_ACCENT
```
public static final int COMBINING_ACCENT
```
    See Also:
    Constant Field Values
  - COMBINING_ACCENT_MASK
```
public static final int COMBINING_ACCENT_MASK
```
    Mask the return value from get(int, int) with this value to get a printable representation of the accent character of a "dead key."
    
    See Also:
    Constant Field Values
  - CREATOR
```
public static final Parcelable.Creator<KeyCharacterMap> CREATOR
```
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: Object
    
    Invoked when the garbage collector has detected that this instance is no longer reachable. The default implementation does nothing, but this method can be overridden to free resources.
    Note that objects that override finalize are significantly more expensive than objects that don't. Finalizers may be run a long time after the object is no longer reachable, depending on memory pressure, so it's a bad idea to rely on them for cleanup. Note also that finalizers are run on a single VM-wide finalizer thread, so doing blocking work in a finalizer is a bad idea. A finalizer is usually only necessary for a class that has a native peer and needs to call a native method to destroy that peer. Even then, it's better to provide an explicit close method (and implement Closeable), and insist that callers manually dispose of instances. This works well for something like files, but less well for something like a BigInteger where typical calling code would have to deal with lots of temporaries. Unfortunately, code that creates lots of temporaries is the worst kind of code from the point of view of the single finalizer thread.
    If you must use finalizers, consider at least providing your own ReferenceQueue and having your own thread process that queue.
    Unlike constructors, finalizers are not automatically chained. You are responsible for calling super.finalize() yourself.
    Uncaught exceptions thrown by finalizers are ignored and do not terminate the finalizer thread. See Effective Java Item 7, "Avoid finalizers" for more.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - load
```
public static KeyCharacterMap load(int deviceId)
```
    Loads the key character maps for the keyboard with the specified device id.
    
    Parameters:
    deviceId - The device id of the keyboard.
    
    Returns:
    The associated key character map.
    
    Throws:
    
    {@link - UnavailableException} if the key character map could not be loaded because it was malformed or the default key character map is missing from the system.
  - get
```
public int get(int keyCode,
      int metaState)
```
    Gets the Unicode character generated by the specified key and meta key state combination.
    Returns the Unicode character that the specified key would produce when the specified meta bits (see MetaKeyKeyListener) were active.
    Returns 0 if the key is not one that is used to type Unicode characters.
    If the return value has bit COMBINING_ACCENT set, the key is a "dead key" that should be combined with another to actually produce a character -- see getDeadChar(int, int) -- after masking with COMBINING_ACCENT_MASK.
    
    Parameters:
    keyCode - The key code.
    metaState - The meta key modifier state.
    
    Returns:
    The associated character or combining accent, or 0 if none.
  - getFallbackAction
```
public KeyCharacterMap.FallbackAction getFallbackAction(int keyCode,
                                               int metaState)
```
    Gets the fallback action to perform if the application does not handle the specified key.
    When an application does not handle a particular key, the system may translate the key to an alternate fallback key (specified in the fallback action) and dispatch it to the application. The event containing the fallback key is flagged with KeyEvent.FLAG_FALLBACK.
    
    Parameters:
    keyCode - The key code.
    metaState - The meta key modifier state.
    
    Returns:
    The fallback action, or null if none. Remember to recycle the fallback action.
  - getNumber
```
public char getNumber(int keyCode)
```
    Gets the number or symbol associated with the key.
    The character value is returned, not the numeric value. If the key is not a number, but is a symbol, the symbol is retuned.
    This method is intended to to support dial pads and other numeric or symbolic entry on keyboards where certain keys serve dual function as alphabetic and symbolic keys. This method returns the number or symbol associated with the key independent of whether the user has pressed the required modifier.
    For example, on one particular keyboard the keys on the top QWERTY row generate numbers when ALT is pressed such that ALT-Q maps to '1'. So for that keyboard when getNumber(int) is called with KeyEvent.KEYCODE_Q it returns '1' so that the user can type numbers without pressing ALT when it makes sense.
    
    Parameters:
    keyCode - The key code.
    
    Returns:
    The associated numeric or symbolic character, or 0 if none.
  - getMatch
```
public char getMatch(int keyCode,
            char[] chars)
```
    Gets the first character in the character array that can be generated by the specified key code.
    This is a convenience function that returns the same value as getMatch(keyCode, chars, 0).
    
    Parameters:
    keyCode - The keycode.
    chars - The array of matching characters to consider.
    
    Returns:
    The matching associated character, or 0 if none.
  - getMatch
```
public char getMatch(int keyCode,
            char[] chars,
            int metaState)
```
    Gets the first character in the character array that can be generated by the specified key code. If there are multiple choices, prefers the one that would be generated with the specified meta key modifier state.
    
    Parameters:
    keyCode - The key code.
    chars - The array of matching characters to consider.
    metaState - The preferred meta key modifier state.
    
    Returns:
    The matching associated character, or 0 if none.
  - getDisplayLabel
```
public char getDisplayLabel(int keyCode)
```
    Gets the primary character for this key. In other words, the label that is physically printed on it.
    
    Parameters:
    keyCode - The key code.
    
    Returns:
    The display label character, or 0 if none (eg. for non-printing keys).
  - getDeadChar
```
public static int getDeadChar(int accent,
              int c)
```
    Get the character that is produced by putting accent on the character c. For example, getDeadChar('`', 'e') returns è.
    
    Parameters:
    accent - The accent character. eg. '`'
    c - The basic character.
    
    Returns:
    The combined character, or 0 if the characters cannot be combined.
  - getKeyData
```
@Deprecated
public boolean getKeyData(int keyCode,
                            KeyCharacterMap.KeyData results)
```
    Deprecated. instead use getDisplayLabel(int), getNumber(int) or get(int, int).
    
    Get the character conversion data for a given key code.
    
    Parameters:
    keyCode - The keyCode to query.
    results - A KeyCharacterMap.KeyData instance that will be filled with the results.
    
    Returns:
    True if the key was mapped. If the key was not mapped, results is not modified.
  - getEvents
```
public KeyEvent[] getEvents(char[] chars)
```
    Get an array of KeyEvent objects that if put into the input stream could plausibly generate the provided sequence of characters. It is not guaranteed that the sequence is the only way to generate these events or that it is optimal.
    This function is primarily offered for instrumentation and testing purposes. It may fail to map characters to key codes. In particular, the key character map for the built-in keyboard device id may be empty. Consider using the key character map associated with the virtual keyboard device id instead.
    For robust text entry, do not use this function. Instead construct a KeyEvent with action code KeyEvent.ACTION_MULTIPLE that contains the desired string using KeyEvent.KeyEvent(long, String, int, int).
    
    Parameters:
    chars - The sequence of characters to generate.
    
    Returns:
    An array of KeyEvent objects, or null if the given char array can not be generated using the current key character map.
  - isPrintingKey
```
public boolean isPrintingKey(int keyCode)
```
    Returns true if the specified key produces a glyph.
    
    Parameters:
    keyCode - The key code.
    
    Returns:
    True if the key is a printing key.
  - getKeyboardType
```
public int getKeyboardType()
```
    Gets the keyboard type. Returns NUMERIC, PREDICTIVE, ALPHA, FULL or SPECIAL_FUNCTION.
    Different keyboard types have different semantics. Refer to the documentation associated with the keyboard type constants for details.
    
    Returns:
    The keyboard type.
  - getModifierBehavior
```
public int getModifierBehavior()
```
    Gets a constant that describes the behavior of this keyboard's modifier keys such as KeyEvent.KEYCODE_SHIFT_LEFT.
    Currently there are two behaviors that may be combined:
    - Chorded behavior: When the modifier key is pressed together with one or more character keys, the keyboard inserts the modified keys and then resets the modifier state when the modifier key is released.
    - Toggled behavior: When the modifier key is pressed and released on its own it first toggles into a latched state. When latched, the modifier will apply to next character key that is pressed and will then reset itself to the initial state. If the modifier is already latched and the modifier key is pressed and release on its own again, then it toggles into a locked state. When locked, the modifier will apply to all subsequent character keys that are pressed until unlocked by pressing the modifier key on its own one more time to reset it to the initial state. Toggled behavior is useful for small profile keyboards designed for thumb typing.
    This function currently returns MODIFIER_BEHAVIOR_CHORDED when the keyboard type is FULL or SPECIAL_FUNCTION and MODIFIER_BEHAVIOR_CHORDED_OR_TOGGLED otherwise. In the future, the function may also take into account global keyboard accessibility settings, other user preferences, or new device capabilities.
    Returns:
    The modifier behavior for this keyboard.
    See Also:
    #MODIFIER_BEHAVIOR_CHORDED}, #MODIFIER_BEHAVIOR_CHORDED_OR_TOGGLED}
  - deviceHasKey
```
public static boolean deviceHasKey(int keyCode)
```
    Queries the framework about whether any physical keys exist on the any keyboard attached to the device that are capable of producing the given key code.
    
    Parameters:
    keyCode - The key code to query.
    
    Returns:
    True if at least one attached keyboard supports the specified key code.
  - deviceHasKeys
```
public static boolean[] deviceHasKeys(int[] keyCodes)
```
    Queries the framework about whether any physical keys exist on the any keyboard attached to the device that are capable of producing the given array of key codes.
    
    Parameters:
    keyCodes - The array of key codes to query.
    
    Returns:
    A new array of the same size as the key codes array whose elements are set to true if at least one attached keyboard supports the corresponding key code at the same index in the key codes array.
  - writeToParcel
```
public void writeToParcel(Parcel out,
                 int flags)
```
    Description copied from interface: Parcelable
    
    Flatten this object in to a Parcel.
    
    Specified by:
    
    writeToParcel in interface Parcelable
    
    Parameters:
    out - The Parcel in which the object should be written.
    flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
  - describeContents
```
public int describeContents()
```
    Description copied from interface: Parcelable
    
    Describe the kinds of special objects contained in this Parcelable's marshalled representation.
    
    Specified by:
    
    describeContents in interface Parcelable
    
    Returns:
    a bitmask indicating the set of special object types marshalled by the Parcelable.

Content

Android Reference

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.

All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.

IT. Expert System.

Android Reference

KeyCharacterMap

Class KeyCharacterMap

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BUILT_IN_KEYBOARD

VIRTUAL_KEYBOARD

NUMERIC

PREDICTIVE

ALPHA

FULL

SPECIAL_FUNCTION

HEX_INPUT

PICKER_DIALOG_INPUT

MODIFIER_BEHAVIOR_CHORDED

MODIFIER_BEHAVIOR_CHORDED_OR_TOGGLED

COMBINING_ACCENT

COMBINING_ACCENT_MASK

CREATOR

Method Detail

finalize

load

get

getFallbackAction

getNumber

getMatch

getMatch

getDisplayLabel

getDeadChar

getKeyData

getEvents

isPrintingKey

getKeyboardType

getModifierBehavior

deviceHasKey

deviceHasKeys

writeToParcel

describeContents

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary