com.smartgwt.client.widgets.grid.events
Class EditorExitEvent

java.lang.Object
  extended by com.google.gwt.event.shared.GwtEvent<H>
      extended by com.smartgwt.client.event.AbstractSmartEvent<EditorExitHandler>
          extended by com.smartgwt.client.widgets.grid.events.EditorExitEvent
All Implemented Interfaces:
Cancellable

public class EditorExitEvent
extends AbstractSmartEvent<EditorExitHandler>
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
EditorExitEvent(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 
Method Summary
 void cancel()
          Returning false from this method will cancel the default behavior (for example saving the row) and leave the editor visible and focus in this edit cell.
protected  void dispatch(EditorExitHandler handler)
          Should only be called by HandlerManager.
static
<S extends HasEditorExitHandlers & HasHandlers>
void
fire(S source, com.google.gwt.core.client.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<EditorExitHandler> getAssociatedType()
          Returns the type used to register this event.
 int getColNum()
          column number of the cell
 EditCompletionEvent getEditCompletionEvent()
          What interaction triggered this edit cell exit
 ListGrid getGrid()
          ListGrid to which this field belongs
 java.lang.Object getNewValue()
          new value for the cell being edited
 Record getRecord()
          record for the cell being edited
 int getRowNum()
          row number for the cell
static GwtEvent.Type<EditorExitHandler> 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

EditorExitEvent

public EditorExitEvent(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail

fire

public static <S extends HasEditorExitHandlers & HasHandlers> void fire(S source,
                                                                       com.google.gwt.core.client.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<EditorExitHandler> getType()
Gets the type associated with this event.

Returns:
returns the handler type

dispatch

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

getAssociatedType

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

cancel

public void cancel()
Returning false from this method will cancel the default behavior (for example saving the row) and leave the editor visible and focus in this edit cell.

Specified by:
cancel in interface Cancellable

isCancelled

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

getEditCompletionEvent

public EditCompletionEvent getEditCompletionEvent()
What interaction triggered this edit cell exit

Returns:
What interaction triggered this edit cell exit

getRecord

public Record getRecord()
record for the cell being edited

Returns:
record for the cell being edited

getNewValue

public java.lang.Object getNewValue()
new value for the cell being edited

Returns:
new value for the cell being edited

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

getGrid

public ListGrid getGrid()
ListGrid to which this field belongs

Returns:
ListGrid to which this field belongs