com.gwtext.client.widgets.event
Interface EditorListener

All Superinterfaces:
ComponentListener
All Known Implementing Classes:
EditorListenerAdapter

public interface EditorListener
extends ComponentListener


Method Summary
 boolean doBeforeComplete(Editor source, java.lang.Object value, java.lang.Object startValue)
          Fires after a change has been made to the field, but before the change is reflected in the underlying field.
 boolean doBeforeStartEdit(Editor source, ExtElement boundEl, java.lang.Object value)
          Fires when editing is initiated, but before the value changes.
 void onComplete(Editor source, java.lang.Object value, java.lang.Object startValue)
          Fires after editing is complete and any changed value has been written to the underlying field.
 void onSpeciakKey(Field field, EventObject e)
          Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.
 
Methods inherited from interface com.gwtext.client.widgets.event.ComponentListener
doBeforeDestroy, doBeforeHide, doBeforeRender, doBeforeShow, doBeforeStateRestore, doBeforeStateSave, onDestroy, onDisable, onEnable, onHide, onRender, onShow, onStateRestore, onStateSave
 

Method Detail

doBeforeComplete

boolean doBeforeComplete(Editor source,
                         java.lang.Object value,
                         java.lang.Object startValue)
Fires after a change has been made to the field, but before the change is reflected in the underlying field. Saving the change to the field can be canceled by returning false from the handler of this event. Note that if the value has not changed and ignoreNoChange = true, the editing will still end but this event will not fire since no edit actually occurred.

Parameters:
source - this
value - the current field value
startValue - the original field value
Returns:
false to cancel the field edit

doBeforeStartEdit

boolean doBeforeStartEdit(Editor source,
                          ExtElement boundEl,
                          java.lang.Object value)
Fires when editing is initiated, but before the value changes. Editing can be canceled by returning false from the handler of this event.

Parameters:
source - this
boundEl - the underlying element bound to this editor
value - the field value beign set
Returns:
fale to cancel the editing

onComplete

void onComplete(Editor source,
                java.lang.Object value,
                java.lang.Object startValue)
Fires after editing is complete and any changed value has been written to the underlying field.

Parameters:
source - this
value - the current field value
startValue - the original field value

onSpeciakKey

void onSpeciakKey(Field field,
                  EventObject e)
Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check EventObject.getKey() to determine which key was pressed.

Parameters:
field - this
e - the event object