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});\nThe text to display in a centered loading message box (defaults to 'Loading...')
\n", - "linenr": 33, - "html_filename": "LoadMask.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "LoadMask.html#Ext-LoadMask-cfg-msgCls", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/LoadMask.js", - "private": false, - "name": "msgCls", - "owner": "Ext.LoadMask", - "doc": "The CSS class to apply to the loading message element (defaults to \"x-mask-loading\")
\n", - "linenr": 38, - "html_filename": "LoadMask.html" - }, - { - "type": "Ext.data.Store", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "LoadMask.html#Ext-LoadMask-cfg-store", - "shortDoc": "Optional Store to which the mask is bound. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/LoadMask.js", - "private": false, - "name": "store", - "owner": "Ext.LoadMask", - "doc": "Optional Store to which the mask is bound. The mask is displayed when a load request is issued, and\nhidden on either load success, or load fail.
\n", - "linenr": 27, - "html_filename": "LoadMask.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "LoadMask.html#Ext-LoadMask-cfg-useMsg", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/LoadMask.js", - "private": false, - "name": "useMsg", - "owner": "Ext.LoadMask", - "doc": "Whether or not to use a loading message class or simply mask the bound element.
\n", - "linenr": 44, - "html_filename": "LoadMask.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "href": "LoadMask.html#Ext-LoadMask-method-constructor", - "tagname": "method", - "protected": false, - "shortDoc": "Creates new LoadMask. ...", - "static": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "The element, element ID, or DOM node you wish to mask.\nAlso, may be a Component who's element you wish to mask.
\n", - "name": "el" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) The config object
\n", - "name": "config" - } - ], - "private": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/LoadMask.js", - "doc": "Creates new LoadMask.
\n", - "owner": "Ext.LoadMask", - "name": "LoadMask", - "html_filename": "LoadMask.html", - "return": { - "type": "Object", - "doc": "\n" - }, - "linenr": 56 - }, - { - "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});\nOptional additional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\nAdds 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": "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});\nCombining 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});\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});\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});\nAppends 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});\nthis
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "LoadMask.html#Ext-LoadMask-method-bindStore", - "shortDoc": "Changes the data store bound to this LoadMask. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/LoadMask.js", - "private": false, - "params": [ - { - "type": "Store", - "optional": false, - "doc": "The store to bind to this LoadMask
\n", - "name": "store" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "initial" - } - ], - "name": "bindStore", - "owner": "Ext.LoadMask", - "doc": "Changes the data store bound to this LoadMask.
\n", - "linenr": 114, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "LoadMask.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\"\nReturns 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'\nReturns 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": "Base3.html#Ext-Base-method-create", - "shortDoc": "Create a new instance of this Class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - - ], - "name": "create", - "owner": "Ext.Base", - "doc": "Create a new instance of this Class.
\n\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.
\n", - "linenr": 329, - "return": { - "type": "Object", - "doc": "the created instance.
\n" - }, - "html_filename": "Base3.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()\nDisables the mask to prevent it from being displayed
\n", - "linenr": 148, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "LoadMask.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "LoadMask.html#Ext-LoadMask-method-enable", - "shortDoc": "Enables the mask so that it can be displayed ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/LoadMask.js", - "private": false, - "params": [ - - ], - "name": "enable", - "owner": "Ext.LoadMask", - "doc": "Enables the mask so that it can be displayed
\n", - "linenr": 160, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "LoadMask.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});\nThe 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": "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'\nclassName
\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": "LoadMask.html#Ext-LoadMask-method-hide", - "shortDoc": "Hide this LoadMask. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/LoadMask.js", - "private": false, - "params": [ - - ], - "name": "hide", - "owner": "Ext.LoadMask", - "doc": "Hide this LoadMask.
\n", - "linenr": 207, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "LoadMask.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();\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
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "LoadMask.html#Ext-LoadMask-method-isDisabled", - "shortDoc": "Method to determine whether this LoadMask is currently disabled. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/LoadMask.js", - "private": false, - "params": [ - - ], - "name": "isDisabled", - "owner": "Ext.LoadMask", - "doc": "Method to determine whether this LoadMask is currently disabled.
\n", - "linenr": 167, - "return": { - "type": "Boolean", - "doc": "the disabled state of this LoadMask.
\n" - }, - "html_filename": "LoadMask.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});\nThe 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});\nCombining 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});\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});\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});\nShorthand 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\"\nthis
\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": "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.
Show this LoadMask over the configured Element.
\n", - "linenr": 200, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "LoadMask.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\nPass 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": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "LoadMask.html#Ext-LoadMask-property-disabled", - "shortDoc": "Read-only. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/LoadMask.js", - "private": false, - "name": "disabled", - "owner": "Ext.LoadMask", - "doc": "Read-only. True if the mask is currently disabled so that it will not be displayed (defaults to false)
\n", - "linenr": 50, - "html_filename": "LoadMask.html" - }, - { - "type": "Class", - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "property", - "href": "Base3.html#Ext-Base-property-self", - "shortDoc": "Get the reference to the current class from which this object was instantiated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "name": "self", - "owner": "Ext.Base", - "doc": "Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.statics\nfor a detailed comparison
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'\nA simple utility class for generically masking elements while loading data. If the store\nconfig option is specified, the masking will be automatically synchronized with the store's loading\nprocess and the mask element will be cached for reuse.
\n\nExample usage:
\n\n\n// Basic mask:\nvar myMask = new Ext.LoadMask(Ext.getBody(), {msg:\"Please wait...\"});\nmyMask.show();\nHierarchy
Ext.BaseExt.AbstractComponentExt.ComponentExt.LoadMaskMixins
Uses
Files
A modal, floating Component which may be shown above a specified Element, or a specified\nComponent while loading data. When shown, the configured owning Element or Component will\nbe covered with a modality mask, and the LoadMask's msg will be displayed centered, accompanied by a spinner image.
\n\n\nIf the store config option is specified, the masking will be automatically shown and then hidden synchronized with\nthe Store's loading process.
\n\n\nBecause this is a floating Component, its z-index will be managed by the global ZIndexManager\nobject, and upon show, it will place itsef at the top of the hierarchy.
\n\n\nExample usage:
\n\n\n// Basic mask:\nvar myMask = new Ext.LoadMask(Ext.getBody(), {msg:\"Please wait...\"});\nmyMask.show();\nA tag name or DomHelper spec used to create the Element which will\nencapsulate this Component.
\n\nYou do not normally need to specify this. For the base classes Ext.Component and\nExt.container.Container, this defaults to 'div'. The more complex Sencha classes use a more\ncomplex DOM structure specified by their own renderTpls.
\n\nThis is intended to allow the developer to create application-specific utility Components encapsulated by\ndifferent DOM elements. Example usage:
\n\n{\n xtype: 'component',\n autoEl: {\n tag: 'img',\n src: 'http://www.example.com/example.jpg'\n }\n}, {\n xtype: 'component',\n autoEl: {\n tag: 'blockquote',\n html: 'autoEl is cool!'\n }\n}, {\n xtype: 'container',\n autoEl: 'ul',\n cls: 'ux-unordered-list',\n items: {\n xtype: 'component',\n autoEl: 'li',\n html: 'First list item'\n }\n}\nThis config is intended mainly for non-floating Components which may or may not be shown. Instead of using\nrenderTo in the configuration, and rendering upon construction, this allows a Component to render itself\nupon first show. If floating is true, the value of this config is omited as if it is true.
Specify as true to have this Component render to the document body upon first show.
Specify as an element, or the ID of an element to have this Component render to a specific element upon first\nshow.
\n\nThis defaults to true for the Window class.
Defaults to: false
true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary,\nfalse to clip any overflowing content.
Defaults to: false
True to automatically show the component upon creation. This config option may only be used for\nfloating components or components that use autoRender. Defaults to false.
\nDefaults to: false
The base CSS class to apply to this components's element. This will also be prepended to elements within this\ncomponent like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and\nyou want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use\ncomponentCls to add specific styling for this component.
\nDefaults to: "x-component"
Specifies the border for this component. The border can be a single numeric value to apply to all sides or it can\nbe a CSS style specification for each style, for example: '10 5 3 10'.
\nAn array describing the child elements of the Component. Each member of the array\nis an object with these properties:
\n\nname - The property name on the Component for the child element.itemId - The id to combine with the Component's id that is the id of the child element.id - The id of the child element.If the array member is a string, it is equivalent to { name: m, itemId: m }.
For example, a Component which renders a title and body text:
\n\nExt.create('Ext.Component', {\n renderTo: Ext.getBody(),\n renderTpl: [\n '<h1 id=\"{id}-title\">{title}</h1>',\n '<p>{msg}</p>',\n ],\n renderData: {\n title: \"Error\",\n msg: \"Something went wrong\"\n },\n childEls: [\"title\"],\n listeners: {\n afterrender: function(cmp){\n // After rendering the component will have a title property\n cmp.title.setStyle({color: \"red\"});\n }\n }\n});\nA more flexible, but somewhat slower, approach is renderSelectors.
\nAn optional extra CSS class that will be added to this component's Element. This can be useful\nfor adding customized styles to the component or any of its children using standard CSS rules.
\nDefaults to: ""
CSS Class to be added to a components root level element to give distinction to it via styling.
\nCSS Class to be added to a components root level element to give distinction to it via styling.
\nThe sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout\nmanager which sizes a Component's internal structure in response to the Component being sized.
\n\nGenerally, developers will not use this configuration as all provided Components which need their internal\nelements sizing (Such as input fields) come with their own componentLayout managers.
\n\nThe default layout manager will be used on instances of the base Ext.Component\nclass which simply sizes the Component's encapsulating element to the height and width specified in the\nsetSize method.
\nSpecify an existing HTML element, or the id of an existing HTML element to use as the content for this component.
This config option is used to take an existing HTML element and place it in the layout element of a new component\n(it simply moves the specified DOM element after the Component is rendered to use as the content.
\n\nNotes:
\n\nThe specified HTML element is appended to the layout element of the component after any configured\nHTML has been inserted, and so the document will not contain this element at the time\nthe render event is fired.
\n\nThe specified HTML element used will not participate in any layout\nscheme that the Component may use. It is just HTML. Layouts operate on child\nitems.
Add either the x-hidden or the x-hide-display CSS class to prevent a brief flicker of the content before it\nis rendered to the panel.
CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.
\nDefaults to: "x-item-disabled"
Specify as true to make a floating Component draggable using the Component's encapsulating element as\nthe drag handle.
\n\nThis may also be specified as a config object for the ComponentDragger which is\ninstantiated to perform dragging.
\n\nFor example to create a Component which may only be dragged around using a certain internal element as the drag\nhandle, use the delegate option:
\n\nnew Ext.Component({\n constrain: true,\n floating: true,\n style: {\n backgroundColor: '#fff',\n border: '1px solid black'\n },\n html: '<h1 style=\"cursor:move\">The title</h1><p>The content</p>',\n draggable: {\n delegate: 'h1'\n }\n}).show();\nDefaults to: false
Specify as true to float the Component outside of the document flow using CSS absolute positioning.
\n\nComponents such as Windows and Menus are floating by default.
\n\nFloating Components that are programatically rendered will register themselves with\nthe global ZIndexManager
\n\nA floating Component may be used as a child item of a Container. This just allows the floating Component to seek\na ZIndexManager by examining the ownerCt chain.
\n\nWhen configured as floating, Components acquire, at render time, a ZIndexManager which\nmanages a stack of related floating Components. The ZIndexManager brings a single floating Component to the top\nof its stack when the Component's toFront method is called.
\n\nThe ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is\nfloating. This is so that descendant floating Components of floating Containers (Such as a ComboBox dropdown\nwithin a Window) can have its zIndex managed relative to any siblings, but always above that floating\nancestor Container.
\n\nIf no floating ancestor is found, a floating Component registers itself with the default ZIndexManager.
\n\nFloating components do not participate in the Container's layout. Because of this, they are not rendered until\nyou explicitly show them.
\n\nAfter rendering, the ownerCt reference is deleted, and the floatParent property is set to the found\nfloating ancestor Container. If no floating ancestor Container was found the floatParent property will\nnot be set.
\nDefaults to: false
Specifies whether the floated component should be automatically focused when\nit is brought to the front.
\nDefaults to: true
Specify as true to have the Component inject framing elements within the Component at render time to provide a\ngraphical rounded frame around the Component content.
This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet\nExplorer prior to version 9 which do not support rounded corners natively.
\n\nThe extra space taken up by this framing is available from the read only property frameSize.
\nA String which specifies how this Component's encapsulating DOM element will be hidden. Values may be:
\n\n'display' : The Component will be hidden using the display: none style.'visibility' : The Component will be hidden using the visibility: hidden style.'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document.\nThis is useful when a hidden Component must maintain measurable dimensions. Hiding using display results in a\nComponent having zero dimensions.Defaults to: "display"
An HTML fragment, or a DomHelper specification to use as the layout element content.\nThe HTML content is added after the component is rendered, so the document will not contain this HTML at the time\nthe render event is fired. This content is inserted into the body before any configured contentEl\nis appended.
\nDefaults to: ""
The unique id of this component instance.
\n\nIt should not be necessary to use this configuration except for singleton objects in your application. Components\ncreated with an id may be accessed globally using Ext.getCmp.
\n\nInstead of using assigned ids, use the itemId config, and ComponentQuery\nwhich provides selector-based searching for Sencha Components analogous to DOM querying. The Container class contains shortcut methods to query\nits descendant Components by selector.
\n\nNote that this id will also be used as the element id for the containing HTML element that is rendered to the\npage for this component. This allows you to write id-based CSS rules to style the specific instance of this\ncomponent uniquely, and also to select sub-elements using this component's id as the parent.
\n\nNote: to avoid complications imposed by a unique id also see itemId.
Note: to access the container of a Component see ownerCt.
Defaults to an auto-assigned id.
\nAn itemId can be used as an alternative way to get a reference to a component when no object reference is\navailable. Instead of using an id with Ext.getCmp, use itemId with\nExt.container.Container.getComponent which will retrieve\nitemId's or id's. Since itemId's are an index to the container's internal MixedCollection, the\nitemId is scoped locally to the container -- avoiding potential conflicts with Ext.ComponentManager\nwhich requires a unique id.
var c = new Ext.panel.Panel({ //\n height: 300,\n renderTo: document.body,\n layout: 'auto',\n items: [\n {\n itemId: 'p1',\n title: 'Panel 1',\n height: 150\n },\n {\n itemId: 'p2',\n title: 'Panel 2',\n height: 150\n }\n ]\n})\np1 = c.getComponent('p1'); // not the same as Ext.getCmp()\np2 = p1.ownerCt.getComponent('p2'); // reference via a sibling\nAlso see id, Ext.container.Container.query, Ext.container.Container.down and\nExt.container.Container.child.
Note: to access the container of an item see ownerCt.
\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});\nA configuration object or an instance of a Ext.ComponentLoader to load remote content for this Component.
\nA configuration object or an instance of a Ext.ComponentLoader to load remote content for this Component.
\nSpecifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can\nbe a CSS style specification for each style, for example: '10 5 3 10'.
\nThe maximum value in pixels which this Component will set its height to.
\n\nWarning: This will override any size management applied by layout managers.
\nThe maximum value in pixels which this Component will set its width to.
\n\nWarning: This will override any size management applied by layout managers.
\nThe minimum value in pixels which this Component will set its height to.
\n\nWarning: This will override any size management applied by layout managers.
\nThe minimum value in pixels which this Component will set its width to.
\n\nWarning: This will override any size management applied by layout managers.
\nThe text to display in a centered loading message box.
\nDefaults to: "Loading..."
The CSS class to apply to the loading message element.
\nDefaults to: "x-mask-loading"
An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element,\nand removed when the mouse moves out. This can be useful for adding customized 'active' or 'hover' styles to the\ncomponent or any of its children using standard CSS rules.
\nDefaults to: ""
Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it\ncan be a CSS style specification for each style, for example: '10 5 3 10'.
\nAn object or array of objects that will provide custom functionality for this component. The only requirement for\na valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component\nis created, if any plugins are available, the component will call the init method on each plugin, passing a\nreference to itself. Each plugin can then call methods or respond to events on the component as needed to provide\nits functionality.
\nThe data used by renderTpl in addition to the following property values of the component:
\n\nSee renderSelectors and childEls for usage examples.
\nAn object containing properties specifying DomQuery selectors which identify child elements\ncreated by the render process.
\n\nAfter the Component's internal structure is rendered according to the renderTpl, this object is iterated through,\nand the found Elements are added as properties to the Component using the renderSelector property name.
For example, a Component which renderes a title and description into its element:
\n\nExt.create('Ext.Component', {\n renderTo: Ext.getBody(),\n renderTpl: [\n '<h1 class=\"title\">{title}</h1>',\n '<p>{desc}</p>'\n ],\n renderData: {\n title: \"Error\",\n desc: \"Something went wrong\"\n },\n renderSelectors: {\n titleEl: 'h1.title',\n descEl: 'p'\n },\n listeners: {\n afterrender: function(cmp){\n // After rendering the component will have a titleEl and descEl properties\n cmp.titleEl.setStyle({color: \"red\"});\n }\n }\n});\nFor a faster, but less flexible, alternative that achieves the same end result (properties for child elements on the\nComponent after render), see childEls and addChildEls.
\nSpecify the id of the element, a DOM element or an existing Element that this component will be rendered into.
\n\nNotes:
\n\nDo not use this option if the Component is to be a child item of a Container.\nIt is the responsibility of the Container's\nlayout manager to render and manage its child items.
\n\nWhen using this config, a call to render() is not required.
\n\nSee render also.
An XTemplate used to create the internal structure inside this Component's encapsulating\nElement.
\n\nYou do not normally need to specify this. For the base classes Ext.Component and\nExt.container.Container, this defaults to null which means that they will be initially rendered\nwith no internal structure; they render their Element empty. The more specialized ExtJS and Touch\nclasses which use a more complex DOM structure, provide their own template definitions.
This is intended to allow the developer to create application-specific utility Components with customized\ninternal structure.
\n\nUpon rendering, any created child elements may be automatically imported into object properties using the\nrenderSelectors and childEls options.
\nDefaults to: null
Specify as true to apply a Resizer to this Component after rendering.
May also be specified as a config object to be passed to the constructor of Resizer\nto override any defaults. By default the Component passes its minimum and maximum size, and uses\nExt.resizer.Resizer.dynamic: false
A valid Ext.resizer.Resizer handles config string. Only applies when resizable = true.
\nDefaults to: "all"
A buffer to be applied if many state events are fired within a short period.
\nDefaults to: 100
Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow, or a string indicating the shadow's display Ext.Shadow.mode. Set to false to disable the\nshadow.
\nDefaults to: "sides"
An array of events that, when fired, should trigger this object to\nsave its state. Defaults to none. stateEvents may be any type\nof event supported by this object, including browser or custom events\n(e.g., ['click', 'customerchange']).
See stateful for an explanation of saving and\nrestoring object state.
The unique id for this object to use for state management purposes.
\n\nSee stateful for an explanation of saving and restoring state.
\n\nA flag which causes the object to attempt to restore the state of\ninternal properties from a saved state on startup. The object must have\na stateId for state to be managed.\nAuto-generated ids are not guaranteed to be stable across page loads and\ncannot be relied upon to save and restore the same state for a object.
\n
For state saving to work, the state manager's provider must have been\nset to an implementation of Ext.state.Provider which overrides the\nset and get\nmethods to save and recall name/value pairs. A built-in implementation,\nExt.state.CookieProvider is available.
\nTo set the state provider for the current page:
\nExt.state.Manager.setProvider(new Ext.state.CookieProvider({\n expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now\n}));\nA stateful object attempts to save state when one of the events\nlisted in the stateEvents configuration fires.
To save state, a stateful object first serializes its state by\ncalling getState. By default, this function does\nnothing. The developer must provide an implementation which returns an\nobject hash which represents the restorable state of the object.
The value yielded by getState is passed to Ext.state.Manager.set\nwhich uses the configured Ext.state.Provider to save the object\nkeyed by the stateId.
During construction, a stateful object attempts to restore\nits state by calling Ext.state.Manager.get passing the\nstateId
The resulting object is passed to applyState.\nThe default implementation of applyState simply copies\nproperties into the object, but a developer may override this to support\nmore behaviour.
You can perform extra processing on state save and restore by attaching\nhandlers to the beforestaterestore, staterestore,\nbeforestatesave and statesave events.
\n\nDefaults to: true
Optional Store to which the mask is bound. The mask is displayed when a load request is issued, and\nhidden on either load success, or load fail.
\nA custom style specification to be applied to this component's Element. Should be a valid argument to\nExt.Element.applyStyles.
\n\nnew Ext.panel.Panel({\n title: 'Some Title',\n renderTo: Ext.getBody(),\n width: 400, height: 300,\n layout: 'form',\n items: [{\n xtype: 'textarea',\n style: {\n width: '95%',\n marginBottom: '10px'\n }\n },\n new Ext.button.Button({\n text: 'Send',\n minWidth: '100',\n style: {\n marginBottom: '10px'\n }\n })\n ]\n});\nThe class that is added to the content target when you set styleHtmlContent to true.
\nDefaults to: "x-html"
True to automatically style the html inside the content target of this component (body for panels).
\nDefaults to: false
An Ext.Template, Ext.XTemplate or an array of strings to form an Ext.XTemplate. Used in\nconjunction with the data and tplWriteMode configurations.
The Ext.(X)Template method to use when updating the content area of the Component.\nSee Ext.XTemplate.overwrite for information on default mode.
Defaults to: "overwrite"
A set style for a component. Can be a string or an Array of multiple strings (UIs)
\nDefaults to: "default"
Whether or not to use a loading message class or simply mask the bound element.
\nDefaults to: true
The xtype configuration option can be used to optimize Component creation and rendering. It serves as a\nshortcut to the full componet name. For example, the component Ext.button.Button has an xtype of button.
You can define your own xtype on a custom component by specifying the\nalias config option with a prefix of widget. For example:
Ext.define('PressMeButton', {\n extend: 'Ext.button.Button',\n alias: 'widget.pressmebutton',\n text: 'Press Me'\n})\nAny Component can be created implicitly as an object config with an xtype specified, allowing it to be\ndeclared and passed into the rendering pipeline without actually being instantiated as an object. Not only is\nrendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources\nuntil they are actually needed. In complex, nested layouts containing many Components, this can make a\nnoticeable improvement in performance.
\n\n// Explicit creation of contained Components:\nvar panel = new Ext.Panel({\n ...\n items: [\n Ext.create('Ext.button.Button', {\n text: 'OK'\n })\n ]\n};\n\n// Implicit creation using xtype:\nvar panel = new Ext.Panel({\n ...\n items: [{\n xtype: 'button',\n text: 'OK'\n }]\n};\nIn the first example, the button will always be created immediately during the panel's initialization. With\nmany added Components, this approach could potentially slow the rendering of the page. In the second example,\nthe button will not be created or rendered until the panel is actually displayed in the browser. If the panel\nis never displayed (for example, if it is a tab that remains hidden) then the button will never be created and\nwill never consume any resources whatsoever.
\nRead-only property indicating whether or not the component can be dragged
\nRead-only property indicating whether or not the component can be dragged
\nOnly present for floating Components which were inserted as descendant items of floating Containers.
\n\nFloating Components that are programatically rendered will not have a floatParent\nproperty.
For floating Components which are child items of a Container, the floatParent will be the floating\nancestor Container which is responsible for the base z-index value of all its floating descendants. It provides\na ZIndexManager which provides z-indexing services for all its descendant floating\nComponents.
\n\nFor example, the dropdown BoundList of a ComboBox which is in a Window will have the\nWindow as its floatParent
See floating and zIndexManager
\nRead-only property indicating the width of any framing elements which were added within the encapsulating element\nto provide graphical, rounded borders. See the frame config.
\n\nThis is an object containing the frame width in pixels for all four sides of the Component containing the\nfollowing properties:
\nThis is an internal flag that you use when creating custom components. By default this is set to true which means\nthat every component gets a mask when its disabled. Components like FieldContainer, FieldSet, Field, Button, Tab\noverride this property to false since they want to implement custom disable logic.
\nRead-only property indicating whether or not the component has been rendered.
\nRead-only property indicating whether or not the component has been rendered.
\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'\nOnly present for floating Components after they have been rendered.
\n\nA reference to the ZIndexManager which is managing this Component's z-index.
\n\nThe ZIndexManager maintains a stack of floating Component z-indices, and also provides\na single modal mask which is insert just beneath the topmost visible modal floating Component.
\n\nFloating Components may be brought to the front or sent to the back of the\nz-index stack.
\n\nThis defaults to the global ZIndexManager for floating Components that are\nprogramatically rendered.
\n\nFor floating Components which are added to a Container, the ZIndexManager is acquired from the first\nancestor Container found which is floating, or if not found the global ZIndexManager is\nused.
\n\nSee floating and floatParent
\nCreates new LoadMask.
\nThe element, element ID, or DOM node you wish to mask.
\n\nAlso, may be a Component who's element you wish to mask. If a Component is specified, then\nthe mask will be automatically sized upon Component resize, the message box will be kept centered,\nand the mask only be visible when the Component is.
\n\nThe config object
\nAdds each argument passed to this method to the childEls array.
\nAdds a CSS class to the top level element representing this component.
\nThe CSS class name to add
\nReturns the Component to allow method chaining.
\nAdds a CSS class to the top level element representing this component.
\nThe CSS class name to add
\nReturns the Component to allow method chaining.
\nAdds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this\ncomponent.
\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.
Method which adds a specified UI + uiCls to the components element. Can be overridden to remove the UI from more\nthan just the components element.
\nThe UI to remove from the element
\nOccurs after componentLayout is run.
\nThe box-adjusted width that was set
\nThe box-adjusted height that was set
\nWhether or not the height/width are stored on the component permanently
\nContainer requesting the layout. Only used when isSetSize is false.
\nAligns this floating Component to the specified element
\nThe element or Ext.Component to align to. If passing a component, it must be a\nomponent instance. If a string id is passed, it will be used as an element id.
\nThe position to align to (see Ext.Element.alignTo for more details).
\nDefaults to: "tl-bl?"
Offset the positioning by [x, y]
\nthis
\nPerform 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
\nApplies the state to the object. This should be overridden in subclasses to do\nmore complex state operations. By default it applies the state properties onto\nthe current object.
\nThe state
\nOccurs before componentLayout is run. Returning false from this method will prevent the componentLayout from\nbeing executed.
\nThe box-adjusted width that was set
\nThe box-adjusted height that was set
\nWhether or not the height/width are stored on the component permanently
\nContainer requesting sent the layout. Only used when isSetSize is false.
\nChanges the data store bound to this LoadMask.
\nThe store to bind to this LoadMask
\nBubbles up the component/container heirarchy, calling the specified function with each component. The scope\n(this) of function call will be the scope provided or the current component. The arguments to the function will\nbe the args provided or the current component. If the function returns false at any point, the bubble is stopped.
\nThe function to call
\nThe scope of the function. Defaults to current node.
\nThe args to call the function with. Defaults to passing the current component.
\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
\nClone the current component using the original config values passed into this instance by default.
\nA new config containing any properties to override in the cloned version.\nAn id property can be passed on this object, otherwise one will be generated to avoid duplicates.
\nclone The cloned copy of this component
\nEnsures that the plugins array contains fully constructed plugin instances. This converts any configs into their\nappropriate instances.
\nDisable the component.
\nPassing true will supress the 'disable' event from being fired.
\nDefaults to: false
Handles autoRender. Floating Components may have an ownerCt. If they are asking to be constrained, constrain them\nwithin that ownerCt, and have their z-index managed locally. Floating Components are always rendered to\ndocument.body
\nThis method needs to be called whenever you change something on this component that requires the Component's\nlayout to be recalculated.
\nthis
\nMoves this floating Component into a constrain region.
\n\nBy default, this Component is constrained to be within the container it was added to, or the element it was\nrendered to.
\n\nAn alternative constraint may be passed.
\nThe Element or Region into which this Component is\nto be constrained. Defaults to the element into which this floating Component was rendered.
\nEnable the component
\nPassing true will supress the 'enable' event from being fired.
\nDefaults to: false
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});\nThis method finds the topmost active layout who's processing will eventually determine the size and position of\nthis Component.
\n\nThis method is useful when dynamically adding Components into Containers, and some processing must take place\nafter the final sizing and positioning of the Component has been performed.
\nFind a container above this component at any level by a custom function. If the passed function returns true, the\ncontainer will be returned.
\nThe custom function to call with the arguments (container, this component).
\nThe first Container for which the custom function returns true
\nFind a container above this component at any level by xtype or class
\n\nSee also the up method.
\nThe first Container which matches the given xtype or class
\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.
\nTry to focus this component.
\nIf applicable, true to also select the text in this component
\nDelay the focus this number of milliseconds (true for 10 milliseconds).
\nthis
\nForces this component to redo its componentLayout.
\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\nProvides the link for Observable's fireEvent method to bubble up the ownership hierarchy.
\nthe Container which owns this Component.
\nRetrieves the id of this component. Will autogenerate an id if one has not already been set.
\nThis function takes the position argument passed to onRender and returns a DOM element that you can use in the\ninsertBefore.
\nIndex, element id or element you want to put this\ncomponent before.
\nDOM element that you can use in the insertBefore
\nGets the Ext.ComponentLoader for this Component.
\nThe loader instance, null if it doesn't exist.
\nRetrieves a plugin by its pluginId which has been bound to this component.
\nplugin instance.
\nGets the current size of the component's underlying element.
\nAn object containing the element's size {width: (element width), height: (element height)}
\nThe supplied default state gathering method for the AbstractComponent class.
\n\nThis method returns dimension settings such as flex, anchor, width and height along with collapsed\nstate.
Subclasses which implement more complex state should call the superclass's implementation, and apply their state\nto the result if this basic state is to be saved.
\n\nNote that Component state will only be saved if the Component has a stateId and there as a StateProvider\nconfigured for the document.
\nGets the xtype for this component as registered with Ext.ComponentManager. For a list of all available\nxtypes, see the Ext.Component header. Example usage:
\n\nvar t = new Ext.form.field.Text();\nalert(t.getXType()); // alerts 'textfield'\nThe xtype
\nReturns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the\nExt.Component header.
\n\nIf using your own subclasses, be aware that a Component must register its own xtype to participate in\ndetermination of inherited xtypes.
\n\nExample usage:
\n\nvar t = new Ext.form.field.Text();\nalert(t.getXTypes()); // alerts 'component/field/textfield'\nThe xtype hierarchy string
\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 this Component, setting it to invisible using the configured hideMode.
\nA callback function to call after the Component is hidden.
\nThe scope (this reference) in which the callback is executed.\nDefaults to this Component.
this
\nThe initComponent template method is an important initialization step for a Component. It is intended to be\nimplemented by each subclass of Ext.Component to provide any needed constructor logic. The\ninitComponent method of the class being created is called first, with each initComponent method\nup the hierarchy to Ext.Component being called thereafter. This makes it easy to implement and,\nif needed, override the constructor logic of the Component at any step in the hierarchy.
\n\nThe initComponent method must contain a call to callParent in order\nto ensure that the parent class' initComponent method is also called.
\n\nThe following example demonstrates using a dynamic string for the text of a button at the time of\ninstantiation of the class.
\n\nExt.define('DynamicButtonText', {\n extend: 'Ext.button.Button',\n\n initComponent: function() {\n this.text = new Date();\n this.renderTo = Ext.getBody();\n this.callParent();\n }\n});\n\nExt.onReady(function() {\n Ext.create('DynamicButtonText');\n});\nThis is a template method. A hook into the functionality of this class.Feel free to override it in child classes.
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'\nmixins The mixin prototypes as key - value pairs
\nDetermines whether this component is the descendant of a particular container.
\nTrue if it is.
\nMethod to determine whether this Component is currently disabled.
\nthe disabled state of this Component.
\nMethod to determine whether this Component is draggable.
\nthe draggable state of this component.
\nMethod to determine whether this Component is droppable.
\nthe droppable state of this component.
\nMethod to determine whether this Component is floating.
\nthe floating state of this component.
\nMethod to determine whether this Component is currently set to hidden.
\nthe hidden state of this Component.
\nReturns true if this component is visible.
\nPass true to interrogate the visibility status of all parent Containers to\ndetermine whether this Component is truly visible to the user.
Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating\ndynamically laid out UIs in a hidden Container before showing them.
\nDefaults to: false
True if this component is visible, false otherwise.
\nTests whether or not this Component is of a specific xtype. This can test whether this Component is descended\nfrom the xtype (default) or whether it is directly of the xtype specified (shallow = true).
\n\nIf using your own subclasses, be aware that a Component must register its own xtype to participate in\ndetermination of inherited xtypes.
\n\nFor a list of all available xtypes, see the Ext.Component header.
\n\nExample usage:
\n\nvar t = new Ext.form.field.Text();\nvar isText = t.isXType('textfield'); // true\nvar isBoxSubclass = t.isXType('field'); // true, descended from Ext.form.field.Base\nvar isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.field.Base instance\nThe xtype to check for this Component
\nTrue to check whether this Component is directly of the specified xtype, false to\ncheck whether this Component is descended from the xtype.
\nDefaults to: false
True if this component descends from the specified xtype, false otherwise.
\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.
Returns the next node in the Component tree in tree traversal order.
\n\nNote that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the\ntree to attempt to find a match. Contrast with nextSibling.
\nA ComponentQuery selector to filter the following nodes.
\nThe next node (or the next node which matches the selector).\nReturns null if there is no matching node.
\nReturns the next sibling of this Component.
\n\nOptionally selects the next sibling which matches the passed ComponentQuery selector.
\n\nMay also be refered to as next()
Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with\nnextNode
A ComponentQuery selector to filter the following items.
\nThe next sibling (or the next sibling which matches the selector).\nReturns null if there is no matching sibling.
\nShorthand 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});\nReturns the previous node in the Component tree in tree traversal order.
\n\nNote that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the\ntree in reverse order to attempt to find a match. Contrast with previousSibling.
\nA ComponentQuery selector to filter the preceding nodes.
\nThe previous node (or the previous node which matches the selector).\nReturns null if there is no matching node.
\nReturns the previous sibling of this Component.
\n\nOptionally selects the previous sibling which matches the passed ComponentQuery\nselector.
\n\nMay also be refered to as prev()
Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with\npreviousNode
A ComponentQuery selector to filter the preceding items.
\nThe previous sibling (or the previous sibling which matches the selector).\nReturns null if there is no matching sibling.
\nRemoves items in the childEls array based on the return value of a supplied test function. The function is called\nwith a entry in childEls and if the test function return true, that entry is removed. If false, that entry is\nkept.
\nThe test function.
\nRemoves a CSS class from the top level element representing this component.
\nReturns the Component to allow method chaining.
\nRemoves a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all\nelements of this component.
\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.
Method which removes a specified UI + uiCls from the components element. The cls which is added to the element\nwill be: this.baseCls + '-' + ui
The UI to add to the element
\nResumes 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.
Conditionally saves a single property from this object to the given state object.\nThe idea is to only save state which has changed from the initial state so that\ncurrent software settings do not override future software settings. Only those\nvalues that are user-changed state should be saved.
\nThe name of the property to save.
\nThe state object in to which to save the property.
\nThe name to use for the property in state.
\nTrue if the property was saved, false if not.
\nThis method is called internally by Ext.ZIndexManager to signal that a floating Component has either been\nmoved to the top of its zIndex stack, or pushed from the top of its zIndex stack.
\n\nIf a Window is superceded by another Window, deactivating it hides its shadow.
\n\nThis method also fires the activate or\ndeactivate event depending on which action occurred.
\nTrue to activate the Component, false to deactivate it.
\nDefaults to: false
The newly active Component which is taking over topmost zIndex position.
\nSets the overflow on the content element of the component.
\nTrue to allow the Component to auto scroll.
\nthis
\nSets the dock position of this component in its parent panel. Note that this only has effect if this item is part\nof the dockedItems collection of a parent that has a DockLayout (note that any Panel has a DockLayout by default)
\nThe dock position.
\nTrue to re-layout parent.
\nDefaults to: false
this
\nSets the height of the component. This method fires the resize event.
\nThe new height to set. This may be one of:
\n\nthis
\nThis method allows you to show or hide a LoadMask on top of this component.
\nTrue to show the default LoadMask, a config object that will be passed to the\nLoadMask constructor, or a message String to show. False to hide the current LoadMask.
\nTrue to mask the targetEl of this Component instead of the this.el. For example,\nsetting this to true on a Panel will cause only the body to be masked.
Defaults to: false
The LoadMask instance that has just been shown.
\nSets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the move event.
\nThe new x position
\nThe new y position
\nTrue to animate the Component into its new position. You may also pass an\nanimation configuration.
\nthis
\nSets the left and top of the component. To set the page XY position instead, use setPagePosition. This\nmethod fires the move event.
\nThe new left
\nThe new top
\nIf true, the Component is animated into its new position. You may also pass an\nanimation configuration.
\nthis
\nSets the width and height of this Component. This method fires the resize event. This method can accept\neither width and height as separate arguments, or you can pass a size object like {width:10, height:20}.
The new width to set. This may be one of:
\n\n{width: widthValue, height: heightValue}.undefined to leave the width unchanged.The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
\n\nundefined to leave the height unchanged.this
\nSets the UI for the component. This will remove any existing UIs on the component. It will also loop through any\nuiCls set on the component and rename them so they include the new UI
\nThe new UI for the component
\nConvenience function to hide or show this component by boolean.
\nTrue to show, false to hide
\nthis
\nSets the width of the component. This method fires the resize event.
\nThe new width to setThis may be one of:
\n\nthis
\nShows this Component, rendering it first if autoRender or floating are true.
After being shown, a floating Component (such as a Ext.window.Window), is activated it and\nbrought to the front of its z-index stack.
\nA callback function to call after the Component is displayed.\nOnly necessary if animation was specified.
\nThe scope (this reference) in which the callback is executed.\nDefaults to this Component.
this
\nDisplays component at specific xy position.\nA floating component (like a menu) is positioned relative to its ownerCt if any.\nUseful for popping up a context menu:
\n\nlisteners: {\n itemcontextmenu: function(view, record, item, index, event, options) {\n Ext.create('Ext.menu.Menu', {\n width: 100,\n height: 100,\n margin: '0 0 10 0',\n items: [{\n text: 'regular item 1'\n },{\n text: 'regular item 2'\n },{\n text: 'regular item 3'\n }]\n }).showAt(event.getXY());\n }\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\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
\nSends this Component to the back of (lower z-index than) any other visible windows
\nthis
\nBrings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManager
\n\nIf this Component is modal, inserts the modal mask just below this Component in the z-index stack.
\nSpecify true to prevent the Component from being focused.
Defaults to: false
this
\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\nWalks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector.
Example:
\n\nvar owningTabPanel = grid.up('tabpanel');\nThe simple selector to test.
\nThe matching ancestor Container (or undefined if no match was found).
Update the content area of a component.
\nIf this component has been configured with a template via the tpl config then\nit will use this argument as data to populate the template. If this component was not configured with a template,\nthe components content area will be updated via Ext.Element update
\nOnly legitimate when using the html configuration.
\nDefaults to: false
Only legitimate when using the html configuration. Callback to execute when\nscripts have finished loading
\nSets the current box measurements of the component's underlying element.
\nAn object in the format {x, y, width, height}
\nthis
\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
\nFires after a Component has been visually activated.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after a Component had been added to a Container.
\nParent Container
\nposition of Component
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the component rendering is finished.
\n\nThe afterrender event is fired after this Component has been rendered, been postprocesed by any\nafterRender method defined for the Component.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before a Component has been visually activated. Returning false from an event listener can prevent\nthe activate from occurring.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before a Component has been visually deactivated. Returning false from an event listener can\nprevent the deactivate from occurring.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before the component is destroyed. Return false from an event handler to stop the\ndestroy.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before the component is hidden when calling the hide method. Return false from an event\nhandler to stop the hide.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before the component is rendered. Return false from an event handler to stop the\nrender.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before the component is shown when calling the show method. Return false from an event\nhandler to stop the show.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before the state of the object is restored. Return false from an event handler to stop the restore.
\nThe hash of state values returned from the StateProvider. If this\nevent is not vetoed, then the state object is passed to applyState. By default,\nthat simply copies property values into this object. The method maybe overriden to\nprovide custom state restoration.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before the state of the object is saved to the configured state provider. Return false to stop the save.
\nThe hash of state values. This is determined by calling\ngetState() on the object. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, Ext.state.Stateful\nhas a null implementation.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after a Component has been visually deactivated.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the component is destroyed.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the component is disabled.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the component is enabled.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the component is hidden. Fires after the component is hidden when calling the hide\nmethod.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the component is moved.
\nThe new x position
\nThe new y position
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when a component is removed from an Ext.container.Container
\nContainer which holds the component
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the component markup is rendered.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the component is resized.
\nThe box-adjusted width that was set
\nThe box-adjusted height that was set
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the component is shown when calling the show method.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the state of the object is restored.
\nThe hash of state values returned from the StateProvider. This is passed\nto applyState. By default, that simply copies property values into this\nobject. The method maybe overriden to provide custom state restoration.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires after the state of the object is saved to the configured state provider.
\nThe hash of state values. This is determined by calling\ngetState() on the object. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, Ext.state.Stateful\nhas a null implementation.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\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.AbstractComponent","template":false,"required":null,"protected":false,"name":"hasUICls","id":"method-hasUICls"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Component","template":false,"required":null,"protected":false,"name":"hide","id":"method-hide"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Component","template":true,"required":null,"protected":false,"name":"initComponent","id":"method-initComponent"},{"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.AbstractComponent","template":false,"required":null,"protected":false,"name":"is","id":"method-is"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"isDescendantOf","id":"method-isDescendantOf"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"isDisabled","id":"method-isDisabled"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"isDraggable","id":"method-isDraggable"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"isDroppable","id":"method-isDroppable"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"isFloating","id":"method-isFloating"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"isHidden","id":"method-isHidden"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"isVisible","id":"method-isVisible"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"isXType","id":"method-isXType"},{"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.AbstractComponent","template":false,"required":null,"protected":false,"name":"nextNode","id":"method-nextNode"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"nextSibling","id":"method-nextSibling"},{"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.AbstractComponent","template":false,"required":null,"protected":false,"name":"previousNode","id":"method-previousNode"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"previousSibling","id":"method-previousSibling"},{"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.AbstractComponent","template":false,"required":null,"protected":false,"name":"removeChildEls","id":"method-removeChildEls"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"removeCls","id":"method-removeCls"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"removeClsWithUI","id":"method-removeClsWithUI"},{"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.AbstractComponent","template":false,"required":null,"protected":false,"name":"removeUIClsFromElement","id":"method-removeUIClsFromElement"},{"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.state.Stateful","template":false,"required":null,"protected":false,"name":"savePropToState","id":"method-savePropToState"},{"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.util.Floating","template":false,"required":null,"protected":false,"name":"setActive","id":"method-setActive"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Component","template":false,"required":null,"protected":false,"name":"setAutoScroll","id":"method-setAutoScroll"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"setDisabled","id":"method-setDisabled"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"setDocked","id":"method-setDocked"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"setHeight","id":"method-setHeight"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"setLoading","id":"method-setLoading"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Component","template":false,"required":null,"protected":false,"name":"setPagePosition","id":"method-setPagePosition"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Component","template":false,"required":null,"protected":false,"name":"setPosition","id":"method-setPosition"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"setSize","id":"method-setSize"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"setUI","id":"method-setUI"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"setVisible","id":"method-setVisible"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"setWidth","id":"method-setWidth"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Component","template":false,"required":null,"protected":false,"name":"show","id":"method-show"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Component","template":false,"required":null,"protected":false,"name":"showAt","id":"method-showAt"},{"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.Floating","template":false,"required":null,"protected":false,"name":"toBack","id":"method-toBack"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Floating","template":false,"required":null,"protected":false,"name":"toFront","id":"method-toFront"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.util.Observable","template":false,"required":null,"protected":false,"name":"un","id":"method-un"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"up","id":"method-up"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":false,"required":null,"protected":false,"name":"update","id":"method-update"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.Component","template":false,"required":null,"protected":false,"name":"updateBox","id":"method-updateBox"}],"event":[{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"activate","id":"event-activate"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"added","id":"event-added"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"afterrender","id":"event-afterrender"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"beforeactivate","id":"event-beforeactivate"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"beforedeactivate","id":"event-beforedeactivate"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"beforedestroy","id":"event-beforedestroy"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"beforehide","id":"event-beforehide"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"beforerender","id":"event-beforerender"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"beforeshow","id":"event-beforeshow"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.state.Stateful","template":null,"required":null,"protected":false,"name":"beforestaterestore","id":"event-beforestaterestore"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.state.Stateful","template":null,"required":null,"protected":false,"name":"beforestatesave","id":"event-beforestatesave"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"deactivate","id":"event-deactivate"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"destroy","id":"event-destroy"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"disable","id":"event-disable"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"enable","id":"event-enable"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"hide","id":"event-hide"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"move","id":"event-move"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"removed","id":"event-removed"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"render","id":"event-render"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"resize","id":"event-resize"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.AbstractComponent","template":null,"required":null,"protected":false,"name":"show","id":"event-show"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.state.Stateful","template":null,"required":null,"protected":false,"name":"staterestore","id":"event-staterestore"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.state.Stateful","template":null,"required":null,"protected":false,"name":"statesave","id":"event-statesave"}]},"private":false,"component":true,"name":"Ext.LoadMask","alternateClassNames":[],"id":"class-Ext.LoadMask","mixedInto":[],"xtypes":{"widget":["loadmask"]},"files":[{"href":"LoadMask.html#Ext-LoadMask","filename":"LoadMask.js"}]}); \ No newline at end of file