X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/output/Ext.util.ComponentDragger.js diff --git a/docs/output/Ext.util.ComponentDragger.js b/docs/output/Ext.util.ComponentDragger.js index e195fd60..f4d4d9c3 100644 --- a/docs/output/Ext.util.ComponentDragger.js +++ b/docs/output/Ext.util.ComponentDragger.js @@ -1,1234 +1,1869 @@ Ext.data.JsonP.Ext_util_ComponentDragger({ - "tagname": "class", - "name": "Ext.util.ComponentDragger", - "doc": "

A subclass of Ext.dd.DragTracker which handles dragging any Component.

\n\n\n

This is configured with a Component to be made draggable, and a config object for the\nExt.dd.DragTracker class.

\n\n\n

A delegate may be provided which may be either the element to use as the mousedown target\nor a Ext.DomQuery selector to activate multiple mousedown targets.

\n\n", - "extends": "Ext.dd.DragTracker", - "mixins": [ - - ], - "alternateClassNames": [ - + "allMixins": [ + "Ext.util.Observable" ], - "xtype": null, - "author": null, + "deprecated": null, "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "autoStart", - "member": "Ext.dd.DragTracker", - "type": "Boolean/Number", - "doc": "

Defaults to false. Specify true to defer trigger start by 1000 ms.\nSpecify a Number for the number of milliseconds to defer trigger start.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 63, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-cfg-autoStart", - "shortDoc": "Defaults to false. Specify true to defer trigger start by 1000 ms.\nSpecify a Number for the number of milliseconds to..." - }, - { - "tagname": "cfg", - "name": "constrain", - "member": "Ext.util.ComponentDragger", - "type": "Boolean", - "doc": "

Specify as true to constrain the Component to within the bounds of the constrainTo region.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ComponentDragger.js", - "linenr": 15, - "html_filename": "ComponentDragger.html", - "href": "ComponentDragger.html#Ext-util-ComponentDragger-cfg-constrain" - }, - { - "tagname": "cfg", - "name": "constrainDelegate", - "member": "Ext.util.ComponentDragger", - "type": "Boolean", - "doc": "

Specify as true to constrain the drag handles within the constrainTo region.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ComponentDragger.js", - "linenr": 27, - "html_filename": "ComponentDragger.html", - "href": "ComponentDragger.html#Ext-util-ComponentDragger-cfg-constrainDelegate" - }, - { - "tagname": "cfg", - "name": "constrainTo", - "member": "Ext.dd.DragTracker", - "type": "Ext.util.Region/Element", - "doc": "

A Region (Or an element from which a Region measurement will be read) which is used to constrain\nthe result of the getOffset call.

\n\n\n

This may be set any time during the DragTracker's lifecycle to set a dynamic constraining region.

\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 49, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-cfg-constrainTo", - "shortDoc": "A Region (Or an element from which a Region measurement will be read) which is used to constrain\nthe result of the ge..." - }, - { - "tagname": "cfg", - "name": "delegate", - "member": "Ext.util.ComponentDragger", - "type": "String/Element", - "doc": "

Optional.

A DomQuery selector which identifies child elements within the Component's encapsulating\nElement which are the drag handles. This limits dragging to only begin when the matching elements are mousedowned.

\n\n

This may also be a specific child element within the Component's encapsulating element to use as the drag handle.

\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ComponentDragger.js", - "linenr": 20, - "html_filename": "ComponentDragger.html", - "href": "ComponentDragger.html#Ext-util-ComponentDragger-cfg-delegate", - "shortDoc": "Optional. A DomQuery selector which identifies child elements within the Component's encapsulating\nElement which are ..." - }, - { - "tagname": "cfg", - "name": "listeners", - "member": "Ext.util.Observable", - "type": "Object", - "doc": "

(optional)

A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.

\n\n

DOM events from ExtJs Components

\n\n\n

While some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n

is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the element option to\nidentify the Component property to add a DOM listener to:

\n\n
new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n
\n\n\n

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 103, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-cfg-listeners", - "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. T..." - }, - { - "tagname": "cfg", - "name": "overCls", - "member": "Ext.dd.DragTracker", - "type": "String", - "doc": "

A CSS class to add to the DragTracker's target element when the element (or, if the delegate option is used,\nwhen a delegate element) is mouseovered.

\n\n\n

If the delegate option is used, these events fire only when a delegate element is entered of left..

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 42, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-cfg-overCls", - "shortDoc": "A CSS class to add to the DragTracker's target element when the element (or, if the delegate option is used,\nwhen a d..." - }, - { - "tagname": "cfg", - "name": "preventDefault", - "member": "Ext.dd.DragTracker", - "type": "Boolean", - "doc": "

Specify false to enable default actions on onMouseDown events. Defaults to true.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 77, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-cfg-preventDefault" - }, - { - "tagname": "cfg", - "name": "stopEvent", - "member": "Ext.dd.DragTracker", - "type": "Boolean", - "doc": "

Specify true to stop the mousedown event from bubbling to outer listeners from the target element (or its delegates). Defaults to false.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 82, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-cfg-stopEvent", - "shortDoc": "Specify true to stop the mousedown event from bubbling to outer listeners from the target element (or its delegates)...." - }, - { - "tagname": "cfg", - "name": "tolerance", - "member": "Ext.dd.DragTracker", - "type": "Number", - "doc": "

Number of pixels the drag target must be moved before dragging is\nconsidered to have started. Defaults to 5.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 56, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-cfg-tolerance" - }, - { - "tagname": "cfg", - "name": "trackOver", - "member": "Ext.dd.DragTracker", - "type": "Boolean", - "doc": "

Defaults to false. Set to true to fire mouseover and mouseout events when the mouse enters or leaves the target element.

\n\n\n

This is implicitly set when an overCls is specified.

\n\n\n

If the delegate option is used, these events fire only when a delegate element is entered of left..

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 34, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-cfg-trackOver", - "shortDoc": "Defaults to false. Set to true to fire mouseover and mouseout events when the mouse enters or leaves the target eleme..." - } - ], - "method": [ - { - "tagname": "method", - "name": "ComponentDragger", - "member": "Ext.util.ComponentDragger", - "doc": "

Create a new ComponentTracker

\n", - "params": [ - { - "type": "object", - "name": "comp", - "doc": "

The Component to provide dragging for.

\n", - "optional": false - }, - { - "type": "object", - "name": "config", - "doc": "

The config object

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "members": { + "cfg": [ + { + "type": "Boolean/Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragTracker.html#Ext-dd-DragTracker-cfg-autoStart", + "shortDoc": "Defaults to false. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "name": "autoStart", + "owner": "Ext.dd.DragTracker", + "doc": "

Defaults to false. Specify true to defer trigger start by 1000 ms.\nSpecify a Number for the number of milliseconds to defer trigger start.

\n", + "linenr": 63, + "html_filename": "DragTracker.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ComponentDragger.js", - "linenr": 1, - "html_filename": "ComponentDragger.html", - "href": "ComponentDragger.html#Ext-util-ComponentDragger-method-constructor", - "shortDoc": "

Create a new ComponentTracker

\n" - }, - { - "tagname": "method", - "name": "addEvents", - "member": "Ext.util.Observable", - "doc": "

Adds the specified events to the list of events which this Observable may fire.

\n", - "params": [ - { - "type": "Object/String", - "name": "o", - "doc": "

Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.

\n", - "optional": false - }, - { - "type": "String", - "name": "", - "doc": "

[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:

\n\n
this.addEvents('storeloaded', 'storecleared');\n
\n\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "ComponentDragger.html#Ext-util-ComponentDragger-cfg-constrain", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/ComponentDragger.js", + "private": false, + "name": "constrain", + "owner": "Ext.util.ComponentDragger", + "doc": "

Specify as true to constrain the Component to within the bounds of the constrainTo region.

\n", + "linenr": 12, + "html_filename": "ComponentDragger.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 452, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-addEvents", - "shortDoc": "

Adds the specified events to the list of events which this Observable may fire.

\n" - }, - { - "tagname": "method", - "name": "addListener", - "member": "Ext.util.Observable", - "doc": "

Appends an event handler to this object.

\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The name of the event to listen for. May also be an object who's property names are event names. See

\n", - "optional": false - }, - { - "type": "Function", - "name": "handler", - "doc": "

The method the event invokes.

\n", - "optional": false - }, - { + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "ComponentDragger.html#Ext-util-ComponentDragger-cfg-constrainDelegate", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/ComponentDragger.js", + "private": false, + "name": "constrainDelegate", + "owner": "Ext.util.ComponentDragger", + "doc": "

Specify as true to constrain the drag handles within the constrainTo region.

\n", + "linenr": 24, + "html_filename": "ComponentDragger.html" + }, + { + "type": "Ext.util.Region/Element", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragTracker.html#Ext-dd-DragTracker-cfg-constrainTo", + "shortDoc": "A Region (Or an element from which a Region measurement will be read) which is used to constrain\nthe result of the ge...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "name": "constrainTo", + "owner": "Ext.dd.DragTracker", + "doc": "

A Region (Or an element from which a Region measurement will be read) which is used to constrain\nthe result of the getOffset call.

\n\n\n

This may be set any time during the DragTracker's lifecycle to set a dynamic constraining region.

\n\n", + "linenr": 49, + "html_filename": "DragTracker.html" + }, + { + "type": "String/Element", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "ComponentDragger.html#Ext-util-ComponentDragger-cfg-delegate", + "shortDoc": "Optional. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/ComponentDragger.js", + "private": false, + "name": "delegate", + "owner": "Ext.util.ComponentDragger", + "doc": "

Optional.

A DomQuery selector which identifies child elements within the Component's encapsulating\nElement which are the drag handles. This limits dragging to only begin when the matching elements are mousedowned.

\n\n

This may also be a specific child element within the Component's encapsulating element to use as the drag handle.

\n\n", + "linenr": 17, + "html_filename": "ComponentDragger.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Observable.html#Ext-util-Observable-cfg-listeners", + "shortDoc": "A config object containing one or more event handlers to be added to this object during initialization. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "name": "listeners", + "owner": "Ext.util.Observable", + "doc": "

A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.

\n\n

DOM events from ExtJS Components

\n\n

While some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:

\n\n
new Ext.panel.Panel({\n    width: 400,\n    height: 200,\n    dockedItems: [{\n        xtype: 'toolbar'\n    }],\n    listeners: {\n        click: {\n            element: 'el', //bind to the underlying el property on the panel\n            fn: function(){ console.log('click el'); }\n        },\n        dblclick: {\n            element: 'body', //bind to the underlying body property on the panel\n            fn: function(){ console.log('dblclick body'); }\n        }\n    }\n});\n
\n", + "linenr": 102, + "html_filename": "Observable.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragTracker.html#Ext-dd-DragTracker-cfg-overCls", + "shortDoc": "A CSS class to add to the DragTracker's target element when the element (or, if the delegate option is used,\nwhen a d...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "name": "overCls", + "owner": "Ext.dd.DragTracker", + "doc": "

A CSS class to add to the DragTracker's target element when the element (or, if the delegate option is used,\nwhen a delegate element) is mouseovered.

\n\n\n

If the delegate option is used, these events fire only when a delegate element is entered of left..

\n", + "linenr": 42, + "html_filename": "DragTracker.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragTracker.html#Ext-dd-DragTracker-cfg-preventDefault", + "shortDoc": "Specify false to enable default actions on onMouseDown events. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "name": "preventDefault", + "owner": "Ext.dd.DragTracker", + "doc": "

Specify false to enable default actions on onMouseDown events. Defaults to true.

\n", + "linenr": 77, + "html_filename": "DragTracker.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragTracker.html#Ext-dd-DragTracker-cfg-stopEvent", + "shortDoc": "Specify true to stop the mousedown event from bubbling to outer listeners from the target element (or its delegates). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "name": "stopEvent", + "owner": "Ext.dd.DragTracker", + "doc": "

Specify true to stop the mousedown event from bubbling to outer listeners from the target element (or its delegates). Defaults to false.

\n", + "linenr": 82, + "html_filename": "DragTracker.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragTracker.html#Ext-dd-DragTracker-cfg-tolerance", + "shortDoc": "Number of pixels the drag target must be moved before dragging is\nconsidered to have started. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "name": "tolerance", + "owner": "Ext.dd.DragTracker", + "doc": "

Number of pixels the drag target must be moved before dragging is\nconsidered to have started. Defaults to 5.

\n", + "linenr": 56, + "html_filename": "DragTracker.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "DragTracker.html#Ext-dd-DragTracker-cfg-trackOver", + "shortDoc": "Defaults to false. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "name": "trackOver", + "owner": "Ext.dd.DragTracker", + "doc": "

Defaults to false. Set to true to fire mouseover and mouseout events when the mouse enters or leaves the target element.

\n\n\n

This is implicitly set when an overCls is specified.

\n\n\n

If the delegate option is used, these events fire only when a delegate element is entered of left..

\n", + "linenr": 34, + "html_filename": "DragTracker.html" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "ComponentDragger.html#Ext-util-ComponentDragger-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates new ComponentDragger. ...", + "static": false, + "params": [ + { + "type": "object", + "optional": false, + "doc": "

The Component to provide dragging for.

\n", + "name": "comp" + }, + { + "type": "object", + "optional": true, + "doc": "

(optional) Config object

\n", + "name": "config" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/ComponentDragger.js", + "doc": "

Creates new ComponentDragger.

\n", + "owner": "Ext.util.ComponentDragger", + "name": "ComponentDragger", + "html_filename": "ComponentDragger.html", + "return": { "type": "Object", - "name": "scope", - "doc": "

(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.

\n", - "optional": true + "doc": "\n" }, - { - "type": "Object", - "name": "options", - "doc": "

(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:


\n\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n

myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n

myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
.\n

\n\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" + "linenr": 33 }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 271, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-addListener", - "shortDoc": "

Appends an event handler to this object.

\n" - }, - { - "tagname": "method", - "name": "addManagedListener", - "member": "Ext.util.Observable", - "doc": "

Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n", - "params": [ - { - "type": "Observable/Element", - "name": "item", - "doc": "

The item to which to add a listener/listeners.

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addEvents", + "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Object/String", + "optional": false, + "doc": "

Either an object with event names as properties with a value of true or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:

\n\n
this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
\n", + "name": "o" + }, + { + "type": "String...", + "optional": false, + "doc": "

Optional additional event names if multiple event names are being passed as separate\nparameters. Usage:

\n\n
this.addEvents('storeloaded', 'storecleared');\n
\n", + "name": "more" + } + ], + "name": "addEvents", + "owner": "Ext.util.Observable", + "doc": "

Adds the specified events to the list of events which this Observable may fire.

\n", + "linenr": 494, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object/String", - "name": "ename", - "doc": "

The event name, or an object containing event name properties.

\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addListener", + "shortDoc": "Appends an event handler to this object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The name of the event to listen for. May also be an object who's property names are\nevent names.

\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "

The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.

\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.

\n", + "name": "scope" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) An object containing handler configuration.

\n\n

Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

\n\n

This object may contain any of the following properties:

\n\n\n\n\n

Combining Options

\n\n

Using the options argument, it is possible to combine different types of listeners:

\n\n

A delayed, one-time listener.

\n\n
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
\n\n

Attaching multiple handlers in 1 call

\n\n

The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:

\n\n
myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n

One can also specify options for each event handler separately:

\n\n
myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n", + "name": "options" + } + ], + "name": "addListener", + "owner": "Ext.util.Observable", + "doc": "

Appends an event handler to this object.

\n", + "linenr": 278, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "fn", - "doc": "

Optional. If the ename parameter was an event name, this\nis the handler function.

\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addManagedListener", + "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable/Element", + "optional": false, + "doc": "

The item to which to add a listener/listeners.

\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "

The event name, or an object containing event name properties.

\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the handler function.

\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", + "name": "scope" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the\naddListener options.

\n", + "name": "opt" + } + ], + "name": "addManagedListener", + "owner": "Ext.util.Observable", + "doc": "

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.

\n", + "linenr": 156, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.

\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-addStatics", + "shortDoc": "Add / override static properties of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "addStatics", + "owner": "Ext.Base", + "doc": "

Add / override static properties of this class.

\n\n
Ext.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
\n", + "linenr": 388, + "return": { + "type": "Ext.Base", + "doc": "

this

\n" }, - { - "type": "Object", - "name": "opt", - "doc": "

Optional. If the ename parameter was an event name, this\nis the addListener options.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 155, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-addManagedListener", - "shortDoc": "

Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n" - }, - { - "tagname": "method", - "name": "capture", - "member": "Ext.util.Observable", - "doc": "

Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.

\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "

The Observable to capture events from.

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callOverridden", + "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n constructo...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "

The arguments, either an array or the arguments object

\n", + "name": "args" + } + ], + "name": "callOverridden", + "owner": "Ext.Base", + "doc": "

Call the original method that was previously overridden with Ext.Base.override

\n\n
Ext.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
\n", + "linenr": 269, + "return": { + "type": "Mixed", + "doc": "

Returns the result after calling the overridden method

\n" }, - { - "type": "Function", - "name": "fn", - "doc": "

The function to call when an event is fired.

\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callParent", + "shortDoc": "Call the parent's overridden method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "

The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)

\n", + "name": "args" + } + ], + "name": "callParent", + "owner": "Ext.Base", + "doc": "

Call the parent's overridden method. For example:

\n\n
Ext.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
\n", + "linenr": 124, + "return": { + "type": "Mixed", + "doc": "

Returns the result from the superclass' method

\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Base3.html" }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 55, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-capture", - "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..." - }, - { - "tagname": "method", - "name": "clearListeners", - "member": "Ext.util.Observable", - "doc": "

Removes all listeners for this object including the managed listeners

\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-capture", + "shortDoc": "Starts capture on the specified Observable. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable", + "optional": false, + "doc": "

The Observable to capture events from.

\n", + "name": "o" + }, + { + "type": "Function", + "optional": false, + "doc": "

The function to call when an event is fired.

\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) The scope (this reference) in which the function is executed. Defaults to\nthe Observable firing the event.

\n", + "name": "scope" + } + ], + "name": "capture", + "owner": "Ext.util.Observable", + "doc": "

Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event before the event is fired. If the supplied function returns false,\nthe event will not fire.

\n", + "linenr": 54, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 383, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-clearListeners", - "shortDoc": "

Removes all listeners for this object including the managed listeners

\n" - }, - { - "tagname": "method", - "name": "clearManagedListeners", - "member": "Ext.util.Observable", - "doc": "

Removes all managed listeners for this object.

\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-clearListeners", + "shortDoc": "Removes all listeners for this object including the managed listeners ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 412, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", - "shortDoc": "

Removes all managed listeners for this object.

\n" - }, - { - "tagname": "method", - "name": "enableBubble", - "member": "Ext.util.Observable", - "doc": "

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.

\n\n\n

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.

\n\n\n

Example:

\n\n\n
Ext.override(Ext.form.field.Base, {\n//  Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n    this.enableBubble('change');\n}),\n\n//  We know that we want Field's events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n    if (!this.formPanel) {\n        this.formPanel = this.findParentByType('form');\n    }\n    return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n    ...\n}],\nlisteners: {\n    change: function() {\n        // Title goes red if form has been modified.\n        myForm.header.setStyle('color', 'red');\n    }\n}\n});\n
\n\n", - "params": [ - { - "type": "String/Array", - "name": "events", - "doc": "

The event name to bubble, or an Array of event names.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 554, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-enableBubble", - "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...." - }, - { - "tagname": "method", - "name": "fireEvent", - "member": "Ext.util.Observable", - "doc": "

Fires the specified event with the passed parameters (minus the event name).

\n\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.

\n\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The name of the event to fire.

\n", - "optional": false + ], + "name": "clearListeners", + "owner": "Ext.util.Observable", + "doc": "

Removes all listeners for this object including the managed listeners

\n", + "linenr": 425, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object...", - "name": "args", - "doc": "

Variable number of parameters are passed to handlers.

\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "

returns false if any of the handlers return false otherwise it returns true.

\n" + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 232, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-fireEvent", - "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..." - }, - { - "tagname": "method", - "name": "getDragTarget", - "member": "Ext.dd.DragTracker", - "doc": "

Returns the drag target. This is usually the DragTracker's encapsulating element.

\n\n

If the delegate option is being used, this may be a child element which matches the\ndelegate selector.

\n\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", + "shortDoc": "Removes all managed listeners for this object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ - ], - "return": { - "type": "Ext.core.Element", - "doc": "

The element currently being tracked.

\n" + ], + "name": "clearManagedListeners", + "owner": "Ext.util.Observable", + "doc": "

Removes all managed listeners for this object.

\n", + "linenr": 454, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 417, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-method-getDragTarget", - "shortDoc": "Returns the drag target. This is usually the DragTracker's encapsulating element.\n\nIf the delegate option is being us..." - }, - { - "tagname": "method", - "name": "getOffset", - "member": "Ext.dd.DragTracker", - "doc": "

Returns the X, Y offset of the current mouse position from the mousedown point.

\n\n\n

This method may optionally constrain the real offset values, and returns a point coerced in one\nof two modes:

\n\n\n\n\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-create", + "shortDoc": "Create a new instance of this Class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "create", + "owner": "Ext.Base", + "doc": "

Create a new instance of this Class.

\n\n
Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n
\n\n

All parameters are passed to the constructor of the class.

\n", + "linenr": 329, + "return": { "type": "Object", - "name": "constrainMode", - "doc": "

{String} Optional. If omitted the true mouse position is returned. May be passed\nas 'point' or 'dragTarget'. See above..

\n", - "optional": false - } - ], - "return": { - "type": "Array", - "doc": "

The X, Y offset from the mousedown point, optionally constrained.

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 461, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-method-getOffset", - "shortDoc": "Returns the X, Y offset of the current mouse position from the mousedown point.\n\n\nThis method may optionally constrai..." - }, - { - "tagname": "method", - "name": "hasListener", - "member": "Ext.util.Observable", - "doc": "

Checks to see if this object has any listeners for a specified event

\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The name of the event to check for

\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "

True if the event is being listened for, else false

\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 480, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-hasListener", - "shortDoc": "

Checks to see if this object has any listeners for a specified event

\n" - }, - { - "tagname": "method", - "name": "initEl", - "member": "Ext.dd.DragTracker", - "doc": "

Initializes the DragTracker on a given element.

\n", - "params": [ - { - "type": "Ext.core.Element/HTMLElement", - "name": "el", - "doc": "

The element

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "doc": "

the created instance.

\n" + }, + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 176, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-method-initEl", - "shortDoc": "

Initializes the DragTracker on a given element.

\n" - }, - { - "tagname": "method", - "name": "observe", - "member": "Ext.util.Observable", - "doc": "

Sets observability on the passed class constructor.

\n\n

This makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.

\n\n

Usage:

\n\n
Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n
\n", - "params": [ - { - "type": "Function", - "name": "c", - "doc": "

The class constructor to make observable.

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-createAlias", + "shortDoc": "Create aliases for existing prototype methods. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "String/Object", + "optional": false, + "doc": "

The new method name, or an object to set multiple aliases. See\nflexSetter

\n", + "name": "alias" + }, + { + "type": "String/Object", + "optional": false, + "doc": "

The original method name

\n", + "name": "origin" + } + ], + "name": "createAlias", + "owner": "Ext.Base", + "doc": "

Create aliases for existing prototype methods. Example:

\n\n
Ext.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
\n", + "linenr": 648, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "listeners", - "doc": "

An object containing a series of listeners to add. See addListener.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Base3.html" }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 69, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-observe", - "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..." - }, - { - "tagname": "method", - "name": "on", - "member": "Ext.util.Observable", - "doc": "

Appends an event handler to this object (shorthand for addListener.)

\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The type of event to listen for

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-enableBubble", + "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String/[String]", + "optional": false, + "doc": "

The event name to bubble, or an Array of event names.

\n", + "name": "events" + } + ], + "name": "enableBubble", + "owner": "Ext.util.Observable", + "doc": "

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. There is no implementation in the Observable base class.

\n\n

This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.

\n\n

Example:

\n\n
Ext.override(Ext.form.field.Base, {\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n        this.enableBubble('change');\n    }),\n\n    //  We know that we want Field's events to bubble directly to the FormPanel.\n    getBubbleTarget : function() {\n        if (!this.formPanel) {\n            this.formPanel = this.findParentByType('form');\n        }\n        return this.formPanel;\n    }\n});\n\nvar myForm = new Ext.formPanel({\n    title: 'User Details',\n    items: [{\n        ...\n    }],\n    listeners: {\n        change: function() {\n            // Title goes red if form has been modified.\n            myForm.header.setStyle('color', 'red');\n        }\n    }\n});\n
\n", + "linenr": 609, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "

The method the event invokes

\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-fireEvent", + "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The name of the event to fire.

\n", + "name": "eventName" + }, + { + "type": "Object...", + "optional": false, + "doc": "

Variable number of parameters are passed to handlers.

\n", + "name": "args" + } + ], + "name": "fireEvent", + "owner": "Ext.util.Observable", + "doc": "

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).

\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.

\n", + "linenr": 233, + "return": { + "type": "Boolean", + "doc": "

returns false if any of the handlers return false otherwise it returns true.

\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.

\n", - "optional": true + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DragTracker.html#Ext-dd-DragTracker-method-getDragTarget", + "shortDoc": "Returns the drag target. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + + ], + "name": "getDragTarget", + "owner": "Ext.dd.DragTracker", + "doc": "

Returns the drag target. This is usually the DragTracker's encapsulating element.

\n\n

If the delegate option is being used, this may be a child element which matches the\ndelegate selector.

\n\n", + "linenr": 417, + "return": { + "type": "Ext.core.Element", + "doc": "

The element currently being tracked.

\n" }, - { - "type": "Object", - "name": "options", - "doc": "

(optional) An object containing handler configuration.

\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "DragTracker.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 616, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-on", - "shortDoc": "

Appends an event handler to this object (shorthand for addListener.)

\n" - }, - { - "tagname": "method", - "name": "onBeforeStart", - "member": "Ext.dd.DragTracker", - "doc": "

Template method which should be overridden by each DragTracker instance. Called when the user first clicks and\nholds the mouse button down. Return false to disallow the drag

\n", - "params": [ - { - "type": "Ext.EventObject", - "name": "e", - "doc": "

The event object

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-getName", + "shortDoc": "Get the current class' name in string format. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "getName", + "owner": "Ext.Base", + "doc": "

Get the current class' name in string format.

\n\n
Ext.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
\n", + "linenr": 631, + "return": { + "type": "String", + "doc": "

className

\n" + }, + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 382, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-method-onBeforeStart", - "shortDoc": "Template method which should be overridden by each DragTracker instance. Called when the user first clicks and\nholds ..." - }, - { - "tagname": "method", - "name": "onDrag", - "member": "Ext.dd.DragTracker", - "doc": "

Template method which should be overridden by each DragTracker instance. Called whenever a drag has been detected.

\n", - "params": [ - { - "type": "Ext.EventObject", - "name": "e", - "doc": "

The event object

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DragTracker.html#Ext-dd-DragTracker-method-getOffset", + "shortDoc": "Returns the X, Y offset of the current mouse position from the mousedown point. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

{String} Optional. If omitted the true mouse position is returned. May be passed\nas 'point' or 'dragTarget'. See above..

\n", + "name": "constrainMode" + } + ], + "name": "getOffset", + "owner": "Ext.dd.DragTracker", + "doc": "

Returns the X, Y offset of the current mouse position from the mousedown point.

\n\n\n

This method may optionally constrain the real offset values, and returns a point coerced in one\nof two modes:

\n\n\n\n\n", + "linenr": 461, + "return": { + "type": "Array", + "doc": "

The X, Y offset from the mousedown point, optionally constrained.

\n" + }, + "html_filename": "DragTracker.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 400, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-method-onDrag", - "shortDoc": "

Template method which should be overridden by each DragTracker instance. Called whenever a drag has been detected.

\n" - }, - { - "tagname": "method", - "name": "onEnd", - "member": "Ext.dd.DragTracker", - "doc": "

Template method which should be overridden by each DragTracker instance. Called when a drag operation has been completed\n(e.g. the user clicked and held the mouse down, dragged the element and then released the mouse button)

\n", - "params": [ - { - "type": "Ext.EventObject", - "name": "e", - "doc": "

The event object

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-hasListener", + "shortDoc": "Checks to see if this object has any listeners for a specified event ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The name of the event to check for

\n", + "name": "eventName" + } + ], + "name": "hasListener", + "owner": "Ext.util.Observable", + "doc": "

Checks to see if this object has any listeners for a specified event

\n", + "linenr": 530, + "return": { + "type": "Boolean", + "doc": "

True if the event is being listened for, else false

\n" + }, + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 408, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-method-onEnd", - "shortDoc": "Template method which should be overridden by each DragTracker instance. Called when a drag operation has been comple..." - }, - { - "tagname": "method", - "name": "onStart", - "member": "Ext.dd.DragTracker", - "doc": "

Template method which should be overridden by each DragTracker instance. Called when a drag operation starts\n(e.g. the user has moved the tracked element beyond the specified tolerance)

\n", - "params": [ - { - "type": "Ext.EventObject", - "name": "e", - "doc": "

The event object

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-implement", + "shortDoc": "Add methods / properties to the prototype of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "implement", + "owner": "Ext.Base", + "doc": "

Add methods / properties to the prototype of this class.

\n\n
Ext.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
\n", + "linenr": 415, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 391, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-method-onStart", - "shortDoc": "Template method which should be overridden by each DragTracker instance. Called when a drag operation starts\n(e.g. th..." - }, - { - "tagname": "method", - "name": "relayEvents", - "member": "Ext.util.Observable", - "doc": "

Relays selected events from the specified Observable as if the events were fired by this.

\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-initConfig", + "shortDoc": "Initialize configuration for this class. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "config" + } + ], + "name": "initConfig", + "owner": "Ext.Base", + "doc": "

Initialize configuration for this class. a typical example:

\n\n
Ext.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
\n", + "linenr": 63, + "return": { "type": "Object", - "name": "origin", - "doc": "

The Observable whose events this object is to relay.

\n", - "optional": false + "doc": "

mixins The mixin prototypes as key - value pairs

\n" }, - { - "type": "Array", - "name": "events", - "doc": "

Array of event names to relay.

\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DragTracker.html#Ext-dd-DragTracker-method-initEl", + "shortDoc": "Initializes the DragTracker on a given element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Ext.core.Element/HTMLElement", + "optional": false, + "doc": "

The element

\n", + "name": "el" + } + ], + "name": "initEl", + "owner": "Ext.dd.DragTracker", + "doc": "

Initializes the DragTracker on a given element.

\n", + "linenr": 176, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "prefix", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "DragTracker.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 520, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-relayEvents", - "shortDoc": "

Relays selected events from the specified Observable as if the events were fired by this.

\n" - }, - { - "tagname": "method", - "name": "releaseCapture", - "member": "Ext.util.Observable", - "doc": "

Removes all added captures from the Observable.

\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "

The Observable to release

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addManagedListener" + }, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-mon", + "shortDoc": "Shorthand for addManagedListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable/Element", + "optional": false, + "doc": "

The item to which to add a listener/listeners.

\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "

The event name, or an object containing event name properties.

\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the handler function.

\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", + "name": "scope" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) If the ename parameter was an event name, this is the\naddListener options.

\n", + "name": "opt" + } + ], + "name": "mon", + "owner": "Ext.util.Observable", + "doc": "

Shorthand for addManagedListener.

\n\n

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.

\n", + "linenr": 681, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 46, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-releaseCapture", - "shortDoc": "

Removes all added captures from the Observable.

\n" - }, - { - "tagname": "method", - "name": "removeListener", - "member": "Ext.util.Observable", - "doc": "

Removes an event handler.

\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The type of event the handler was associated with.

\n", - "optional": false + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeManagedListener" }, - { - "type": "Function", - "name": "handler", - "doc": "

The handler to remove. This must be a reference to the function passed into the addListener call.

\n", - "optional": false + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-mun", + "shortDoc": "Shorthand for removeManagedListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable|Element", + "optional": false, + "doc": "

The item from which to remove a listener/listeners.

\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "

The event name, or an object containing event name properties.

\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "

Optional. If the ename parameter was an event name, this is the handler function.

\n", + "name": "fn" + }, + { + "type": "Object", + "optional": false, + "doc": "

Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", + "name": "scope" + } + ], + "name": "mun", + "owner": "Ext.util.Observable", + "doc": "

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

\n", + "linenr": 687, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

(optional) The scope originally specified for the handler.

\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 352, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-removeListener", - "shortDoc": "

Removes an event handler.

\n" - }, - { - "tagname": "method", - "name": "removeManagedListener", - "member": "Ext.util.Observable", - "doc": "

Removes listeners that were added by the mon method.

\n", - "params": [ - { - "type": "Observable|Element", - "name": "item", - "doc": "

The item from which to remove a listener/listeners.

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-observe", + "shortDoc": "Sets observability on the passed class constructor. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Function", + "optional": false, + "doc": "

The class constructor to make observable.

\n", + "name": "c" + }, + { + "type": "Object", + "optional": false, + "doc": "

An object containing a series of listeners to add. See addListener.

\n", + "name": "listeners" + } + ], + "name": "observe", + "owner": "Ext.util.Observable", + "doc": "

Sets observability on the passed class constructor.

\n\n

This makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.

\n\n

Usage:

\n\n
Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n
\n", + "linenr": 69, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object|String", - "name": "ename", - "doc": "

The event name, or an object containing event name properties.

\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addListener" }, - { - "type": "Function", - "name": "fn", - "doc": "

Optional. If the ename parameter was an event name, this\nis the handler function.

\n", - "optional": false + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-on", + "shortDoc": "Shorthand for addListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The name of the event to listen for. May also be an object who's property names are\nevent names.

\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "

The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.

\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.

\n", + "name": "scope" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) An object containing handler configuration.

\n\n

Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

\n\n

This object may contain any of the following properties:

\n\n\n\n\n

Combining Options

\n\n

Using the options argument, it is possible to combine different types of listeners:

\n\n

A delayed, one-time listener.

\n\n
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
\n\n

Attaching multiple handlers in 1 call

\n\n

The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:

\n\n
myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n

One can also specify options for each event handler separately:

\n\n
myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n", + "name": "options" + } + ], + "name": "on", + "owner": "Ext.util.Observable", + "doc": "

Shorthand for addListener.

\n\n

Appends an event handler to this object.

\n", + "linenr": 669, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 196, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", - "shortDoc": "

Removes listeners that were added by the mon method.

\n" - }, - { - "tagname": "method", - "name": "resumeEvents", - "member": "Ext.util.Observable", - "doc": "

Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.

\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DragTracker.html#Ext-dd-DragTracker-method-onBeforeStart", + "shortDoc": "Template method which should be overridden by each DragTracker instance. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Ext.EventObject", + "optional": false, + "doc": "

The event object

\n", + "name": "e" + } + ], + "name": "onBeforeStart", + "owner": "Ext.dd.DragTracker", + "doc": "

Template method which should be overridden by each DragTracker instance. Called when the user first clicks and\nholds the mouse button down. Return false to disallow the drag

\n", + "linenr": 382, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "DragTracker.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 502, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-resumeEvents", - "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..." - }, - { - "tagname": "method", - "name": "suspendEvents", - "member": "Ext.util.Observable", - "doc": "

Suspend the firing of all events. (see resumeEvents)

\n", - "params": [ - { - "type": "Boolean", - "name": "queueSuspended", - "doc": "

Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DragTracker.html#Ext-dd-DragTracker-method-onDrag", + "shortDoc": "Template method which should be overridden by each DragTracker instance. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Ext.EventObject", + "optional": false, + "doc": "

The event object

\n", + "name": "e" + } + ], + "name": "onDrag", + "owner": "Ext.dd.DragTracker", + "doc": "

Template method which should be overridden by each DragTracker instance. Called whenever a drag has been detected.

\n", + "linenr": 400, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "DragTracker.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 490, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-suspendEvents", - "shortDoc": "

Suspend the firing of all events. (see resumeEvents)

\n" - }, - { - "tagname": "method", - "name": "un", - "member": "Ext.util.Observable", - "doc": "

Removes an event handler (shorthand for removeListener.)

\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "

The type of event the handler was associated with.

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DragTracker.html#Ext-dd-DragTracker-method-onEnd", + "shortDoc": "Template method which should be overridden by each DragTracker instance. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Ext.EventObject", + "optional": false, + "doc": "

The event object

\n", + "name": "e" + } + ], + "name": "onEnd", + "owner": "Ext.dd.DragTracker", + "doc": "

Template method which should be overridden by each DragTracker instance. Called when a drag operation has been completed\n(e.g. the user clicked and held the mouse down, dragged the element and then released the mouse button)

\n", + "linenr": 408, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "

The handler to remove. This must be a reference to the function passed into the addListener call.

\n", - "optional": false + "html_filename": "DragTracker.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "DragTracker.html#Ext-dd-DragTracker-method-onStart", + "shortDoc": "Template method which should be overridden by each DragTracker instance. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Ext.EventObject", + "optional": false, + "doc": "

The event object

\n", + "name": "e" + } + ], + "name": "onStart", + "owner": "Ext.dd.DragTracker", + "doc": "

Template method which should be overridden by each DragTracker instance. Called when a drag operation starts\n(e.g. the user has moved the tracked element beyond the specified tolerance)

\n", + "linenr": 391, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "

(optional) The scope originally specified for the handler.

\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "DragTracker.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 608, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-un", - "shortDoc": "

Removes an event handler (shorthand for removeListener.)

\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "active", - "member": "Ext.dd.DragTracker", - "type": "Boolean", - "doc": "

Read-only property indicated whether the user is currently dragging this\ntracker.

\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 18, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-property-active" - }, - { - "tagname": "property", - "name": "dragTarget", - "member": "Ext.dd.DragTracker", - "type": "HtmlElement", - "doc": "

Only valid during drag operations. Read-only.

\n\n\n

The element being dragged.

\n\n\n

If the delegate option is used, this will be the delegate element which was mousedowned.

\n\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 26, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-property-dragTarget", - "shortDoc": "Only valid during drag operations. Read-only.\n\n\nThe element being dragged.\n\n\nIf the delegate option is used, this wil..." - } - ], - "event": [ - { - "tagname": "event", - "name": "beforestart", - "member": "Ext.dd.DragTracker", - "doc": "\n", - "params": [ - { - "type": "Object", - "name": "this", - "doc": "\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-override", + "shortDoc": "Override prototype members of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "override", + "owner": "Ext.Base", + "doc": "

Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden

\n\n
Ext.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
\n", + "linenr": 518, + "return": { + "type": "Ext.Base", + "doc": "

this

\n" }, - { - "type": "Object", - "name": "e", - "doc": "

event object

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 133, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-event-beforestart", - "shortDoc": "\n" - }, - { - "tagname": "event", - "name": "drag", - "member": "Ext.dd.DragTracker", - "doc": "\n", - "params": [ - { - "type": "Object", - "name": "this", - "doc": "\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-relayEvents", + "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

The Observable whose events this object is to relay.

\n", + "name": "origin" + }, + { + "type": "[String]", + "optional": false, + "doc": "

Array of event names to relay.

\n", + "name": "events" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "prefix" + } + ], + "name": "relayEvents", + "owner": "Ext.util.Observable", + "doc": "

Relays selected events from the specified Observable as if the events were fired by this.

\n", + "linenr": 573, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "e", - "doc": "

event object

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 154, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-event-drag", - "shortDoc": "\n" - }, - { - "tagname": "event", - "name": "dragend", - "member": "Ext.dd.DragTracker", - "doc": "\n", - "params": [ - { - "type": "Object", - "name": "this", - "doc": "\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-releaseCapture", + "shortDoc": "Removes all added captures from the Observable. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable", + "optional": false, + "doc": "

The Observable to release

\n", + "name": "o" + } + ], + "name": "releaseCapture", + "owner": "Ext.util.Observable", + "doc": "

Removes all added captures from the Observable.

\n", + "linenr": 44, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "e", - "doc": "

event object

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 147, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-event-dragend", - "shortDoc": "\n" - }, - { - "tagname": "event", - "name": "dragstart", - "member": "Ext.dd.DragTracker", - "doc": "\n", - "params": [ - { - "type": "Object", - "name": "this", - "doc": "\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-removeListener", + "shortDoc": "Removes an event handler. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The type of event the handler was associated with.

\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "

The handler to remove. This must be a reference to the function passed into the\naddListener call.

\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) The scope originally specified for the handler.

\n", + "name": "scope" + } + ], + "name": "removeListener", + "owner": "Ext.util.Observable", + "doc": "

Removes an event handler.

\n", + "linenr": 392, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "e", - "doc": "

event object

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 140, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-event-dragstart", - "shortDoc": "\n" - }, - { - "tagname": "event", - "name": "mousedown", - "member": "Ext.dd.DragTracker", - "doc": "

Fires when the mouse button is pressed down, but before a drag operation begins. The\ndrag operation begins after either the mouse has been moved by tolerance pixels, or after\nthe autoStart timer fires.

\n\n\n

Return false to veto the drag operation.

\n\n", - "params": [ - { - "type": "Object", - "name": "this", - "doc": "\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", + "shortDoc": "Removes listeners that were added by the mon method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable|Element", + "optional": false, + "doc": "

The item from which to remove a listener/listeners.

\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "

The event name, or an object containing event name properties.

\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "

Optional. If the ename parameter was an event name, this is the handler function.

\n", + "name": "fn" + }, + { + "type": "Object", + "optional": false, + "doc": "

Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.

\n", + "name": "scope" + } + ], + "name": "removeManagedListener", + "owner": "Ext.util.Observable", + "doc": "

Removes listeners that were added by the mon method.

\n", + "linenr": 197, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "e", - "doc": "

event object

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 109, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-event-mousedown", - "shortDoc": "Fires when the mouse button is pressed down, but before a drag operation begins. The\ndrag operation begins after eith..." - }, - { - "tagname": "event", - "name": "mousemove", - "member": "Ext.dd.DragTracker", - "doc": "

Fired when the mouse is moved. Returning false cancels the drag operation.

\n", - "params": [ - { - "type": "Object", - "name": "this", - "doc": "\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-resumeEvents", + "shortDoc": "Resumes firing events (see suspendEvents). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + + ], + "name": "resumeEvents", + "owner": "Ext.util.Observable", + "doc": "

Resumes firing events (see suspendEvents).

\n\n

If events were suspended using the **queueSuspended** parameter, then all events fired\nduring event suspension will be sent to any listeners now.

\n", + "linenr": 554, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "e", - "doc": "

event object

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 126, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-event-mousemove", - "shortDoc": "

Fired when the mouse is moved. Returning false cancels the drag operation.

\n" - }, - { - "tagname": "event", - "name": "mouseout", - "member": "Ext.dd.DragTracker", - "doc": "

Only available when trackOver is true

\n\n\n

Fires when the mouse exits the DragTracker's target element (or if delegate is\nused, when the mouse exits a delegate element).

\n\n", - "params": [ - { - "type": "Object", - "name": "this", - "doc": "\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-statics", + "shortDoc": "Get the reference to the class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "statics", + "owner": "Ext.Base", + "doc": "

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base.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

\n\n
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
\n", + "linenr": 199, + "return": { + "type": "Class", + "doc": "\n" }, - { - "type": "Object", - "name": "e", - "doc": "

event object

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 100, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-event-mouseout", - "shortDoc": "Only available when trackOver is true\n\n\nFires when the mouse exits the DragTracker's target element (or if delegate i..." - }, - { - "tagname": "event", - "name": "mouseover", - "member": "Ext.dd.DragTracker", - "doc": "

Only available when trackOver is true

\n\n\n

Fires when the mouse enters the DragTracker's target element (or if delegate is\nused, when the mouse enters a delegate element).

\n\n", - "params": [ - { - "type": "Object", - "name": "this", - "doc": "\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-suspendEvents", + "shortDoc": "Suspends the firing of all events. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Boolean", + "optional": false, + "doc": "

Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.

\n", + "name": "queueSuspended" + } + ], + "name": "suspendEvents", + "owner": "Ext.util.Observable", + "doc": "

Suspends the firing of all events. (see resumeEvents)

\n", + "linenr": 541, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "e", - "doc": "

event object

\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeListener" }, - { - "type": "HtmlElement", - "name": "target", - "doc": "

The element mouseovered.

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 90, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-event-mouseover", - "shortDoc": "Only available when trackOver is true\n\n\nFires when the mouse enters the DragTracker's target element (or if delegate ..." - }, - { - "tagname": "event", - "name": "mouseup", - "member": "Ext.dd.DragTracker", - "doc": "\n", - "params": [ - { - "type": "Object", - "name": "this", - "doc": "\n", - "optional": false + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-un", + "shortDoc": "Shorthand for removeListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The type of event the handler was associated with.

\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "

The handler to remove. This must be a reference to the function passed into the\naddListener call.

\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "

(optional) The scope originally specified for the handler.

\n", + "name": "scope" + } + ], + "name": "un", + "owner": "Ext.util.Observable", + "doc": "

Shorthand for removeListener.

\n\n

Removes an event handler.

\n", + "linenr": 675, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "e", - "doc": "

event object

\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/dd/DragTracker.js", - "linenr": 119, - "html_filename": "DragTracker.html", - "href": "DragTracker.html#Ext-dd-DragTracker-event-mouseup", - "shortDoc": "\n" - } - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/ComponentDragger.js", - "linenr": 1, - "html_filename": "ComponentDragger.html", - "href": "ComponentDragger.html#Ext-util-ComponentDragger", - "cssVar": [ + "html_filename": "Observable.html" + } + ], + "property": [ + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "DragTracker.html#Ext-dd-DragTracker-property-active", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "name": "active", + "owner": "Ext.dd.DragTracker", + "doc": "

Read-only property indicated whether the user is currently dragging this\ntracker.

\n", + "linenr": 18, + "html_filename": "DragTracker.html" + }, + { + "type": "HtmlElement", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "DragTracker.html#Ext-dd-DragTracker-property-dragTarget", + "shortDoc": "Only valid during drag operations. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "name": "dragTarget", + "owner": "Ext.dd.DragTracker", + "doc": "

Only valid during drag operations. Read-only.

\n\n\n

The element being dragged.

\n\n\n

If the delegate option is used, this will be the delegate element which was mousedowned.

\n\n", + "linenr": 26, + "html_filename": "DragTracker.html" + }, + { + "type": "Class", + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "property", + "href": "Base3.html#Ext-Base-property-self", + "shortDoc": "Get the reference to the current class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "name": "self", + "owner": "Ext.Base", + "doc": "

Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.statics\nfor a detailed comparison

\n\n
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
\n", + "linenr": 18, + "html_filename": "Base3.html" + } + ], + "cssVar": [ - ], - "cssMixin": [ + ], + "cssMixin": [ - ], - "component": false, + ], + "event": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "DragTracker.html#Ext-dd-DragTracker-event-beforestart", + "shortDoc": " ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "

event object

\n", + "name": "e" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" + } + ], + "name": "beforestart", + "owner": "Ext.dd.DragTracker", + "doc": "\n", + "linenr": 133, + "html_filename": "DragTracker.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "DragTracker.html#Ext-dd-DragTracker-event-drag", + "shortDoc": " ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "

event object

\n", + "name": "e" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" + } + ], + "name": "drag", + "owner": "Ext.dd.DragTracker", + "doc": "\n", + "linenr": 154, + "html_filename": "DragTracker.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "DragTracker.html#Ext-dd-DragTracker-event-dragend", + "shortDoc": " ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "

event object

\n", + "name": "e" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" + } + ], + "name": "dragend", + "owner": "Ext.dd.DragTracker", + "doc": "\n", + "linenr": 147, + "html_filename": "DragTracker.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "DragTracker.html#Ext-dd-DragTracker-event-dragstart", + "shortDoc": " ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "

event object

\n", + "name": "e" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" + } + ], + "name": "dragstart", + "owner": "Ext.dd.DragTracker", + "doc": "\n", + "linenr": 140, + "html_filename": "DragTracker.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "DragTracker.html#Ext-dd-DragTracker-event-mousedown", + "shortDoc": "Fires when the mouse button is pressed down, but before a drag operation begins. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "

event object

\n", + "name": "e" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" + } + ], + "name": "mousedown", + "owner": "Ext.dd.DragTracker", + "doc": "

Fires when the mouse button is pressed down, but before a drag operation begins. The\ndrag operation begins after either the mouse has been moved by tolerance pixels, or after\nthe autoStart timer fires.

\n\n\n

Return false to veto the drag operation.

\n\n", + "linenr": 109, + "html_filename": "DragTracker.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "DragTracker.html#Ext-dd-DragTracker-event-mousemove", + "shortDoc": "Fired when the mouse is moved. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "

event object

\n", + "name": "e" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" + } + ], + "name": "mousemove", + "owner": "Ext.dd.DragTracker", + "doc": "

Fired when the mouse is moved. Returning false cancels the drag operation.

\n", + "linenr": 126, + "html_filename": "DragTracker.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "DragTracker.html#Ext-dd-DragTracker-event-mouseout", + "shortDoc": "Only available when trackOver is true\n\n\nFires when the mouse exits the DragTracker's target element (or if delegate i...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "

event object

\n", + "name": "e" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" + } + ], + "name": "mouseout", + "owner": "Ext.dd.DragTracker", + "doc": "

Only available when trackOver is true

\n\n\n

Fires when the mouse exits the DragTracker's target element (or if delegate is\nused, when the mouse exits a delegate element).

\n\n", + "linenr": 100, + "html_filename": "DragTracker.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "DragTracker.html#Ext-dd-DragTracker-event-mouseover", + "shortDoc": "Only available when trackOver is true\n\n\nFires when the mouse enters the DragTracker's target element (or if delegate ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "

event object

\n", + "name": "e" + }, + { + "type": "HtmlElement", + "optional": false, + "doc": "

The element mouseovered.

\n", + "name": "target" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" + } + ], + "name": "mouseover", + "owner": "Ext.dd.DragTracker", + "doc": "

Only available when trackOver is true

\n\n\n

Fires when the mouse enters the DragTracker's target element (or if delegate is\nused, when the mouse enters a delegate element).

\n\n", + "linenr": 90, + "html_filename": "DragTracker.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "DragTracker.html#Ext-dd-DragTracker-event-mouseup", + "shortDoc": " ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/dd/DragTracker.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "

event object

\n", + "name": "e" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "

The options object passed to Ext.util.Observable.addListener.

\n" + } + ], + "name": "mouseup", + "owner": "Ext.dd.DragTracker", + "doc": "\n", + "linenr": 119, + "html_filename": "DragTracker.html" + } + ] + }, + "singleton": false, + "alias": null, "superclasses": [ + "Ext.Base", "Ext.dd.DragTracker" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "ComponentDragger.html#Ext-util-ComponentDragger", "subclasses": [ ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/ComponentDragger.js", + "private": false, + "alternateClassNames": [ + + ], + "name": "Ext.util.ComponentDragger", + "doc": "

A subclass of Ext.dd.DragTracker which handles dragging any Component.

\n\n\n

This is configured with a Component to be made draggable, and a config object for the\nExt.dd.DragTracker class.

\n\n\n

A delegate may be provided which may be either the element to use as the mousedown target\nor a Ext.DomQuery selector to activate multiple mousedown targets.

\n\n", "mixedInto": [ ], - "allMixins": [ - "Ext.util.Observable" - ] + "linenr": 1, + "xtypes": [ + + ], + "html_filename": "ComponentDragger.html", + "extends": "Ext.dd.DragTracker" }); \ No newline at end of file