Sencha Documentation

Provides a convenient wrapper for normalized keyboard navigation. KeyNav allows you to bind navigation keys to function calls that will get called when the keys are pressed, providing an easy way to implement custom navigation schemes for any UI component.

The following are all of the possible keys that can be implemented: enter, left, right, up, down, tab, esc, pageUp, pageDown, del, home, end. Usage:

var nav = new Ext.util.KeyNav("my-element", {
    "left" : function(e){
        this.moveLeft(e.ctrlKey);
    },
    "right" : function(e){
        this.moveRight(e.ctrlKey);
    },
    "enter" : function(e){
        this.save();
    },
    scope : this
});

Config Options

 
The method to call on the Ext.EventObject after this KeyNav intercepts a key. Valid values are Ext.EventObject.stopE...
The method to call on the Ext.EventObject after this KeyNav intercepts a key. Valid values are Ext.EventObject.stopEvent, Ext.EventObject.preventDefault and Ext.EventObject.stopPropagation (defaults to 'stopEvent')
 
disabled : Boolean
True to disable this KeyNav instance (defaults to false)
True to disable this KeyNav instance (defaults to false)
 
forceKeyDown : Boolean
Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since IE doe...
Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since IE does not propagate special keys on keypress, but setting this to true will force other browsers to also handle keydown instead of keypress.

Methods

 
destroy( Boolean removeEl ) : Void
Destroy this KeyNav (this is the same as calling disable).
Destroy this KeyNav (this is the same as calling disable).

Parameters

  • removeEl : Boolean
    True to remove the element associated with this KeyNav.

Returns

  • Void
 
disable : Void
Disable this KeyNav
Disable this KeyNav
 
enable : Void
Enable this KeyNav
Enable this KeyNav
 
getKeyEvent : String
Determines the event to bind to listen for keys. Depends on the forceKeyDown setting, as well as the useKeyDown optio...
Determines the event to bind to listen for keys. Depends on the forceKeyDown setting, as well as the useKeyDown option on the EventManager.
 
setDisabled( Boolean disabled ) : Void
Convenience function for setting disabled/enabled by boolean.
Convenience function for setting disabled/enabled by boolean.

Parameters

  • disabled : Boolean

Returns

  • Void