|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
|
+--net.rim.device.api.system.EventInjector.Event
|
+--net.rim.device.api.system.EventInjector.KeyCodeEvent
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.
EventInjector,
EventInjector.Event,
EventInjector.TrackwheelEvent,
EventInjector.KeyEvent,
EventInjector.NavigationEvent| Field Summary | ||
|
static int |
KEY_DOWN
Represents a constant indicating that the key is in the down position. |
|
static int |
KEY_REPEAT
Represents a constant indicating that the key is in the down position, repeating the character. |
|
static int |
KEY_UP
Represents a constant indicating that the key is in the up position. |
| Constructor Summary | ||
|
EventInjector.KeyCodeEvent(int event,
char keyName,
int status)
Constructs a new KeyCodeEvent instance whose time is set to the current device uptime. |
|
|
EventInjector.KeyCodeEvent(int event,
char keyName,
int status,
int time)
Deprecated. Use KeyCodeEvent(int, char, int) instead. |
|
| Method Summary | ||
|
int |
getKeyCode()
Gets the keycode injected by this event |
|
int |
getStatus()
Returns the status. |
|
int |
getTime()
Returns the time of the event. |
|
void |
setKeyCode(char keyName,
int status)
Set the keycode injected by this event. |
|
void |
setStatus(int status)
Sets the status of a key. |
|
void |
setTime(int time)
Deprecated. Use EventInjector.Event.setTimeToCurrent() instead. |
| Methods inherited from class net.rim.device.api.system.EventInjector.Event |
getEvent, post, setEvent, setTimeToCurrent |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final int KEY_DOWN
public static final int KEY_REPEAT
public static final int KEY_UP
| Constructor Detail |
public EventInjector.KeyCodeEvent(int event,
char keyName,
int status)
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 defined 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 except STATUS_TRACKWHEEL and STATUS_FOUR_WAY (as defined by KeypadListener).IllegalArgumentException - if status is invalid
public EventInjector.KeyCodeEvent(int event,
char keyName,
int status,
int time)
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 defined 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 except STATUS_TRACKWHEEL and STATUS_FOUR_WAY (as defined by KeypadListener).time - No longer used. Time is set to the current device uptime.IllegalArgumentException - if status is invalid| Method Detail |
public int getKeyCode()
public int getStatus()
getStatus in class EventInjector.Eventpublic int getTime()
EventInjector.EventgetTime in class EventInjector.Event
public void setKeyCode(char keyName,
int status)
Characters), then Status is reset.keyName - The name of the key pressed (see constructor for notes).status - Status of the key. See constructor for valid statuses.IllegalArgumentException - If status is invalid.public void setStatus(int status)
setStatus in class EventInjector.Eventstatus - An integer representing the status of the key. See constructor for valid statuses.IllegalArgumentException - If status is invalid.public void setTime(int time)
EventInjector.Event.setTimeToCurrent() instead.
time - No longer used. Time is set to the current device uptime.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2008 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.