X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.EventManager.js?ds=sidebyside diff --git a/docs/output/Ext.EventManager.js b/docs/output/Ext.EventManager.js new file mode 100644 index 00000000..5e6938e1 --- /dev/null +++ b/docs/output/Ext.EventManager.js @@ -0,0 +1,620 @@ +Ext.data.JsonP.Ext_EventManager({ + "tagname": "class", + "name": "Ext.EventManager", + "doc": "
Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides\nseveral useful events directly.\nSee Ext.EventObject for more details on normalized event objects.
\n", + "extends": null, + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": true, + "private": false, + "cfg": [ + + ], + "method": [ + { + "tagname": "method", + "name": "addListener", + "member": "Ext.EventManager", + "doc": "Appends an event handler to an element. The shorthand version on is equivalent. Typically you will\nuse Ext.core.Element.addListener directly on an Element in favor of calling this version.
\n", + "params": [ + { + "type": "String/HTMLElement", + "name": "el", + "doc": "The html element or id to assign the event handler to.
\n", + "optional": false + }, + { + "type": "String", + "name": "eventName", + "doc": "The name of the event to listen for.
\n", + "optional": false + }, + { + "type": "Function", + "name": "handler", + "doc": "The handler function the event invokes. This function is passed\nthe following parameters:
(optional) The scope (this
reference) in which the handler function is executed. Defaults to the Element.
(optional) An object containing handler configuration properties.\nThis may contain any of the following properties:
this
reference) in which the handler function is executed. Defaults to the Element.See Ext.core.Element.addListener for examples of how to use these options.
\n\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 284, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-addListener", + "shortDoc": "Appends an event handler to an element. The shorthand version on is equivalent. Typically you will\nuse Ext.core.Ele..." + }, + { + "tagname": "method", + "name": "getId", + "member": "Ext.EventManager", + "doc": "Get the id of the element. If one has not been assigned, automatically assign it.
\n", + "params": [ + { + "type": "Mixed", + "name": "element", + "doc": "The element to get the id for.
\n", + "optional": false + } + ], + "return": { + "type": "String", + "doc": "id
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 170, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-getId", + "shortDoc": "Get the id of the element. If one has not been assigned, automatically assign it.
\n" + }, + { + "tagname": "method", + "name": "getKeyEvent", + "member": "Ext.EventManager", + "doc": "Indicates which event to use for getting key presses.
\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "The appropriate event name.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 827, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-getKeyEvent", + "shortDoc": "Indicates which event to use for getting key presses.
\n" + }, + { + "tagname": "method", + "name": "getPageX", + "member": "Ext.EventManager", + "doc": "Gets the x coordinate from the event
\n", + "params": [ + { + "type": "Object", + "name": "event", + "doc": "The event
\n", + "optional": false + } + ], + "return": { + "type": "Number", + "doc": "The x coordinate
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 649, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-getPageX", + "shortDoc": "Gets the x coordinate from the event
\n" + }, + { + "tagname": "method", + "name": "getPageXY", + "member": "Ext.EventManager", + "doc": "Gets the x & ycoordinate from the event
\n", + "params": [ + { + "type": "Object", + "name": "event", + "doc": "The event
\n", + "optional": false + } + ], + "return": { + "type": "Array", + "doc": "The x/y coordinate
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 667, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-getPageXY", + "shortDoc": "Gets the x & ycoordinate from the event
\n" + }, + { + "tagname": "method", + "name": "getPageY", + "member": "Ext.EventManager", + "doc": "Gets the y coordinate from the event
\n", + "params": [ + { + "type": "Object", + "name": "event", + "doc": "The event
\n", + "optional": false + } + ], + "return": { + "type": "Number", + "doc": "The y coordinate
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 658, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-getPageY", + "shortDoc": "Gets the y coordinate from the event
\n" + }, + { + "tagname": "method", + "name": "getRelatedTarget", + "member": "Ext.EventManager", + "doc": "Gets the related target from the event.
\n", + "params": [ + { + "type": "Object", + "name": "event", + "doc": "The event
\n", + "optional": false + } + ], + "return": { + "type": "HTMLElement", + "doc": "The related target.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 631, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-getRelatedTarget", + "shortDoc": "Gets the related target from the event.
\n" + }, + { + "tagname": "method", + "name": "getTarget", + "member": "Ext.EventManager", + "doc": "Gets the target of the event.
\n", + "params": [ + { + "type": "Object", + "name": "event", + "doc": "The event
\n", + "optional": false + } + ], + "return": { + "type": "HTMLElement", + "doc": "target
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 687, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-getTarget", + "shortDoc": "Gets the target of the event.
\n" + }, + { + "tagname": "method", + "name": "on", + "member": "Ext.EventManager", + "doc": "Alias for Ext.EventManager.addListener
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 852, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-on", + "shortDoc": "Alias for Ext.EventManager.addListener
\n" + }, + { + "tagname": "method", + "name": "onDocumentReady", + "member": "Ext.EventManager", + "doc": "Adds a listener to be notified when the document is ready (before onload and before images are loaded). Can be\naccessed shorthanded as Ext.onReady().
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The method the event invokes.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope (this
reference) in which the handler function executes. Defaults to the browser window.
(optional) Options object as passed to Ext.core.Element.addListener.
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 129, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-onDocumentReady", + "shortDoc": "Adds a listener to be notified when the document is ready (before onload and before images are loaded). Can be\naccess..." + }, + { + "tagname": "method", + "name": "onWindowResize", + "member": "Ext.EventManager", + "doc": "Adds a listener to be notified when the browser window is resized and provides resize event buffering (100 milliseconds),\npasses new viewport width and height to handlers.
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The handler function the window resize event invokes.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "The scope (this
reference) in which the handler function executes. Defaults to the browser window.
Options object as passed to Ext.core.Element.addListener
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 725, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-onWindowResize", + "shortDoc": "Adds a listener to be notified when the browser window is resized and provides resize event buffering (100 millisecon..." + }, + { + "tagname": "method", + "name": "preventDefault", + "member": "Ext.EventManager", + "doc": "Prevents the browsers default handling of the event.
\n", + "params": [ + { + "type": "Event", + "name": "The", + "doc": "event to prevent the default
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 609, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-preventDefault", + "shortDoc": "Prevents the browsers default handling of the event.
\n" + }, + { + "tagname": "method", + "name": "purgeElement", + "member": "Ext.EventManager", + "doc": "Recursively removes all previous added listeners from an element and its children. Typically you will use Ext.core.Element.purgeAllListeners\ndirectly on an Element in favor of calling this version.
\n", + "params": [ + { + "type": "String/HTMLElement", + "name": "el", + "doc": "The id or html element from which to remove all event handlers.
\n", + "optional": false + }, + { + "type": "String", + "name": "eventName", + "doc": "(optional) The name of the event.
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 452, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-purgeElement", + "shortDoc": "Recursively removes all previous added listeners from an element and its children. Typically you will use Ext.core.El..." + }, + { + "tagname": "method", + "name": "removeAll", + "member": "Ext.EventManager", + "doc": "Removes all event handers from an element. Typically you will use Ext.core.Element.removeAllListeners\ndirectly on an Element in favor of calling this version.
\n", + "params": [ + { + "type": "String/HTMLElement", + "name": "el", + "doc": "The id or html element from which to remove all event handlers.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 431, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-removeAll", + "shortDoc": "Removes all event handers from an element. Typically you will use Ext.core.Element.removeAllListeners\ndirectly on an..." + }, + { + "tagname": "method", + "name": "removeListener", + "member": "Ext.EventManager", + "doc": "Removes an event handler from an element. The shorthand version un is equivalent. Typically\nyou will use Ext.core.Element.removeListener directly on an Element in favor of calling this version.
\n", + "params": [ + { + "type": "String/HTMLElement", + "name": "el", + "doc": "The id or html element from which to remove the listener.
\n", + "optional": false + }, + { + "type": "String", + "name": "eventName", + "doc": "The name of the event.
\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "The handler function to remove. This must be a reference to the function passed into the addListener call.
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "If a scope (this
reference) was specified when the listener was added,\nthen this must refer to the same object.
Removes the passed window resize listener.
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The method the event invokes
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "The scope of handler
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 758, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-removeResizeListener", + "shortDoc": "Removes the passed window resize listener.
\n" + }, + { + "tagname": "method", + "name": "removeUnloadListener", + "member": "Ext.EventManager", + "doc": "Removes the passed window unload listener.
\n", + "params": [ + { + "type": "Function", + "name": "fn", + "doc": "The method the event invokes
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "The scope of handler
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 806, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-removeUnloadListener", + "shortDoc": "Removes the passed window unload listener.
\n" + }, + { + "tagname": "method", + "name": "stopEvent", + "member": "Ext.EventManager", + "doc": "Stop the event (preventDefault and stopPropagation)
\n", + "params": [ + { + "type": "Event", + "name": "The", + "doc": "event to stop
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 587, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-stopEvent", + "shortDoc": "Stop the event (preventDefault and stopPropagation)
\n" + }, + { + "tagname": "method", + "name": "stopPropagation", + "member": "Ext.EventManager", + "doc": "Cancels bubbling of the event.
\n", + "params": [ + { + "type": "Event", + "name": "The", + "doc": "event to stop bubbling.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 596, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-stopPropagation", + "shortDoc": "Cancels bubbling of the event.
\n" + }, + { + "tagname": "method", + "name": "un", + "member": "Ext.EventManager", + "doc": "Alias for Ext.EventManager.removeListener
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 859, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager-method-un", + "shortDoc": "Alias for Ext.EventManager.removeListener
\n" + } + ], + "property": [ + + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/platform/core/src/EventManager.js", + "linenr": 1, + "html_filename": "EventManager.html", + "href": "EventManager.html#Ext-EventManager", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file