Package com.smartgwt.client.widgets.form.events

Class ItemKeyPressEvent

java.lang.Object

com.google.web.bindery.event.shared.Event<H>

com.google.gwt.event.shared.GwtEvent<H>

com.smartgwt.client.event.AbstractSmartEvent<H>

com.smartgwt.client.widgets.events.BrowserEvent<ItemKeyPressHandler>

com.smartgwt.client.widgets.form.events.ItemKeyPressEvent

All Implemented Interfaces:

Cancellable

public class ItemKeyPressEvent
extends BrowserEvent<ItemKeyPressHandler>
implements 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

Constructor	Description
ItemKeyPressEvent(JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Call this method to cancel the keyPress
protected void	dispatch(ItemKeyPressHandler handler)
static <S extends HasItemKeyPressHandlers & 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.
final GwtEvent.Type<ItemKeyPressHandler>	getAssociatedType()
int	getCharacterValue()	numeric character value of the pressed key.
Canvas	getFiringCanvas()	Returns the Canvas firing the event.
FormItem	getItem()	the FormItem where the change event occurred
String	getKeyName()	name of the key that was pressed (EG: "A", "Space")
static GwtEvent.Type<ItemKeyPressHandler>	getType()	Gets the type associated with this event.
boolean	isCancelled()

Methods inherited from class com.smartgwt.client.widgets.events.BrowserEvent

getX, getY, isAltKeyDown, isCtrlKeyDown, isLeftButtonDown, isRightButtonDown

Methods inherited from class com.smartgwt.client.event.AbstractSmartEvent

getFiringInstanceAsJavaScriptObject

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 Details

ItemKeyPressEvent

public ItemKeyPressEvent(JavaScriptObject jsObj)

Method Details

getFiringCanvas

public Canvas getFiringCanvas()

Returns the Canvas firing the event.

Returns:

Canvas firing the event

fire

public static <S extends HasItemKeyPressHandlers & 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<ItemKeyPressHandler> getType()

Gets the type associated with this event.

Returns:

returns the handler type

dispatch

protected void dispatch(ItemKeyPressHandler handler)

Specified by:

dispatch in class GwtEvent<ItemKeyPressHandler>

getAssociatedType

public final GwtEvent.Type<ItemKeyPressHandler> getAssociatedType()

Specified by:

getAssociatedType in class GwtEvent<ItemKeyPressHandler>

cancel

public void cancel()

Call this method to cancel the keyPress

Specified by:

cancel in interface Cancellable

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

Returns:

true if cancelled

getItem

public FormItem getItem()

the FormItem where the change event occurred

Returns:

the FormItem where the change event occurred

getKeyName

public String getKeyName()

name of the key that was pressed (EG: "A", "Space")

Returns:

name of the key that was pressed (EG: "A", "Space")

getCharacterValue

public int getCharacterValue()

numeric character value of the pressed key.

Returns:

numeric character value of the pressed key.