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

java.lang.Object
  extended by com.google.web.bindery.event.shared.Event<H>
      extended by com.google.gwt.event.shared.GwtEvent<H>
          extended by com.smartgwt.client.event.AbstractSmartEvent<KeyDownHandler>
              extended by com.smartgwt.client.widgets.form.fields.events.KeyDownEvent
All Implemented Interfaces:
Cancellable

public class KeyDownEvent
extends AbstractSmartEvent<KeyDownHandler>
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
KeyDownEvent(JavaScriptObject jsObj)
           
 
Method Summary
 void cancel()
          Call this method to attempt to cancel the event.
protected  void dispatch(KeyDownHandler handler)
           
static
<S extends HasKeyDownHandlers & 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<KeyDownHandler> getAssociatedType()
           
 DynamicForm getForm()
          Pointer to the item's form
 FormItem getItem()
          Item over which the keydown occurred
 String getKeyName()
          Name of the key pressed (Example: "A", "Enter")
static GwtEvent.Type<KeyDownHandler> 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
 
Methods inherited from class com.google.web.bindery.event.shared.Event
setSource, toDebugString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

KeyDownEvent

public KeyDownEvent(JavaScriptObject jsObj)
Method Detail

fire

public static <S extends HasKeyDownHandlers & 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<KeyDownHandler> getType()
Gets the type associated with this event.

Returns:
returns the handler type

dispatch

protected void dispatch(KeyDownHandler handler)
Specified by:
dispatch in class GwtEvent<KeyDownHandler>

getAssociatedType

public final GwtEvent.Type<KeyDownHandler> getAssociatedType()
Overrides:
getAssociatedType in class GwtEvent<KeyDownHandler>

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, use FormItem.change or FormItem.transformInput 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 keydown occurred

Returns:
Item over which the keydown 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")