com.smartgwt.client.widgets.grid.events

Class ChangeEvent

java.lang.Object

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

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

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

com.smartgwt.client.widgets.grid.events.ChangeEvent

All Implemented Interfaces:

Cancellable

public class ChangeEvent
extends AbstractSmartEvent<ChangeHandler>
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

Constructors

Constructor and Description
ChangeEvent(JavaScriptObject jsObj)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() The change may be cancelled
protected void	dispatch(ChangeHandler handler)
static <S extends HasChangeHandlers & 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<ChangeHandler>	getAssociatedType()
int	getColNum() column number of the cell
DynamicForm	getForm() the managing DynamicForm instance
FormItem	getItem() the editor (form item) itself (also available as "this").
java.lang.Object	getOldValue() The previous value of the form item
int	getRowNum() row number for the cell
static GwtEvent.Type<ChangeHandler>	getType() Gets the type associated with this event.
java.lang.Object	getValue() The new value of the form item
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

ChangeEvent

public ChangeEvent(JavaScriptObject jsObj)

Method Detail

fire

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

Gets the type associated with this event.

Returns:

returns the handler type

dispatch

protected void dispatch(ChangeHandler handler)

Specified by:

dispatch in class GwtEvent<ChangeHandler>

getAssociatedType

public final GwtEvent.Type<ChangeHandler> getAssociatedType()

Overrides:

getAssociatedType in class GwtEvent<ChangeHandler>

cancel

public void cancel()

The change may be cancelled

Specified by:

cancel in interface Cancellable

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

Returns:

true if cancelled

getForm

public DynamicForm getForm()

the managing DynamicForm instance

Returns:

the managing DynamicForm instance

getItem

public FormItem getItem()

the editor (form item) itself (also available as "this"). Note that in addition to the standard FormItem APIs available on the editor, it also has:
- a pointer back to the containing listGrid [item.grid]
- the colNum being edited [item.colNum]
- the rowNum being edited [item.rowNum]

Returns:

the editor (form item) itself (also available as "this"). Note that in addition to the standard FormItem APIs available on the editor, it also has:
- a pointer back to the containing listGrid [item.grid]
- the colNum being edited [item.colNum]
- the rowNum being edited [item.rowNum]

getValue

public java.lang.Object getValue()

The new value of the form item

Returns:

The new value of the form item

getOldValue

public java.lang.Object getOldValue()

The previous value of the form item

Returns:

The previous value of the form item

getRowNum

public int getRowNum()

row number for the cell

Returns:

row number for the cell

getColNum

public int getColNum()

column number of the cell

Returns:

column number of the cell