Class KeyPressEvent
java.lang.Object
com.google.web.bindery.event.shared.Event<H>
com.google.gwt.event.shared.GwtEvent<H>
com.smartgwt.client.event.AbstractSmartEvent<KeyPressHandler>
com.smartgwt.client.widgets.form.fields.events.KeyPressEvent
- All Implemented Interfaces:
Cancellable
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent
GwtEvent.Type<H extends Object> -
Field Summary
Fields inherited from class com.smartgwt.client.event.AbstractSmartEvent
jsObj -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcancel()Call this method to attempt to cancel the event.protected voiddispatch(KeyPressHandler handler) static <S extends HasKeyPressHandlers & HasHandlers>
voidfire(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.final GwtEvent.Type<KeyPressHandler>If this was a character key, this is the numeric value for the characterReturns theFormItemfiring the event.getForm()Pointer to the item's formgetItem()Item over which the keypress occurredName of the key pressed (Example:"A","Enter")static GwtEvent.Type<KeyPressHandler>getType()Gets the type associated with this event.final booleanHelper method pointing toEventHandler.altKeyDown()booleanfinal booleanHelper method pointing toEventHandler.ctrlKeyDown()final booleanHelper method pointing toEventHandler.shiftKeyDown()Methods inherited from class com.smartgwt.client.event.AbstractSmartEvent
getFiringInstanceAsJavaScriptObjectMethods inherited from class com.google.gwt.event.shared.GwtEvent
assertLive, getSource, isLive, kill, reviveMethods inherited from class com.google.web.bindery.event.shared.Event
setSource, toDebugString, toString
-
Constructor Details
-
KeyPressEvent
-
-
Method Details
-
getFiringItem
Returns theFormItemfiring the event.- Returns:
- FormItem firing the event
-
fire
public static <S extends HasKeyPressHandlers & HasHandlers> void 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.- Type Parameters:
S- The event source- Parameters:
source- the source of the handlersjsObj- the native event
-
getType
Gets the type associated with this event.- Returns:
- returns the handler type
-
dispatch
- Specified by:
dispatchin classGwtEvent<KeyPressHandler>
-
getAssociatedType
- Specified by:
getAssociatedTypein classGwtEvent<KeyPressHandler>
-
cancel
public void cancel()Call this method to attempt to cancel the event. Note for general purpose APIs for managing whether user input is allowed, useFormItem.change()orFormItem.transformInput()instead.- Specified by:
cancelin interfaceCancellable
-
isCancelled
public boolean isCancelled()- Specified by:
isCancelledin interfaceCancellable- Returns:
- true if cancelled
-
getItem
Item over which the keypress occurred- Returns:
- Item over which the keypress occurred
-
getForm
Pointer to the item's form- Returns:
- Pointer to the item's form
-
getKeyName
Name of the key pressed (Example:"A","Enter")- Returns:
- Name of the key pressed (Example:
"A","Enter")
-
getCharacterValue
If this was a character key, this is the numeric value for the character- Returns:
- If this was a character key, this is the numeric value for the character. Note that non-character keys like shift, alt, backspace return null
-
isAltKeyDown
public final boolean isAltKeyDown()Helper method pointing toEventHandler.altKeyDown()- Returns:
- true if the alt key is being held down.
-
isCtrlKeyDown
public final boolean isCtrlKeyDown()Helper method pointing toEventHandler.ctrlKeyDown()- Returns:
- true if the control key is being held down.
-
isShiftKeyDown
public final boolean isShiftKeyDown()Helper method pointing toEventHandler.shiftKeyDown()- Returns:
- true if the shift key is being held down.
-