com.smartgwt.client.widgets.form.events
Class ItemChangeEvent

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

public class ItemChangeEvent
extends BrowserEvent<ItemChangeHandler>
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
ItemChangeEvent(JavaScriptObject jsObj)
           
 
Method Summary
 void cancel()
          return false to cancel the change, or true to allow it
protected  void dispatch(ItemChangeHandler handler)
          Should only be called by HandlerManager.
static
<S extends HasItemChangeHandlers & 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<ItemChangeHandler> getAssociatedType()
          Returns the type used to register this event.
 FormItem getItem()
          the FormItem where the change event occurred
 Object getNewValue()
          new value for the FormItem
 Object getOldValue()
          value the FormItem had previous to this change() event
static GwtEvent.Type<ItemChangeHandler> 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.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

ItemChangeEvent

public ItemChangeEvent(JavaScriptObject jsObj)
Method Detail

fire

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

Returns:
returns the handler type

dispatch

protected void dispatch(ItemChangeHandler 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<ItemChangeHandler>
Parameters:
handler - handler

getAssociatedType

public final GwtEvent.Type<ItemChangeHandler> 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<ItemChangeHandler>
Returns:
the type

cancel

public void cancel()
return false to cancel the change, or true to allow it

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

getNewValue

public Object getNewValue()
new value for the FormItem

Returns:
new value for the FormItem

getOldValue

public Object getOldValue()
value the FormItem had previous to this change() event

Returns:
value the FormItem had previous to this change() event