X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/0494b8d9b9bb03ab6c22b34dae81261e3cd7e3e6..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/api/Ext.view.BoundListKeyNav.html diff --git a/docs/api/Ext.view.BoundListKeyNav.html b/docs/api/Ext.view.BoundListKeyNav.html new file mode 100644 index 00000000..87a01d55 --- /dev/null +++ b/docs/api/Ext.view.BoundListKeyNav.html @@ -0,0 +1,99 @@ +Ext.view.BoundListKeyNav | Ext JS 4.0 Documentation +
For up to date documentation and features, visit +http://docs.sencha.com/ext-js/4-0

Sencha Documentation

+ + + + + +

Hierarchy

Ext.util.KeyNav
Ext.view.BoundListKeyNav

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 invokes the selection model's select action using the highlighted item.

+
Defined By

Config Options

Other Configs

 

@required +The Ext.view.BoundList instance for which key navigation will be managed. This is required.

+

@required +The Ext.view.BoundList instance for which key navigation will be managed. This is required.

+
 
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')

+
 

True to disable this KeyNav instance (defaults to false)

+

True to disable this KeyNav instance (defaults to false)

+
 
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.

+
Defined By

Methods

 
BoundListKeyNav( +Mixed el, Object config) + : void

 

+

Parameters

  • el : Mixed

    The element to bind to

    +
  • config : Object

    The config

    +

Returns

  • void    +
 
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 this KeyNav

+

Disable this KeyNav

+

Returns

  • void    +
 

Enable this KeyNav

+

Enable this KeyNav

+

Returns

  • void    +
 
getKeyEvent( +Object forceKeyDown) + : 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.

+

Parameters

  • forceKeyDown : Object
    +

Returns

  • String   

    The type of event to listen for.

    +
 

Highlights the item at the given index.

+

Highlights the item at the given index.

+

Parameters

  • index : Number
    +

Returns

  • 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.

+

Parameters

  • e : Object
    +

Returns

  • void    +
 
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    +
\ No newline at end of file