Sencha Documentation

Ext.view.BoundListKeyNav

Overview

Super classes

Ext.util.KeyNav
A specialized Ext.util.KeyNav implementation for navigating a Ext.view.BoundList using the keyboard. The up, down, pageup, pagedown, home, and end keys move the active highlight through the list. The enter key (and optionally the tab key) invokes the selection model's select action using the highlighted item.

Config Options

 
boundList : Ext.view.BoundList
 
defaultEventAction : String
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.
 
selectOnTab : Boolean
Whether the Tab key should select the currently highlighted item. Defaults to true.
Whether the Tab key should select the currently highlighted item. Defaults to true.

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.
 
highlightAt( Number index ) : Void
Highlights the item at the given index.
Highlights the item at the given index.

Parameters

  • index : Number

Returns

  • Void
 
selectHighlighted : Void
Triggers selection of the currently highlighted item according to the behavior of the configured SelectionModel.
Triggers selection of the currently highlighted item according to the behavior of the configured SelectionModel.
 
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
© 2011 Sencha Inc.