SHOW Signed

net.rim.device.api.system
Class EventInjector.KeyCodeEvent

java.lang.Object
  |
  +--net.rim.device.api.system.EventInjector.Event
        |
        +--net.rim.device.api.system.EventInjector.KeyCodeEvent
Enclosing class:
EventInjector

public static class EventInjector.KeyCodeEvent
extends EventInjector.Event

The event class that defines a physical key press event.

Use this class to create events that mimic an actual key being pressed on the device. This class may come in handy when the actual key pressed (and not the character that may result from the key being pressed) is important (i.e. injecting keyboard shortcuts, etc.).

It is recommended to inject a KEY_DOWN event followed by a KEY_UP event on the same key to more accurately emulate keyboard use, although this may not always be necessary.

This is a more powerful event class than KeyEvent, but more difficult to use because application behaviour depends on the context when the key is invoked. For example, if you inject the 'X' key on a device with a QWERTY keyboard in the phone application, the number 8 will be dialed. If you inject in a compose screen, the letter "x" will be output on the screen.

To inject actual characters (for typing, etc.), use EventInjector.KeyEvent.

Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:
JDE 4.2.0
See Also:
EventInjector, EventInjector.Event, EventInjector.TrackwheelEvent, EventInjector.KeyEvent

Field Summary
 Category: Signed static int KEY_DOWN
          Represents a constant indicating that the key is in the down position.
 Category: Signed static int KEY_REPEAT
          Represents a constant indicating that the key is in the down position, repeating the character.
 Category: Signed static int KEY_UP
          Represents a constant indicating that the key is in the up position.
   
Constructor Summary
 Category: Signed EventInjector.KeyCodeEvent(int event, char keyName, int status, int time)
          Constructs a new KeyCodeEvent instance.
 
Method Summary
 Category: Signed  int getKeyCode()
          Gets the keycode injected by this event
 Category: Signed  int getTime()
          Gets the time for the event
 Category: Signed  void setKeyCode(char keyName, int status)
          Set the keycode injected by this event
 Category: Signed  void setTime(int time)
          Sets the time for the event
 
Methods inherited from class net.rim.device.api.system.EventInjector.Event
getEvent, getStatus, post, setEvent, setStatus
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KEY_DOWN

public static final int KEY_DOWN
Represents a constant indicating that the key is in the down position.
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

KEY_REPEAT

public static final int KEY_REPEAT
Represents a constant indicating that the key is in the down position, repeating the character.
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

KEY_UP

public static final int KEY_UP
Represents a constant indicating that the key is in the up position.
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Constructor Detail

EventInjector.KeyCodeEvent

public EventInjector.KeyCodeEvent(int event,
                                  char keyName,
                                  int status,
                                  int time)
Constructs a new KeyCodeEvent instance.
Parameters:
event - One of KEY_DOWN, KEY_REPEAT or KEY_UP.
keyName - The name of the key pressed. Keys are named as follows:

On a QWERTY keyboard, the name of the key is the Latin alphabetic character that appears on it (Q, W, E, etc.) or one of the KEY constants definded in Keypad cast to a char.

On a reduced QWERTY keyboard, the name of the key is the leftmost Latin alphabetic character that appears on it (Q, E, T, etc.) or one of the KEY constants definded in Keypad cast to a char.

status - Any status flags (as defined by KeypadListener).
time - The time the key is held, in milliseconds.
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.
Method Detail

getKeyCode

public int getKeyCode()
Gets the keycode injected by this event
Returns:
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getTime

public int getTime()
Gets the time for the event
Returns:
The time of the event
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setKeyCode

public void setKeyCode(char keyName,
                       int status)
Set the keycode injected by this event
Parameters:
keyName - The name of the key pressed (see constructor for notes).
status - Status of the key.
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

setTime

public void setTime(int time)
Sets the time for the event
Parameters:
time - Integer representation of the time
Since:
JDE 4.2.0
Category:
Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.


Copyright 1999-2007 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.