The fill color
\n", - "linenr": 165, - "html_filename": "Sprite2.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-font", - "shortDoc": "Used with text type sprites. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "font", - "owner": "Ext.draw.Sprite", - "doc": "Used with text type sprites. The full font description. Uses the same syntax as the CSS font parameter
\n", - "linenr": 177, - "html_filename": "Sprite2.html" - }, - { - "type": "String/Array", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-group", - "shortDoc": "The group that this sprite belongs to, or an array of groups. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "group", - "owner": "Ext.draw.Sprite", - "doc": "The group that this sprite belongs to, or an array of groups. Only relevant when added to a\nExt.draw.Surface
\n", - "linenr": 185, - "html_filename": "Sprite2.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-height", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "height", - "owner": "Ext.draw.Sprite", - "doc": "Used in rectangle sprites, the height of the rectangle
\n", - "linenr": 137, - "html_filename": "Sprite2.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-opacity", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "opacity", - "owner": "Ext.draw.Sprite", - "doc": "The opacity of the sprite
\n", - "linenr": 161, - "html_filename": "Sprite2.html" - }, - { - "type": "Array", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-path", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "path", - "owner": "Ext.draw.Sprite", - "doc": "Used in path sprites, the path of the sprite written in SVG-like path syntax
\n", - "linenr": 157, - "html_filename": "Sprite2.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-radius", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "radius", - "owner": "Ext.draw.Sprite", - "doc": "Used in circle sprites, the radius of the circle
\n", - "linenr": 145, - "html_filename": "Sprite2.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-size", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "size", - "owner": "Ext.draw.Sprite", - "doc": "Used in square sprites, the dimension of the square
\n", - "linenr": 141, - "html_filename": "Sprite2.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-stroke", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "stroke", - "owner": "Ext.draw.Sprite", - "doc": "-width The width of the stroke
\n", - "linenr": 173, - "html_filename": "Sprite2.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-text", - "shortDoc": "Used with text type sprites. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "text", - "owner": "Ext.draw.Sprite", - "doc": "Used with text type sprites. The text itself
\n", - "linenr": 181, - "html_filename": "Sprite2.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-type", - "shortDoc": "The type of the sprite. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "type", - "owner": "Ext.draw.Sprite", - "doc": "The type of the sprite. Possible options are 'circle', 'path', 'rect', 'text', 'square', 'image'
\n", - "linenr": 129, - "html_filename": "Sprite2.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-width", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "width", - "owner": "Ext.draw.Sprite", - "doc": "Used in rectangle sprites, the width of the rectangle
\n", - "linenr": 133, - "html_filename": "Sprite2.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-x", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "x", - "owner": "Ext.draw.Sprite", - "doc": "The position along the x-axis
\n", - "linenr": 149, - "html_filename": "Sprite2.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "Sprite2.html#Ext-draw-Sprite-cfg-y", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "y", - "owner": "Ext.draw.Sprite", - "doc": "The position along the y-axis
\n", - "linenr": 153, - "html_filename": "Sprite2.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sprite2.html#Ext-draw-Sprite-method-addCls", - "shortDoc": "Adds one or more CSS classes to the element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "params": [ - { - "type": "String/Array", - "optional": false, - "doc": "The CSS class to add, or an array of classes
\n", - "name": "className" - } - ], - "name": "addCls", - "owner": "Ext.draw.Sprite", - "doc": "Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out. Note this method\nis severly limited in VML.
\n", - "linenr": 478, - "return": { - "type": "Ext.draw.Sprite", - "doc": "this
\n" - }, - "html_filename": "Sprite2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sprite2.html#Ext-draw-Sprite-method-destroy", - "shortDoc": "Removes the sprite and clears all listeners. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "params": [ - - ], - "name": "destroy", - "owner": "Ext.draw.Sprite", - "doc": "Removes the sprite and clears all listeners.
\n", - "linenr": 445, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Sprite2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sprite2.html#Ext-draw-Sprite-method-getBBox", - "shortDoc": "Retrieve the bounding box of the sprite. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "params": [ - - ], - "name": "getBBox", - "owner": "Ext.draw.Sprite", - "doc": "Retrieve the bounding box of the sprite. This will be returned as an object with x, y, width, and height properties.
\n", - "linenr": 394, - "return": { - "type": "Object", - "doc": "bbox
\n" - }, - "html_filename": "Sprite2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sprite2.html#Ext-draw-Sprite-method-hide", - "shortDoc": "Hide the sprite. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "Flag to immediatly draw the change.
\n", - "name": "redraw" - } - ], - "name": "hide", - "owner": "Ext.draw.Sprite", - "doc": "Hide the sprite.
\n", - "linenr": 406, - "return": { - "type": "Ext.draw.Sprite", - "doc": "this
\n" - }, - "html_filename": "Sprite2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sprite2.html#Ext-draw-Sprite-method-redraw", - "shortDoc": "Redraw the sprite. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "params": [ - - ], - "name": "redraw", - "owner": "Ext.draw.Sprite", - "doc": "Redraw the sprite.
\n", - "linenr": 458, - "return": { - "type": "Ext.draw.Sprite", - "doc": "this
\n" - }, - "html_filename": "Sprite2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sprite2.html#Ext-draw-Sprite-method-remove", - "shortDoc": "Remove the sprite. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "params": [ - - ], - "name": "remove", - "owner": "Ext.draw.Sprite", - "doc": "Remove the sprite.
\n", - "linenr": 430, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Sprite2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sprite2.html#Ext-draw-Sprite-method-removeCls", - "shortDoc": "Removes one or more CSS classes from the element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "params": [ - { - "type": "String/Array", - "optional": false, - "doc": "The CSS class to remove, or an array of classes. Note this method\nis severly limited in VML.
\n", - "name": "className" - } - ], - "name": "removeCls", - "owner": "Ext.draw.Sprite", - "doc": "Removes one or more CSS classes from the element.
\n", - "linenr": 489, - "return": { - "type": "Ext.draw.Sprite", - "doc": "this
\n" - }, - "html_filename": "Sprite2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sprite2.html#Ext-draw-Sprite-method-setAttributes", - "shortDoc": "Change the attributes of the sprite. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "attributes to be changed on the sprite.
\n", - "name": "attrs" - }, - { - "type": "Boolean", - "optional": false, - "doc": "Flag to immediatly draw the change.
\n", - "name": "redraw" - } - ], - "name": "setAttributes", - "owner": "Ext.draw.Sprite", - "doc": "Change the attributes of the sprite.
\n", - "linenr": 297, - "return": { - "type": "Ext.draw.Sprite", - "doc": "this
\n" - }, - "html_filename": "Sprite2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sprite2.html#Ext-draw-Sprite-method-setStyle", - "shortDoc": "Wrapper for setting style properties, also takes single object parameter of multiple styles. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "params": [ - { - "type": "String/Object", - "optional": false, - "doc": "The style property to be set, or an object of multiple styles.
\n", - "name": "property" - }, - { - "type": "String", - "optional": true, - "doc": "(optional) The value to apply to the given property, or null if an object was passed.
\n", - "name": "value" - } - ], - "name": "setStyle", - "owner": "Ext.draw.Sprite", - "doc": "Wrapper for setting style properties, also takes single object parameter of multiple styles.
\n", - "linenr": 467, - "return": { - "type": "Ext.draw.Sprite", - "doc": "this
\n" - }, - "html_filename": "Sprite2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sprite2.html#Ext-draw-Sprite-method-show", - "shortDoc": "Show the sprite. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "Flag to immediatly draw the change.
\n", - "name": "redraw" - } - ], - "name": "show", - "owner": "Ext.draw.Sprite", - "doc": "Show the sprite.
\n", - "linenr": 418, - "return": { - "type": "Ext.draw.Sprite", - "doc": "this
\n" - }, - "html_filename": "Sprite2.html" - } - ], - "property": [ - { - "type": "Ext.dd.DragSource.", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Sprite2.html#Ext-draw-Sprite-property-dd", - "shortDoc": "If this Sprite is configured draggable, this property will contain\nan instance of Ext.dd.DragSource which handles dra...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "name": "dd", - "owner": "Ext.draw.Sprite", - "doc": "If this Sprite is configured draggable, this property will contain\nan instance of Ext.dd.DragSource which handles dragging the Sprite.
\n\n\nThe developer must provide implementations of the abstract methods of Ext.dd.DragSource\nin order to supply behaviour for each stage of the drag/drop process. See draggable.
\n", - "linenr": 278, - "html_filename": "Sprite2.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "Sprite2.html#Ext-draw-Sprite", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/draw/Sprite.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.draw.Sprite", - "doc": "A Sprite is an object rendered in a Drawing surface. There are different options and types of sprites.\nThe configuration of a Sprite is an object with the following properties:
\n\nfont parameter.For translate, the configuration object contains x and y attributes that indicate where to\ntranslate the object. For example:
\n\nsprite.setAttributes({\n translate: {\n x: 10,\n y: 10\n }\n}, true);\nFor rotation, the configuration object contains x and y attributes for the center of the rotation (which are optional),\nand a degrees attribute that specifies the rotation in degrees. For example:
sprite.setAttributes({\n rotate: {\n degrees: 90\n }\n}, true);\nThat example will create a 90 degrees rotation using the centroid of the Sprite as center of rotation, whereas:
\n\nsprite.setAttributes({\n rotate: {\n x: 0,\n y: 0,\n degrees: 90\n }\n}, true);\nwill create a rotation around the (0, 0) axis.
For scaling, the configuration object contains x and y attributes for the x-axis and y-axis scaling. For example:
\n\nsprite.setAttributes({\n scale: {\n x: 10,\n y: 3\n }\n}, true);\nYou can also specify the center of scaling by adding cx and cy as properties:
sprite.setAttributes({\n scale: {\n cx: 0,\n cy: 0,\n x: 10,\n y: 3\n }\n}, true);\nThat last example will scale a sprite taking as centers of scaling the (0, 0) coordinate.
Sprites can be created with a reference to a Ext.draw.Surface
\n\n var drawComponent = Ext.create('Ext.draw.Component', options here...);\n\n var sprite = Ext.create('Ext.draw.Sprite', {\n type: 'circle',\n fill: '#ff0',\n surface: drawComponent.surface,\n radius: 5\n });\nSprites can also be added to the surface as a configuration object:
\n\n var sprite = drawComponent.surface.add({\n type: 'circle',\n fill: '#ff0',\n radius: 5\n });\nIn order to properly apply properties and render the sprite we have to\nshow the sprite setting the option redraw to true:
sprite.show(true);\nThe constructor configuration object of the Sprite can also be used and passed into the Ext.draw.Surface\nadd method to append a new sprite to the canvas. For example:
\n\ndrawComponent.surface.add({\n type: 'circle',\n fill: '#ffc',\n radius: 100,\n x: 100,\n y: 100\n});\nHierarchy
Ext.BaseExt.draw.SpriteMixins
Requires
Files
A Sprite is an object rendered in a Drawing surface.
\n\nFor translate, the configuration object contains x and y attributes that indicate where to\ntranslate the object. For example:
\n\nsprite.setAttributes({\n translate: {\n x: 10,\n y: 10\n }\n}, true);\nFor rotation, the configuration object contains x and y attributes for the center of the rotation (which are optional),\nand a degrees attribute that specifies the rotation in degrees. For example:
sprite.setAttributes({\n rotate: {\n degrees: 90\n }\n}, true);\nThat example will create a 90 degrees rotation using the centroid of the Sprite as center of rotation, whereas:
\n\nsprite.setAttributes({\n rotate: {\n x: 0,\n y: 0,\n degrees: 90\n }\n}, true);\nwill create a rotation around the (0, 0) axis.
For scaling, the configuration object contains x and y attributes for the x-axis and y-axis scaling. For example:
\n\nsprite.setAttributes({\n scale: {\n x: 10,\n y: 3\n }\n}, true);\nYou can also specify the center of scaling by adding cx and cy as properties:
sprite.setAttributes({\n scale: {\n cx: 0,\n cy: 0,\n x: 10,\n y: 3\n }\n}, true);\nThat last example will scale a sprite taking as centers of scaling the (0, 0) coordinate.
Sprites can be created with a reference to a Ext.draw.Surface
\n\nvar drawComponent = Ext.create('Ext.draw.Component', options here...);\n\nvar sprite = Ext.create('Ext.draw.Sprite', {\n type: 'circle',\n fill: '#ff0',\n surface: drawComponent.surface,\n radius: 5\n});\nSprites can also be added to the surface as a configuration object:
\n\nvar sprite = drawComponent.surface.add({\n type: 'circle',\n fill: '#ff0',\n radius: 5\n});\nIn order to properly apply properties and render the sprite we have to\nshow the sprite setting the option redraw to true:
sprite.show(true);\nThe constructor configuration object of the Sprite can also be used and passed into the Ext.draw.Surface\nadd method to append a new sprite to the canvas. For example:
\n\ndrawComponent.surface.add({\n type: 'circle',\n fill: '#ffc',\n radius: 100,\n x: 100,\n y: 100\n});\nUsed with text type sprites. The full font description. Uses the same syntax as the CSS font parameter
\nThe group that this sprite belongs to, or an array of groups. Only relevant when added to a\nExt.draw.Surface
\nUsed in rectangle sprites, the height of the rectangle
\nUsed in rectangle sprites, the height of the rectangle
\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});\nUsed in path sprites, the path of the sprite written in SVG-like path syntax
\nUsed in path sprites, the path of the sprite written in SVG-like path syntax
\nUsed in circle sprites, the radius of the circle
\nUsed in circle sprites, the radius of the circle
\nUsed in square sprites, the dimension of the square
\nUsed in square sprites, the dimension of the square
\nThe type of the sprite. Possible options are 'circle', 'path', 'rect', 'text', 'square', 'image'
\nIf this Sprite is configured draggable, this property will contain\nan instance of Ext.dd.DragSource which handles dragging the Sprite.
\n\nThe developer must provide implementations of the abstract methods of Ext.dd.DragSource\nin order to supply behaviour for each stage of the drag/drop process. See draggable.
\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'\nAdds one or more CSS classes to the element. Duplicate classes are automatically filtered out. Note this method\nis severly limited in VML.
\nthis
\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});\nAdditional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\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});\nCombining 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});\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});\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});\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.
Perform custom animation on this object.
\n
This method is applicable to both the Component class and the Element class.\nIt performs animated transitions of certain properties of this object over a specified timeline.
\nThe sole parameter is an object which specifies start property values, end property values, and properties which\ndescribe the timeline. Of the properties listed below, only to is mandatory.
Properties include
from to durationeasing \n- ease
\n- easeIn
\n- easeOut
\n- easeInOut
\n- backIn
\n- backOut
\n- elasticIn
\n- elasticOut
\n- bounceIn
\n- bounceOut
\n
keyframes listeners beforeanimate event or the afteranimate event.from, to, and keyframe objects:x y left left value. Units must be supplied.top top value. Units must be supplied.width width value. Units must be supplied.height height value. Units must be supplied.scrollLeft scrollLeft value.scrollTop scrollLeft value.opacity opacity value. This must be a value between 0 and 1.Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state\nwill result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to\ndirectly animate certain properties of Components.
\nfrom, to, and keyframe objects:x y left left value in pixels.top top value in pixels.width width value in pixels.width width value in pixels.dynamic For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:
\nmyWindow = Ext.create('Ext.window.Window', {\n title: 'Test Component animation',\n width: 500,\n height: 300,\n layout: {\n type: 'hbox',\n align: 'stretch'\n },\n items: [{\n title: 'Left: 33%',\n margins: '5 0 5 5',\n flex: 1\n }, {\n title: 'Left: 66%',\n margins: '5 5 5 5',\n flex: 2\n }]\n});\nmyWindow.show();\nmyWindow.header.el.on('click', function() {\n myWindow.animate({\n to: {\n width: (myWindow.getWidth() == 500) ? 700 : 500,\n height: (myWindow.getHeight() == 300) ? 400 : 300,\n }\n });\n});\nFor performance reasons, by default, the internal layout is only updated when the Window reaches its final \"to\" size. If dynamic updating of the Window's child\nComponents is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.
An object containing properties which describe the animation's start and end states, and the timeline of the animation.
\nthis
\nCall the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\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'\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
\nRemoves the sprite and clears all listeners.
\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});\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 the current animation if this object has any effects actively running or queued, else returns false.
\nAnim if element has active effects, else false
\n\nRetrieves the bounding box of the sprite.\nThis will be returned as an object with x, y, width, and height properties.
\nbbox
\nReturns the current animation if this object has any effects actively running or queued, else returns false.
\nThis method has been deprecated since 4.0
Replaced by getActiveAnimation
\nAnim if element has active effects, else false
\n\nHides the sprite.
\nFlag to immediatly draw the change.
\nthis
\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'\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});\nCombining 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});\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});\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});\nRemoves one or more CSS classes from the element.
\nThe CSS class to remove, or an array of classes. Note this method\nis severly limited in VML.
\nthis
\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.
Change the attributes of the sprite.
\nattributes to be changed on the sprite.
\nFlag to immediatly draw the change.
\nthis
\nWrapper for setting style properties, also takes single object parameter of multiple styles.
\nThe style property to be set, or an object of multiple styles.
\nThe value to apply to the given property, or null if an object was passed.
\nthis
\nShows the sprite.
\nFlag to immediatly draw the change.
\nthis
\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\nStops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\nThe Element
\nStops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\nThis method has been deprecated since 4.0
Replaced by stopAnimation
\nThe Element
\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.
\nEnsures that all effects queued after syncFx is called on this object are\nrun concurrently. This is the opposite of sequenceFx.
\nthis
\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});\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 '$$$$$$$'\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\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'\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();\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\"\nthis
\nReplaced by getActiveAnimation
\n","version":"4.0"},"static":false,"owner":"Ext.util.Animate","template":false,"required":null,"protected":false,"name":"hasActiveFx","id":"method-hasActiveFx"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"hasListener","id":"method-hasListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.draw.Sprite","template":false,"required":null,"protected":false,"name":"hide","id":"method-hide"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"initConfig","id":"method-initConfig"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"mon","id":"method-mon"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"mun","id":"method-mun"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"on","id":"method-on"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.draw.Sprite","template":false,"required":null,"protected":false,"name":"redraw","id":"method-redraw"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"relayEvents","id":"method-relayEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.draw.Sprite","template":false,"required":null,"protected":false,"name":"remove","id":"method-remove"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.draw.Sprite","template":false,"required":null,"protected":false,"name":"removeCls","id":"method-removeCls"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"removeListener","id":"method-removeListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"removeManagedListener","id":"method-removeManagedListener"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"resumeEvents","id":"method-resumeEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Animate","template":false,"required":null,"protected":false,"name":"sequenceFx","id":"method-sequenceFx"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.draw.Sprite","template":false,"required":null,"protected":false,"name":"setAttributes","id":"method-setAttributes"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.draw.Sprite","template":false,"required":null,"protected":false,"name":"setStyle","id":"method-setStyle"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.draw.Sprite","template":false,"required":null,"protected":false,"name":"show","id":"method-show"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Base","template":false,"required":null,"protected":true,"name":"statics","id":"method-statics"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Animate","template":false,"required":null,"protected":false,"name":"stopAnimation","id":"method-stopAnimation"},{"tagname":"method","deprecated":{"doc":"Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.","tagname":"deprecated","text":"Replaced by stopAnimation
\n","version":"4.0"},"static":false,"owner":"Ext.util.Animate","template":false,"required":null,"protected":false,"name":"stopFx","id":"method-stopFx"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"suspendEvents","id":"method-suspendEvents"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Animate","template":false,"required":null,"protected":false,"name":"syncFx","id":"method-syncFx"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"un","id":"method-un"}],"event":[]},"private":false,"component":false,"name":"Ext.draw.Sprite","alternateClassNames":[],"id":"class-Ext.draw.Sprite","mixedInto":[],"xtypes":{},"files":[{"href":"Sprite.html#Ext-draw-Sprite","filename":"Sprite.js"}]}); \ No newline at end of file