X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..refs/heads/master:/docs/output/Ext.draw.Surface.js?ds=sidebyside diff --git a/docs/output/Ext.draw.Surface.js b/docs/output/Ext.draw.Surface.js index d4d4f14c..affdb0bf 100644 --- a/docs/output/Ext.draw.Surface.js +++ b/docs/output/Ext.draw.Surface.js @@ -1,1539 +1 @@ -Ext.data.JsonP.Ext_draw_Surface({ - "allMixins": [ - "Ext.util.Observable" - ], - "deprecated": null, - "docauthor": null, - "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" - }, - { - "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\nDOM events from ExtJS Components
\n\nWhile 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:
new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n
\n",
- "linenr": 102,
- "html_filename": "Observable.html"
- },
- {
- "type": "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": "Surface", - "html_filename": "Surface.html", - "return": { - "type": "Object", - "doc": "\n" - }, - "linenr": 223 - }, - { - "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": [ - - ], - "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\nFor example:
\n\ndrawComponent.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"
- },
- {
- "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\nFor example:
\n\ndrawComponent.surface.addCls(sprite, 'x-visible');\n
\n",
- "linenr": 273,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "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:
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\nthis.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" - }, - "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\nThe gradient object to be passed into this method is composed by:
\n\nFor example:
\n\ndrawComponent.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" - }, - "html_filename": "Surface.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-addListener", - "shortDoc": "Appends an event handler to this object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The name of the event to listen for. May also be an object who's property names are\nevent names.
\n", - "name": "eventName" - }, - { - "type": "Function", - "optional": false, - "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
(optional) The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.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\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.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" - }, - "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.
(optional) If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
(optional) If the ename
parameter was an event name, this is the\naddListener options.
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" - }, - "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\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\n",
- "linenr": 388,
- "return": {
- "type": "Ext.Base",
- "doc": "this
\n" - }, - "html_filename": "Base3.html" - }, - { - "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
Call the original method that was previously overridden with Ext.Base.override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\n",
- "linenr": 269,
- "return": {
- "type": "Mixed",
- "doc": "Returns the result after calling the overridden method
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-callParent", - "shortDoc": "Call the parent's overridden method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Array/Arguments", - "optional": false, - "doc": "The arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Call the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\n",
- "linenr": 124,
- "return": {
- "type": "Mixed",
- "doc": "Returns the result from the superclass' method
\n" - }, - "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.
Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event before the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", - "linenr": 54, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "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": [ - - ], - "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" - }, - { - "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": [ - - ], - "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" - }, - { - "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']
.
Creates and returns a new concrete Surface instance appropriate for the current environment.
\n", - "linenr": 137, - "return": { - "type": "Object", - "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\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\n",
- "linenr": 648,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "html_filename": "Base3.html"
- },
- {
- "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": [
-
- ],
- "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\nFor example:
\n\n drawComponent.surface.destroy();\n
\n",
- "linenr": 835,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "html_filename": "Surface.html"
- },
- {
- "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.
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\nExample:
\n\nExt.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"
- },
- {
- "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).
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" - }, - "html_filename": "Observable.html" - }, - { - "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\nFor example:
\n\nvar spriteGroup = drawComponent.surface.getGroup('someGroupId');\n
\n",
- "linenr": 768,
- "return": {
- "type": "Object",
- "doc": "\n"
- },
- "html_filename": "Surface.html"
- },
- {
- "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": [
-
- ],
- "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" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-getName", - "shortDoc": "Get the current class' name in string format. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - - ], - "name": "getName", - "owner": "Ext.Base", - "doc": "Get the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\n",
- "linenr": 631,
- "return": {
- "type": "String",
- "doc": "className
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-hasListener", - "shortDoc": "Checks to see if this object has any listeners for a specified event ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The name of the event to check for
\n", - "name": "eventName" - } - ], - "name": "hasListener", - "owner": "Ext.util.Observable", - "doc": "Checks to see if this object has any listeners for a specified event
\n", - "linenr": 530, - "return": { - "type": "Boolean", - "doc": "True if the event is being listened for, else false
\n" - }, - "html_filename": "Observable.html" - }, - { - "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\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\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\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n",
- "linenr": 63,
- "return": {
- "type": "Object",
- "doc": "mixins The mixin prototypes as key - value pairs
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": { - "tagname": "alias", - "cls": "Ext.util.Observable", - "doc": null, - "owner": "addManagedListener" - }, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-mon", - "shortDoc": "Shorthand for addManagedListener. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable/Element", - "optional": false, - "doc": "The item to which to add a listener/listeners.
\n", - "name": "item" - }, - { - "type": "Object/String", - "optional": false, - "doc": "The event name, or an object containing event name properties.
\n", - "name": "ename" - }, - { - "type": "Function", - "optional": true, - "doc": "(optional) If the ename
parameter was an event name, this is the handler function.
(optional) If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
(optional) If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", - "linenr": 681, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "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.
Optional. If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\n", - "linenr": 687, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "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\nThis 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\nUsage:
\n\nExt.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"
- },
- "html_filename": "Observable.html"
- },
- {
- "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.
(optional) The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.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\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.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\nAppends an event handler to this object.
\n", - "linenr": 669, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "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\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\n",
- "linenr": 518,
- "return": {
- "type": "Ext.Base",
- "doc": "this
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-relayEvents", - "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "The Observable whose events this object is to relay.
\n", - "name": "origin" - }, - { - "type": "[String]", - "optional": false, - "doc": "Array of event names to relay.
\n", - "name": "events" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "prefix" - } - ], - "name": "relayEvents", - "owner": "Ext.util.Observable", - "doc": "Relays selected events from the specified Observable as if the events were fired by this
.
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" - }, - "html_filename": "Observable.html" - }, - { - "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.
For example:
\n\ndrawComponent.surface.remove(sprite);\n//or...\nsprite.remove();\n
\n",
- "linenr": 573,
- "return": {
- "type": "Number",
- "doc": "the sprite's new index in the list
\n" - }, - "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\nFor example:
\n\ndrawComponent.surface.removeAll();\n
\n",
- "linenr": 600,
- "return": {
- "type": "Number",
- "doc": "The sprite's new index in the list.
\n" - }, - "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\nFor example:
\n\ndrawComponent.surface.removeCls(sprite, 'x-visible');\n
\n",
- "linenr": 286,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "html_filename": "Surface.html"
- },
- {
- "deprecated": null,
- "alias": null,
- "protected": false,
- "tagname": "method",
- "href": "Observable.html#Ext-util-Observable-method-removeListener",
- "shortDoc": "Removes an event handler. ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
- "private": false,
- "params": [
- {
- "type": "String",
- "optional": false,
- "doc": "The type of event the handler was associated with.
\n", - "name": "eventName" - }, - { - "type": "Function", - "optional": false, - "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", - "name": "handler" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) The scope originally specified for the handler.
\n", - "name": "scope" - } - ], - "name": "removeListener", - "owner": "Ext.util.Observable", - "doc": "Removes an event handler.
\n", - "linenr": 392, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", - "shortDoc": "Removes listeners that were added by the mon method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable|Element", - "optional": false, - "doc": "The item from which to remove a listener/listeners.
\n", - "name": "item" - }, - { - "type": "Object|String", - "optional": false, - "doc": "The event name, or an object containing event name properties.
\n", - "name": "ename" - }, - { - "type": "Function", - "optional": false, - "doc": "Optional. If the ename
parameter was an event name, this is the handler function.
Optional. If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Removes listeners that were added by the mon method.
\n", - "linenr": 197, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-resumeEvents", - "shortDoc": "Resumes firing events (see suspendEvents). ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - - ], - "name": "resumeEvents", - "owner": "Ext.util.Observable", - "doc": "Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the **queueSuspended**
parameter, then all events fired\nduring event suspension will be sent to any listeners now.
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\nFor example:
\n\ndrawComponent.surface.setSize(500, 500);\n
\n\nThis method is generally called when also setting the size of the draw Component.
\n", - "linenr": 373, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Surface.html" - }, - { - "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\nFor example:
\n\ndrawComponent.surface.setStyle(sprite, {\n 'cursor': 'pointer'\n});\n
\n",
- "linenr": 299,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "html_filename": "Surface.html"
- },
- {
- "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.
For example:
\n\nvar spriteGroup = drawComponent.surface.setText(sprite, 'my new text');\n
\n",
- "linenr": 809,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "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
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"
- },
- "html_filename": "Base3.html"
- },
- {
- "deprecated": null,
- "alias": null,
- "protected": false,
- "tagname": "method",
- "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
- "shortDoc": "Suspends the firing of all events. ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
- "private": false,
- "params": [
- {
- "type": "Boolean",
- "optional": false,
- "doc": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n", - "name": "queueSuspended" - } - ], - "name": "suspendEvents", - "owner": "Ext.util.Observable", - "doc": "Suspends the firing of all events. (see resumeEvents)
\n", - "linenr": 541, - "return": { - "type": "void", - "doc": "\n" - }, - "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\nRemoves 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
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\n",
- "linenr": 18,
- "html_filename": "Base3.html"
- }
- ],
- "cssVar": [
-
- ],
- "cssMixin": [
-
- ],
- "event": [
-
- ]
- },
- "singleton": false,
- "alias": null,
- "superclasses": [
- "Ext.Base"
- ],
- "protected": false,
- "tagname": "class",
- "mixins": [
- "Ext.util.Observable"
- ],
- "href": "Surface.html#Ext-draw-Surface",
- "subclasses": [
- "Ext.draw.engine.Vml",
- "Ext.draw.engine.Svg"
- ],
- "static": false,
- "author": null,
- "component": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Surface.js",
- "private": false,
- "alternateClassNames": [
-
- ],
- "name": "Ext.draw.Surface",
- "doc": "A Surface is an interface to render methods inside a draw Ext.draw.Component.\nA Surface contains methods to render sprites, get bounding boxes of sprites, add\nsprites to the canvas, initialize other graphic components, etc. One of the most used\nmethods for this class is the add
method, to add Sprites to the surface.
Most of the Surface methods are abstract and they have a concrete implementation\nin VML or SVG engines.
\n\nA Surface instance can be accessed as a property of a draw component. For example:
\n\ndrawComponent.surface.add({\n type: 'circle',\n fill: '#ffc',\n radius: 100,\n x: 100,\n y: 100\n});\n
\n\nThe configuration object passed in the add
method is the same as described in the Ext.draw.Sprite\nclass documentation.
You can also add event listeners to the surface using the Observable
listener syntax. Supported events are:
For example:
\n\ndrawComponent.surface.on({\n 'mousemove': function() {\n console.log('moving the mouse over the surface'); \n }\n});\n
\n\nvar drawComponent = Ext.create('Ext.draw.Component', {\n width: 800,\n height: 600,\n renderTo: document.body\n}), surface = drawComponent.surface;\n\nsurface.add([{\n type: 'circle',\n radius: 10,\n fill: '#f00',\n x: 10,\n y: 10,\n group: 'circles'\n}, {\n type: 'circle',\n radius: 10,\n fill: '#0f0',\n x: 50,\n y: 50,\n group: 'circles'\n}, {\n type: 'circle',\n radius: 10,\n fill: '#00f',\n x: 100,\n y: 100,\n group: 'circles'\n}, {\n type: 'rect',\n width: 20,\n height: 20,\n fill: '#f00',\n x: 10,\n y: 10,\n group: 'rectangles'\n}, {\n type: 'rect',\n width: 20,\n height: 20,\n fill: '#0f0',\n x: 50,\n y: 50,\n group: 'rectangles'\n}, {\n type: 'rect',\n width: 20,\n height: 20,\n fill: '#00f',\n x: 100,\n y: 100,\n group: 'rectangles'\n}]);\n\n// Get references to my groups\ncircles = surface.getGroup('circles');\nrectangles = surface.getGroup('rectangles');\n\n// Animate the circles down\ncircles.animate({\n duration: 1000,\n to: {\n translate: {\n y: 200\n }\n }\n});\n\n// Animate the rectangles across\nrectangles.animate({\n duration: 1000,\n to: {\n translate: {\n x: 200\n }\n }\n});\n
\n",
- "mixedInto": [
-
- ],
- "linenr": 1,
- "xtypes": [
-
- ],
- "html_filename": "Surface.html",
- "extends": "Ext.Base"
-});
\ No newline at end of file
+Ext.data.JsonP.Ext_draw_Surface({"tagname":"class","html":"Hierarchy
Ext.BaseExt.draw.SurfaceMixins
Requires
Uses
Files
A Surface is an interface to render methods inside a draw Ext.draw.Component.\nA Surface contains methods to render sprites, get bounding boxes of sprites, add\nsprites to the canvas, initialize other graphic components, etc. One of the most used\nmethods for this class is the add
method, to add Sprites to the surface.
Most of the Surface methods are abstract and they have a concrete implementation\nin VML or SVG engines.
\n\nA Surface instance can be accessed as a property of a draw component. For example:
\n\ndrawComponent.surface.add({\n type: 'circle',\n fill: '#ffc',\n radius: 100,\n x: 100,\n y: 100\n});\n
\n\nThe configuration object passed in the add
method is the same as described in the Ext.draw.Sprite\nclass documentation.
You can also add event listeners to the surface using the Observable
listener syntax. Supported events are:
For example:
\n\ndrawComponent.surface.on({\n 'mousemove': function() {\n console.log('moving the mouse over the surface');\n }\n});\n
\n\nvar drawComponent = Ext.create('Ext.draw.Component', {\n width: 800,\n height: 600,\n renderTo: document.body\n}), surface = drawComponent.surface;\n\nsurface.add([{\n type: 'circle',\n radius: 10,\n fill: '#f00',\n x: 10,\n y: 10,\n group: 'circles'\n}, {\n type: 'circle',\n radius: 10,\n fill: '#0f0',\n x: 50,\n y: 50,\n group: 'circles'\n}, {\n type: 'circle',\n radius: 10,\n fill: '#00f',\n x: 100,\n y: 100,\n group: 'circles'\n}, {\n type: 'rect',\n width: 20,\n height: 20,\n fill: '#f00',\n x: 10,\n y: 10,\n group: 'rectangles'\n}, {\n type: 'rect',\n width: 20,\n height: 20,\n fill: '#0f0',\n x: 50,\n y: 50,\n group: 'rectangles'\n}, {\n type: 'rect',\n width: 20,\n height: 20,\n fill: '#00f',\n x: 100,\n y: 100,\n group: 'rectangles'\n}]);\n\n// Get references to my groups\ncircles = surface.getGroup('circles');\nrectangles = surface.getGroup('rectangles');\n\n// Animate the circles down\ncircles.animate({\n duration: 1000,\n to: {\n translate: {\n y: 200\n }\n }\n});\n\n// Animate the rectangles across\nrectangles.animate({\n duration: 1000,\n to: {\n translate: {\n x: 200\n }\n }\n});\n
\nThe height of this component in pixels (defaults to auto).
\nThe height of this component in pixels (defaults to auto).
\nA 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\nDOM events from Ext JS Components
\n\nWhile some Ext JS 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:
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
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nAdds a Sprite to the surface. See Ext.draw.Sprite for the configuration object to be\npassed into this method.
\n\nFor example:
\n\ndrawComponent.surface.add({\n type: 'circle',\n fill: '#ffc',\n radius: 100,\n x: 100,\n y: 100\n});\n
\nAdds the specified events to the list of events which this Observable may fire.
\nEither 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:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n
\nAdditional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\nAdds 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\nThe gradient object to be passed into this method is composed by:
\n\nFor example:
\n\ndrawComponent.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});
\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe 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\n\n\nmyGridPanel.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\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Call the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nRemoves all listeners for this object including the managed listeners
\nDestroys the surface. This is done by removing all components from it and\nalso removing its reference to a DOM element.
\n\nFor example:
\n\n drawComponent.surface.destroy();\n
\nEnables 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.
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\nExample:
\n\nExt.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
\nFires the specified event with the passed parameters (minus the event name, plus the options
object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\nThe name of the event to fire.
\nVariable number of parameters are passed to handlers.
\nreturns false if any of the handlers return false otherwise it returns true.
\nReturns a new group or an existent group associated with the current surface.\nThe group returned is a Ext.draw.CompositeSprite group.
\n\nFor example:
\n\nvar spriteGroup = drawComponent.surface.getGroup('someGroupId');\n
\nThe unique identifier of the group.
\nRetrieves the id of this component.\nWill autogenerate an id if one has not already been set.
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nShorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for addListener.
\n\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe 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\n\n\nmyGridPanel.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\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nRemoves a given sprite from the surface, optionally destroying the sprite in the process.\nYou can also call the sprite own remove
method.
For example:
\n\ndrawComponent.surface.remove(sprite);\n//or...\nsprite.remove();\n
\nthe sprite's new index in the list
\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the queueSuspended
parameter, then all events fired\nduring event suspension will be sent to any listeners now.
Sets the size of the surface. Accomodates the background (if any) to fit the new size too.
\n\nFor example:
\n\ndrawComponent.surface.setSize(500, 500);\n
\n\nThis method is generally called when also setting the size of the draw Component.
\nChanges the text in the sprite element. The sprite must be a text
sprite.\nThis method can also be called from Ext.draw.Sprite.
For example:
\n\nvar spriteGroup = drawComponent.surface.setText(sprite, 'my new text');\n
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nSuspends the firing of all events. (see resumeEvents)
\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\nShorthand for removeListener.
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreates and returns a new concrete Surface instance appropriate for the current environment.
\nInitial configuration for the Surface instance
\norder of implementations to use; the first one that is\navailable in the current environment will be used. Defaults to ['Svg', 'Vml']
.
The created Surface or false.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nthis
\n