public class KeyPressEvent extends BrowserEvent<KeyPressHandler> implements Cancellable
GwtEvent.Type<H>jsObj| Constructor and Description |
|---|
KeyPressEvent(JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
void |
cancel()
Call this method to suppress native behavior in response to the keyPress, and prevent this event from bubbling to
this widget's parent, or true or undefined to bubble.
|
protected void |
dispatch(KeyPressHandler handler) |
static <S extends HasKeyPressHandlers & HasHandlers> |
fire(S source,
JavaScriptObject jsObj)
Fires a open event on all registered handlers in the handler manager.If no
such handlers exist, this method will do nothing.
|
GwtEvent.Type<KeyPressHandler> |
getAssociatedType() |
java.lang.String |
getKeyName()
Return the name of the key for the event passed in.
|
static GwtEvent.Type<KeyPressHandler> |
getType()
Gets the type associated with this event.
|
boolean |
isCancelled() |
getX, getY, isAltKeyDown, isCtrlKeyDown, isLeftButtonDown, isRightButtonDownassertLive, getSource, isLive, kill, revivesetSource, toDebugString, toStringpublic KeyPressEvent(JavaScriptObject jsObj)
public static <S extends HasKeyPressHandlers & HasHandlers> void fire(S source, JavaScriptObject jsObj)
S - The event sourcesource - the source of the handlersjsObj - the native eventpublic static GwtEvent.Type<KeyPressHandler> getType()
protected void dispatch(KeyPressHandler handler)
dispatch in class GwtEvent<KeyPressHandler>public final GwtEvent.Type<KeyPressHandler> getAssociatedType()
getAssociatedType in class GwtEvent<KeyPressHandler>public void cancel()
cancel in interface Cancellablepublic boolean isCancelled()
isCancelled in interface Cancellablepublic java.lang.String getKeyName()
Strings to identify the various keys on the keyboard.
For alpha keys, the single (uppercase) character value is used, such as "Q"
For Numeric keys, the number is used as in a single character string, like "1"
Function keys are identified as "f1" - "f12"
Non alpha-numeric character keys (such as the key for "[" / "{") are identified by their unmodified character value (the value obtained by hitting the key without holding shift down), by default - exceptions are listed below.
Additional key names:
- Space
- Tab
- Enter
- Escape
- Backspace
- Insert
- Delete
- Arrow_Up
- Arrow_Down
- Arrow_Left
- Arrow_Right
- Home
- End
- Page_Up
- Page_Down
- Shift
- Ctrl
- Alt
[Note: Some keys may not be available for capture on every platform]
KeyNames