X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..6746dc89c47ed01b165cc1152533605f97eb8e8d:/docs/output/Ext.draw.engine.Svg.js diff --git a/docs/output/Ext.draw.engine.Svg.js b/docs/output/Ext.draw.engine.Svg.js index 4cb51282..7dbb1dce 100644 --- a/docs/output/Ext.draw.engine.Svg.js +++ b/docs/output/Ext.draw.engine.Svg.js @@ -1,1091 +1,1624 @@ Ext.data.JsonP.Ext_draw_engine_Svg({ - "tagname": "class", - "name": "Ext.draw.engine.Svg", - "doc": "

Provides specific methods to draw with SVG.

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

The height of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset see Ext.Component.anchor.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 199, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-cfg-height", - "shortDoc": "The height of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset s..." - }, - { - "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": "width", - "member": "Ext.draw.Surface", - "type": "Number", - "doc": "

The width of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset see Ext.Component.anchor.

\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 204, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-cfg-width", - "shortDoc": "The width of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset se..." - } - ], - "method": [ - { - "tagname": "method", - "name": "add", - "member": "Ext.draw.Surface", - "doc": "

Add a Sprite to the surface. See Ext.draw.Sprite for the configuration object to be passed into this method.

\n\n

For example:

\n\n
drawComponent.surface.add({\n    type: 'circle',\n    fill: '#ffc',\n    radius: 100,\n    x: 100,\n    y: 100\n});\n
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" + "members": { + "cfg": [ + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Surface.html#Ext-draw-Surface-cfg-height", + "shortDoc": "The height of this component in pixels (defaults to auto). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "name": "height", + "owner": "Ext.draw.Surface", + "doc": "

The height of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset see Ext.Component.anchor.

\n", + "linenr": 206, + "html_filename": "Surface.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 474, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-add", - "shortDoc": "Add a Sprite to the surface. See Ext.draw.Sprite for the configuration object to be passed into this method.\n\nFor exa..." - }, - { - "tagname": "method", - "name": "addCls", - "member": "Ext.draw.Surface", - "doc": "

Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.

\n\n

For example:

\n\n
     drawComponent.surface.addCls(sprite, 'x-visible');\n
\n", - "params": [ - { - "type": "Object", - "name": "sprite", - "doc": "

The sprite to add the class to.

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

The CSS class to add, or an array of classes

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "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" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 261, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-addCls", - "shortDoc": "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.\n\nFor example:\n\n dr..." - }, - { - "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": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Surface.html#Ext-draw-Surface-cfg-width", + "shortDoc": "The width of this component in pixels (defaults to auto). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "name": "width", + "owner": "Ext.draw.Surface", + "doc": "

The width of this component in pixels (defaults to auto).\nNote to express this dimension as a percentage or offset see Ext.Component.anchor.

\n", + "linenr": 211, + "html_filename": "Surface.html" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "Surface.html#Ext-draw-Surface-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates new Surface. ...", + "static": false, + "params": [ + { + "type": "Object", + "optional": true, + "doc": "

(optional) Config object.

\n", + "name": "config" + } + ], + "private": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "doc": "

Creates new Surface.

\n", + "owner": "Ext.draw.Surface", + "name": "Svg", + "html_filename": "Surface.html", + "return": { + "type": "Object", + "doc": "\n" }, - { - "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" + "linenr": 223 }, - "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": "addGradient", - "member": "Ext.draw.Surface", - "doc": "

Add a gradient definition to the Surface. Note that in some surface engines, adding\na gradient via this method will not take effect if the surface has already been rendered.\nTherefore, it is preferred to pass the gradients as an item to the surface config, rather\nthan calling this method, especially if the surface is rendered immediately (e.g. due to\n'renderTo' in its config). For more information on how to create gradients in the Chart\nconfiguration object please refer to Ext.chart.Chart.

\n\n

The gradient object to be passed into this method is composed by:

\n\n\n\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Surface.html#Ext-draw-Surface-method-add", + "shortDoc": "Adds a Sprite to the surface. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" + ], + "name": "add", + "owner": "Ext.draw.Surface", + "doc": "

Adds a Sprite to the surface. See Ext.draw.Sprite for the configuration object to be\npassed into this method.

\n\n

For example:

\n\n
drawComponent.surface.add({\n    type: 'circle',\n    fill: '#ffc',\n    radius: 100,\n    x: 100,\n    y: 100\n});\n
\n", + "linenr": 485, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Surface.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 440, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-addGradient", - "shortDoc": "Add a gradient definition to the Surface. Note that in some surface engines, adding\na gradient via this method will 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 + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Surface.html#Ext-draw-Surface-method-addCls", + "shortDoc": "Adds one or more CSS classes to the element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

The sprite to add the class to.

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

The CSS class to add, or an array of classes

\n", + "name": "className" + } + ], + "name": "addCls", + "owner": "Ext.draw.Surface", + "doc": "

Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.

\n\n

For example:

\n\n
drawComponent.surface.addCls(sprite, 'x-visible');\n
\n", + "linenr": 273, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "

The method the event invokes.

\n", - "optional": false + "html_filename": "Surface.html" + }, + { + "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", - "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": "Surface.html#Ext-draw-Surface-method-addGradient", + "shortDoc": "Adds a gradient definition to the Surface. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ + + ], + "name": "addGradient", + "owner": "Ext.draw.Surface", + "doc": "

Adds a gradient definition to the Surface. Note that in some surface engines, adding\na gradient via this method will not take effect if the surface has already been rendered.\nTherefore, it is preferred to pass the gradients as an item to the surface config, rather\nthan calling this method, especially if the surface is rendered immediately (e.g. due to\n'renderTo' in its config). For more information on how to create gradients in the Chart\nconfiguration object please refer to Ext.chart.Chart.

\n\n

The gradient object to be passed into this method is composed by:

\n\n\n\n\n

For example:

\n\n

drawComponent.surface.addGradient({

\n\n
   id: 'gradientId',\n   angle: 45,\n   stops: {\n       0: {\n           color: '#555'\n       },\n       100: {\n           color: '#ddd'\n       }\n   }\n
\n\n

});

\n", + "linenr": 452, + "return": { + "type": "void", + "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" + "html_filename": "Surface.html" }, - "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-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": "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-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": "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": "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": "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": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Svg.html#Ext-draw-engine-Svg-method-applyZIndex", + "shortDoc": "Insert or move a given sprite's element to the correct place in the DOM list for its zIndex ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/engine/Svg.js", + "private": false, + "params": [ + { + "type": "Ext.draw.Sprite", + "optional": false, + "doc": "\n", + "name": "sprite" + } + ], + "name": "applyZIndex", + "owner": "Ext.draw.engine.Svg", + "doc": "

Insert or move a given sprite's element to the correct place in the DOM list for its zIndex

\n", + "linenr": 564, + "return": { + "type": "void", + "doc": "\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": "Svg.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": "applyZIndex", - "member": "Ext.draw.engine.Svg", - "doc": "

Insert or move a given sprite's element to the correct place in the DOM list for its zIndex

\n", - "params": [ - { - "type": "Ext.draw.Sprite", - "name": "sprite", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "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" + }, + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/engine/Svg.js", - "linenr": 544, - "html_filename": "Svg.html", - "href": "Svg.html#Ext-draw-engine-Svg-method-applyZIndex", - "shortDoc": "

Insert or move a given sprite's element to the correct place in the DOM list for its zIndex

\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": 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": "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": 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" }, - { - "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": "Observable.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": [ + { + "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" + ], + "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" + }, + "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-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": "void", - "doc": "\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/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": "create", - "member": "Ext.draw.Surface", - "doc": "

Create and return a new concrete Surface instance appropriate for the current environment.

\n", - "params": [ - { + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Surface.html#Ext-draw-Surface-method-create", + "shortDoc": "Creates and returns a new concrete Surface instance appropriate for the current environment. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

Initial configuration for the Surface instance

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

Optional order of implementations to use; the first one that is\navailable in the current environment will be used. Defaults to ['Svg', 'Vml'].

\n", + "name": "enginePriority" + } + ], + "name": "create", + "owner": "Ext.draw.Surface", + "doc": "

Creates and returns a new concrete Surface instance appropriate for the current environment.

\n", + "linenr": 137, + "return": { "type": "Object", - "name": "config", - "doc": "

Initial configuration for the Surface instance

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

The created Surface or false.

\n" + }, + "html_filename": "Surface.html" + }, + { + "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": "Array", - "name": "enginePriority", - "doc": "

Optional order of implementations to use; the first one that is

\n\n
           available in the current environment will be used. Defaults to\n           <code>['Svg', 'Vml']</code>.\n
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 131, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-create", - "shortDoc": "

Create and return a new concrete Surface instance appropriate for the current environment.

\n" - }, - { - "tagname": "method", - "name": "destroy", - "member": "Ext.draw.Surface", - "doc": "

Destroys the surface. This is done by removing all components from it and\nalso removing its reference to a DOM element.

\n\n

For example:

\n\n
 drawComponent.surface.destroy();\n
\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Surface.html#Ext-draw-Surface-method-destroy", + "shortDoc": "Destroys the surface. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" + ], + "name": "destroy", + "owner": "Ext.draw.Surface", + "doc": "

Destroys the surface. This is done by removing all components from it and\nalso removing its reference to a DOM element.

\n\n

For example:

\n\n
 drawComponent.surface.destroy();\n
\n", + "linenr": 835, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Surface.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 823, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-destroy", - "shortDoc": "Destroys the surface. This is done by removing all components from it and\nalso removing its reference to a DOM elemen..." - }, - { - "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" + { + "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" + }, + "html_filename": "Observable.html" }, - "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 + { + "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": "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": "getGroup", - "member": "Ext.draw.Surface", - "doc": "

Returns a new group or an existent group associated with the current surface.\nThe group returned is a Ext.draw.CompositeSprite group.

\n\n

For example:

\n\n
 var spriteGroup = drawComponent.surface.getGroup('someGroupId');\n
\n", - "params": [ - { - "type": "String", - "name": "id", - "doc": "

The unique identifier of the group.

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

The Ext.draw.CompositeSprite.

\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Surface.html#Ext-draw-Surface-method-getGroup", + "shortDoc": "Returns a new group or an existent group associated with the current surface. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The unique identifier of the group.

\n", + "name": "id" + } + ], + "name": "getGroup", + "owner": "Ext.draw.Surface", + "doc": "

Returns a new group or an existent group associated with the current surface.\nThe group returned is a Ext.draw.CompositeSprite group.

\n\n

For example:

\n\n
var spriteGroup = drawComponent.surface.getGroup('someGroupId');\n
\n", + "linenr": 768, + "return": { + "type": "Object", + "doc": "

The Ext.draw.CompositeSprite.

\n" + }, + "html_filename": "Surface.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 756, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-getGroup", - "shortDoc": "Returns a new group or an existent group associated with the current surface.\nThe group returned is a Ext.draw.Compos..." - }, - { - "tagname": "method", - "name": "getId", - "member": "Ext.draw.Surface", - "doc": "

Retrieves the id of this component.\nWill autogenerate an id if one has not already been set.

\n", - "params": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Surface.html#Ext-draw-Surface-method-getId", + "shortDoc": "Retrieves the id of this component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" + ], + "name": "getId", + "owner": "Ext.draw.Surface", + "doc": "

Retrieves the id of this component.\nWill autogenerate an id if one has not already been set.

\n", + "linenr": 827, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Surface.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 815, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-getId", - "shortDoc": "

Retrieves the id of this component.\nWill autogenerate an id if one has not already been set.

\n" - }, - { - "tagname": "method", - "name": "getRegion", - "member": "Ext.draw.engine.Svg", - "doc": "

Get the region for the surface's canvas area

\n", - "params": [ + { + "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": [ - ], - "return": { - "type": "Ext.util.Region", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/engine/Svg.js", - "linenr": 232, - "html_filename": "Svg.html", - "href": "Svg.html#Ext-draw-engine-Svg-method-getRegion", - "shortDoc": "

Get the region for the surface's canvas area

\n" - }, - { - "tagname": "method", - "name": "hasCls", - "member": "Ext.draw.engine.Svg", - "doc": "

Checks if the specified CSS class exists on this element's DOM node.

\n", - "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", - "name": "className", - "doc": "

The CSS class to check for

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

className

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

True if the class exists, else false

\n" + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/engine/Svg.js", - "linenr": 608, - "html_filename": "Svg.html", - "href": "Svg.html#Ext-draw-engine-Svg-method-hasCls", - "shortDoc": "

Checks if the specified CSS class exists on this element's DOM node.

\n" - }, - { - "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" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Svg.html#Ext-draw-engine-Svg-method-getRegion", + "shortDoc": "Get the region for the surface's canvas area ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/engine/Svg.js", + "private": false, + "params": [ + + ], + "name": "getRegion", + "owner": "Ext.draw.engine.Svg", + "doc": "

Get the region for the surface's canvas area

\n", + "linenr": 234, + "return": { + "type": "Ext.util.Region", + "doc": "\n" + }, + "html_filename": "Svg.html" }, - "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": "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": "Svg.html#Ext-draw-engine-Svg-method-hasCls", + "shortDoc": "Checks if the specified CSS class exists on this element's DOM node. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/engine/Svg.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "

The CSS class to check for

\n", + "name": "className" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "className" + } + ], + "name": "hasCls", + "owner": "Ext.draw.engine.Svg", + "doc": "

Checks if the specified CSS class exists on this element's DOM node.

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

True if the class exists, else false

\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": "Svg.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-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" }, - { - "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": "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" + }, + { + "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": "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": "

mixins The mixin prototypes as key - value pairs

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

(optional) An object containing handler configuration.

\n", - "optional": true - } - ], - "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": 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": "relayEvents", - "member": "Ext.util.Observable", - "doc": "

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

\n", - "params": [ - { - "type": "Object", - "name": "origin", - "doc": "

The Observable whose events this object is to relay.

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

Array of event names to relay.

\n", - "optional": false + "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" }, - { - "type": "Object", - "name": "prefix", - "doc": "\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": 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": "removeManagedListener" + }, + "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" + }, + "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": "remove", - "member": "Ext.draw.Surface", - "doc": "

Remove a given sprite from the surface, optionally destroying the sprite in the process.\nYou can also call the sprite own remove method.

\n\n

For example:

\n\n
 drawComponent.surface.remove(sprite);\n //or...\n sprite.remove();\n
\n", - "params": [ - { - "type": "Ext.draw.Sprite", - "name": "sprite", - "doc": "\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": "Boolean", - "name": "destroySprite", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Number", - "doc": "

the sprite's new index in the list

\n" + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 561, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-remove", - "shortDoc": "Remove a given sprite from the surface, optionally destroying the sprite in the process.\nYou can also call the sprite..." - }, - { - "tagname": "method", - "name": "removeAll", - "member": "Ext.draw.Surface", - "doc": "

Remove all sprites from the surface, optionally destroying the sprites in the process.

\n\n

For example:

\n\n
 drawComponent.surface.removeAll();\n
\n", - "params": [ - { - "type": "Boolean", - "name": "destroySprites", - "doc": "

Whether to destroy all sprites when removing them.

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

The sprite's new index in the list.

\n" + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addListener" + }, + "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" + }, + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 588, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-removeAll", - "shortDoc": "Remove all sprites from the surface, optionally destroying the sprites in the process.\n\nFor example:\n\n drawComponent...." - }, - { - "tagname": "method", - "name": "removeCls", - "member": "Ext.draw.Surface", - "doc": "

Removes one or more CSS classes from the element.

\n\n

For example:

\n\n
 drawComponent.surface.removeCls(sprite, 'x-visible');\n
\n", - "params": [ - { - "type": "Object", - "name": "sprite", - "doc": "

The sprite to remove the class from.

\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": "String/Array", - "name": "className", - "doc": "

The CSS class to remove, or an array of classes

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Base3.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 274, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-removeCls", - "shortDoc": "Removes one or more CSS classes from the element.\n\nFor example:\n\n drawComponent.surface.removeCls(sprite, 'x-visible'..." - }, - { - "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": 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": "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": "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": "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": "Surface.html#Ext-draw-Surface-method-remove", + "shortDoc": "Removes a given sprite from the surface, optionally destroying the sprite in the process. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ + { + "type": "Ext.draw.Sprite", + "optional": false, + "doc": "\n", + "name": "sprite" + }, + { + "type": "Boolean", + "optional": false, + "doc": "\n", + "name": "destroySprite" + } + ], + "name": "remove", + "owner": "Ext.draw.Surface", + "doc": "

Removes a given sprite from the surface, optionally destroying the sprite in the process.\nYou can also call the sprite own remove method.

\n\n

For example:

\n\n
drawComponent.surface.remove(sprite);\n//or...\nsprite.remove();\n
\n", + "linenr": 573, + "return": { + "type": "Number", + "doc": "

the sprite's new index in the list

\n" }, - { - "type": "Object|String", - "name": "ename", - "doc": "

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

\n", - "optional": false + "html_filename": "Surface.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Surface.html#Ext-draw-Surface-method-removeAll", + "shortDoc": "Removes all sprites from the surface, optionally destroying the sprites in the process. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ + { + "type": "Boolean", + "optional": false, + "doc": "

Whether to destroy all sprites when removing them.

\n", + "name": "destroySprites" + } + ], + "name": "removeAll", + "owner": "Ext.draw.Surface", + "doc": "

Removes all sprites from the surface, optionally destroying the sprites in the process.

\n\n

For example:

\n\n
drawComponent.surface.removeAll();\n
\n", + "linenr": 600, + "return": { + "type": "Number", + "doc": "

The sprite's new index in the list.

\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": "Surface.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Surface.html#Ext-draw-Surface-method-removeCls", + "shortDoc": "Removes one or more CSS classes from the element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

The sprite to remove the class from.

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

The CSS class to remove, or an array of classes

\n", + "name": "className" + } + ], + "name": "removeCls", + "owner": "Ext.draw.Surface", + "doc": "

Removes one or more CSS classes from the element.

\n\n

For example:

\n\n
drawComponent.surface.removeCls(sprite, 'x-visible');\n
\n", + "linenr": 286, + "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": "Surface.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": "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" + }, + "html_filename": "Observable.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": "setSize", - "member": "Ext.draw.Surface", - "doc": "

Sets the size of the surface. Accomodates the background (if any) to fit the new size too.

\n\n

For example:

\n\n
 drawComponent.surface.setSize(500, 500);\n
\n\n

This method is generally called when also setting the size of the draw Component.

\n", - "params": [ - { - "type": "Number", - "name": "w", - "doc": "

The new width of the canvas.

\n", - "optional": false + { + "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": "Number", - "name": "h", - "doc": "

The new height of the canvas.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 361, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-setSize", - "shortDoc": "Sets the size of the surface. Accomodates the background (if any) to fit the new size too.\n\nFor example:\n\n drawCompon..." - }, - { - "tagname": "method", - "name": "setStyle", - "member": "Ext.draw.Surface", - "doc": "

Sets CSS style attributes to an element.

\n\n

For example:

\n\n
 drawComponent.surface.setStyle(sprite, {\n     'cursor': 'pointer'\n });\n
\n", - "params": [ - { - "type": "Object", - "name": "sprite", - "doc": "

The sprite to add, or an array of classes to

\n", - "optional": false + { + "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": "styles", - "doc": "

An Object with CSS styles.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 287, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-setStyle", - "shortDoc": "Sets CSS style attributes to an element.\n\nFor example:\n\n drawComponent.surface.setStyle(sprite, {\n 'cursor': 'poi..." - }, - { - "tagname": "method", - "name": "setText", - "member": "Ext.draw.Surface", - "doc": "

Changes the text in the sprite element. The sprite must be a text sprite.\nThis method can also be called from Ext.draw.Sprite.

\n\n

For example:

\n\n
 var spriteGroup = drawComponent.surface.setText(sprite, 'my new text');\n
\n", - "params": [ - { - "type": "Object", - "name": "sprite", - "doc": "

The Sprite to change the text.

\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Surface.html#Ext-draw-Surface-method-setSize", + "shortDoc": "Sets the size of the surface. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "

The new width of the canvas.

\n", + "name": "w" + }, + { + "type": "Number", + "optional": false, + "doc": "

The new height of the canvas.

\n", + "name": "h" + } + ], + "name": "setSize", + "owner": "Ext.draw.Surface", + "doc": "

Sets the size of the surface. Accomodates the background (if any) to fit the new size too.

\n\n

For example:

\n\n
drawComponent.surface.setSize(500, 500);\n
\n\n

This method is generally called when also setting the size of the draw Component.

\n", + "linenr": 373, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "String", - "name": "text", - "doc": "

The new text to be set.

\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "Surface.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/Surface.js", - "linenr": 797, - "html_filename": "Surface.html", - "href": "Surface.html#Ext-draw-Surface-method-setText", - "shortDoc": "Changes the text in the sprite element. The sprite must be a text sprite.\nThis method can also be called from Ext.dra..." - }, - { - "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": "Surface.html#Ext-draw-Surface-method-setStyle", + "shortDoc": "Sets CSS style attributes to an element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

The sprite to add, or an array of classes to

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

An Object with CSS styles.

\n", + "name": "styles" + } + ], + "name": "setStyle", + "owner": "Ext.draw.Surface", + "doc": "

Sets CSS style attributes to an element.

\n\n

For example:

\n\n
drawComponent.surface.setStyle(sprite, {\n    'cursor': 'pointer'\n});\n
\n", + "linenr": 299, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Surface.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": "Surface.html#Ext-draw-Surface-method-setText", + "shortDoc": "Changes the text in the sprite element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "

The Sprite to change the text.

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

The new text to be set.

\n", + "name": "text" + } + ], + "name": "setText", + "owner": "Ext.draw.Surface", + "doc": "

Changes the text in the sprite element. The sprite must be a text sprite.\nThis method can also be called from Ext.draw.Sprite.

\n\n

For example:

\n\n
var spriteGroup = drawComponent.surface.setText(sprite, 'my new text');\n
\n", + "linenr": 809, + "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": "Surface.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": "scope", - "doc": "

(optional) The scope originally specified for the handler.

\n", - "optional": true - } - ], - "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": 608, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-un", - "shortDoc": "

Removes an event handler (shorthand for removeListener.)

\n" - } - ], - "property": [ + { + "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" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeListener" + }, + "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" + }, + "html_filename": "Observable.html" + } + ], + "property": [ + { + "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": [ - ], - "event": [ + ], + "cssMixin": [ + ], + "event": [ + + ] + }, + "singleton": false, + "alias": null, + "superclasses": [ + "Ext.Base", + "Ext.draw.Surface" ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/draw/engine/Svg.js", - "linenr": 1, - "html_filename": "Svg.html", - "href": "Svg.html#Ext-draw-engine-Svg", - "cssVar": [ + "protected": false, + "tagname": "class", + "mixins": [ ], - "cssMixin": [ + "href": "Svg.html#Ext-draw-engine-Svg", + "subclasses": [ ], + "static": false, + "author": null, "component": false, - "superclasses": [ - "Ext.draw.Surface" - ], - "subclasses": [ + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/engine/Svg.js", + "private": false, + "alternateClassNames": [ ], + "name": "Ext.draw.engine.Svg", + "doc": "

Provides specific methods to draw with SVG.

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