X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/output/Ext.view.BoundListKeyNav.js diff --git a/docs/output/Ext.view.BoundListKeyNav.js b/docs/output/Ext.view.BoundListKeyNav.js index fec05e98..0296930e 100644 --- a/docs/output/Ext.view.BoundListKeyNav.js +++ b/docs/output/Ext.view.BoundListKeyNav.js @@ -1,296 +1 @@ -Ext.data.JsonP.Ext_view_BoundListKeyNav({ - "tagname": "class", - "name": "Ext.view.BoundListKeyNav", - "doc": "
A specialized Ext.util.KeyNav implementation for navigating a Ext.view.BoundList using\nthe keyboard. The up, down, pageup, pagedown, home, and end keys move the active highlight\nthrough the list. The enter key invokes the selection model's select action using the highlighted item.
\n", - "extends": "Ext.util.KeyNav", - "mixins": [ - - ], - "alternateClassNames": [ - - ], - "xtype": null, - "author": null, - "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "boundList", - "member": "Ext.view.BoundListKeyNav", - "type": "Ext.view.BoundList", - "doc": "@required\nThe Ext.view.BoundList instance for which key navigation will be managed. This is required.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/view/BoundListKeyNav.js", - "linenr": 12, - "html_filename": "BoundListKeyNav.html", - "href": "BoundListKeyNav.html#Ext-view-BoundListKeyNav-cfg-boundList" - }, - { - "tagname": "cfg", - "name": "defaultEventAction", - "member": "Ext.util.KeyNav", - "type": "String", - "doc": "The method to call on the Ext.EventObject after this KeyNav intercepts a key. Valid values are\nExt.EventObject.stopEvent, Ext.EventObject.preventDefault and\nExt.EventObject.stopPropagation (defaults to 'stopEvent')
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js", - "linenr": 108, - "html_filename": "KeyNav2.html", - "href": "KeyNav2.html#Ext-util-KeyNav-cfg-defaultEventAction", - "shortDoc": "The method to call on the Ext.EventObject after this KeyNav intercepts a key. Valid values are\nExt.EventObject.stopE..." - }, - { - "tagname": "cfg", - "name": "disabled", - "member": "Ext.util.KeyNav", - "type": "Boolean", - "doc": "True to disable this KeyNav instance (defaults to false)
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js", - "linenr": 102, - "html_filename": "KeyNav2.html", - "href": "KeyNav2.html#Ext-util-KeyNav-cfg-disabled" - }, - { - "tagname": "cfg", - "name": "forceKeyDown", - "member": "Ext.util.KeyNav", - "type": "Boolean", - "doc": "Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since\nIE does not propagate special keys on keypress, but setting this to true will force other browsers to also\nhandle keydown instead of keypress.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js", - "linenr": 116, - "html_filename": "KeyNav2.html", - "href": "KeyNav2.html#Ext-util-KeyNav-cfg-forceKeyDown", - "shortDoc": "Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since\nIE doe..." - } - ], - "method": [ - { - "tagname": "method", - "name": "BoundListKeyNav", - "member": "Ext.util.KeyNav", - "doc": "\n", - "params": [ - { - "type": "Mixed", - "name": "el", - "doc": "The element to bind to
\n", - "optional": false - }, - { - "type": "Object", - "name": "config", - "doc": "The config
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js", - "linenr": 1, - "html_filename": "KeyNav2.html", - "href": "KeyNav2.html#Ext-util-KeyNav-method-constructor", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "destroy", - "member": "Ext.util.KeyNav", - "doc": "Destroy this KeyNav (this is the same as calling disable).
\n", - "params": [ - { - "type": "Boolean", - "name": "removeEl", - "doc": "True to remove the element associated with this KeyNav.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js", - "linenr": 124, - "html_filename": "KeyNav2.html", - "href": "KeyNav2.html#Ext-util-KeyNav-method-destroy", - "shortDoc": "Destroy this KeyNav (this is the same as calling disable).
\n" - }, - { - "tagname": "method", - "name": "disable", - "member": "Ext.util.KeyNav", - "doc": "Disable this KeyNav
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js", - "linenr": 141, - "html_filename": "KeyNav2.html", - "href": "KeyNav2.html#Ext-util-KeyNav-method-disable", - "shortDoc": "Disable this KeyNav
\n" - }, - { - "tagname": "method", - "name": "enable", - "member": "Ext.util.KeyNav", - "doc": "Enable this KeyNav
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js", - "linenr": 133, - "html_filename": "KeyNav2.html", - "href": "KeyNav2.html#Ext-util-KeyNav-method-enable", - "shortDoc": "Enable this KeyNav
\n" - }, - { - "tagname": "method", - "name": "getKeyEvent", - "member": "Ext.util.KeyNav", - "doc": "Determines the event to bind to listen for keys. Depends on the forceKeyDown setting,\nas well as the useKeyDown option on the EventManager.
\n", - "params": [ - { - "type": "Object", - "name": "forceKeyDown", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "String", - "doc": "The type of event to listen for.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js", - "linenr": 158, - "html_filename": "KeyNav2.html", - "href": "KeyNav2.html#Ext-util-KeyNav-method-getKeyEvent", - "shortDoc": "Determines the event to bind to listen for keys. Depends on the forceKeyDown setting,\nas well as the useKeyDown optio..." - }, - { - "tagname": "method", - "name": "highlightAt", - "member": "Ext.view.BoundListKeyNav", - "doc": "Highlights the item at the given index.
\n", - "params": [ - { - "type": "Number", - "name": "index", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/view/BoundListKeyNav.js", - "linenr": 67, - "html_filename": "BoundListKeyNav.html", - "href": "BoundListKeyNav.html#Ext-view-BoundListKeyNav-method-highlightAt", - "shortDoc": "Highlights the item at the given index.
\n" - }, - { - "tagname": "method", - "name": "selectHighlighted", - "member": "Ext.view.BoundListKeyNav", - "doc": "Triggers selection of the currently highlighted item according to the behavior of\nthe configured SelectionModel.
\n", - "params": [ - { - "type": "Object", - "name": "e", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/view/BoundListKeyNav.js", - "linenr": 81, - "html_filename": "BoundListKeyNav.html", - "href": "BoundListKeyNav.html#Ext-view-BoundListKeyNav-method-selectHighlighted", - "shortDoc": "Triggers selection of the currently highlighted item according to the behavior of\nthe configured SelectionModel.
\n" - }, - { - "tagname": "method", - "name": "setDisabled", - "member": "Ext.util.KeyNav", - "doc": "Convenience function for setting disabled/enabled by boolean.
\n", - "params": [ - { - "type": "Boolean", - "name": "disabled", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js", - "linenr": 149, - "html_filename": "KeyNav2.html", - "href": "KeyNav2.html#Ext-util-KeyNav-method-setDisabled", - "shortDoc": "Convenience function for setting disabled/enabled by boolean.
\n" - } - ], - "property": [ - - ], - "event": [ - - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/view/BoundListKeyNav.js", - "linenr": 1, - "html_filename": "BoundListKeyNav.html", - "href": "BoundListKeyNav.html#Ext-view-BoundListKeyNav", - "cssVar": [ - - ], - "cssMixin": [ - - ], - "component": false, - "superclasses": [ - "Ext.util.KeyNav" - ], - "subclasses": [ - - ], - "mixedInto": [ - - ], - "allMixins": [ - - ] -}); \ No newline at end of file +Ext.data.JsonP.Ext_view_BoundListKeyNav({"tagname":"class","html":"Hierarchy
Ext.BaseExt.util.KeyNavExt.view.BoundListKeyNavRequires
Files
A specialized Ext.util.KeyNav implementation for navigating a Ext.view.BoundList using\nthe keyboard. The up, down, pageup, pagedown, home, and end keys move the active highlight\nthrough the list. The enter key invokes the selection model's select action using the highlighted item.
\nThe Ext.view.BoundList instance for which key navigation will be managed.
\nThe Ext.view.BoundList instance for which key navigation will be managed.
\nThe method to call on the Ext.EventObject after this KeyNav intercepts a key. Valid values are\nExt.EventObject.stopEvent, Ext.EventObject.preventDefault and\nExt.EventObject.stopPropagation.
\nDefaults to: "stopEvent"
Handle the keydown event instead of keypress. KeyNav automatically does this for IE since\nIE does not propagate special keys on keypress, but setting this to true will force other browsers to also\nhandle keydown instead of keypress.
\nDefaults to: false
Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nCreates new KeyNav.
\nThe element or its ID to bind to
\nThe config
\nCall the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nDestroy this KeyNav (this is the same as calling disable).
\nTrue to remove the element associated with this KeyNav.
\nDetermines the event to bind to listen for keys. Depends on the forceKeyDown setting,\nas well as the useKeyDown option on the EventManager.
\nThe type of event to listen for.
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nTriggers selection of the currently highlighted item according to the behavior of\nthe configured SelectionModel.
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nthis
\n