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.Animating an Element
\nWhen animating an Element, the following properties may be specified infrom, to, and keyframe objects:- \n
xThe page X position in pixels.\nyThe page Y position in pixels\nleftThe element's CSSleftvalue. Units must be supplied. \ntopThe element's CSStopvalue. Units must be supplied. \nwidthThe element's CSSwidthvalue. Units must be supplied. \nheightThe element's CSSheightvalue. Units must be supplied. \nscrollLeftThe element'sscrollLeftvalue. \nscrollTopThe element'sscrollLeftvalue. \nopacityThe element'sopacityvalue. This must be a value between0and1. \n
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.
\nAnimating a Component
\nWhen animating an Element, the following properties may be specified infrom, to, and keyframe objects:- \n
xThe Component's page X position in pixels.\nyThe Component's page Y position in pixels\nleftThe Component'sleftvalue in pixels. \ntopThe Component'stopvalue in pixels. \nwidthThe Component'swidthvalue in pixels. \nwidthThe Component'swidthvalue in pixels. \ndynamicSpecify as true to update the Component's layout (if it is a Container) at every frame\nof the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.\n
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.
this
\n" - }, - "html_filename": "Animate.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Stateful.html#Ext-state-Stateful-method-applyState", - "shortDoc": "Applies the state to the object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "The state
\n", - "name": "state" - } - ], - "name": "applyState", - "owner": "Ext.state.Stateful", - "doc": "Applies 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.
\n", - "linenr": 225, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Stateful.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-beforeComponentLayout", - "shortDoc": "Occurs before componentLayout is run. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "The box-adjusted width that was set
\n", - "name": "adjWidth" - }, - { - "type": "Number", - "optional": false, - "doc": "The box-adjusted height that was set
\n", - "name": "adjHeight" - }, - { - "type": "Boolean", - "optional": false, - "doc": "Whether or not the height/width are stored on the component permanently
\n", - "name": "isSetSize" - }, - { - "type": "Ext.Component", - "optional": false, - "doc": "Container requesting sent the layout. Only used when isSetSize is false.
\n", - "name": "callingContainer" - } - ], - "name": "beforeComponentLayout", - "owner": "Ext.AbstractComponent", - "doc": "Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout\nfrom being executed.
\n", - "linenr": 2709, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-bubble", - "shortDoc": "Bubbles up the component/container heirarchy, calling the specified function with each component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "The function to call
\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) The scope of the function (defaults to current node)
\n", - "name": "scope" - }, - { - "type": "Array", - "optional": true, - "doc": "(optional) The args to call the function with (default to passing the current component)
\n", - "name": "args" - } - ], - "name": "bubble", - "owner": "Ext.Component", - "doc": "Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of\nfunction call will be the scope provided or the current component. The arguments to the function\nwill be the args provided or the current component. If the function returns false at any point,\nthe bubble is stopped.
\n", - "linenr": 1007, - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "html_filename": "Component2.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": "Floating.html#Ext-util-Floating-method-center", - "shortDoc": "Center this Component in its container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", - "private": false, - "params": [ - - ], - "name": "center", - "owner": "Ext.util.Floating", - "doc": "Center this Component in its container.
\n", - "linenr": 251, - "return": { - "type": "Component", - "doc": "this
\n" - }, - "html_filename": "Floating.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": "Component2.html#Ext-Component-method-cloneConfig", - "shortDoc": "Clone the current component using the original config values passed into this instance by default. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "A 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.
\n", - "name": "overrides" - } - ], - "name": "cloneConfig", - "owner": "Ext.Component", - "doc": "Clone the current component using the original config values passed into this instance by default.
\n", - "linenr": 947, - "return": { - "type": "Ext.Component", - "doc": "clone The cloned copy of this component
\n" - }, - "html_filename": "Component2.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()\nDestroys the Component.
\n", - "linenr": 2891, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-disable", - "shortDoc": "Disable the component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "Passing true, will supress the 'disable' event from being fired.
\n", - "name": "silent" - } - ], - "name": "disable", - "owner": "Ext.AbstractComponent", - "doc": "Disable the component.
\n", - "linenr": 2245, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-doAutoRender", - "shortDoc": "Handles autoRender. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "doAutoRender", - "owner": "Ext.AbstractComponent", - "doc": "Handles autoRender.\nFloating Components may have an ownerCt. If they are asking to be constrained, constrain them within that\nownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body
\n", - "linenr": 920, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-doComponentLayout", - "shortDoc": "This method needs to be called whenever you change something on this component that requires the Component's\nlayout t...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "width" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "height" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "isSetSize" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "callingContainer" - } - ], - "name": "doComponentLayout", - "owner": "Ext.AbstractComponent", - "doc": "This method needs to be called whenever you change something on this component that requires the Component's\nlayout to be recalculated.
\n", - "linenr": 2630, - "return": { - "type": "Ext.container.Container", - "doc": "this
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Floating.html#Ext-util-Floating-method-doConstrain", - "shortDoc": "Moves this floating Component into a constrain region. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "Optional. The Element or Region into which this Component is to be constrained.
\n", - "name": "constrainTo" - } - ], - "name": "doConstrain", - "owner": "Ext.util.Floating", - "doc": "Moves this floating Component into a constrain region.
\n\n\nBy default, this Component is constrained to be within the container it was added to, or the element\nit was rendered to.
\n\n\nAn alternative constraint may be passed.
\n\n", - "linenr": 135, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Floating.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-enable", - "shortDoc": "Enable the component ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "Passing false will supress the 'enable' event from being fired.
\n", - "name": "silent" - } - ], - "name": "enable", - "owner": "Ext.AbstractComponent", - "doc": "Enable the component
\n", - "linenr": 2222, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.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});\nThis method finds the topmost active layout who's processing will eventually determine the size and position of this\nComponent.
\n
This method is useful when dynamically adding Components into Containers, and some processing must take place after the\nfinal sizing and positioning of the Component has been performed.
\n\n", - "linenr": 876, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-findParentBy", - "shortDoc": "Find a container above this component at any level by a custom function. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "The custom function to call with the arguments (container, this component).
\n", - "name": "fn" - } - ], - "name": "findParentBy", - "owner": "Ext.Component", - "doc": "Find a container above this component at any level by a custom function. If the passed function returns\ntrue, the container will be returned.
\n", - "linenr": 978, - "return": { - "type": "Ext.container.Container", - "doc": "The first Container for which the custom function returns true
\n" - }, - "html_filename": "Component2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-findParentByType", - "shortDoc": "Find a container above this component at any level by xtype or class\n\n\nSee also the up method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "String/Class", - "optional": false, - "doc": "The xtype string for a component, or the class of the component directly
\n", - "name": "xtype" - } - ], - "name": "findParentByType", - "owner": "Ext.Component", - "doc": "Find a container above this component at any level by xtype or class
\n\n\nSee also the up method.
\n\n", - "linenr": 992, - "return": { - "type": "Ext.container.Container", - "doc": "The first Container which matches the given xtype or class
\n" - }, - "html_filename": "Component2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-fireEvent", - "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The name of the event to fire.
\n", - "name": "eventName" - }, - { - "type": "Object...", - "optional": false, - "doc": "Variable number of parameters are passed to handlers.
\n", - "name": "args" - } - ], - "name": "fireEvent", - "owner": "Ext.util.Observable", - "doc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\n", - "linenr": 233, - "return": { - "type": "Boolean", - "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-focus", - "shortDoc": "Try to focus this component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": true, - "doc": "(optional) If applicable, true to also select the text in this component
\n", - "name": "selectText" - }, - { - "type": "Boolean/Number", - "optional": true, - "doc": "(optional) Delay the focus this number of milliseconds (true for 10 milliseconds).
\n", - "name": "delay" - } - ], - "name": "focus", - "owner": "Ext.Component", - "doc": "Try to focus this component.
\n", - "linenr": 856, - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "html_filename": "Component2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-forceComponentLayout", - "shortDoc": "Forces this component to redo its componentLayout. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "forceComponentLayout", - "owner": "Ext.AbstractComponent", - "doc": "Forces this component to redo its componentLayout.
\n", - "linenr": 2673, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Animate.html#Ext-util-Animate-method-getActiveAnimation", - "shortDoc": "Returns thq current animation if this object has any effects actively running or queued, else returns false. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Animate.js", - "private": false, - "params": [ - - ], - "name": "getActiveAnimation", - "owner": "Ext.util.Animate", - "doc": "Returns thq current animation if this object has any effects actively running or queued, else returns false.
\n", - "linenr": 377, - "return": { - "type": "Mixed", - "doc": "anim if element has active effects, else false
\n" - }, - "html_filename": "Animate.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-getBox", - "shortDoc": "Gets the current box measurements of the component's underlying element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": true, - "doc": "(optional) If true the element's left and top are returned instead of page XY (defaults to false)
\n", - "name": "local" - } - ], - "name": "getBox", - "owner": "Ext.Component", - "doc": "Gets the current box measurements of the component's underlying element.
\n", - "linenr": 541, - "return": { - "type": "Object", - "doc": "box An object in the format {x, y, width, height}
\n" - }, - "html_filename": "Component2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getBubbleTarget", - "shortDoc": "Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "getBubbleTarget", - "owner": "Ext.AbstractComponent", - "doc": "Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.
\n", - "linenr": 2443, - "return": { - "type": "Ext.container.Container", - "doc": "the Container which owns this Component.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getEl", - "shortDoc": "Retrieves the top level element representing this component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "getEl", - "owner": "Ext.AbstractComponent", - "doc": "Retrieves the top level element representing this component.
\n", - "linenr": 2059, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getHeight", - "shortDoc": "Gets the current height of the component's underlying element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "getHeight", - "owner": "Ext.AbstractComponent", - "doc": "Gets the current height of the component's underlying element.
\n", - "linenr": 2798, - "return": { - "type": "Number", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getId", - "shortDoc": "Retrieves the id of this component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "getId", - "owner": "Ext.AbstractComponent", - "doc": "Retrieves the id of this component.\nWill autogenerate an id if one has not already been set.
\n", - "linenr": 2047, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getInsertPosition", - "shortDoc": "This function takes the position argument passed to onRender and returns a\nDOM element that you can use in the insert...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String/Number/Element/HTMLElement", - "optional": false, - "doc": "Index, element id or element you want\nto put this component before.
\n", - "name": "position" - } - ], - "name": "getInsertPosition", - "owner": "Ext.AbstractComponent", - "doc": "This function takes the position argument passed to onRender and returns a\nDOM element that you can use in the insertBefore.
\n", - "linenr": 1674, - "return": { - "type": "HTMLElement", - "doc": "DOM element that you can use in the insertBefore
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getLoader", - "shortDoc": "Gets the Ext.ComponentLoader for this Component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "getLoader", - "owner": "Ext.AbstractComponent", - "doc": "Gets the Ext.ComponentLoader for this Component.
\n", - "linenr": 2806, - "return": { - "type": "Ext.ComponentLoader", - "doc": "The loader instance, null if it doesn't exist.
\n" - }, - "html_filename": "AbstractComponent.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": "AbstractComponent.html#Ext-AbstractComponent-method-getPlugin", - "shortDoc": "Retrieves a plugin by its pluginId which has been bound to this\ncomponent. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "pluginId" - } - ], - "name": "getPlugin", - "owner": "Ext.AbstractComponent", - "doc": "Retrieves a plugin by its pluginId which has been bound to this\ncomponent.
\n", - "linenr": 2934, - "return": { - "type": "Ext.AbstractPlugin", - "doc": "pluginInstance
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-getPosition", - "shortDoc": "Gets the current XY position of the component's underlying element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": true, - "doc": "(optional) If true the element's left and top are returned instead of page XY (defaults to false)
\n", - "name": "local" - } - ], - "name": "getPosition", - "owner": "Ext.Component", - "doc": "Gets the current XY position of the component's underlying element.
\n", - "linenr": 606, - "return": { - "type": "Array", - "doc": "The XY position of the element (e.g., [100, 200])
\n" - }, - "html_filename": "Component2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getSize", - "shortDoc": "Gets the current size of the component's underlying element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "getSize", - "owner": "Ext.AbstractComponent", - "doc": "Gets the current size of the component's underlying element.
\n", - "linenr": 2782, - "return": { - "type": "Object", - "doc": "An object containing the element's size {width: (element width), height: (element height)}
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getState", - "shortDoc": "The supplied default state gathering method for the AbstractComponent class. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "getState", - "owner": "Ext.AbstractComponent", - "doc": "The supplied default state gathering method for the AbstractComponent class.\nThis method returns dimension setings such asflex, anchor, width\nand height along with collapsed state.\n\nSubclasses 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\n\nNote that Component state will only be saved if the Component has a stateId and there as a StateProvider\nconfigured for the document.
\n\n", - "linenr": 750, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Stateful.html#Ext-state-Stateful-method-getStateId", - "shortDoc": "Gets the state id for this object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", - "private": false, - "params": [ - - ], - "name": "getStateId", - "owner": "Ext.state.Stateful", - "doc": "Gets the state id for this object.
\n", - "linenr": 237, - "return": { - "type": "String", - "doc": "The state id, null if not found.
\n" - }, - "html_filename": "Stateful.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getWidth", - "shortDoc": "Gets the current width of the component's underlying element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "getWidth", - "owner": "Ext.AbstractComponent", - "doc": "Gets the current width of the component's underlying element.
\n", - "linenr": 2790, - "return": { - "type": "Number", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-getXType", - "shortDoc": "Gets the xtype for this component as registered with Ext.ComponentManager. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - - ], - "name": "getXType", - "owner": "Ext.Component", - "doc": "Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all\navailable xtypes, see the Ext.Component header. Example usage:
\n\nvar t = new Ext.form.field.Text();\nalert(t.getXType()); // alerts 'textfield'\nThe xtype
\n" - }, - "html_filename": "Component2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getXTypes", - "shortDoc": "Returns this Component's xtype hierarchy as a slash-delimited string. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "getXTypes", - "owner": "Ext.AbstractComponent", - "doc": "Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all\navailable xtypes, see the Ext.Component header.
\n\n\nIf using your own subclasses, be aware that a Component must register its own xtype\nto participate in determination of inherited xtypes.
\n\n\nExample usage:
\n\n\nvar t = new Ext.form.field.Text();\nalert(t.getXTypes()); // alerts 'component/field/textfield'\nThe xtype hierarchy string
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": { - "version": "4.0", - "text": "Replaced by getActiveAnimation
\n\n\n\n", - "tagname": "deprecated", - "doc": "Returns thq current animation if this object has any effects actively running or queued, else returns false." - }, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Animate.html#Ext-util-Animate-method-hasActiveFx", - "shortDoc": "Returns thq current animation if this object has any effects actively running or queued, else returns false. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Animate.js", - "private": false, - "params": [ - - ], - "name": "hasActiveFx", - "owner": "Ext.util.Animate", - "doc": "Returns thq current animation if this object has any effects actively running or queued, else returns false.
\n", - "linenr": 369, - "return": { - "type": "Mixed", - "doc": "anim if element has active effects, else false
\n" - }, - "html_filename": "Animate.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": "AbstractComponent.html#Ext-AbstractComponent-method-hasUICls", - "shortDoc": "Checks if there is currently a specified uiCls ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The cls to check
\n", - "name": "cls" - } - ], - "name": "hasUICls", - "owner": "Ext.AbstractComponent", - "doc": "Checks if there is currently a specified uiCls
\n", - "linenr": 1523, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-hide", - "shortDoc": "Hides this Component, setting it to invisible using the configured hideMode. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "String/Element/Component", - "optional": false, - "doc": "Optional, and only valid for floating Components such as\nWindows or ToolTips, or regular Components which have been configured\nwith floating: true..\nThe target to which the Component should animate while hiding (defaults to null with no animation)
(optional) A callback function to call after the Component is hidden.
\n", - "name": "callback" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) The scope (this reference) in which the callback is executed. Defaults to this Component.
Hides this Component, setting it to invisible using the configured hideMode.
\n", - "linenr": 751, - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "html_filename": "Component2.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": "AbstractComponent.html#Ext-AbstractComponent-method-is", - "shortDoc": "Tests whether this Component matches the selector string. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The selector string to test against.
\n", - "name": "selector" - } - ], - "name": "is", - "owner": "Ext.AbstractComponent", - "doc": "Tests whether this Component matches the selector string.
\n", - "linenr": 1886, - "return": { - "type": "Boolean", - "doc": "True if this Component matches the selector.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDescendantOf", - "shortDoc": "Determines whether this component is the descendant of a particular container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Container", - "optional": false, - "doc": "\n", - "name": "container" - } - ], - "name": "isDescendantOf", - "owner": "Ext.AbstractComponent", - "doc": "Determines whether this component is the descendant of a particular container.
\n", - "linenr": 2950, - "return": { - "type": "Boolean", - "doc": "isDescendant
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDisabled", - "shortDoc": "Method to determine whether this Component is currently disabled. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "isDisabled", - "owner": "Ext.AbstractComponent", - "doc": "Method to determine whether this Component is currently disabled.
\n", - "linenr": 2282, - "return": { - "type": "Boolean", - "doc": "the disabled state of this Component.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDraggable", - "shortDoc": "Method to determine whether this Component is draggable. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "isDraggable", - "owner": "Ext.AbstractComponent", - "doc": "Method to determine whether this Component is draggable.
\n", - "linenr": 2459, - "return": { - "type": "Boolean", - "doc": "the draggable state of this component.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDroppable", - "shortDoc": "Method to determine whether this Component is droppable. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "isDroppable", - "owner": "Ext.AbstractComponent", - "doc": "Method to determine whether this Component is droppable.
\n", - "linenr": 2467, - "return": { - "type": "Boolean", - "doc": "the droppable state of this component.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isFloating", - "shortDoc": "Method to determine whether this Component is floating. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "isFloating", - "owner": "Ext.AbstractComponent", - "doc": "Method to determine whether this Component is floating.
\n", - "linenr": 2451, - "return": { - "type": "Boolean", - "doc": "the floating state of this component.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isHidden", - "shortDoc": "Method to determine whether this Component is currently set to hidden. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "isHidden", - "owner": "Ext.AbstractComponent", - "doc": "Method to determine whether this Component is currently set to hidden.
\n", - "linenr": 2298, - "return": { - "type": "Boolean", - "doc": "the hidden state of this Component.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isVisible", - "shortDoc": "Returns true if this component is visible. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": ".
Optional. Pass true to interrogate the visibility status of all\nparent Containers to determine 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\nwhen creating dynamically laid out UIs in a hidden Container before showing them.
\n\n", - "name": "deep" - } - ], - "name": "isVisible", - "owner": "Ext.AbstractComponent", - "doc": "Returns true if this component is visible.
\n", - "linenr": 2182, - "return": { - "type": "Boolean", - "doc": "True if this component is visible, false otherwise.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isXType", - "shortDoc": "Tests whether or not this Component is of a specific xtype. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The xtype to check for this Component
\n", - "name": "xtype" - }, - { - "type": "Boolean", - "optional": true, - "doc": "(optional) False to check whether this Component is descended from the xtype (this is\nthe default), or true to check whether this Component is directly of the specified xtype.
\n", - "name": "shallow" - } - ], - "name": "isXType", - "owner": "Ext.AbstractComponent", - "doc": "Tests 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\n\nIf using your own subclasses, be aware that a Component must register its own xtype\nto participate in determination of inherited xtypes.
\n\n\nFor a list of all available xtypes, see the Ext.Component header.
\n\n\nExample usage:
\n\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\nTrue if this component descends from the specified xtype, false otherwise.
\n" - }, - "html_filename": "AbstractComponent.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": "AbstractComponent.html#Ext-AbstractComponent-method-nextNode", - "shortDoc": "Returns the next node in the Component tree in tree traversal order. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "Optional A ComponentQuery selector to filter the following nodes.
\n", - "name": "selector" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "includeSelf" - } - ], - "name": "nextNode", - "owner": "Ext.AbstractComponent", - "doc": "Returns the next node in the Component tree in tree traversal order.
\n\n\nNote that this is not limited to siblings, and if invoked upon a node with no matching siblings, will\nwalk the tree to attempt to find a match. Contrast with nextSibling.
\n\n", - "linenr": 2012, - "return": { - "type": "void", - "doc": "The next node (or the next node which matches the selector). Returns null if there is no matching node.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-nextSibling", - "shortDoc": "Returns the next sibling of this Component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "Optional A ComponentQuery selector to filter the following items.
\n", - "name": "selector" - } - ], - "name": "nextSibling", - "owner": "Ext.AbstractComponent", - "doc": "Returns the next sibling of this Component.
\n\n\nOptionally selects the next sibling which matches the passed ComponentQuery selector.
\n\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 nextNode
The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.
\n" - }, - "html_filename": "AbstractComponent.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\n- \n
scope : Object
\n\nThe scope (
thisreference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event. \ndelay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
\nsingle : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
\nbuffer : 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.
\ntarget : 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.
\nelement : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n\n
Combining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\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": "AbstractComponent.html#Ext-AbstractComponent-method-previousNode", - "shortDoc": "Returns the previous node in the Component tree in tree traversal order. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "Optional. A ComponentQuery selector to filter the preceding nodes.
\n", - "name": "selector" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "includeSelf" - } - ], - "name": "previousNode", - "owner": "Ext.AbstractComponent", - "doc": "Returns the previous node in the Component tree in tree traversal order.
\n\n\nNote that this is not limited to siblings, and if invoked upon a node with no matching siblings, will\nwalk the tree in reverse order to attempt to find a match. Contrast with previousSibling.
\n\n", - "linenr": 1976, - "return": { - "type": "void", - "doc": "The previous node (or the previous node which matches the selector). Returns null if there is no matching node.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-previousSibling", - "shortDoc": "Returns the previous sibling of this Component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "Optional. A ComponentQuery selector to filter the preceding items.
\n", - "name": "selector" - } - ], - "name": "previousSibling", - "owner": "Ext.AbstractComponent", - "doc": "Returns the previous sibling of this Component.
\n\n\nOptionally selects the previous sibling which matches the passed ComponentQuery selector.
\n\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 previousNode
The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.
\n" - }, - "html_filename": "AbstractComponent.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": "AbstractComponent.html#Ext-AbstractComponent-method-removeCls", - "shortDoc": "Removes a CSS class from the top level element representing this component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "className" - } - ], - "name": "removeCls", - "owner": "Ext.AbstractComponent", - "doc": "Removes a CSS class from the top level element representing this component.
\n", - "linenr": 2338, - "return": { - "type": "Ext.Component", - "doc": "Returns the Component to allow method chaining.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-removeClsWithUI", - "shortDoc": "Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes\nit from all elements of thi...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String/Array", - "optional": false, - "doc": "A string or an array of strings to remove to the uiCls
\n", - "name": "cls" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "skip" - } - ], - "name": "removeClsWithUI", - "owner": "Ext.AbstractComponent", - "doc": "Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes\nit from all elements of this component.
\n", - "linenr": 1494, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.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": "AbstractComponent.html#Ext-AbstractComponent-method-removeUIClsFromElement", - "shortDoc": "Method which removes a specified UI + uiCls from the components element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The UI to add to the element
\n", - "name": "ui" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "force" - } - ], - "name": "removeUIClsFromElement", - "owner": "Ext.AbstractComponent", - "doc": "Method which removes a specified UI + uiCls from the components element.\nThe cls which is added to the element will be: this.baseCls + '-' + ui
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.
Ensures that all effects queued after sequenceFx is called on this object are\nrun in sequence. This is the opposite of syncFx.
\n", - "linenr": 357, - "return": { - "type": "Object", - "doc": "this
\n" - }, - "html_filename": "Animate.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Floating.html#Ext-util-Floating-method-setActive", - "shortDoc": "This method is called internally by Ext.ZIndexManager to signal that a floating\nComponent has either been moved to th...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "True to activate the Component, false to deactivate it (defaults to false)
\n", - "name": "active" - }, - { - "type": "Component", - "optional": false, - "doc": "The newly active Component which is taking over topmost zIndex position.
\n", - "name": "newActive" - } - ], - "name": "setActive", - "owner": "Ext.util.Floating", - "doc": "This method is called internally by Ext.ZIndexManager to signal that a floating\nComponent has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.
\n\n\nIf a Window is superceded by another Window, deactivating it hides its shadow.
\n\n\nThis method also fires the activate or deactivate event depending on which action occurred.
\n\n", - "linenr": 218, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Floating.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-setAutoScroll", - "shortDoc": "Sets the overflow on the content element of the component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "True to allow the Component to auto scroll.
\n", - "name": "scroll" - } - ], - "name": "setAutoScroll", - "owner": "Ext.Component", - "doc": "Sets the overflow on the content element of the component.
\n", - "linenr": 362, - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "html_filename": "Component2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setDisabled", - "shortDoc": "Enable or disable the component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "\n", - "name": "disabled" - } - ], - "name": "setDisabled", - "owner": "Ext.AbstractComponent", - "doc": "Enable or disable the component.
\n", - "linenr": 2290, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setDocked", - "shortDoc": "Sets the dock position of this component in its parent panel. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "dock" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "layoutParent" - } - ], - "name": "setDocked", - "owner": "Ext.AbstractComponent", - "doc": "Sets the dock position of this component in its parent panel. Note that\nthis only has effect if this item is part of the dockedItems collection\nof a parent that has a DockLayout (note that any Panel has a DockLayout\nby default)
\n", - "linenr": 2865, - "return": { - "type": "Component", - "doc": "this
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setHeight", - "shortDoc": "Sets the height of the component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "The new height to set. This may be one of:
- \n
- A Number specifying the new height in the Element's Ext.core.Element.defaultUnits (by default, pixels). \n
- A String used to set the CSS height style. \n
- undefined to leave the height unchanged. \n
Sets the height of the component. This method fires the resize event.
\n", - "linenr": 2769, - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setLoading", - "shortDoc": "This method allows you to show or hide a LoadMask on top of this component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Boolean/Object/String", - "optional": false, - "doc": "True to show the default LoadMask, a config object\nthat will be passed to the LoadMask constructor, or a message String to show. False to\nhide the current LoadMask.
\n", - "name": "load" - }, - { - "type": "Boolean", - "optional": false, - "doc": "True to mask the targetEl of this Component instead of the this.el.\nFor example, setting this to true on a Panel will cause only the body to be masked. (defaults to false)
\n", - "name": "targetEl" - } - ], - "name": "setLoading", - "owner": "Ext.AbstractComponent", - "doc": "This method allows you to show or hide a LoadMask on top of this component.
\n", - "linenr": 2830, - "return": { - "type": "Ext.LoadMask", - "doc": "The LoadMask instance that has just been shown.
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-setPagePosition", - "shortDoc": "Sets the page XY position of the component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "The new x position
\n", - "name": "x" - }, - { - "type": "Number", - "optional": false, - "doc": "The new y position
\n", - "name": "y" - }, - { - "type": "Mixed", - "optional": false, - "doc": "If passed, the Component is animated into its new position. If this parameter\nis a number, it is used as the animation duration in milliseconds.
\n", - "name": "animate" - } - ], - "name": "setPagePosition", - "owner": "Ext.Component", - "doc": "Sets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the move event.
\n", - "linenr": 504, - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "html_filename": "Component2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-setPosition", - "shortDoc": "Sets the left and top of the component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "The new left
\n", - "name": "left" - }, - { - "type": "Number", - "optional": false, - "doc": "The new top
\n", - "name": "top" - }, - { - "type": "Mixed", - "optional": false, - "doc": "If true, the Component is animated into its new position. You may also pass an animation configuration.
\n", - "name": "animate" - } - ], - "name": "setPosition", - "owner": "Ext.Component", - "doc": "Sets the left and top of the component. To set the page XY position instead, use setPagePosition.\nThis method fires the move event.
\n", - "linenr": 420, - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "html_filename": "Component2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setSize", - "shortDoc": "Sets the width and height of this Component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Mixed", - "optional": false, - "doc": "The new width to set. This may be one of:
- \n
- A Number specifying the new width in the Element's Ext.core.Element.defaultUnits (by default, pixels). \n
- A String used to set the CSS width style. \n
- A size object in the format
{width: widthValue, height: heightValue}. \n undefinedto leave the width unchanged. \n
The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
- \n
- A Number specifying the new height in the Element's Ext.core.Element.defaultUnits (by default, pixels). \n
- A String used to set the CSS height style. Animation may not be used. \n
undefinedto leave the height unchanged. \n
Sets 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}.
this
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Tool.html#Ext-panel-Tool-method-setType", - "shortDoc": "Set the type of the tool. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Tool.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The new type. See the type config.
\n", - "name": "type" - } - ], - "name": "setType", - "owner": "Ext.panel.Tool", - "doc": "Set the type of the tool. Allows the icon to be changed.
\n", - "linenr": 194, - "return": { - "type": "Ext.panel.Tool", - "doc": "this
\n" - }, - "html_filename": "Tool.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setUI", - "shortDoc": "Sets the UI for the component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The new UI for the component
\n", - "name": "ui" - } - ], - "name": "setUI", - "owner": "Ext.AbstractComponent", - "doc": "Sets the UI for the component. This will remove any existing UIs on the component. It will also\nloop through any uiCls set on the component and rename them so they include the new UI
\n", - "linenr": 1417, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setVisible", - "shortDoc": "Convenience function to hide or show this component by boolean. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "True to show, false to hide
\n", - "name": "visible" - } - ], - "name": "setVisible", - "owner": "Ext.AbstractComponent", - "doc": "Convenience function to hide or show this component by boolean.
\n", - "linenr": 2173, - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setWidth", - "shortDoc": "Sets the width of the component. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "The new width to setThis may be one of:
- \n
- A Number specifying the new width in the Element's Ext.core.Element.defaultUnits (by default, pixels). \n
- A String used to set the CSS width style. \n
Sets the width of the component. This method fires the resize event.
\n", - "linenr": 2757, - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-show", - "shortDoc": "Shows this Component, rendering it first if autoRender or floating are true. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "String/Element", - "optional": false, - "doc": "Optional, and only valid for floating Components such as\nWindows or ToolTips, or regular Components which have been configured\nwith floating: true. The target from which the Component should\nanimate from while opening (defaults to null with no animation)
(optional) A callback function to call after the Component is displayed. Only necessary if animation was specified.
\n", - "name": "callback" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) The scope (this reference) in which the callback is executed. Defaults to this Component.
Shows 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 brought to the front of\nits z-index stack.
\n\n", - "linenr": 648, - "return": { - "type": "Component", - "doc": "this
\n" - }, - "html_filename": "Component2.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\nStops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\n", - "linenr": 335, - "return": { - "type": "Ext.core.Element", - "doc": "The Element
\n" - }, - "html_filename": "Animate.html" - }, - { - "deprecated": { - "version": "4.0", - "text": "Replaced by stopAnimation
\n\n\n\n", - "tagname": "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." - }, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Animate.html#Ext-util-Animate-method-stopFx", - "shortDoc": "Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Animate.js", - "private": false, - "params": [ - - ], - "name": "stopFx", - "owner": "Ext.util.Animate", - "doc": "Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\n", - "linenr": 326, - "return": { - "type": "Ext.core.Element", - "doc": "The Element
\n" - }, - "html_filename": "Animate.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-suspendEvents", - "shortDoc": "Suspends the firing of all events. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": false, - "doc": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n", - "name": "queueSuspended" - } - ], - "name": "suspendEvents", - "owner": "Ext.util.Observable", - "doc": "Suspends the firing of all events. (see resumeEvents)
\n", - "linenr": 541, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Animate.html#Ext-util-Animate-method-syncFx", - "shortDoc": "Ensures that all effects queued after syncFx is called on this object are\nrun concurrently. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Animate.js", - "private": false, - "params": [ - - ], - "name": "syncFx", - "owner": "Ext.util.Animate", - "doc": "Ensures that all effects queued after syncFx is called on this object are\nrun concurrently. This is the opposite of sequenceFx.
\n", - "linenr": 345, - "return": { - "type": "Object", - "doc": "this
\n" - }, - "html_filename": "Animate.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Floating.html#Ext-util-Floating-method-toBack", - "shortDoc": "Sends this Component to the back of (lower z-index than) any other visible windows ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", - "private": false, - "params": [ - - ], - "name": "toBack", - "owner": "Ext.util.Floating", - "doc": "Sends this Component to the back of (lower z-index than) any other visible windows
\n", - "linenr": 242, - "return": { - "type": "Component", - "doc": "this
\n" - }, - "html_filename": "Floating.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Floating.html#Ext-util-Floating-method-toFront", - "shortDoc": "Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": true, - "doc": "(optional) Specify true to prevent the Component from being focused.
Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManager
\n\n\nIf this Component is modal, inserts the modal mask just below this Component in the z-index stack.
\n\n", - "linenr": 190, - "return": { - "type": "Component", - "doc": "this
\n" - }, - "html_filename": "Floating.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" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-up", - "shortDoc": "Walks up the ownerCt axis looking for an ancestor Container which matches\nthe passed simple selector. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "Optional. The simple selector to test.
\n", - "name": "selector" - } - ], - "name": "up", - "owner": "Ext.AbstractComponent", - "doc": "Walks up the ownerCt axis looking for an ancestor Container which matches\nthe passed simple selector.
Example:\n
var owningTabPanel = grid.up('tabpanel');\nThe matching ancestor Container (or undefined if no match was found).
If this component has been configured with a template via the tpl config\nthen it will use this argument as data to populate the template.\nIf this component was not configured with a template, the components\ncontent area will be updated via Ext.core.Element update
\n", - "name": "htmlOrData" - }, - { - "type": "Boolean", - "optional": true, - "doc": "(optional) Only legitimate when using the html configuration. Defaults to false
\n", - "name": "loadScripts" - }, - { - "type": "Function", - "optional": true, - "doc": "(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
\n", - "name": "callback" - } - ], - "name": "update", - "owner": "Ext.AbstractComponent", - "doc": "Update the content area of a component.
\n", - "linenr": 2141, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Component2.html#Ext-Component-method-updateBox", - "shortDoc": "Sets the current box measurements of the component's underlying element. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "An object in the format {x, y, width, height}
\n", - "name": "box" - } - ], - "name": "updateBox", - "owner": "Ext.Component", - "doc": "Sets the current box measurements of the component's underlying element.
\n", - "linenr": 554, - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "html_filename": "Component2.html" - } - ], - "property": [ - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "AbstractComponent.html#Ext-AbstractComponent-property-draggable", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "name": "draggable", - "owner": "Ext.AbstractComponent", - "doc": "Read-only property indicating whether or not the component can be dragged
\n", - "linenr": 395, - "html_filename": "AbstractComponent.html" - }, - { - "type": "Ext.Container", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Component2.html#Ext-Component-property-floatParent", - "shortDoc": "Optional. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", - "private": false, - "name": "floatParent", - "owner": "Ext.Component", - "doc": "Optional. Only present for floating Components which were inserted as descendant items of floating Containers.
\n\n\nFloating Components that are programatically rendered will not have a floatParent property.
For floating Components which are child items of a Container, the floatParent will be the floating ancestor Container which is\nresponsible for the base z-index value of all its floating descendants. It provides a ZIndexManager which provides\nz-indexing services for all its descendant floating Components.
\n\n\nFor example, the dropdown BoundList of a ComboBox which is in a Window will have the Window as its\nfloatParent
See floating and zIndexManager
\n\n", - "linenr": 224, - "html_filename": "Component2.html" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "AbstractComponent.html#Ext-AbstractComponent-property-frameSize", - "shortDoc": "Read-only property indicating the width of any framing elements which were added within the encapsulating element\nto ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "name": "frameSize", - "owner": "Ext.AbstractComponent", - "doc": "Read-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\n\nThis is an object containing the frame width in pixels for all four sides of the Component containing\nthe following properties:
\n\n\n- \n
topThe width of the top framing element in pixels. \nrightThe width of the right framing element in pixels. \nbottomThe width of the bottom framing element in pixels. \nleftThe width of the left framing element in pixels. \n
This is an internal flag that you use when creating custom components.\nBy default this is set to true which means that every component gets a mask when its disabled.\nComponents like FieldContainer, FieldSet, Field, Button, Tab override this property to false\nsince they want to implement custom disable logic.
\n", - "linenr": 534, - "html_filename": "AbstractComponent.html" - }, - { - "type": "Ext.Container", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "AbstractComponent.html#Ext-AbstractComponent-property-ownerCt", - "shortDoc": "This Component's owner Container (defaults to undefined, and is set automatically when\nthis Component is added to a C...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "name": "ownerCt", - "owner": "Ext.AbstractComponent", - "doc": "This Component's owner Container (defaults to undefined, and is set automatically when\nthis Component is added to a Container). Read-only.
\n\nNote: to access items within the Container see itemId.
\n\n", - "linenr": 102, - "html_filename": "AbstractComponent.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "AbstractComponent.html#Ext-AbstractComponent-property-rendered", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "name": "rendered", - "owner": "Ext.AbstractComponent", - "doc": "Read-only property indicating whether or not the component has been rendered.
\n", - "linenr": 521, - "html_filename": "AbstractComponent.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'\nOptional. Only present for floating Components after they have been rendered.
\n\n\nA reference to the ZIndexManager which is managing this Component's z-index.
\n\n\nThe ZIndexManager maintains a stack of floating Component z-indices, and also provides a single modal\nmask which is insert just beneath the topmost visible modal floating Component.
\n\n\nFloating Components may be brought to the front or sent to the back of the z-index stack.
\n\n\nThis defaults to the global ZIndexManager for floating Components that are programatically\nrendered.
\n\n\nFor floating Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found\nwhich is floating, or if not found the global ZIndexManager is used.
\n\n\nSee floating and floatParent
\n\n", - "linenr": 209, - "html_filename": "Component2.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-activate", - "shortDoc": "Fires after a Component has been visually activated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "activate", - "owner": "Ext.AbstractComponent", - "doc": "Fires after a Component has been visually activated.
\n", - "linenr": 565, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-added", - "shortDoc": "Fires after a Component had been added to a Container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Ext.container.Container", - "optional": false, - "doc": "Parent Container
\n", - "name": "container" - }, - { - "type": "Number", - "optional": false, - "doc": "position of Component
\n", - "name": "pos" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "added", - "owner": "Ext.AbstractComponent", - "doc": "Fires after a Component had been added to a Container.
\n", - "linenr": 585, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-afterrender", - "shortDoc": "Fires after the component rendering is finished. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "afterrender", - "owner": "Ext.AbstractComponent", - "doc": "Fires after the component rendering is finished.
\n\n\nThe afterrender event is fired after this Component has been rendered, been postprocesed\nby any afterRender method defined for the Component.
\n\n", - "linenr": 652, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforeactivate", - "shortDoc": "Fires before a Component has been visually activated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforeactivate", - "owner": "Ext.AbstractComponent", - "doc": "Fires before a Component has been visually activated.\nReturning false from an event listener can prevent the activate\nfrom occurring.
\n", - "linenr": 557, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforedeactivate", - "shortDoc": "Fires before a Component has been visually deactivated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforedeactivate", - "owner": "Ext.AbstractComponent", - "doc": "Fires before a Component has been visually deactivated.\nReturning false from an event listener can prevent the deactivate\nfrom occurring.
\n", - "linenr": 571, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforedestroy", - "shortDoc": "Fires before the component is destroyed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforedestroy", - "owner": "Ext.AbstractComponent", - "doc": "Fires before the component is destroyed. Return false from an event handler to stop the destroy.
\n", - "linenr": 660, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforehide", - "shortDoc": "Fires before the component is hidden when calling the hide method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforehide", - "owner": "Ext.AbstractComponent", - "doc": "Fires before the component is hidden when calling the hide method.\nReturn false from an event handler to stop the hide.
\n", - "linenr": 618, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforerender", - "shortDoc": "Fires before the component is rendered. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforerender", - "owner": "Ext.AbstractComponent", - "doc": "Fires before the component is rendered. Return false from an\nevent handler to stop the render.
\n", - "linenr": 639, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforeshow", - "shortDoc": "Fires before the component is shown when calling the show method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforeshow", - "owner": "Ext.AbstractComponent", - "doc": "Fires before the component is shown when calling the show method.\nReturn false from an event handler to stop the show.
\n", - "linenr": 605, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Stateful.html#Ext-state-Stateful-event-beforestaterestore", - "shortDoc": "Fires before the state of the object is restored. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", - "private": false, - "params": [ - { - "type": "Ext.state.Stateful", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "optional": false, - "doc": "The 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.
\n", - "name": "state" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforestaterestore", - "owner": "Ext.state.Stateful", - "doc": "Fires before the state of the object is restored. Return false from an event handler to stop the restore.
\n", - "linenr": 101, - "html_filename": "Stateful.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Stateful.html#Ext-state-Stateful-event-beforestatesave", - "shortDoc": "Fires before the state of the object is saved to the configured state provider. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", - "private": false, - "params": [ - { - "type": "Ext.state.Stateful", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "optional": false, - "doc": "The 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.
\n", - "name": "state" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforestatesave", - "owner": "Ext.state.Stateful", - "doc": "Fires before the state of the object is saved to the configured state provider. Return false to stop the save.
\n", - "linenr": 122, - "html_filename": "Stateful.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Tool.html#Ext-panel-Tool-event-click", - "shortDoc": "Fires when the tool is clicked ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Tool.js", - "private": false, - "params": [ - { - "type": "Ext.panel.Tool", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Ext.EventObject", - "optional": false, - "doc": "The event object
\n", - "name": "e" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "click", - "owner": "Ext.panel.Tool", - "doc": "Fires when the tool is clicked
\n", - "linenr": 116, - "html_filename": "Tool.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-deactivate", - "shortDoc": "Fires after a Component has been visually deactivated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "deactivate", - "owner": "Ext.AbstractComponent", - "doc": "Fires after a Component has been visually deactivated.
\n", - "linenr": 579, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-destroy", - "shortDoc": "Fires after the component is destroyed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "destroy", - "owner": "Ext.AbstractComponent", - "doc": "Fires after the component is destroyed.
\n", - "linenr": 666, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-disable", - "shortDoc": "Fires after the component is disabled. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "disable", - "owner": "Ext.AbstractComponent", - "doc": "Fires after the component is disabled.
\n", - "linenr": 593, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-enable", - "shortDoc": "Fires after the component is enabled. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "enable", - "owner": "Ext.AbstractComponent", - "doc": "Fires after the component is enabled.
\n", - "linenr": 599, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-hide", - "shortDoc": "Fires after the component is hidden. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "hide", - "owner": "Ext.AbstractComponent", - "doc": "Fires after the component is hidden.\nFires after the component is hidden when calling the hide method.
\n", - "linenr": 625, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-move", - "shortDoc": "Fires after the component is moved. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Number", - "optional": false, - "doc": "The new x position
\n", - "name": "x" - }, - { - "type": "Number", - "optional": false, - "doc": "The new y position
\n", - "name": "y" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "move", - "owner": "Ext.AbstractComponent", - "doc": "Fires after the component is moved.
\n", - "linenr": 680, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-removed", - "shortDoc": "Fires when a component is removed from an Ext.container.Container ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Ext.container.Container", - "optional": false, - "doc": "Container which holds the component
\n", - "name": "ownerCt" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "removed", - "owner": "Ext.AbstractComponent", - "doc": "Fires when a component is removed from an Ext.container.Container
\n", - "linenr": 632, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-render", - "shortDoc": "Fires after the component markup is rendered. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "render", - "owner": "Ext.AbstractComponent", - "doc": "Fires after the component markup is rendered.
\n", - "linenr": 646, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-resize", - "shortDoc": "Fires after the component is resized. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Number", - "optional": false, - "doc": "The box-adjusted width that was set
\n", - "name": "adjWidth" - }, - { - "type": "Number", - "optional": false, - "doc": "The box-adjusted height that was set
\n", - "name": "adjHeight" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "resize", - "owner": "Ext.AbstractComponent", - "doc": "Fires after the component is resized.
\n", - "linenr": 672, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-show", - "shortDoc": "Fires after the component is shown when calling the show method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "show", - "owner": "Ext.AbstractComponent", - "doc": "Fires after the component is shown when calling the show method.
\n", - "linenr": 612, - "html_filename": "AbstractComponent.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Stateful.html#Ext-state-Stateful-event-staterestore", - "shortDoc": "Fires after the state of the object is restored. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", - "private": false, - "params": [ - { - "type": "Ext.state.Stateful", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "optional": false, - "doc": "The 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.
\n", - "name": "state" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "staterestore", - "owner": "Ext.state.Stateful", - "doc": "Fires after the state of the object is restored.
\n", - "linenr": 112, - "html_filename": "Stateful.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Stateful.html#Ext-state-Stateful-event-statesave", - "shortDoc": "Fires after the state of the object is saved to the configured state provider. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", - "private": false, - "params": [ - { - "type": "Ext.state.Stateful", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "optional": false, - "doc": "The 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.
\n", - "name": "state" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "statesave", - "owner": "Ext.state.Stateful", - "doc": "Fires after the state of the object is saved to the configured state provider.
\n", - "linenr": 133, - "html_filename": "Stateful.html" - } - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - "Ext.Base", - "Ext.AbstractComponent", - "Ext.Component" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "Tool.html#Ext-panel-Tool", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": true, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Tool.js", - "private": false, - "alternateClassNames": [ - - ], - "name": "Ext.panel.Tool", - "doc": "This class is used to display small visual icons in the header of a panel. There are a set of\n25 icons that can be specified by using the type config. The handler config\ncan be used to provide a function that will respond to any click events. In general, this class\nwill not be instantiated directly, rather it will be created by specifying the Ext.panel.Panel.tools\nconfiguration on the Panel itself.
\n\nExample Usage
\n\nExt.create('Ext.panel.Panel', {\n width: 200,\n height: 200,\n renderTo: document.body,\n title: 'A Panel',\n tools: [{\n type: 'help',\n handler: function(){\n // show help here\n }\n }, {\n itemId: 'refresh',\n type: 'refresh',\n hidden: true,\n handler: function(){\n // do refresh\n }\n }, {\n type: 'search',\n handler: function(event, target, owner, tool){\n // do search\n owner.child('#refresh').show();\n }\n }]\n});\nHierarchy
Ext.BaseExt.AbstractComponentExt.ComponentExt.panel.ToolMixins
Requires
Files
This class is used to display small visual icons in the header of a panel. There are a set of\n25 icons that can be specified by using the type config. The handler config\ncan be used to provide a function that will respond to any click events. In general, this class\nwill not be instantiated directly, rather it will be created by specifying the Ext.panel.Panel.tools\nconfiguration on the Panel itself.
\n\nExt.create('Ext.panel.Panel', {\n width: 200,\n height: 200,\n renderTo: document.body,\n title: 'A Panel',\n tools: [{\n type: 'help',\n handler: function(){\n // show help here\n }\n }, {\n itemId: 'refresh',\n type: 'refresh',\n hidden: true,\n handler: function(){\n // do refresh\n }\n }, {\n type: 'search',\n handler: function(event, target, owner, tool){\n // do search\n owner.child('#refresh').show();\n }\n }]\n});\nConfig options
A 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\n- \n
name- The property name on the Component for the child element. \nitemId- The id to combine with the Component's id that is the id of the child element. \nid- The id of the child element. \n
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\nFloating Components as child items of a Container
\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 function to execute when the tool is clicked. Arguments passed are:
\n\n- \n
- event : Ext.EventObject - The click event. \n
- toolEl : Ext.Element - The tool Element. \n
- owner : Ext.panel.Header - The host panel header. \n
- tool : Ext.panel.Tool - The tool object \n
A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be:
\n\n- \n
'display': The Component will be hidden using thedisplay: nonestyle. \n'visibility': The Component will be hidden using thevisibility: hiddenstyle. \n'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 usingdisplayresults in a\nComponent having zero dimensions. \n
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.
\nAn 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\n- \n
- id \n
- ui \n
- uiCls \n
- baseCls \n
- componentCls \n
- frame \n
See 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
The scope to execute the handler function. Defaults to the tool.
\nSpecifies 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
Specify as false to allow click event to propagate.
\nDefaults to: true
A 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
The tooltip for the tool - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config\nobject
\nThe tooltip for the tool - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config\nobject
\nThe type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.
\nDefaults to: "qtip"
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"
The type of tool to render. The following types are available:
\n\n- \n
close
\n- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
- \n
A set style for a component. Can be a string or an Array of multiple strings (UIs)
\nDefaults to: "default"
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.
\nProperties
Read-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
\nMethods
Instance Methods Creates new Component. ...Creates new Component.
\nParameters
- config : Ext.Element/String/Object
The configuration options may be specified as either:
\n\n\n- an element : it is set as the internal element and its id used as the component id
\n- a string : it is assumed to be the id of an existing element and is used as the component id
\n- anything else : it is assumed to be a standard config object and is applied to the component
\n
\n\n
Returns
- Object\n
addChildEls( )Adds each argument passed to this method to the childEls array. ...Adds each argument passed to this method to the childEls array.
\n Adds a CSS class to the top level element representing this component. ...Adds a CSS class to the top level element representing this component.
\nParameters
- cls : String
The CSS class name to add
\n
Returns
- Ext.Component
Returns the Component to allow method chaining.
\n
Adds a CSS class to the top level element representing this component. ...Adds a CSS class to the top level element representing this component.
\nParameters
- cls : String
The CSS class name to add
\n
Returns
- Ext.Component
Returns the Component to allow method chaining.
\n
addClsWithUI( String/String[] cls, Object skip )Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this\ncomponent. ...Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this\ncomponent.
\nParameters
Adds the specified events to the list of events which this Observable may fire. ...Adds the specified events to the list of events which this Observable may fire.
\nParameters
- o : Object/String
Either an object with event names as properties with a value of true or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
\n\nthis.addEvents({\n storeloaded: true,\n storecleared: true\n});\n
\n - more : String... (optional)
Additional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\n
addListener( String eventName, Function fn, [Object scope], [Object options] )Appends an event handler to this object. ...Appends an event handler to this object.
\nParameters
- eventName : String
The name of the event to listen for. May also be an object who's property names are\nevent names.
\n\n - fn : Function
The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.
\n\n - scope : Object (optional)
The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
\n\n - options : Object (optional)
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\n\nscope : Object
\n\nThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
\n\n\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});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\n
addManagedListener( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestr...Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nParameters
- item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n - ename : Object/String
The event name, or an object containing event name properties.
\n\n - fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n - scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n - opt : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n
addStateEvents( String/String[] events ) addUIClsToElement( String ui )Method which adds a specified UI + uiCls to the components element. ...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.
\nParameters
- ui : String
The UI to remove from the element
\n
afterComponentLayout( Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component callingContainer )Occurs after componentLayout is run. ...Occurs after componentLayout is run.
\nParameters
- adjWidth : Number
The box-adjusted width that was set
\n - adjHeight : Number
The box-adjusted height that was set
\n - isSetSize : Boolean
Whether or not the height/width are stored on the component permanently
\n - callingContainer : Ext.Component
Container requesting the layout. Only used when isSetSize is false.
\n
alignTo( Ext.Component/Ext.Element/HTMLElement/String element, [String position], [Number[] offsets] ) : Ext.ComponentAligns this floating Component to the specified element ...Aligns this floating Component to the specified element
\nParameters
- element : Ext.Component/Ext.Element/HTMLElement/String
The 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.
\n - position : String (optional)
The position to align to (see Ext.Element.alignTo for more details).
\nDefaults to: "tl-bl?"
- offsets : Number[] (optional)
Offset the positioning by [x, y]
\n
Returns
- Ext.Component
this
\n
Perform custom animation on this object. ...Perform custom animation on this object.
\n
This method is applicable to both the Component class and the Element class.\nIt performs animated transitions of certain properties of this object over a specified timeline.
\nThe sole parameter is an object which specifies start property values, end property values, and properties which\ndescribe the timeline. Of the properties listed below, only to is mandatory.
\nProperties include
\nfrom An object which specifies start values for the properties being animated.\nIf not supplied, properties are animated from current settings. The actual properties which may be animated depend upon\nths object being animated. See the sections below on Element and Component animation.\nto An object which specifies end values for the properties being animated.durationThe duration in milliseconds for which the animation will run.easing A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:\n- ease
\n- easeIn
\n- easeOut
\n- easeInOut
\n- backIn
\n- backOut
\n- elasticIn
\n- elasticOut
\n- bounceIn
\n- bounceOut
\n
keyframes This is an object which describes the state of animated properties at certain points along the timeline.\nit is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.listeners This is a standard listeners configuration object which may be used\nto inject behaviour at either the beforeanimate event or the afteranimate event.Animating an Element
\nWhen animating an Element, the following properties may be specified in from, to, and keyframe objects:\nx The page X position in pixels.y The page Y position in pixelsleft The element's CSS left value. Units must be supplied.top The element's CSS top value. Units must be supplied.width The element's CSS width value. Units must be supplied.height The element's CSS height value. Units must be supplied.scrollLeft The element's scrollLeft value.scrollTop The element's scrollLeft value.opacity The element's opacity value. This must be a value between 0 and 1.
\nBe 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.
\nAnimating a Component
\nWhen animating an Element, the following properties may be specified in from, to, and keyframe objects:\nx The Component's page X position in pixels.y The Component's page Y position in pixelsleft The Component's left value in pixels.top The Component's top value in pixels.width The Component's width value in pixels.width The Component's width value in pixels.dynamic Specify as true to update the Component's layout (if it is a Container) at every frame\nof the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.
\nFor 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});\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.
\n\nParameters
- config : Object
An object containing properties which describe the animation's start and end states, and the timeline of the animation.
\n
Returns
- Object
this
\n
applyState( Object state )Applies the state to the object. ...Applies 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.
\nParameters
- state : Object
The state
\n
beforeComponentLayout( Number adjWidth, Number adjHeight, Boolean isSetSize, Ext.Component callingContainer )Occurs before componentLayout is run. ...Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout from\nbeing executed.
\nParameters
- adjWidth : Number
The box-adjusted width that was set
\n - adjHeight : Number
The box-adjusted height that was set
\n - isSetSize : Boolean
Whether or not the height/width are stored on the component permanently
\n - callingContainer : Ext.Component
Container requesting sent the layout. Only used when isSetSize is false.
\n
Bubbles up the component/container heirarchy, calling the specified function with each component. ...Bubbles 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.
\nParameters
- fn : Function
The function to call
\n - scope : Object (optional)
The scope of the function. Defaults to current node.
\n - args : Array (optional)
The args to call the function with. Defaults to passing the current component.
\n
Returns
- Ext.Component
this
\n
Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...Call the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nParameters
- args : Array/Arguments
The arguments, either an array or the arguments object
\n
Returns
- Object
Returns the result after calling the overridden method
\n
Call the parent's overridden method. ...Call the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nParameters
- args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
\n
Returns
- Object
Returns the result from the superclass' method
\n
Removes all listeners for this object including the managed listeners ...Removes all listeners for this object including the managed listeners
\n Clone the current component using the original config values passed into this instance by default. ...Clone the current component using the original config values passed into this instance by default.
\nParameters
- overrides : Object
A 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.
\n
Returns
- Ext.Component
clone The cloned copy of this component
\n
Ensures that the plugins array contains fully constructed plugin instances. ...Ensures that the plugins array contains fully constructed plugin instances. This converts any configs into their\nappropriate instances.
\n Disable the component. ...Disable the component.
\nParameters
- silent : Boolean (optional)
Passing true will supress the 'disable' event from being fired.
\nDefaults to: false
doAutoRender( )Handles autoRender. ...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
\n doComponentLayout( Object width, Object height, Object isSetSize, Object callingContainer ) : Ext.container.ContainerThis method needs to be called whenever you change something on this component that requires the Component's\nlayout t...This method needs to be called whenever you change something on this component that requires the Component's\nlayout to be recalculated.
\nParameters
Returns
- Ext.container.Container
this
\n
doConstrain( [String/HTMLElement/Ext.Element/Ext.util.Region constrainTo] )Moves this floating Component into a constrain region. ...Moves 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.
\nParameters
- constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)
The Element or Region into which this Component is\nto be constrained. Defaults to the element into which this floating Component was rendered.
\n
Enable the component ...Enable the component
\nParameters
- silent : Boolean (optional)
Passing true will supress the 'enable' event from being fired.
\nDefaults to: false
enableBubble( String/String[] events )Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. There is no implementation in the Observable base class.
\n\nThis is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\n
\nParameters
This method finds the topmost active layout who's processing will eventually determine the size and position of\nthis ...This 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.
\nReturns
Find a container above this component at any level by a custom function. ...Find a container above this component at any level by a custom function. If the passed function returns true, the\ncontainer will be returned.
\nParameters
- fn : Function
The custom function to call with the arguments (container, this component).
\n
Returns
- Ext.container.Container
The first Container for which the custom function returns true
\n
Find a container above this component at any level by xtype or class\n\nSee also the up method. ...Find a container above this component at any level by xtype or class
\n\nSee also the up method.
\nParameters
Returns
- Ext.container.Container
The first Container which matches the given xtype or class
\n
Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).
\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\nParameters
- eventName : String
The name of the event to fire.
\n - args : Object...
Variable number of parameters are passed to handlers.
\n
Returns
- Boolean
returns false if any of the handlers return false otherwise it returns true.
\n
Try to focus this component. ...Try to focus this component.
\nParameters
- selectText : Boolean (optional)
If applicable, true to also select the text in this component
\n - delay : Boolean/Number (optional)
Delay the focus this number of milliseconds (true for 10 milliseconds).
\n
Returns
- Ext.Component
this
\n
Forces this component to redo its componentLayout. ...Forces this component to redo its componentLayout.
\n Returns the current animation if this object has any effects actively running or queued, else returns false. ...Returns the current animation if this object has any effects actively running or queued, else returns false.
\nReturns
- Ext.fx.Anim/Boolean
Anim if element has active effects, else false
\n\n
Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy. ...Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.
\nReturns
- Ext.container.Container
the Container which owns this Component.
\n
Retrieves the id of this component. ...Retrieves the id of this component. Will autogenerate an id if one has not already been set.
\nReturns
- String\n
getInsertPosition( String/Number/Ext.Element/HTMLElement position ) : HTMLElementThis function takes the position argument passed to onRender and returns a DOM element that you can use in the\ninsert...This function takes the position argument passed to onRender and returns a DOM element that you can use in the\ninsertBefore.
\nParameters
- position : String/Number/Ext.Element/HTMLElement
Index, element id or element you want to put this\ncomponent before.
\n
Returns
- HTMLElement
DOM element that you can use in the insertBefore
\n
Gets the Ext.ComponentLoader for this Component. ...Gets the Ext.ComponentLoader for this Component.
\nReturns
- Ext.ComponentLoader
The loader instance, null if it doesn't exist.
\n
Retrieves a plugin by its pluginId which has been bound to this component. ...Retrieves a plugin by its pluginId which has been bound to this component.
\nParameters
- pluginId : Object\n
Returns
- Ext.AbstractPlugin
plugin instance.
\n
Gets the current size of the component's underlying element. ...Gets the current size of the component's underlying element.
\nReturns
- Object
An object containing the element's size {width: (element width), height: (element height)}
\n
The supplied default state gathering method for the AbstractComponent class. ...The 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.
\n\nSubclasses 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.
\nReturns
- Object\n
Gets the xtype for this component as registered with Ext.ComponentManager. ...Gets 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'\n
\nReturns
- String
The xtype
\n
Returns this Component's xtype hierarchy as a slash-delimited string. ...Returns 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'\n
\nReturns
- String
The xtype hierarchy string
\n
Returns the current animation if this object has any effects actively running or queued, else returns false. ...Returns 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
\nReturns
- Ext.fx.Anim/Boolean
Anim if element has active effects, else false
\n\n
hide( [String/Ext.Element/Ext.Component animateTarget], [Function callback], [Object scope] ) : Ext.ComponentHides this Component, setting it to invisible using the configured hideMode. ...Hides this Component, setting it to invisible using the configured hideMode.
\nParameters
- animateTarget : String/Ext.Element/Ext.Component (optional)
- callback : Function (optional)
A callback function to call after the Component is hidden.
\n - scope : Object (optional)
The scope (this reference) in which the callback is executed.\nDefaults to this Component.
\n
Returns
- Ext.Component
this
\n
initComponent( )templateThe initComponent template method is an important initialization step for a Component. ...The 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});\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. ...Initialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nParameters
- config : Object\n
Returns
- Object
mixins The mixin prototypes as key - value pairs
\n
Determines whether this component is the descendant of a particular container. ...Determines whether this component is the descendant of a particular container.
\nParameters
- container : Ext.Container\n
Returns
- Boolean
True if it is.
\n
isDisabled( ) : BooleanMethod to determine whether this Component is currently disabled. ...Method to determine whether this Component is currently disabled.
\nReturns
- Boolean
the disabled state of this Component.
\n
isDraggable( ) : BooleanMethod to determine whether this Component is draggable. ...Method to determine whether this Component is draggable.
\nReturns
- Boolean
the draggable state of this component.
\n
isDroppable( ) : BooleanMethod to determine whether this Component is droppable. ...Method to determine whether this Component is droppable.
\nReturns
- Boolean
the droppable state of this component.
\n
isFloating( ) : BooleanMethod to determine whether this Component is floating. ...Method to determine whether this Component is floating.
\nReturns
- Boolean
the floating state of this component.
\n
Method to determine whether this Component is currently set to hidden. ...Method to determine whether this Component is currently set to hidden.
\nReturns
- Boolean
the hidden state of this Component.
\n
Returns true if this component is visible. ...Returns true if this component is visible.
\nParameters
- deep : Boolean (optional)
Pass true to interrogate the visibility status of all parent Containers to\ndetermine whether this Component is truly visible to the user.
\n\nGenerally, 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
Returns
- Boolean
True if this component is visible, false otherwise.
\n
Tests whether or not this Component is of a specific xtype. ...Tests 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\n
\nParameters
- xtype : String
The xtype to check for this Component
\n - shallow : Boolean (optional)
True 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
Returns
- Boolean
True if this component descends from the specified xtype, false otherwise.
\n
mon( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope], [Object opt] )Shorthand for addManagedListener. ...Shorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nParameters
- item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n - ename : Object/String
The event name, or an object containing event name properties.
\n\n - fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n - scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n - opt : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n
mun( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )Shorthand for removeManagedListener. ...Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\nParameters
- item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n - ename : Object/String
The event name, or an object containing event name properties.
\n\n - fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n - scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
Returns the next node in the Component tree in tree traversal order. ...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.
\nParameters
- selector : String (optional)
A ComponentQuery selector to filter the following nodes.
\n
Returns
- Ext.Component
The next node (or the next node which matches the selector).\nReturns null if there is no matching node.
\n
Returns the next sibling of this Component. ...Returns 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()
\n\nNote that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with\nnextNode
\nParameters
- selector : String (optional)
A ComponentQuery selector to filter the following items.
\n
Returns
- Ext.Component
The next sibling (or the next sibling which matches the selector).\nReturns null if there is no matching sibling.
\n
Shorthand for addListener. ...Shorthand for addListener.
\n\nAppends an event handler to this object.
\nParameters
- eventName : String
The name of the event to listen for. May also be an object who's property names are\nevent names.
\n\n - fn : Function
The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.
\n\n - scope : Object (optional)
The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
\n\n - options : Object (optional)
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\n\nscope : Object
\n\nThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
\n\n\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});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\n
Returns the previous node in the Component tree in tree traversal order. ...Returns 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.
\nParameters
- selector : String (optional)
A ComponentQuery selector to filter the preceding nodes.
\n
Returns
- Ext.Component
The previous node (or the previous node which matches the selector).\nReturns null if there is no matching node.
\n
Returns the previous sibling of this Component. ...Returns 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()
\n\nNote that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with\npreviousNode
\nParameters
- selector : String (optional)
A ComponentQuery selector to filter the preceding items.
\n
Returns
- Ext.Component
The previous sibling (or the previous sibling which matches the selector).\nReturns null if there is no matching sibling.
\n
relayEvents( Object origin, String[] events, String prefix )Relays selected events from the specified Observable as if the events were fired by this. ... removeChildEls( Function testFn )Removes items in the childEls array based on the return value of a supplied test function. ...Removes 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.
\nParameters
- testFn : Function
The test function.
\n
Removes a CSS class from the top level element representing this component. ...Removes a CSS class from the top level element representing this component.
\nParameters
- className : Object\n
Returns
- Ext.Component
Returns the Component to allow method chaining.
\n
removeClsWithUI( String/String[] cls )Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all\nelements of thi...Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all\nelements of this component.
\nParameters
removeListener( String eventName, Function fn, [Object scope] )Removes an event handler. ...Removes an event handler.
\nParameters
- eventName : String
The type of event the handler was associated with.
\n\n - fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n - scope : Object (optional)
The 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\n
removeManagedListener( Ext.util.Observable/Ext.Element item, Object/String ename, [Function fn], [Object scope] )Removes listeners that were added by the mon method. ...Removes listeners that were added by the mon method.
\nParameters
- item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n - ename : Object/String
The event name, or an object containing event name properties.
\n\n - fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n - scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
removeUIClsFromElement( String ui )Method which removes a specified UI + uiCls from the components element. ...Method which removes a specified UI + uiCls from the components element. The cls which is added to the element\nwill be: this.baseCls + '-' + ui
\nParameters
- ui : String
The UI to add to the element
\n
resumeEvents( )Resumes firing events (see suspendEvents). ...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.
\n Conditionally saves a single property from this object to the given state object. ...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.
\nParameters
- propName : String
The name of the property to save.
\n - state : Object
The state object in to which to save the property.
\n - stateName : String (optional)
The name to use for the property in state.
\n
Returns
- Boolean
True if the property was saved, false if not.
\n
sequenceFx( ) : Object setActive( [Boolean active], [Ext.Component newActive] )This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been\nmoved to th...This 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.
\nParameters
- active : Boolean (optional)
True to activate the Component, false to deactivate it.
\nDefaults to: false
- newActive : Ext.Component (optional)
The newly active Component which is taking over topmost zIndex position.
\n
Sets the overflow on the content element of the component. ...Sets the overflow on the content element of the component.
\nParameters
- scroll : Boolean
True to allow the Component to auto scroll.
\n
Returns
- Ext.Component
this
\n
Sets the dock position of this component in its parent panel. ...Sets 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)
\nParameters
- dock : Object
The dock position.
\n - layoutParent : Boolean (optional)
True to re-layout parent.
\nDefaults to: false
Returns
- Ext.Component
this
\n
Sets the height of the component. ...Sets the height of the component. This method fires the resize event.
\nParameters
- height : Number
The new height to set. This may be one of:
\n\n\n- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
\n- A String used to set the CSS height style.
\n- undefined to leave the height unchanged.
\n
\n\n
Returns
- Ext.Component
this
\n
This method allows you to show or hide a LoadMask on top of this component. ...This method allows you to show or hide a LoadMask on top of this component.
\nParameters
- load : Boolean/Object/String
True 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.
\n - targetEl : Boolean (optional)
True 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.
\nDefaults to: false
Returns
- Ext.LoadMask
The LoadMask instance that has just been shown.
\n
Sets the page XY position of the component. ...Sets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the move event.
\nParameters
- x : Number
The new x position
\n - y : Number
The new y position
\n - animate : Boolean/Object (optional)
True to animate the Component into its new position. You may also pass an\nanimation configuration.
\n
Returns
- Ext.Component
this
\n
Sets the left and top of the component. ...Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This\nmethod fires the move event.
\nParameters
- left : Number
The new left
\n - top : Number
The new top
\n - animate : Boolean/Object (optional)
If true, the Component is animated into its new position. You may also pass an\nanimation configuration.
\n
Returns
- Ext.Component
this
\n
Sets the width and height of this Component. ...Sets 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}.
\nParameters
- width : Number/String/Object
The new width to set. This may be one of:
\n\n\n- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
\n- A String used to set the CSS width style.
\n- A size object in the format
{width: widthValue, height: heightValue}. \nundefined to leave the width unchanged.
\n\n - height : Number/String
The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
\n\n\n- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
\n- A String used to set the CSS height style. Animation may not be used.
\nundefined to leave the height unchanged.
\n\n
Returns
- Ext.Component
this
\n
Sets the type of the tool. ... Sets the UI for the component. ...Sets 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
\nParameters
- ui : String
The new UI for the component
\n
Convenience function to hide or show this component by boolean. ...Convenience function to hide or show this component by boolean.
\nParameters
- visible : Boolean
True to show, false to hide
\n
Returns
- Ext.Component
this
\n
Sets the width of the component. ...Sets the width of the component. This method fires the resize event.
\nParameters
- width : Number
The new width to setThis may be one of:
\n\n\n- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels).
\n- A String used to set the CSS width style.
\n
\n\n
Returns
- Ext.Component
this
\n
Shows this Component, rendering it first if autoRender or floating are true. ...Shows this Component, rendering it first if autoRender or floating are true.
\n\nAfter being shown, a floating Component (such as a Ext.window.Window), is activated it and\nbrought to the front of its z-index stack.
\nParameters
- animateTarget : String/Ext.Element (optional)
- callback : Function (optional)
A callback function to call after the Component is displayed.\nOnly necessary if animation was specified.
\n - scope : Object (optional)
The scope (this reference) in which the callback is executed.\nDefaults to this Component.
\n
Returns
- Ext.Component
this
\n
Displays component at specific xy position. ...Displays 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}\n
\nParameters
Get the reference to the class from which this object was instantiated. ...Get 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
\n\nExt.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nReturns
stopAnimation( ) : Ext.ElementStops any running effects and clears this object's internal effects queue if it contains\nany additional effects that ...Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\nReturns
- Ext.Element
The Element
\n
stopFx( ) : Ext.ElementdeprecatedStops any running effects and clears this object's internal effects queue if it contains\nany additional effects that ...Stops 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
\nReturns
- Ext.Element
The Element
\n
suspendEvents( Boolean queueSuspended )Suspends the firing of all events. ...Suspends the firing of all events. (see resumeEvents)
\nParameters
- queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n
Ensures that all effects queued after syncFx is called on this object are\nrun concurrently. ...Ensures that all effects queued after syncFx is called on this object are\nrun concurrently. This is the opposite of sequenceFx.
\nReturns
- Object
this
\n
toBack( ) : Ext.ComponentSends this Component to the back of (lower z-index than) any other visible windows ...Sends this Component to the back of (lower z-index than) any other visible windows
\nReturns
- Ext.Component
this
\n
Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag...Brings 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.
\nParameters
- preventFocus : Boolean (optional)
Specify true to prevent the Component from being focused.
\nDefaults to: false
Returns
- Ext.Component
this
\n
Shorthand for removeListener. ...Shorthand for removeListener.
\n\nRemoves an event handler.
\nParameters
- eventName : String
The type of event the handler was associated with.
\n\n - fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n - scope : Object (optional)
The 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\n
Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector. ...Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector.
\n\nExample:
\n\nvar owningTabPanel = grid.up('tabpanel');\n
\nParameters
- selector : String (optional)
The simple selector to test.
\n
Returns
- Ext.container.Container
The matching ancestor Container (or undefined if no match was found).
\n
Update the content area of a component. ...Update the content area of a component.
\nParameters
- htmlOrData : String/Object
If 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
\n - loadScripts : Boolean (optional)
Only legitimate when using the html configuration.
\nDefaults to: false
- callback : Function (optional)
Only legitimate when using the html configuration. Callback to execute when\nscripts have finished loading
\n
Sets the current box measurements of the component's underlying element. ...Sets the current box measurements of the component's underlying element.
\nParameters
- box : Object
An object in the format {x, y, width, height}
\n
Returns
- Ext.Component
this
\n
Defined ByStatic Methods Add / override static properties of this class. ...Add / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nParameters
- members : Object\n
Returns
- Ext.Base
this
\n
Borrow another class' members to the prototype of this class. ...Borrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nParameters
- fromClass : Ext.Base
The class to borrow members from
\n - members : String/String[]
The names of the members to borrow
\n
Returns
- Ext.Base
this
\n
Create a new instance of this Class. ...Create a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nReturns
- Object
the created instance.
\n
createAlias( String/Object alias, String/Object origin )staticCreate aliases for existing prototype methods. ...Create aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nParameters
- alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n - origin : String/Object
The original method name
\n
Get the current class' name in string format. ...Get the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nReturns
- String
className
\n
Add methods / properties to the prototype of this class. ...Add methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nParameters
- members : Object\n
Override prototype members of this class. ...Override prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nParameters
- members : Object\n
Returns
- Ext.Base
this
\n
Defined ByEvents
activate( Ext.Component this, Object eOpts )Fires after a Component has been visually activated. ...Fires after a Component has been visually activated.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
added( Ext.Component this, Ext.container.Container container, Number pos, Object eOpts )Fires after a Component had been added to a Container. ...Fires after a Component had been added to a Container.
\nParameters
- this : Ext.Component\n
- container : Ext.container.Container
Parent Container
\n - pos : Number
position of Component
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
afterrender( Ext.Component this, Object eOpts )Fires after the component rendering is finished. ...Fires 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.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
beforeactivate( Ext.Component this, Object eOpts )Fires before a Component has been visually activated. ...Fires before a Component has been visually activated. Returning false from an event listener can prevent\nthe activate from occurring.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
beforedeactivate( Ext.Component this, Object eOpts )Fires before a Component has been visually deactivated. ...Fires before a Component has been visually deactivated. Returning false from an event listener can\nprevent the deactivate from occurring.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
beforedestroy( Ext.Component this, Object eOpts )Fires before the component is destroyed. ...Fires before the component is destroyed. Return false from an event handler to stop the\ndestroy.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
beforehide( Ext.Component this, Object eOpts )Fires before the component is hidden when calling the hide method. ...Fires before the component is hidden when calling the hide method. Return false from an event\nhandler to stop the hide.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
beforerender( Ext.Component this, Object eOpts )Fires before the component is rendered. ...Fires before the component is rendered. Return false from an event handler to stop the\nrender.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
beforeshow( Ext.Component this, Object eOpts )Fires before the component is shown when calling the show method. ...Fires before the component is shown when calling the show method. Return false from an event\nhandler to stop the show.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
beforestaterestore( Ext.state.Stateful this, Object state, Object eOpts )Fires before the state of the object is restored. ...Fires before the state of the object is restored. Return false from an event handler to stop the restore.
\nParameters
- this : Ext.state.Stateful\n
- state : Object
The 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.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
beforestatesave( Ext.state.Stateful this, Object state, Object eOpts )Fires before the state of the object is saved to the configured state provider. ...Fires before the state of the object is saved to the configured state provider. Return false to stop the save.
\nParameters
- this : Ext.state.Stateful\n
- state : Object
The 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.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
click( Ext.panel.Tool this, Ext.EventObject e, Object eOpts )Fires when the tool is clicked ...Fires when the tool is clicked
\nParameters
- this : Ext.panel.Tool\n
- e : Ext.EventObject
The event object
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
deactivate( Ext.Component this, Object eOpts )Fires after a Component has been visually deactivated. ...Fires after a Component has been visually deactivated.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
destroy( Ext.Component this, Object eOpts )Fires after the component is destroyed. ...Fires after the component is destroyed.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
disable( Ext.Component this, Object eOpts )Fires after the component is disabled. ...Fires after the component is disabled.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
enable( Ext.Component this, Object eOpts )Fires after the component is enabled. ...Fires after the component is enabled.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
hide( Ext.Component this, Object eOpts )Fires after the component is hidden. ...Fires after the component is hidden. Fires after the component is hidden when calling the hide\nmethod.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
move( Ext.Component this, Number x, Number y, Object eOpts )Fires after the component is moved. ...Fires after the component is moved.
\nParameters
- this : Ext.Component\n
- x : Number
The new x position
\n - y : Number
The new y position
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
removed( Ext.Component this, Ext.container.Container ownerCt, Object eOpts )Fires when a component is removed from an Ext.container.Container ...Fires when a component is removed from an Ext.container.Container
\nParameters
- this : Ext.Component\n
- ownerCt : Ext.container.Container
Container which holds the component
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
render( Ext.Component this, Object eOpts )Fires after the component markup is rendered. ...Fires after the component markup is rendered.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
resize( Ext.Component this, Number adjWidth, Number adjHeight, Object eOpts )Fires after the component is resized. ...Fires after the component is resized.
\nParameters
- this : Ext.Component\n
- adjWidth : Number
The box-adjusted width that was set
\n - adjHeight : Number
The box-adjusted height that was set
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
show( Ext.Component this, Object eOpts )Fires after the component is shown when calling the show method. ...Fires after the component is shown when calling the show method.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
staterestore( Ext.state.Stateful this, Object state, Object eOpts )Fires after the state of the object is restored. ...Fires after the state of the object is restored.
\nParameters
- this : Ext.state.Stateful\n
- state : Object
The 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.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
statesave( Ext.state.Stateful this, Object state, Object eOpts )Fires after the state of the object is saved to the configured state provider. ...Fires after the state of the object is saved to the configured state provider.
\nParameters
- this : Ext.state.Stateful\n
- state : Object
The 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.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Creates new Component.
\nParameters
- config : Ext.Element/String/Object
The configuration options may be specified as either:
\n\n- \n
- an element : it is set as the internal element and its id used as the component id \n
- a string : it is assumed to be the id of an existing element and is used as the component id \n
- anything else : it is assumed to be a standard config object and is applied to the component \n
Returns
- Object\n
Adds each argument passed to this method to the childEls array.
\nAdds a CSS class to the top level element representing this component.
\nParameters
- cls : String
The CSS class name to add
\n
Returns
- Ext.Component
Returns the Component to allow method chaining.
\n
Adds a CSS class to the top level element representing this component.
\nParameters
- cls : String
The CSS class name to add
\n
Returns
- Ext.Component
Returns the Component to allow method chaining.
\n
Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this\ncomponent.
\nParameters
Adds the specified events to the list of events which this Observable may fire.
\nParameters
- o : Object/String
Either an object with event names as properties with a value of
\n\ntrueor the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
\nthis.addEvents({\n storeloaded: true,\n storecleared: true\n});\n - more : String... (optional)
Additional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\n
\nthis.addEvents('storeloaded', 'storecleared');\n
Appends an event handler to this object.
\nParameters
- eventName : String
The name of the event to listen for. May also be an object who's property names are\nevent names.
\n\n - fn : Function
The method the event invokes. Will be called with arguments given to\nfireEvent plus the
\n\noptionsparameter described below. - scope : Object (optional)
The scope (
\n\nthisreference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event. - options : Object (optional)
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\n- \n
scope : Object
\n\nThe scope (
thisreference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event. \ndelay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
\nsingle : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
\nbuffer : 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.
\ntarget : 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.
\nelement : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\n
\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\n
\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\n
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nParameters
- item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n - ename : Object/String
The event name, or an object containing event name properties.
\n\n - fn : Function (optional)
If the
\n\nenameparameter was an event name, this is the handler function. - scope : Object (optional)
If the
\n\nenameparameter was an event name, this is the scope (thisreference)\nin which the handler function is executed. - opt : Object (optional)
If the
\n\nenameparameter 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.
\nParameters
- ui : String
The UI to remove from the element
\n
Occurs after componentLayout is run.
\nParameters
- adjWidth : Number
The box-adjusted width that was set
\n - adjHeight : Number
The box-adjusted height that was set
\n - isSetSize : Boolean
Whether or not the height/width are stored on the component permanently
\n - callingContainer : Ext.Component
Container requesting the layout. Only used when isSetSize is false.
\n
Aligns this floating Component to the specified element
\nParameters
- element : Ext.Component/Ext.Element/HTMLElement/String
The 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.
\n - position : String (optional)
The position to align to (see Ext.Element.alignTo for more details).
\nDefaults to:
"tl-bl?" - offsets : Number[] (optional)
Offset the positioning by [x, y]
\n
Returns
- Ext.Component
this
\n
Perform custom animation on this object.
\n
This method is applicable to both the Component class and the Element class.\nIt performs animated transitions of certain properties of this object over a specified timeline.
\nThe sole parameter is an object which specifies start property values, end property values, and properties which\ndescribe the timeline. Of the properties listed below, only to is mandatory.
Properties include
- \n
fromAn object which specifies start values for the properties being animated.\nIf not supplied, properties are animated from current settings. The actual properties which may be animated depend upon\nths object being animated. See the sections below on Element and Component animation.\ntoAn object which specifies end values for the properties being animated.durationThe duration in milliseconds for which the animation will run.easingA string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:- \n
- ease \n
- easeIn \n
- easeOut \n
- easeInOut \n
- backIn \n
- backOut \n
- elasticIn \n
- elasticOut \n
- bounceIn \n
- bounceOut \n
keyframesThis is an object which describes the state of animated properties at certain points along the timeline.\nit is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.listenersThis is a standard listeners configuration object which may be used\nto inject behaviour at either thebeforeanimateevent or theafteranimateevent.Animating an Element
\nWhen animating an Element, the following properties may be specified infrom,to, andkeyframeobjects:- \n
xThe page X position in pixels.\nyThe page Y position in pixels\nleftThe element's CSSleftvalue. Units must be supplied. \ntopThe element's CSStopvalue. Units must be supplied. \nwidthThe element's CSSwidthvalue. Units must be supplied. \nheightThe element's CSSheightvalue. Units must be supplied. \nscrollLeftThe element'sscrollLeftvalue. \nscrollTopThe element'sscrollLeftvalue. \nopacityThe element'sopacityvalue. This must be a value between0and1. \n
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.
\nAnimating a Component
\nWhen animating an Element, the following properties may be specified infrom,to, andkeyframeobjects:- \n
xThe Component's page X position in pixels.\nyThe Component's page Y position in pixels\nleftThe Component'sleftvalue in pixels. \ntopThe Component'stopvalue in pixels. \nwidthThe Component'swidthvalue in pixels. \nwidthThe Component'swidthvalue in pixels. \ndynamicSpecify as true to update the Component's layout (if it is a Container) at every frame\nof the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.\n
For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:
\n
\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
\n\n\"to\"size. If dynamic updating of the Window's child\nComponents is required, then configure the animation withdynamic: trueand the two child items will maintain their proportions during the animation.Parameters
- config : Object
An object containing properties which describe the animation's start and end states, and the timeline of the animation.
\n
Returns
- Object
this
\n
Applies 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.
\nParameters
- state : Object
The state
\n
Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout from\nbeing executed.
\nParameters
- adjWidth : Number
The box-adjusted width that was set
\n - adjHeight : Number
The box-adjusted height that was set
\n - isSetSize : Boolean
Whether or not the height/width are stored on the component permanently
\n - callingContainer : Ext.Component
Container requesting sent the layout. Only used when isSetSize is false.
\n
Bubbles 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.
\nParameters
- fn : Function
The function to call
\n - scope : Object (optional)
The scope of the function. Defaults to current node.
\n - args : Array (optional)
The args to call the function with. Defaults to passing the current component.
\n
Returns
- Ext.Component
this
\n
Call the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\nParameters
- args : Array/Arguments
The arguments, either an array or the
\nargumentsobject
Returns
- Object
Returns the result after calling the overridden method
\n
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'\nParameters
- args : Array/Arguments
The arguments, either an array or the
\nargumentsobject\nfrom the current method, for example:this.callParent(arguments)
Returns
- Object
Returns the result from the superclass' method
\n
Removes all listeners for this object including the managed listeners
\nClone the current component using the original config values passed into this instance by default.
\nParameters
- overrides : Object
A 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.
\n
Returns
- Ext.Component
clone The cloned copy of this component
\n
Ensures that the plugins array contains fully constructed plugin instances. This converts any configs into their\nappropriate instances.
\nDisable the component.
\nParameters
- silent : Boolean (optional)
Passing 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.
\nParameters
Returns
- Ext.container.Container
this
\n
Moves 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.
\nParameters
- constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)
The Element or Region into which this Component is\nto be constrained. Defaults to the element into which this floating Component was rendered.
\n
Enable the component
\nParameters
- silent : Boolean (optional)
Passing 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});\nParameters
This 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.
\nReturns
Find a container above this component at any level by a custom function. If the passed function returns true, the\ncontainer will be returned.
\nParameters
- fn : Function
The custom function to call with the arguments (container, this component).
\n
Returns
- Ext.container.Container
The first Container for which the custom function returns true
\n
Find a container above this component at any level by xtype or class
\n\nSee also the up method.
\nParameters
Returns
- Ext.container.Container
The first Container which matches the given xtype or class
\n
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.
\nParameters
- eventName : String
The name of the event to fire.
\n - args : Object...
Variable number of parameters are passed to handlers.
\n
Returns
- Boolean
returns false if any of the handlers return false otherwise it returns true.
\n
Try to focus this component.
\nParameters
- selectText : Boolean (optional)
If applicable, true to also select the text in this component
\n - delay : Boolean/Number (optional)
Delay the focus this number of milliseconds (true for 10 milliseconds).
\n
Returns
- Ext.Component
this
\n
Forces this component to redo its componentLayout.
\nReturns the current animation if this object has any effects actively running or queued, else returns false.
\nReturns
- Ext.fx.Anim/Boolean
Anim if element has active effects, else false
\n\n
Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.
\nReturns
- Ext.container.Container
the Container which owns this Component.
\n
Retrieves the id of this component. Will autogenerate an id if one has not already been set.
\nReturns
- String\n
This function takes the position argument passed to onRender and returns a DOM element that you can use in the\ninsertBefore.
\nParameters
- position : String/Number/Ext.Element/HTMLElement
Index, element id or element you want to put this\ncomponent before.
\n
Returns
- HTMLElement
DOM element that you can use in the insertBefore
\n
Gets the Ext.ComponentLoader for this Component.
\nReturns
- Ext.ComponentLoader
The loader instance, null if it doesn't exist.
\n
Retrieves a plugin by its pluginId which has been bound to this component.
\nParameters
- pluginId : Object\n
Returns
- Ext.AbstractPlugin
plugin instance.
\n
Gets the current size of the component's underlying element.
\nReturns
- Object
An object containing the element's size {width: (element width), height: (element height)}
\n
The 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.
\nReturns
- Object\n
Gets 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'\nReturns
- String
The xtype
\n
Returns 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'\nReturns
- String
The xtype hierarchy string
\n
Returns 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
\nReturns
- Ext.fx.Anim/Boolean
Anim if element has active effects, else false
\n\n
Hides this Component, setting it to invisible using the configured hideMode.
\nParameters
- animateTarget : String/Ext.Element/Ext.Component (optional)
- callback : Function (optional)
A callback function to call after the Component is hidden.
\n - scope : Object (optional)
The scope (
\nthisreference) in which the callback is executed.\nDefaults to this Component.
Returns
- Ext.Component
this
\n
The 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'\nParameters
- config : Object\n
Returns
- Object
mixins The mixin prototypes as key - value pairs
\n
Determines whether this component is the descendant of a particular container.
\nParameters
- container : Ext.Container\n
Returns
- Boolean
True if it is.
\n
Method to determine whether this Component is currently disabled.
\nReturns
- Boolean
the disabled state of this Component.
\n
Method to determine whether this Component is draggable.
\nReturns
- Boolean
the draggable state of this component.
\n
Method to determine whether this Component is droppable.
\nReturns
- Boolean
the droppable state of this component.
\n
Method to determine whether this Component is floating.
\nReturns
- Boolean
the floating state of this component.
\n
Method to determine whether this Component is currently set to hidden.
\nReturns
- Boolean
the hidden state of this Component.
\n
Returns true if this component is visible.
\nParameters
- deep : Boolean (optional)
Pass
\n\ntrueto 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
Returns
- Boolean
True if this component is visible, false otherwise.
\n
Tests 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\nParameters
- xtype : String
The xtype to check for this Component
\n - shallow : Boolean (optional)
True 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
Returns
- Boolean
True if this component descends from the specified xtype, false otherwise.
\n
Shorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nParameters
- item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n - ename : Object/String
The event name, or an object containing event name properties.
\n\n - fn : Function (optional)
If the
\n\nenameparameter was an event name, this is the handler function. - scope : Object (optional)
If the
\n\nenameparameter was an event name, this is the scope (thisreference)\nin which the handler function is executed. - opt : Object (optional)
If the
\n\nenameparameter was an event name, this is the\naddListener options.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\nParameters
- item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n - ename : Object/String
The event name, or an object containing event name properties.
\n\n - fn : Function (optional)
If the
\n\nenameparameter was an event name, this is the handler function. - scope : Object (optional)
If the
\n\nenameparameter was an event name, this is the scope (thisreference)\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.
\nParameters
- selector : String (optional)
A ComponentQuery selector to filter the following nodes.
\n
Returns
- Ext.Component
The next node (or the next node which matches the selector).\nReturns null if there is no matching node.
\n
Returns 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
Parameters
- selector : String (optional)
A ComponentQuery selector to filter the following items.
\n
Returns
- Ext.Component
The next sibling (or the next sibling which matches the selector).\nReturns null if there is no matching sibling.
\n
Shorthand for addListener.
\n\nAppends an event handler to this object.
\nParameters
- eventName : String
The name of the event to listen for. May also be an object who's property names are\nevent names.
\n\n - fn : Function
The method the event invokes. Will be called with arguments given to\nfireEvent plus the
\n\noptionsparameter described below. - scope : Object (optional)
The scope (
\n\nthisreference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event. - options : Object (optional)
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\n- \n
scope : Object
\n\nThe scope (
thisreference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event. \ndelay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
\nsingle : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
\nbuffer : 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.
\ntarget : 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.
\nelement : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\n
\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\n
\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\n
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
Returns 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.
\nParameters
- selector : String (optional)
A ComponentQuery selector to filter the preceding nodes.
\n
Returns
- Ext.Component
The previous node (or the previous node which matches the selector).\nReturns null if there is no matching node.
\n
Returns 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
Parameters
- selector : String (optional)
A ComponentQuery selector to filter the preceding items.
\n
Returns
- Ext.Component
The previous sibling (or the previous sibling which matches the selector).\nReturns null if there is no matching sibling.
\n
Removes 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.
\nParameters
- testFn : Function
The test function.
\n
Removes a CSS class from the top level element representing this component.
\nParameters
- className : Object\n
Returns
- Ext.Component
Returns the Component to allow method chaining.
\n
Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all\nelements of this component.
\nParameters
Removes an event handler.
\nParameters
- eventName : String
The type of event the handler was associated with.
\n\n - fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n - scope : Object (optional)
The 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\n
Removes listeners that were added by the mon method.
\nParameters
- item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n - ename : Object/String
The event name, or an object containing event name properties.
\n\n - fn : Function (optional)
If the
\n\nenameparameter was an event name, this is the handler function. - scope : Object (optional)
If the
\n\nenameparameter was an event name, this is the scope (thisreference)\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
Parameters
- ui : String
The UI to add to the element
\n
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.
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.
\nParameters
- propName : String
The name of the property to save.
\n - state : Object
The state object in to which to save the property.
\n - stateName : String (optional)
The name to use for the property in state.
\n
Returns
- Boolean
True if the property was saved, false if not.
\n
This 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.
\nParameters
- active : Boolean (optional)
True to activate the Component, false to deactivate it.
\nDefaults to:
false - newActive : Ext.Component (optional)
The newly active Component which is taking over topmost zIndex position.
\n
Sets the overflow on the content element of the component.
\nParameters
- scroll : Boolean
True to allow the Component to auto scroll.
\n
Returns
- Ext.Component
this
\n
Sets 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)
\nParameters
- dock : Object
The dock position.
\n - layoutParent : Boolean (optional)
True to re-layout parent.
\nDefaults to:
false
Returns
- Ext.Component
this
\n
Sets the height of the component. This method fires the resize event.
\nParameters
- height : Number
The new height to set. This may be one of:
\n\n- \n
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels). \n
- A String used to set the CSS height style. \n
- undefined to leave the height unchanged. \n
Returns
- Ext.Component
this
\n
This method allows you to show or hide a LoadMask on top of this component.
\nParameters
- load : Boolean/Object/String
True 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.
\n - targetEl : Boolean (optional)
True to mask the targetEl of this Component instead of the
\nthis.el. For example,\nsetting this to true on a Panel will cause only the body to be masked.Defaults to:
false
Returns
- Ext.LoadMask
The LoadMask instance that has just been shown.
\n
Sets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the move event.
\nParameters
- x : Number
The new x position
\n - y : Number
The new y position
\n - animate : Boolean/Object (optional)
True to animate the Component into its new position. You may also pass an\nanimation configuration.
\n
Returns
- Ext.Component
this
\n
Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This\nmethod fires the move event.
\nParameters
- left : Number
The new left
\n - top : Number
The new top
\n - animate : Boolean/Object (optional)
If true, the Component is animated into its new position. You may also pass an\nanimation configuration.
\n
Returns
- Ext.Component
this
\n
Sets 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}.
Parameters
- width : Number/String/Object
The new width to set. This may be one of:
\n\n- \n
- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels). \n
- A String used to set the CSS width style. \n
- A size object in the format
{width: widthValue, height: heightValue}. \n undefinedto leave the width unchanged. \n
- height : Number/String
The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
\n\n- \n
- A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels). \n
- A String used to set the CSS height style. Animation may not be used. \n
undefinedto leave the height unchanged. \n
Returns
- Ext.Component
this
\n
Sets 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
\nParameters
- ui : String
The new UI for the component
\n
Convenience function to hide or show this component by boolean.
\nParameters
- visible : Boolean
True to show, false to hide
\n
Returns
- Ext.Component
this
\n
Sets the width of the component. This method fires the resize event.
\nParameters
- width : Number
The new width to setThis may be one of:
\n\n- \n
- A Number specifying the new width in the Element's Ext.Element.defaultUnits (by default, pixels). \n
- A String used to set the CSS width style. \n
Returns
- Ext.Component
this
\n
Shows 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.
\nParameters
- animateTarget : String/Ext.Element (optional)
- callback : Function (optional)
A callback function to call after the Component is displayed.\nOnly necessary if animation was specified.
\n - scope : Object (optional)
The scope (
\nthisreference) in which the callback is executed.\nDefaults to this Component.
Returns
- Ext.Component
this
\n
Displays 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}\nParameters
Get 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\nReturns
Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\nReturns
- Ext.Element
The Element
\n
Stops 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
\nReturns
- Ext.Element
The Element
\n
Suspends the firing of all events. (see resumeEvents)
\nParameters
- queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n
Ensures that all effects queued after syncFx is called on this object are\nrun concurrently. This is the opposite of sequenceFx.
\nReturns
- Object
this
\n
Sends this Component to the back of (lower z-index than) any other visible windows
\nReturns
- Ext.Component
this
\n
Brings 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.
\nParameters
- preventFocus : Boolean (optional)
Specify
\ntrueto prevent the Component from being focused.Defaults to:
false
Returns
- Ext.Component
this
\n
Shorthand for removeListener.
\n\nRemoves an event handler.
\nParameters
- eventName : String
The type of event the handler was associated with.
\n\n - fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n - scope : Object (optional)
The 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\n
Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector.
Example:
\n\nvar owningTabPanel = grid.up('tabpanel');\nParameters
- selector : String (optional)
The simple selector to test.
\n
Returns
- Ext.container.Container
The matching ancestor Container (or
\nundefinedif no match was found).
Update the content area of a component.
\nParameters
- htmlOrData : String/Object
If 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
\n - loadScripts : Boolean (optional)
Only legitimate when using the html configuration.
\nDefaults to:
false - callback : Function (optional)
Only legitimate when using the html configuration. Callback to execute when\nscripts have finished loading
\n
Sets the current box measurements of the component's underlying element.
\nParameters
- box : Object
An object in the format {x, y, width, height}
\n
Returns
- Ext.Component
this
\n
Static Methods Add / override static properties of this class. ...Add / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nParameters
- members : Object\n
Returns
- Ext.Base
this
\n
Borrow another class' members to the prototype of this class. ...Borrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nParameters
- fromClass : Ext.Base
The class to borrow members from
\n - members : String/String[]
The names of the members to borrow
\n
Returns
- Ext.Base
this
\n
Create a new instance of this Class. ...Create a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nReturns
- Object
the created instance.
\n
createAlias( String/Object alias, String/Object origin )staticCreate aliases for existing prototype methods. ...Create aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nParameters
- alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n - origin : String/Object
The original method name
\n
Get the current class' name in string format. ...Get the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nReturns
- String
className
\n
Add methods / properties to the prototype of this class. ...Add methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nParameters
- members : Object\n
Override prototype members of this class. ...Override prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nParameters
- members : Object\n
Returns
- Ext.Base
this
\n
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});\nParameters
- members : Object\n
Returns
- Ext.Base
this
\n
Borrow 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 '$$$$$$$'\nParameters
- fromClass : Ext.Base
The class to borrow members from
\n - members : String/String[]
The names of the members to borrow
\n
Returns
- Ext.Base
this
\n
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.
\nReturns
- Object
the created instance.
\n
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()\nParameters
- alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n - origin : String/Object
The original method name
\n
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'\nReturns
- String
className
\n
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();\nParameters
- members : Object\n
Override 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\"\nParameters
- members : Object\n
Returns
- Ext.Base
this
\n
Events
Fires after a Component has been visually activated.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after a Component had been added to a Container.
\nParameters
- this : Ext.Component\n
- container : Ext.container.Container
Parent Container
\n - pos : Number
position of Component
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires 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.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires before a Component has been visually activated. Returning false from an event listener can prevent\nthe activate from occurring.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires before a Component has been visually deactivated. Returning false from an event listener can\nprevent the deactivate from occurring.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires before the component is destroyed. Return false from an event handler to stop the\ndestroy.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires before the component is hidden when calling the hide method. Return false from an event\nhandler to stop the hide.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires before the component is rendered. Return false from an event handler to stop the\nrender.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires before the component is shown when calling the show method. Return false from an event\nhandler to stop the show.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires before the state of the object is restored. Return false from an event handler to stop the restore.
\nParameters
- this : Ext.state.Stateful\n
- state : Object
The 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.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires before the state of the object is saved to the configured state provider. Return false to stop the save.
\nParameters
- this : Ext.state.Stateful\n
- state : Object
The 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.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires when the tool is clicked
\nParameters
- this : Ext.panel.Tool\n
- e : Ext.EventObject
The event object
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after a Component has been visually deactivated.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the component is destroyed.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the component is disabled.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the component is enabled.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the component is hidden. Fires after the component is hidden when calling the hide\nmethod.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the component is moved.
\nParameters
- this : Ext.Component\n
- x : Number
The new x position
\n - y : Number
The new y position
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires when a component is removed from an Ext.container.Container
\nParameters
- this : Ext.Component\n
- ownerCt : Ext.container.Container
Container which holds the component
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the component markup is rendered.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the component is resized.
\nParameters
- this : Ext.Component\n
- adjWidth : Number
The box-adjusted width that was set
\n - adjHeight : Number
The box-adjusted height that was set
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the component is shown when calling the show method.
\nParameters
- this : Ext.Component\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the state of the object is restored.
\nParameters
- this : Ext.state.Stateful\n
- state : Object
The 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.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the state of the object is saved to the configured state provider.
\nParameters
- this : Ext.state.Stateful\n
- state : Object
The 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.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Replaced 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.panel.Tool","template":false,"required":null,"protected":false,"name":"setType","id":"method-setType"},{"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.panel.Tool","template":null,"required":null,"protected":false,"name":"click","id":"event-click"},{"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.panel.Tool","alternateClassNames":[],"id":"class-Ext.panel.Tool","mixedInto":[],"xtypes":{"widget":["tool"]},"files":[{"href":"Tool.html#Ext-panel-Tool","filename":"Tool.js"}]}); \ No newline at end of file