com.smartgwt.client.widgets.form.fields.events
Class KeyPressEvent

java.lang.Object
  extended by com.google.gwt.event.shared.GwtEvent<H>
      extended by com.smartgwt.client.event.AbstractSmartEvent<KeyPressHandler>
          extended by com.smartgwt.client.widgets.form.fields.events.KeyPressEvent
All Implemented Interfaces:
Cancellable

public class KeyPressEvent
extends AbstractSmartEvent<KeyPressHandler>
implements Cancellable


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent
GwtEvent.Type<H>
 
Field Summary
 
Fields inherited from class com.smartgwt.client.event.AbstractSmartEvent
jsObj
 
Constructor Summary
KeyPressEvent(JavaScriptObject jsObj)
           
 
Method Summary
 void cancel()
          return false to attempt to cancel the event.
protected  void dispatch(KeyPressHandler handler)
          Should only be called by HandlerManager.
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.
 GwtEvent.Type<KeyPressHandler> getAssociatedType()
          Returns the type used to register this event.
 Integer getCharacterValue()
          If this was a character key, this is the numeric value for the character
 DynamicForm getForm()
          Pointer to the item's form
 FormItem getItem()
          Item over which the keypress occurred
 String getKeyName()
          Name of the key pressed (Example: "A", "Enter")
static GwtEvent.Type<KeyPressHandler> getType()
          Gets the type associated with this event.
 boolean isCancelled()
           
 
Methods inherited from class com.google.gwt.event.shared.GwtEvent
assertLive, getSource, isLive, kill, revive, toDebugString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

KeyPressEvent

public KeyPressEvent(JavaScriptObject jsObj)
Method Detail

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 handlers
jsObj - the native event

getType

public static GwtEvent.Type<KeyPressHandler> getType()
Gets the type associated with this event.

Returns:
returns the handler type

dispatch

protected void dispatch(KeyPressHandler handler)
Description copied from class: GwtEvent
Should only be called by HandlerManager. In other words, do not use or call.

Specified by:
dispatch in class GwtEvent<KeyPressHandler>
Parameters:
handler - handler

getAssociatedType

public final GwtEvent.Type<KeyPressHandler> getAssociatedType()
Description copied from class: GwtEvent
Returns the type used to register this event. Used by handler manager to dispatch events to the correct handlers.

Specified by:
getAssociatedType in class GwtEvent<KeyPressHandler>
Returns:
the type

cancel

public void cancel()
return false to attempt to cancel the event. Note for general purpose APIs for managing whether user input is allowed, use FormItem.addChangeHandler(com.smartgwt.client.widgets.form.fields.events.ChangeHandler) or FormItem.setInputTransformer(com.smartgwt.client.widgets.form.FormItemInputTransformer) instead.

Specified by:
cancel in interface Cancellable

isCancelled

public boolean isCancelled()
Specified by:
isCancelled in interface Cancellable
Returns:
true if cancelled

getItem

public FormItem getItem()
Item over which the keypress occurred

Returns:
Item over which the keypress occurred

getForm

public DynamicForm getForm()
Pointer to the item's form

Returns:
Pointer to the item's form

getKeyName

public String getKeyName()
Name of the key pressed (Example: "A", "Enter")

Returns:
Name of the key pressed (Example: "A", "Enter")

getCharacterValue

public Integer 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