X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..refs/heads/master:/docs/source/KeyNav2.html
diff --git a/docs/source/KeyNav2.html b/docs/source/KeyNav2.html
index 83d378e6..72ef815a 100644
--- a/docs/source/KeyNav2.html
+++ b/docs/source/KeyNav2.html
@@ -3,8 +3,8 @@
The source code
-
-
+
+
@@ -15,135 +15,174 @@
- * @class Ext.menu.KeyNav
- * @private
- */
-Ext.define('Ext.menu.KeyNav', {
- extend: 'Ext.util.KeyNav',
-
- requires: ['Ext.FocusManager'],
-
- constructor: function(menu) {
- var me = this;
-
- me.menu = menu;
- me.callParent([menu.el, {
- down: me.down,
- enter: me.enter,
- esc: me.escape,
- left: me.left,
- right: me.right,
- space: me.enter,
- tab: me.tab,
- up: me.up
- }]);
+ /**
+ * @class Ext.util.KeyNav
+ * <p>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.</p>
+ * <p>The following are all of the possible keys that can be implemented: enter, space, left, right, up, down, tab, esc,
+ * pageUp, pageDown, del, backspace, home, end. Usage:</p>
+ <pre><code>
+var nav = new Ext.util.KeyNav("my-element", {
+ "left" : function(e){
+ this.moveLeft(e.ctrlKey);
},
-
- down: function(e) {
- var me = this,
- fi = me.menu.focusedItem;
-
- if (fi && e.getKey() == Ext.EventObject.DOWN && me.isWhitelisted(fi)) {
- return true;
- }
- me.focusNextItem(1);
+ "right" : function(e){
+ this.moveRight(e.ctrlKey);
},
-
- enter: function(e) {
- var menu = this.menu;
-
- if (menu.activeItem) {
- menu.onClick(e);
+ "enter" : function(e){
+ this.save();
+ },
+ scope : this
+});
+</code></pre>
+ */
+Ext.define('Ext.util.KeyNav', {
+
+ alternateClassName: 'Ext.KeyNav',
+
+ requires: ['Ext.util.KeyMap'],
+
+ statics: {
+ keyOptions: {
+ left: 37,
+ right: 39,
+ up: 38,
+ down: 40,
+ space: 32,
+ pageUp: 33,
+ pageDown: 34,
+ del: 46,
+ backspace: 8,
+ home: 36,
+ end: 35,
+ enter: 13,
+ esc: 27,
+ tab: 9
}
},
- escape: function(e) {
- Ext.menu.Manager.hideAll();
+ /**
+ * Creates new KeyNav.
+ * @param {String/HTMLElement/Ext.Element} el The element or its ID to bind to
+ * @param {Object} config The config
+ */
+ constructor: function(el, config){
+ this.setConfig(el, config || {});
},
-
- focusNextItem: function(step) {
- var menu = this.menu,
- items = menu.items,
- focusedItem = menu.focusedItem,
- startIdx = focusedItem ? items.indexOf(focusedItem) : -1,
- idx = startIdx + step;
-
- while (idx != startIdx) {
- if (idx < 0) {
- idx = items.length - 1;
- } else if (idx >= items.length) {
- idx = 0;
- }
-
- var item = items.getAt(idx);
- if (menu.canActivateItem(item)) {
- menu.setActiveItem(item);
- break;
+
+ /**
+ * Sets up a configuration for the KeyNav.
+ * @private
+ * @param {String/HTMLElement/Ext.Element} el The element or its ID to bind to
+ * @param {Object} config A configuration object as specified in the constructor.
+ */
+ setConfig: function(el, config) {
+ if (this.map) {
+ this.map.destroy();
+ }
+
+ var map = Ext.create('Ext.util.KeyMap', el, null, this.getKeyEvent('forceKeyDown' in config ? config.forceKeyDown : this.forceKeyDown)),
+ keys = Ext.util.KeyNav.keyOptions,
+ scope = config.scope || this,
+ key;
+
+ this.map = map;
+ for (key in keys) {
+ if (keys.hasOwnProperty(key)) {
+ if (config[key]) {
+ map.addBinding({
+ scope: scope,
+ key: keys[key],
+ handler: Ext.Function.bind(this.handleEvent, scope, [config[key]], true),
+ defaultEventAction: config.defaultEventAction || this.defaultEventAction
+ });
+ }
}
- idx += step;
+ }
+
+ map.disable();
+ if (!config.disabled) {
+ map.enable();
}
},
-
- isWhitelisted: function(item) {
- return Ext.FocusManager.isWhitelisted(item);
+
+ /**
+ * Method for filtering out the map argument
+ * @private
+ * @param {Ext.util.KeyMap} map
+ * @param {Ext.EventObject} event
+ * @param {Object} options Contains the handler to call
+ */
+ handleEvent: function(map, event, handler){
+ return handler.call(this, event);
},
-
- left: function(e) {
- var menu = this.menu,
- fi = menu.focusedItem,
- ai = menu.activeItem;
-
- if (fi && this.isWhitelisted(fi)) {
- return true;
- }
-
- menu.hide();
- if (menu.parentMenu) {
- menu.parentMenu.focus();
- }
+
+ /**
+ * @cfg {Boolean} disabled
+ * True to disable this KeyNav instance.
+ */
+ disabled: false,
+
+ /**
+ * @cfg {String} defaultEventAction
+ * The method to call on the {@link Ext.EventObject} after this KeyNav intercepts a key. Valid values are
+ * {@link Ext.EventObject#stopEvent}, {@link Ext.EventObject#preventDefault} and
+ * {@link Ext.EventObject#stopPropagation}.
+ */
+ defaultEventAction: "stopEvent",
+
+ /**
+ * @cfg {Boolean} forceKeyDown
+ * Handle the keydown event instead of keypress. 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.
+ */
+ forceKeyDown: false,
+
+ /**
+ * Destroy this KeyNav (this is the same as calling disable).
+ * @param {Boolean} removeEl True to remove the element associated with this KeyNav.
+ */
+ destroy: function(removeEl){
+ this.map.destroy(removeEl);
+ delete this.map;
},
- right: function(e) {
- var menu = this.menu,
- fi = menu.focusedItem,
- ai = menu.activeItem,
- am;
-
- if (fi && this.isWhitelisted(fi)) {
- return true;
- }
-
- if (ai) {
- am = menu.activeItem.menu;
- if (am) {
- ai.expandMenu(0);
- Ext.defer(function() {
- am.setActiveItem(am.items.getAt(0));
- }, 25);
- }
- }
+ /**
+ * Enable this KeyNav
+ */
+ enable: function() {
+ this.map.enable();
+ this.disabled = false;
},
- tab: function(e) {
- var me = this;
-
- if (e.shiftKey) {
- me.up(e);
- } else {
- me.down(e);
- }
+ /**
+ * Disable this KeyNav
+ */
+ disable: function() {
+ this.map.disable();
+ this.disabled = true;
},
-
- up: function(e) {
- var me = this,
- fi = me.menu.focusedItem;
-
- if (fi && e.getKey() == Ext.EventObject.UP && me.isWhitelisted(fi)) {
- return true;
- }
- me.focusNextItem(-1);
+
+ /**
+ * Convenience function for setting disabled/enabled by boolean.
+ * @param {Boolean} disabled
+ */
+ setDisabled : function(disabled){
+ this.map.setDisabled(disabled);
+ this.disabled = disabled;
+ },
+
+ /**
+ * Determines the event to bind to listen for keys. Depends on the {@link #forceKeyDown} setting,
+ * as well as the useKeyDown option on the EventManager.
+ * @return {String} The type of event to listen for.
+ */
+ getKeyEvent: function(forceKeyDown){
+ return (forceKeyDown || Ext.EventManager.useKeyDown) ? 'keydown' : 'keypress';
}
-});
+});
+