Clear Up
SharpKit Reference

KeyMapConfig Class

Namespace: Ext.util

Base Types

System.Object

Constructors

Name Description
KeyMapConfig(Object[])

Fields

Name Description
binding Either a single object describing a handling function for s specified key (or set of keys), or an array of such objects.
  • key : String/String[]

    A single keycode or an array of keycodes to handle

  • shift : Boolean

    True to handle key only when shift is pressed, False to handle the key only when shift is not pressed (defaults to undefined)

  • ctrl : Boolean

    True to handle key only when ctrl is pressed, False to handle the key only when ctrl is not pressed (defaults to undefined)

  • alt : Boolean

    True to handle key only when alt is pressed, False to handle the key only when alt is not pressed (defaults to undefined)

  • handler : Function

    The function to call when KeyMap finds the expected key combination

  • fn : Function

    Alias of handler (for backwards-compatibility)

  • scope : Object

    The scope of the callback function

  • defaultEventAction : String

    A default action to apply to the event. Possible values are: stopEvent, stopPropagation, preventDefault. If no value is set no action is performed.

  • eventName The event to listen for to pick up key events. Defaults to: "keydown"
    ignoreInputFields Configure this as true if there are any input fields within the target, and this KeyNav should not process events from input fields, (<input>, <textarea> and elements withcontentEditable="true"`) Defaults to: false
    processEvent An optional event processor function which accepts the argument list provided by the configured event of the target, and returns a keyEvent for processing by the KeyMap. This may be useful when the target is a Component with s complex event signature, where the event is not the first parameter. Extra information from the event arguments may be injected into the event for use by the handler functions before returning it.
    processEventScope The scope (this context) in which the processEvent method is executed. Defaults to: this
    target The object on which to listen for the event specified by the eventName config option.
    © Copyright 2005-2011 SharpKit. All rights reserved.