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": "AbstractContainer2.html#Ext-container-AbstractContainer-method-beforeLayout", - "shortDoc": "Occurs before componentLayout is run. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - - ], - "name": "beforeLayout", - "owner": "Ext.container.AbstractContainer", - "doc": "Occurs before componentLayout is run. Returning false from this method will prevent the containerLayout\nfrom being executed.
\n", - "linenr": 855, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractContainer2.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": "AbstractContainer2.html#Ext-container-AbstractContainer-method-cascade", - "shortDoc": "Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.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 component)
\n", - "name": "scope" - }, - { - "type": "Array", - "optional": true, - "doc": "(optional) The args to call the function with. The current component always passed as the last argument.
\n", - "name": "args" - } - ], - "name": "cascade", - "owner": "Ext.container.AbstractContainer", - "doc": "Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified function with\neach component. The scope (this reference) of the\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 cascade is stopped on that branch.
this
\n" - }, - "html_filename": "AbstractContainer2.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": "AbstractContainer2.html#Ext-container-AbstractContainer-method-child", - "shortDoc": "Retrieves the first direct child of this container which matches the passed selector. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "An Ext.ComponentQuery selector
\n", - "name": "selector" - } - ], - "name": "child", - "owner": "Ext.container.AbstractContainer", - "doc": "Retrieves the first direct child of this container which matches the passed selector.\nThe passed in selector must comply with an Ext.ComponentQuery selector.
\n", - "linenr": 784, - "return": { - "type": "void", - "doc": "Ext.Component
\n" - }, - "html_filename": "AbstractContainer2.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": "Panel2.html#Ext-panel-Panel-method-close", - "shortDoc": "Closes the Panel. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - - ], - "name": "close", - "owner": "Ext.panel.Panel", - "doc": "Closes the Panel. By default, this method, removes it from the DOM, destroys\nthe Panel object and all its descendant Components. The beforeclose\nevent is fired before the close happens and will cancel the close action if it returns false.
\n
Note: This method is not affected by the closeAction setting which\nonly affects the action triggered when clicking the 'close' tool in the header.\nTo hide the Panel without destroying it, call hide.
\n\n", - "linenr": 755, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Panel2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Panel2.html#Ext-panel-Panel-method-collapse", - "shortDoc": "Collapses the panel body so that the body becomes hidden. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": ". The direction to collapse towards. Must be one of
- \n
- Ext.Component.DIRECTION_TOP \n
- Ext.Component.DIRECTION_RIGHT \n
- Ext.Component.DIRECTION_BOTTOM \n
- Ext.Component.DIRECTION_LEFT
True to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n", - "name": "animate" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "internal" - } - ], - "name": "collapse", - "owner": "Ext.panel.Panel", - "doc": "Collapses the panel body so that the body becomes hidden. Docked Components parallel to the\nborder towards which the collapse takes place will remain visible. Fires the beforecollapse event which will\ncancel the collapse action if it returns false.
\n", - "linenr": 887, - "return": { - "type": "Ext.panel.Panel", - "doc": "this
\n" - }, - "html_filename": "Panel2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "MessageBox.html#Ext-window-MessageBox-method-confirm", - "shortDoc": "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm). ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The title bar text
\n", - "name": "title" - }, - { - "type": "String", - "optional": false, - "doc": "The message box body text
\n", - "name": "msg" - }, - { - "type": "Function", - "optional": true, - "doc": "(optional) The callback function invoked after the message box is closed
\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) The scope (this reference) in which the callback is executed. Defaults to the browser wnidow.
Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).\nIf a callback function is passed it will be called after the user clicks either button,\nand the id of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).
\n", - "linenr": 628, - "return": { - "type": "Ext.window.MessageBox", - "doc": "this
\n" - }, - "html_filename": "MessageBox.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": "AbstractContainer2.html#Ext-container-AbstractContainer-method-doLayout", - "shortDoc": "Manually force this container's layout to be recalculated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - - ], - "name": "doLayout", - "owner": "Ext.container.AbstractContainer", - "doc": "Manually force this container's layout to be recalculated. The framwork uses this internally to refresh layouts\nform most cases.
\n", - "linenr": 321, - "return": { - "type": "Ext.container.Container", - "doc": "this
\n" - }, - "html_filename": "AbstractContainer2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractContainer2.html#Ext-container-AbstractContainer-method-down", - "shortDoc": "Retrieves the first descendant of this container which matches the passed selector. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "An Ext.ComponentQuery selector
\n", - "name": "selector" - } - ], - "name": "down", - "owner": "Ext.container.AbstractContainer", - "doc": "Retrieves the first descendant of this container which matches the passed selector.\nThe passed in selector must comply with an Ext.ComponentQuery selector.
\n", - "linenr": 794, - "return": { - "type": "void", - "doc": "Ext.Component
\n" - }, - "html_filename": "AbstractContainer2.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});\nTrue to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n", - "name": "animate" - } - ], - "name": "expand", - "owner": "Ext.panel.Panel", - "doc": "Expands the panel body so that it becomes visible. Fires the beforeexpand event which will\ncancel the expand action if it returns false.
\n", - "linenr": 1178, - "return": { - "type": "Ext.panel.Panel", - "doc": "this
\n" - }, - "html_filename": "Panel2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-findLayoutController", - "shortDoc": "This method finds the topmost active layout who's processing will eventually determine the size and position of this\n...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "params": [ - - ], - "name": "findLayoutController", - "owner": "Ext.AbstractComponent", - "doc": "This 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": "Container2.html#Ext-container-Container-method-getChildByElement", - "shortDoc": "Return the immediate child Component in which the passed element is located. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/container/Container.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "The element to test.
\n", - "name": "el" - } - ], - "name": "getChildByElement", - "owner": "Ext.container.Container", - "doc": "Return the immediate child Component in which the passed element is located.
\n", - "linenr": 160, - "return": { - "type": "Component", - "doc": "The child item which contains the passed element.
\n" - }, - "html_filename": "Container2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPanel.html#Ext-panel-AbstractPanel-method-getComponent", - "shortDoc": "Attempts a default component lookup (see Ext.container.Container.getComponent). ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/panel/AbstractPanel.js", - "private": false, - "params": [ - { - "type": "String/Number", - "optional": false, - "doc": "The component id, itemId or position to find
\n", - "name": "comp" - } - ], - "name": "getComponent", - "owner": "Ext.panel.AbstractPanel", - "doc": "Attempts a default component lookup (see Ext.container.Container.getComponent). If the component is not found in the normal\nitems, the dockedItems are searched and the matched component (if any) returned (see {@loink #getDockedComponent}). Note that docked\nitems will only be matched by component id or itemId -- if you pass a numeric index only non-docked child components will be searched.
\n", - "linenr": 176, - "return": { - "type": "Ext.Component", - "doc": "The component (if found)
\n" - }, - "html_filename": "AbstractPanel.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPanel.html#Ext-panel-AbstractPanel-method-getDockedComponent", - "shortDoc": "Finds a docked component by id, itemId or position. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/panel/AbstractPanel.js", - "private": false, - "params": [ - { - "type": "String/Number", - "optional": false, - "doc": "The id, itemId or position of the docked component (see getComponent for details)
\n", - "name": "comp" - } - ], - "name": "getDockedComponent", - "owner": "Ext.panel.AbstractPanel", - "doc": "Finds a docked component by id, itemId or position. Also see getDockedItems
\n", - "linenr": 164, - "return": { - "type": "Ext.Component", - "doc": "The docked component (if found)
\n" - }, - "html_filename": "AbstractPanel.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPanel.html#Ext-panel-AbstractPanel-method-getDockedItems", - "shortDoc": "Retrieve an array of all currently docked Components. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/panel/AbstractPanel.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "A ComponentQuery selector string to filter the returned items.
\n", - "name": "cqSelector" - } - ], - "name": "getDockedItems", - "owner": "Ext.panel.AbstractPanel", - "doc": "Retrieve an array of all currently docked Components.
\n", - "linenr": 363, - "return": { - "type": "Array", - "doc": "An array of components.
\n" - }, - "html_filename": "AbstractPanel.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": "Window.html#Ext-window-Window-method-getFocusEl", - "shortDoc": "Gets the configured default focus item. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "params": [ - - ], - "name": "getFocusEl", - "owner": "Ext.window.Window", - "doc": "Gets the configured default focus item. If a defaultFocus is set, it will receive focus, otherwise the\nContainer itself will receive focus.
\n", - "linenr": 464, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Window.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": "AbstractContainer2.html#Ext-container-AbstractContainer-method-getLayout", - "shortDoc": "Returns the layout instance currently associated with this Container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - - ], - "name": "getLayout", - "owner": "Ext.container.AbstractContainer", - "doc": "Returns the layout instance currently associated with this Container.\nIf a layout has not been instantiated yet, that is done first
\n", - "linenr": 307, - "return": { - "type": "Ext.layout.container.AbstractContainer", - "doc": "The layout
\n" - }, - "html_filename": "AbstractContainer2.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", - "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": "AbstractContainer2.html#Ext-container-AbstractContainer-method-insert", - "shortDoc": "Inserts a Component into this Container at a specified index. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "The index at which the Component will be inserted\ninto the Container's items collection
\n", - "name": "index" - }, - { - "type": "Ext.Component", - "optional": false, - "doc": "The child Component to insert.
\nExt uses lazy rendering, and will only render the inserted Component should\nit become necessary.
\nA Component config object may be passed in order to avoid the overhead of\nconstructing a real Component object if lazy rendering might mean that the\ninserted Component will not be rendered immediately. To take advantage of\nthis 'lazy instantiation', set the Ext.Component.xtype config\nproperty to the registered type of the Component wanted.
\nFor a list of all available xtypes, see Ext.Component.
Inserts a Component into this Container at a specified index. Fires the\nbeforeadd event before inserting, then fires the add event after the\nComponent has been inserted.
\n", - "linenr": 547, - "return": { - "type": "Ext.Component", - "doc": "component The Component (or config object) that was\ninserted with the Container's default config values applied.
\n" - }, - "html_filename": "AbstractContainer2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractPanel.html#Ext-panel-AbstractPanel-method-insertDocked", - "shortDoc": "Inserts docked item(s) to the panel at the indicated position. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/panel/AbstractPanel.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "The index at which the Component will be inserted
\n", - "name": "pos" - }, - { - "type": "Object/Array", - "optional": false, - "doc": ". The Component or array of components to add. The components\nmust include a 'dock' paramater on each component to indicate where it should be docked ('top', 'right',\n'bottom', 'left').
\n", - "name": "component" - } - ], - "name": "insertDocked", - "owner": "Ext.panel.AbstractPanel", - "doc": "Inserts docked item(s) to the panel at the indicated position.
\n", - "linenr": 309, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractPanel.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": null, - "protected": false, - "tagname": "method", - "href": "Window.html#Ext-window-Window-method-maximize", - "shortDoc": "Fits the window within its current container and automatically replaces\nthe 'maximize' tool button with the 'restore'...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "params": [ - - ], - "name": "maximize", - "owner": "Ext.window.Window", - "doc": "Fits the window within its current container and automatically replaces\nthe 'maximize' tool button with the 'restore' tool button.\nAlso see toggleMaximize.
\n", - "linenr": 605, - "return": { - "type": "Ext.window.Window", - "doc": "this
\n" - }, - "html_filename": "Window.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Window.html#Ext-window-Window-method-minimize", - "shortDoc": "Placeholder method for minimizing the window. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "params": [ - - ], - "name": "minimize", - "owner": "Ext.window.Window", - "doc": "Placeholder method for minimizing the window. By default, this method simply fires the minimize event\nsince the behavior of minimizing a window is application-specific. To implement custom minimize behavior,\neither the minimize event can be handled or this method can be overridden.
\n", - "linenr": 567, - "return": { - "type": "Ext.window.Window", - "doc": "this
\n" - }, - "html_filename": "Window.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": null, - "protected": false, - "tagname": "method", - "href": "AbstractContainer2.html#Ext-container-AbstractContainer-method-move", - "shortDoc": "Moves a Component within the Container ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "The index the Component you wish to move is currently at.
\n", - "name": "fromIdx" - }, - { - "type": "Number", - "optional": false, - "doc": "The new index for the Component.
\n", - "name": "toIdx" - } - ], - "name": "move", - "owner": "Ext.container.AbstractContainer", - "doc": "Moves a Component within the Container
\n", - "linenr": 569, - "return": { - "type": "Ext.Component", - "doc": "component The Component (or config object) that was moved.
\n" - }, - "html_filename": "AbstractContainer2.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": "MessageBox.html#Ext-window-MessageBox-method-progress", - "shortDoc": "Displays a message box with a progress bar. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The title bar text
\n", - "name": "title" - }, - { - "type": "String", - "optional": false, - "doc": "The message box body text
\n", - "name": "msg" - }, - { - "type": "String", - "optional": true, - "doc": "(optional) The text to display inside the progress bar (defaults to '')
\n", - "name": "progressText" - } - ], - "name": "progress", - "owner": "Ext.window.MessageBox", - "doc": "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via updateProgress\nand closing the message box when the process is complete.
\n", - "linenr": 733, - "return": { - "type": "Ext.window.MessageBox", - "doc": "this
\n" - }, - "html_filename": "MessageBox.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "MessageBox.html#Ext-window-MessageBox-method-prompt", - "shortDoc": "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's p...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The title bar text
\n", - "name": "title" - }, - { - "type": "String", - "optional": false, - "doc": "The message box body text
\n", - "name": "msg" - }, - { - "type": "Function", - "optional": true, - "doc": "(optional) The callback function invoked after the message box is closed
\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) The scope (this reference) in which the callback is executed. Defaults to the browser wnidow.
(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)
\n", - "name": "multiline" - }, - { - "type": "String", - "optional": true, - "doc": "(optional) Default value of the text input element (defaults to '')
\n", - "name": "value" - } - ], - "name": "prompt", - "owner": "Ext.window.MessageBox", - "doc": "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).\nThe prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user\nclicks either button, and the id of the button that was clicked (could also be the top-right\nclose button) and the text that was entered will be passed as the two parameters to the callback.
\n", - "linenr": 653, - "return": { - "type": "Ext.window.MessageBox", - "doc": "this
\n" - }, - "html_filename": "MessageBox.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractContainer2.html#Ext-container-AbstractContainer-method-query", - "shortDoc": "Retrieves all descendant components which match the passed selector. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "Selector complying to an Ext.ComponentQuery selector
\n", - "name": "selector" - } - ], - "name": "query", - "owner": "Ext.container.AbstractContainer", - "doc": "Retrieves all descendant components which match the passed selector.\nExecutes an Ext.ComponentQuery.query using this container as its root.
\n", - "linenr": 774, - "return": { - "type": "Array", - "doc": "Ext.Component's which matched the selector
\n" - }, - "html_filename": "AbstractContainer2.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": "AbstractContainer2.html#Ext-container-AbstractContainer-method-remove", - "shortDoc": "Removes a component from this container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Component/String", - "optional": false, - "doc": "The component reference or id to remove.
\n", - "name": "component" - }, - { - "type": "Boolean", - "optional": true, - "doc": "(optional) True to automatically invoke the removed Component's Ext.Component.destroy function.\nDefaults to the value of this Container's autoDestroy config.
\n", - "name": "autoDestroy" - } - ], - "name": "remove", - "owner": "Ext.container.AbstractContainer", - "doc": "Removes a component from this container. Fires the beforeremove event before removing, then fires\nthe remove event after the component has been removed.
\n", - "linenr": 600, - "return": { - "type": "Ext.Component", - "doc": "component The Component that was removed.
\n" - }, - "html_filename": "AbstractContainer2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractContainer2.html#Ext-container-AbstractContainer-method-removeAll", - "shortDoc": "Removes all components from this container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Boolean", - "optional": true, - "doc": "(optional) True to automatically invoke the removed Component's Ext.Component.destroy function.\nDefaults to the value of this Container's autoDestroy config.
\n", - "name": "autoDestroy" - } - ], - "name": "removeAll", - "owner": "Ext.container.AbstractContainer", - "doc": "Removes all components from this container.
\n", - "linenr": 653, - "return": { - "type": "Array", - "doc": "Array of the destroyed components
\n" - }, - "html_filename": "AbstractContainer2.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": "AbstractPanel.html#Ext-panel-AbstractPanel-method-removeDocked", - "shortDoc": "Removes the docked item from the panel. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/panel/AbstractPanel.js", - "private": false, - "params": [ - { - "type": "Ext.Component", - "optional": false, - "doc": ". The Component to remove.
\n", - "name": "item" - }, - { - "type": "Boolean", - "optional": true, - "doc": "(optional) Destroy the component after removal.
\n", - "name": "autoDestroy" - } - ], - "name": "removeDocked", - "owner": "Ext.panel.AbstractPanel", - "doc": "Removes the docked item from the panel.
\n", - "linenr": 320, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractPanel.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
Restores a maximized window back to its original\nsize and position prior to being maximized and also replaces\nthe 'restore' tool button with the 'maximize' tool button.\nAlso see toggleMaximize.
\n", - "linenr": 644, - "return": { - "type": "Ext.window.Window", - "doc": "this
\n" - }, - "html_filename": "Window.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-resumeEvents", - "shortDoc": "Resumes firing events (see suspendEvents). ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - - ], - "name": "resumeEvents", - "owner": "Ext.util.Observable", - "doc": "Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the **queueSuspended** parameter, then all events fired\nduring event suspension will be sent to any listeners now.
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": "MessageBox.html#Ext-window-MessageBox-method-setIcon", - "shortDoc": "Adds the specified icon to the dialog. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "A CSS classname specifying the icon's background image url, or empty string to clear the icon
\n", - "name": "icon" - } - ], - "name": "setIcon", - "owner": "Ext.window.MessageBox", - "doc": "Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default\nstyling, and the class passed in is expected to supply the background image url. Pass in empty string ('')\nto clear any existing icon. This method must be called before the MessageBox is shown.\nThe following built-in icon classes are supported, but you can also pass in a custom class name:
\n\nExt.window.MessageBox.INFO\nExt.window.MessageBox.WARNING\nExt.window.MessageBox.QUESTION\nExt.window.MessageBox.ERROR\n\n\n", - "linenr": 576, - "return": { - "type": "Ext.window.MessageBox", - "doc": "
this
\n" - }, - "html_filename": "MessageBox.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Panel2.html#Ext-panel-Panel-method-setIconCls", - "shortDoc": "Set the iconCls for the panel's header. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "\n", - "name": "newIconCls" - } - ], - "name": "setIconCls", - "owner": "Ext.panel.Panel", - "doc": "Set the iconCls for the panel's header. See Ext.panel.Header.iconCls.
\n", - "linenr": 459, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Panel2.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": "Panel2.html#Ext-panel-Panel-method-setTitle", - "shortDoc": "Set a title for the panel's header. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "\n", - "name": "newTitle" - } - ], - "name": "setTitle", - "owner": "Ext.panel.Panel", - "doc": "Set a title for the panel's header. See Ext.panel.Header.title.
\n", - "linenr": 438, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Panel2.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": "MessageBox.html#Ext-window-MessageBox-method-show", - "shortDoc": "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "The following config options are supported:
- \n
- animateTarget : String/ElementAn id or Element from which the message box should animate as it\nopens and closes (defaults to undefined)\n
- buttons : NumberA bitwise button specifier consisting of the sum of any of the following constants:
- \n
- Ext.window.MessageBox.OK \n
- Ext.window.MessageBox.YES \n
- Ext.window.MessageBox.NO \n
- Ext.window.MessageBox.CANCEL \n
\n - closable : BooleanFalse to hide the top-right close button (defaults to true). Note that\nprogress and wait dialogs will ignore this property and always hide the close button as they can only\nbe closed programmatically.\n
- cls : StringA custom CSS class to apply to the message box's container element\n
- defaultTextHeight : NumberThe default height in pixels of the message box's multiline textarea\nif displayed (defaults to 75)\n
- fn : FunctionA callback function which is called when the dialog is dismissed either\nby clicking on the configured buttons, or on the dialog close button, or by pressing\nthe return button to enter input.\n\n
Progress and wait dialogs will ignore this option since they do not respond to user\nactions and can only be closed programmatically, so any required function should be called\nby the same code after it closes the dialog. Parameters passed:
- \n
- buttonId : StringThe ID of the button pressed, one of:
- \n
- ok \n
- yes \n
- no \n
- cancel \n
\n - text : String \n
- opt : ObjectThe config object passed to show.\n
\n - buttonId : String
- scope : ObjectThe scope (
thisreference) in which the function will be executed. \n - icon : StringA CSS class that provides a background image to be used as the body icon for the\ndialog (e.g. Ext.window.MessageBox.WARNING or 'custom-class') (defaults to '')\n
- iconCls : StringThe standard Ext.window.Window.iconCls to\nadd an optional header icon (defaults to '')\n
- maxWidth : NumberThe maximum width in pixels of the message box (defaults to 600)\n
- minWidth : NumberThe minimum width in pixels of the message box (defaults to 100)\n
- modal : BooleanFalse to allow user interaction with the page while the message box is\ndisplayed (defaults to true)\n
- msg : StringA string that will replace the existing message box body text (defaults to the\nXHTML-compliant non-breaking space character ' ')\n
- multiline : Boolean\nTrue to prompt the user to enter multi-line text (defaults to false)\n
- progress : BooleanTrue to display a progress bar (defaults to false)\n
- progressText : StringThe text to display inside the progress bar if progress = true (defaults to '')\n
- prompt : BooleanTrue to prompt the user to enter single-line text (defaults to false)\n
- proxyDrag : BooleanTrue to display a lightweight proxy while dragging (defaults to false)\n
- title : StringThe title text\n
- value : StringThe string value to set into the active textbox element if displayed\n
- wait : BooleanTrue to display a progress bar (defaults to false)\n
- waitConfig : ObjectA Ext.ProgressBar.waitConfig object (applies only if wait = true)\n
- width : NumberThe width of the dialog in pixels\n
Ext.Msg.show({\ntitle: 'Address',\nmsg: 'Please enter your address:',\nwidth: 300,\nbuttons: Ext.window.MessageBox.OKCANCEL,\nmultiline: true,\nfn: saveAddress,\nanimateTarget: 'addAddressBtn',\nicon: Ext.window.MessageBox.INFO\n});\nDisplays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,\nalthough those calls are basic shortcuts and do not support all of the config options allowed here.
\n", - "linenr": 436, - "return": { - "type": "Ext.window.MessageBox", - "doc": "this
\n" - }, - "html_filename": "MessageBox.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", - "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": null, - "protected": false, - "tagname": "method", - "href": "Panel2.html#Ext-panel-Panel-method-toggleCollapse", - "shortDoc": "Shortcut for performing an expand or collapse based on the current state of the panel. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - - ], - "name": "toggleCollapse", - "owner": "Ext.panel.Panel", - "doc": "Shortcut for performing an expand or collapse based on the current state of the panel.
\n", - "linenr": 1366, - "return": { - "type": "Ext.panel.Panel", - "doc": "this
\n" - }, - "html_filename": "Panel2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Window.html#Ext-window-Window-method-toggleMaximize", - "shortDoc": "A shortcut method for toggling between maximize and restore based on the current maximized\nstate of the window. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "params": [ - - ], - "name": "toggleMaximize", - "owner": "Ext.window.Window", - "doc": "A shortcut method for toggling between maximize and restore based on the current maximized\nstate of the window.
\n", - "linenr": 723, - "return": { - "type": "Ext.window.Window", - "doc": "this
\n" - }, - "html_filename": "Window.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" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "MessageBox.html#Ext-window-MessageBox-method-updateProgress", - "shortDoc": "Updates a progress-style message box's text and progress bar. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "params": [ - { - "type": "Number", - "optional": false, - "doc": "Any number between 0 and 1 (e.g., .5, defaults to 0)
\n", - "name": "value" - }, - { - "type": "String", - "optional": false, - "doc": "The progress text to display inside the progress bar (defaults to '')
\n", - "name": "progressText" - }, - { - "type": "String", - "optional": false, - "doc": "The message box's body text is replaced with the specified string (defaults to undefined\nso that any existing body text will not get overwritten by default unless a new value is passed in)
\n", - "name": "msg" - } - ], - "name": "updateProgress", - "owner": "Ext.window.MessageBox", - "doc": "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via progress or wait,\nor by calling show with progress: true.
\n", - "linenr": 604, - "return": { - "type": "Ext.window.MessageBox", - "doc": "this
\n" - }, - "html_filename": "MessageBox.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "MessageBox.html#Ext-window-MessageBox-method-wait", - "shortDoc": "Displays a message box with an infinitely auto-updating progress bar. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The message box body text
\n", - "name": "msg" - }, - { - "type": "String", - "optional": true, - "doc": "(optional) The title bar text
\n", - "name": "title" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) A Ext.ProgressBar.waitConfig object
\n", - "name": "config" - } - ], - "name": "wait", - "owner": "Ext.window.MessageBox", - "doc": "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.
\n", - "linenr": 684, - "return": { - "type": "Ext.window.MessageBox", - "doc": "this
\n" - }, - "html_filename": "MessageBox.html" - } - ], - "property": [ - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-CANCEL", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "CANCEL", - "owner": "Ext.window.MessageBox", - "doc": "Button config that displays a single Cancel button
\n", - "linenr": 71, - "html_filename": "MessageBox.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-ERROR", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "ERROR", - "owner": "Ext.window.MessageBox", - "doc": "The CSS class that provides the ERROR icon image
\n", - "linenr": 106, - "html_filename": "MessageBox.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-INFO", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "INFO", - "owner": "Ext.window.MessageBox", - "doc": "The CSS class that provides the INFO icon image
\n", - "linenr": 91, - "html_filename": "MessageBox.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-NO", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "NO", - "owner": "Ext.window.MessageBox", - "doc": "Button config that displays a single No button
\n", - "linenr": 66, - "html_filename": "MessageBox.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-OK", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "OK", - "owner": "Ext.window.MessageBox", - "doc": "Button config that displays a single OK button
\n", - "linenr": 56, - "html_filename": "MessageBox.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-OKCANCEL", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "OKCANCEL", - "owner": "Ext.window.MessageBox", - "doc": "Button config that displays OK and Cancel buttons
\n", - "linenr": 76, - "html_filename": "MessageBox.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-QUESTION", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "QUESTION", - "owner": "Ext.window.MessageBox", - "doc": "The CSS class that provides the QUESTION icon image
\n", - "linenr": 101, - "html_filename": "MessageBox.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-WARNING", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "WARNING", - "owner": "Ext.window.MessageBox", - "doc": "The CSS class that provides the WARNING icon image
\n", - "linenr": 96, - "html_filename": "MessageBox.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-YES", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "YES", - "owner": "Ext.window.MessageBox", - "doc": "Button config that displays a single Yes button
\n", - "linenr": 61, - "html_filename": "MessageBox.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-YESNO", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "YESNO", - "owner": "Ext.window.MessageBox", - "doc": "Button config that displays Yes and No buttons
\n", - "linenr": 81, - "html_filename": "MessageBox.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-YESNOCANCEL", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "YESNOCANCEL", - "owner": "Ext.window.MessageBox", - "doc": "Button config that displays Yes, No and Cancel buttons
\n", - "linenr": 86, - "html_filename": "MessageBox.html" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-buttonText", - "shortDoc": "An object containing the default button text strings that can be overriden for localized language support. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "buttonText", - "owner": "Ext.window.MessageBox", - "doc": "An object containing the default button text strings that can be overriden for localized language support.\nSupported properties are: ok, cancel, yes and no. Generally you should include a locale-specific\nresource file for handling language support across the framework.\nCustomize the default text like so: Ext.window.MessageBox.buttonText.yes = \"oui\"; //french
\n", - "linenr": 149, - "html_filename": "MessageBox.html" - }, - { - "type": "Ext.util.ComponentDragger", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Window.html#Ext-window-Window-property-dd", - "shortDoc": "If this Window is configured draggable, this property will contain\nan instance of Ext.util.ComponentDragger (A subcla...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "name": "dd", - "owner": "Ext.window.Window", - "doc": "If this Window is configured draggable, this property will contain\nan instance of Ext.util.ComponentDragger (A subclass of DragTracker)\nwhich handles dragging the Window's DOM Element, and constraining according to the constrain\nand constrainHeader .
\n\n\nThis has implementations of onBeforeStart, onDrag and onEnd\nwhich perform the dragging action. If extra logic is needed at these points, use\ncreateInterceptor or createSequence to\naugment the existing implementations.
The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
\n", - "linenr": 132, - "html_filename": "MessageBox.html" - }, - { - "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
The MixedCollection containing all the child items of this container.
\n", - "linenr": 273, - "html_filename": "AbstractContainer2.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "AbstractComponent.html#Ext-AbstractComponent-property-maskOnDisable", - "shortDoc": "This is an internal flag that you use when creating custom components. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", - "private": false, - "name": "maskOnDisable", - "owner": "Ext.AbstractComponent", - "doc": "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": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-minProgressWidth", - "shortDoc": "The minimum width in pixels of the message box if it is a progress-style dialog. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "minProgressWidth", - "owner": "Ext.window.MessageBox", - "doc": "The minimum width in pixels of the message box if it is a progress-style dialog. This is useful\nfor setting a different minimum width than text-only dialogs may need (defaults to 250).
\n", - "linenr": 137, - "html_filename": "MessageBox.html" - }, - { - "type": "Number", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "MessageBox.html#Ext-window-MessageBox-property-minPromptWidth", - "shortDoc": "The minimum width in pixels of the message box if it is a prompt dialog. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "name": "minPromptWidth", - "owner": "Ext.window.MessageBox", - "doc": "The minimum width in pixels of the message box if it is a prompt dialog. This is useful\nfor setting a different minimum width than text-only dialogs may need (defaults to 250).
\n", - "linenr": 143, - "html_filename": "MessageBox.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": "Window.html#Ext-window-Window-event-activate", - "shortDoc": "Fires after the window has been visually activated via setActive. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "params": [ - { - "type": "Ext.window.Window", - "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.window.Window", - "doc": "Fires after the window has been visually activated via setActive.
\n", - "linenr": 208, - "html_filename": "Window.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractContainer2.html#Ext-container-AbstractContainer-event-add", - "shortDoc": "@bubbles\nFires after any Ext.Component is added or inserted into the container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Ext.container.Container", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Ext.Component", - "optional": false, - "doc": "The component that was added
\n", - "name": "component" - }, - { - "type": "Number", - "optional": false, - "doc": "The index at which the component was added to the container's items collection
\n", - "name": "index" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "add", - "owner": "Ext.container.AbstractContainer", - "doc": "@bubbles\nFires after any Ext.Component is added or inserted into the container.
\n", - "linenr": 215, - "html_filename": "AbstractContainer2.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": "AbstractContainer2.html#Ext-container-AbstractContainer-event-afterlayout", - "shortDoc": "Fires when the components in this container are arranged by the associated layout manager. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Ext.container.Container", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "ContainerLayout", - "optional": false, - "doc": "The ContainerLayout implementation for this container
\n", - "name": "layout" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "afterlayout", - "owner": "Ext.container.AbstractContainer", - "doc": "Fires when the components in this container are arranged by the associated layout manager.
\n", - "linenr": 191, - "html_filename": "AbstractContainer2.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": "AbstractContainer2.html#Ext-container-AbstractContainer-event-beforeadd", - "shortDoc": "Fires before any Ext.Component is added or inserted into the container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Ext.container.Container", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Ext.Component", - "optional": false, - "doc": "The component being added
\n", - "name": "component" - }, - { - "type": "Number", - "optional": false, - "doc": "The index at which the component will be added to the container's items collection
\n", - "name": "index" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforeadd", - "owner": "Ext.container.AbstractContainer", - "doc": "Fires before any Ext.Component is added or inserted into the container.\nA handler can return false to cancel the add.
\n", - "linenr": 198, - "html_filename": "AbstractContainer2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractContainer2.html#Ext-container-AbstractContainer-event-beforecardswitch", - "shortDoc": "Fires before this container switches the active card. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Ext.container.Container", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Ext.Component", - "optional": false, - "doc": "The card that will be switched to
\n", - "name": "newCard" - }, - { - "type": "Ext.Component", - "optional": false, - "doc": "The card that will be switched from
\n", - "name": "oldCard" - }, - { - "type": "Number", - "optional": false, - "doc": "The index of the card that will be switched to
\n", - "name": "index" - }, - { - "type": "Boolean", - "optional": false, - "doc": "True if this cardswitch will be animated
\n", - "name": "animated" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforecardswitch", - "owner": "Ext.container.AbstractContainer", - "doc": "Fires before this container switches the active card. This event\nis only available if this container uses a CardLayout. Note that\nTabPanel and Carousel both get a CardLayout by default, so both\nwill have this event.\nA handler can return false to cancel the card switch.
\n", - "linenr": 232, - "html_filename": "AbstractContainer2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Panel2.html#Ext-panel-Panel-event-beforecollapse", - "shortDoc": "Fires before this panel is collapsed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - { - "type": "Ext.panel.Panel", - "optional": false, - "doc": "The Panel being collapsed.
\n", - "name": "p" - }, - { - "type": "String", - "optional": false, - "doc": ". The direction of the collapse. One of
- \n
- Ext.Component.DIRECTION_TOP \n
- Ext.Component.DIRECTION_RIGHT \n
- Ext.Component.DIRECTION_BOTTOM \n
- Ext.Component.DIRECTION_LEFT
True if the collapse is animated, else false.
\n", - "name": "animate" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforecollapse", - "owner": "Ext.panel.Panel", - "doc": "Fires before this panel is collapsed. Return false to prevent the collapse.
\n", - "linenr": 327, - "html_filename": "Panel2.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": "Panel2.html#Ext-panel-Panel-event-beforeexpand", - "shortDoc": "Fires before this panel is expanded. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - { - "type": "Ext.panel.Panel", - "optional": false, - "doc": "The Panel being expanded.
\n", - "name": "p" - }, - { - "type": "Boolean", - "optional": false, - "doc": "True if the expand is animated, else false.
\n", - "name": "animate" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforeexpand", - "owner": "Ext.panel.Panel", - "doc": "Fires before this panel is expanded. Return false to prevent the expand.
\n", - "linenr": 319, - "html_filename": "Panel2.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": "AbstractContainer2.html#Ext-container-AbstractContainer-event-beforeremove", - "shortDoc": "Fires before any Ext.Component is removed from the container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Ext.container.Container", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Ext.Component", - "optional": false, - "doc": "The component being removed
\n", - "name": "component" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforeremove", - "owner": "Ext.container.AbstractContainer", - "doc": "Fires before any Ext.Component is removed from the container. A handler can return\nfalse to cancel the remove.
\n", - "linenr": 207, - "html_filename": "AbstractContainer2.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": "AbstractPanel.html#Ext-panel-AbstractPanel-event-bodyresize", - "shortDoc": "Fires after the Panel has been resized. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/panel/AbstractPanel.js", - "private": false, - "params": [ - { - "type": "Ext.panel.Panel", - "optional": false, - "doc": "the Panel which has been resized.
\n", - "name": "p" - }, - { - "type": "Number", - "optional": false, - "doc": "The Panel body's new width.
\n", - "name": "width" - }, - { - "type": "Number", - "optional": false, - "doc": "The Panel body's new height.
\n", - "name": "height" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "bodyresize", - "owner": "Ext.panel.AbstractPanel", - "doc": "Fires after the Panel has been resized.
\n", - "linenr": 121, - "html_filename": "AbstractPanel.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractContainer2.html#Ext-container-AbstractContainer-event-cardswitch", - "shortDoc": "Fires after this container switches the active card. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Ext.container.Container", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Ext.Component", - "optional": false, - "doc": "The card that has been switched to
\n", - "name": "newCard" - }, - { - "type": "Ext.Component", - "optional": false, - "doc": "The card that has been switched from
\n", - "name": "oldCard" - }, - { - "type": "Number", - "optional": false, - "doc": "The index of the card that has been switched to
\n", - "name": "index" - }, - { - "type": "Boolean", - "optional": false, - "doc": "True if this cardswitch was animated
\n", - "name": "animated" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "cardswitch", - "owner": "Ext.container.AbstractContainer", - "doc": "Fires after this container switches the active card. If the card\nis switched using an animation, this event will fire after the\nanimation has finished. This event is only available if this container\nuses a CardLayout. Note that TabPanel and Carousel both get a CardLayout\nby default, so both will have this event.
\n", - "linenr": 246, - "html_filename": "AbstractContainer2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Panel2.html#Ext-panel-Panel-event-collapse", - "shortDoc": "Fires after this Panel hass collapsed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - { - "type": "Ext.panel.Panel", - "optional": false, - "doc": "The Panel that has been collapsed.
\n", - "name": "p" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "collapse", - "owner": "Ext.panel.Panel", - "doc": "Fires after this Panel hass collapsed.
\n", - "linenr": 347, - "html_filename": "Panel2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Window.html#Ext-window-Window-event-deactivate", - "shortDoc": "Fires after the window has been visually deactivated via setActive. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "params": [ - { - "type": "Ext.window.Window", - "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.window.Window", - "doc": "Fires after the window has been visually deactivated via setActive.
\n", - "linenr": 213, - "html_filename": "Window.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": "Panel2.html#Ext-panel-Panel-event-expand", - "shortDoc": "Fires after this Panel has expanded. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - { - "type": "Ext.panel.Panel", - "optional": false, - "doc": "The Panel that has been expanded.
\n", - "name": "p" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "expand", - "owner": "Ext.panel.Panel", - "doc": "Fires after this Panel has expanded.
\n", - "linenr": 340, - "html_filename": "Panel2.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": "Panel2.html#Ext-panel-Panel-event-iconchange", - "shortDoc": "Fires after the Panel iconCls has been set or changed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - { - "type": "Ext.panel.Panel", - "optional": false, - "doc": "the Panel which has been resized.
\n", - "name": "p" - }, - { - "type": "String", - "optional": false, - "doc": "The new iconCls.
\n", - "name": "newIconCls" - }, - { - "type": "String", - "optional": false, - "doc": "The previous panel iconCls.
\n", - "name": "oldIconCls" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "iconchange", - "owner": "Ext.panel.Panel", - "doc": "Fires after the Panel iconCls has been set or changed.
\n", - "linenr": 363, - "html_filename": "Panel2.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Window.html#Ext-window-Window-event-maximize", - "shortDoc": "Fires after the window has been maximized. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "params": [ - { - "type": "Ext.window.Window", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "maximize", - "owner": "Ext.window.Window", - "doc": "Fires after the window has been maximized.
\n", - "linenr": 226, - "html_filename": "Window.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Window.html#Ext-window-Window-event-minimize", - "shortDoc": "Fires after the window has been minimized. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "params": [ - { - "type": "Ext.window.Window", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "minimize", - "owner": "Ext.window.Window", - "doc": "Fires after the window has been minimized.
\n", - "linenr": 232, - "html_filename": "Window.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": "AbstractContainer2.html#Ext-container-AbstractContainer-event-remove", - "shortDoc": "@bubbles\nFires after any Ext.Component is removed from the container. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/container/AbstractContainer.js", - "private": false, - "params": [ - { - "type": "Ext.container.Container", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Ext.Component", - "optional": false, - "doc": "The component that was removed
\n", - "name": "component" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "remove", - "owner": "Ext.container.AbstractContainer", - "doc": "@bubbles\nFires after any Ext.Component is removed from the container.
\n", - "linenr": 224, - "html_filename": "AbstractContainer2.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": "Window.html#Ext-window-Window-event-resize", - "shortDoc": "Fires after the window has been resized. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "params": [ - { - "type": "Ext.window.Window", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Number", - "optional": false, - "doc": "The window's new width
\n", - "name": "width" - }, - { - "type": "Number", - "optional": false, - "doc": "The window's new height
\n", - "name": "height" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "resize", - "owner": "Ext.window.Window", - "doc": "Fires after the window has been resized.
\n", - "linenr": 218, - "html_filename": "Window.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Window.html#Ext-window-Window-event-restore", - "shortDoc": "Fires after the window has been restored to its original size after being maximized. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/Window.js", - "private": false, - "params": [ - { - "type": "Ext.window.Window", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "restore", - "owner": "Ext.window.Window", - "doc": "Fires after the window has been restored to its original size after being maximized.
\n", - "linenr": 238, - "html_filename": "Window.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" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "Panel2.html#Ext-panel-Panel-event-titlechange", - "shortDoc": "Fires after the Panel title has been set or changed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/panel/Panel.js", - "private": false, - "params": [ - { - "type": "Ext.panel.Panel", - "optional": false, - "doc": "the Panel which has been resized.
\n", - "name": "p" - }, - { - "type": "String", - "optional": false, - "doc": "The new title.
\n", - "name": "newTitle" - }, - { - "type": "String", - "optional": false, - "doc": "The previous panel title.
\n", - "name": "oldTitle" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "titlechange", - "owner": "Ext.panel.Panel", - "doc": "Fires after the Panel title has been set or changed.
\n", - "linenr": 354, - "html_filename": "Panel2.html" - } - ] - }, - "singleton": true, - "alias": null, - "superclasses": [ - "Ext.Base", - "Ext.AbstractComponent", - "Ext.Component", - "Ext.container.AbstractContainer", - "Ext.container.Container", - "Ext.panel.AbstractPanel", - "Ext.panel.Panel", - "Ext.window.Window" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "MessageBox.html#Ext-window-MessageBox", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": true, - "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/window/MessageBox.js", - "private": false, - "alternateClassNames": [ - "Ext.MessageBox" - ], - "name": "Ext.window.MessageBox", - "doc": "Utility class for generating different styles of message boxes. The singleton instance, Ext.Msg can also be used.\nNote that a MessageBox is asynchronous. Unlike a regular JavaScript alert (which will halt\nbrowser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code\nthat should only run after some user feedback from the MessageBox, you must use a callback function\n(see the function parameter for show for more details).
![\"alert](\"doc-resources/Ext.window.MessageBox/messagebox1.png\")
![\"prompt](\"doc-resources/Ext.window.MessageBox/messagebox2.png\")
![\"show](\"doc-resources/Ext.window.MessageBox/messagebox3.png\")
Example usage:
\n\n// Basic alert:\nExt.Msg.alert('Status', 'Changes saved successfully.');\n\n// Prompt for user data and process the result using a callback:\nExt.Msg.prompt('Name', 'Please enter your name:', function(btn, text){\n if (btn == 'ok'){\n // process text value and close...\n }\n});\n\n// Show a dialog using config options:\nExt.Msg.show({\n title:'Save Changes?',\n msg: 'You are closing a tab that has unsaved changes. Would you like to save your changes?',\n buttons: Ext.Msg.YESNOCANCEL,\n fn: processResult,\n animateTarget: 'elId',\n icon: Ext.window.MessageBox.QUESTION\n});\nHierarchy
Mixins
Requires
Files
Utility class for generating different styles of message boxes. The singleton instance, Ext.MessageBox\nalias Ext.Msg can also be used.
Note that a MessageBox is asynchronous. Unlike a regular JavaScript alert (which will halt\nbrowser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code\nthat should only run after some user feedback from the MessageBox, you must use a callback function\n(see the function parameter for show for more details).
Basic alert
\n\nExt.Msg.alert('Status', 'Changes saved successfully.');\nPrompt for user data and process the result using a callback
\n\nExt.Msg.prompt('Name', 'Please enter your name:', function(btn, text){\n if (btn == 'ok'){\n // process text value and close...\n }\n});\nShow a dialog using config options
\n\nExt.Msg.show({\n title:'Save Changes?',\n msg: 'You are closing a tab that has unsaved changes. Would you like to save your changes?',\n buttons: Ext.Msg.YESNOCANCEL,\n icon: Ext.Msg.QUESTION\n});\nConfig options
A string component id or the numeric index of the component that should be initially activated within the\ncontainer's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first\nitem in the container's collection). activeItem only applies to layout styles that can display\nitems one at a time (like Ext.layout.container.Card and Ext.layout.container.Fit).
\ntrue to animate the transition when the panel is collapsed, false to skip the animation (defaults to true\nif the Ext.fx.Anim class is available, otherwise false). May also be specified as the animation\nduration in milliseconds.
Id or element from which the window should animate while opening.
\nDefaults to: null
If true the container will automatically destroy any contained component that is removed from it, else\ndestruction must be handled manually.\nDefaults to true.
\nDefaults to: true
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 panel's element.
\nDefaults to: "x-window"
Convenience config. Short for 'Bottom Bar'.
\n\nbbar: [\n { xtype: 'button', text: 'Button 1' }\n]\nis equivalent to
\n\ndockedItems: [{\n xtype: 'toolbar',\n dock: 'bottom',\n items: [\n { xtype: 'button', text: 'Button 1' }\n ]\n}]\nA shortcut to add or remove the border on the body of a panel. This only applies to a panel\nwhich has the frame configuration set to true.
A CSS class, space-delimited string of classes, or array of classes to be applied to the panel's body element.\nThe following examples are all valid:
\n\nbodyCls: 'foo'\nbodyCls: 'foo bar'\nbodyCls: ['foo', 'bar']\nA shortcut for setting a padding style on the body element. The value can either be\na number to be applied to all sides, or a normal css string describing padding.
\nCustom CSS styles to be applied to the panel's body element, which can be supplied as a valid CSS style string,\nan object containing style property name/value pairs or a function that returns such a string or object.\nFor example, these two formats are interpreted to be equivalent:
\n\nbodyStyle: 'background:#ffc; padding:10px;'\n\nbodyStyle: {\n background: '#ffc',\n padding: '10px'\n}\nSpecifies 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 of events that, when fired, should be bubbled to any parent container.\nSee Ext.util.Observable.enableBubble.\nDefaults to ['add', 'remove'].\n\n
Defaults to: ["add", "remove"]
An 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.
\nTrue to display the 'close' tool button and allow the user to close the window, false to hide the button and\ndisallow closing the window.
\n\nBy default, when close is requested by either clicking the close button in the header or pressing ESC when the\nWindow has focus, the close method will be called. This will destroy the\nWindow and its content meaning that it may not be reused.
\n\nTo make closing a Window hide the Window so that it may be reused, set closeAction to 'hide'.
\nDefaults to: true
The action to take when the close header tool is clicked:
\n\n- \n
\n\n'destroy':remove the window from the DOM and destroy it and all descendant\nComponents. The window will not be available to be redisplayed via the show method.
\n
\n\n'hide':hide the window by setting visibility to hidden and applying negative offsets. The window will be\navailable to be redisplayed via the show method.
\n
Note: This behavior has changed! setting does affect the close method which will invoke the\napproriate closeAction.
\nDefaults to: "destroy"
An 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: ""
The direction to collapse the Panel when the toggle button is clicked.
\n\nDefaults to the headerPosition
\n\nImportant: This config is ignored for collapsible Panels which are direct child items of a border layout.
\n\nSpecify as 'top', 'bottom', 'left' or 'right'.
true to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in\nthe panel's title bar, false to render it last.
Defaults to: true
Important: this config is only effective for collapsible Panels which are direct child items of a\nborder layout.
\n\nWhen not a direct child item of a border layout, then the Panel's header\nremains visible, and the body is collapsed to zero dimensions. If the Panel has no header, then a new header\n(orientated correctly depending on the collapseDirection) will be inserted to show a the title and a re-\nexpand tool.
\n\nWhen a child item of a border layout, this config has two options:
\n\n- \n
\n\nundefined/omittedWhen collapsed, a placeholder Header is injected into the layout to represent the Panel\nand to provide a UI with a Tool to allow the user to re-expand the Panel.
\n
\n\nheader:The Panel collapses to leave its header visible as when not inside a border\nlayout.
\n
True to render the window collapsed, false to render it expanded. Note that if expandOnShow\nis true (the default) it will override the collapsed config and the window will always be\nexpanded when shown.
Defaults to: false
A CSS class to add to the panel's element after it has been collapsed.
\nDefaults to: "collapsed"
True to make the panel collapsible and have an expand/collapse toggle Tool added into the header tool button\narea. False to keep the panel sized either statically, or by an owning layout manager, with no toggle Tool.
\n\nSee collapseMode and collapseDirection
\nDefaults to: false
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.
\nTrue to constrain the window within its containing element, false to allow it to fall outside of its containing\nelement. By default the window will be rendered to document.body. To render and constrain the window within\nanother element specify renderTo. Optionally the header only can be constrained\nusing constrainHeader.
\nDefaults to: false
True to constrain the window header within its containing element (allowing the window body to fall outside of\nits containing element) or false to allow the header to fall outside its containing element.\nOptionally the entire window can be constrained using constrain.
\nDefaults to: false
Specify 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.
This object holds the default weights applied to dockedItems that have no weight. These start with a\nweight of 1, to allow negative weights to insert before top items and are odd numbers\nso that even weights can be used to get between different dock orders.
\n\nTo make default docking order match border layout, do this:
\n\nExt.panel.AbstractPanel.prototype.defaultDockWeights = { top: 1, bottom: 3, left: 5, right: 7 };Changing these defaults as above or individually on this object will effect all Panels.\nTo change the defaults on a single panel, you should replace the entire object:
\n\ninitComponent: function () {\n // NOTE: Don't change members of defaultDockWeights since the object is shared.\n this.defaultDockWeights = { top: 1, bottom: 3, left: 5, right: 7 };\n\n this.callParent();\n}To change only one of the default values, you do this:
\n\ninitComponent: function () {\n // NOTE: Don't change members of defaultDockWeights since the object is shared.\n this.defaultDockWeights = Ext.applyIf({ top: 10 }, this.defaultDockWeights);\n\n this.callParent();\n}Defaults to: {top: 1, left: 3, right: 5, bottom: 7}
Specifies a Component to receive focus when this Window is focused.
\n\nThis may be one of:
\n\n- \n
- The index of a footer Button. \n
- The id or Ext.AbstractComponent.itemId of a descendant Component. \n
- A Component. \n
The default xtype of child Components to create in this Container when\na child item is specified as a raw configuration object, rather than as an instantiated Component.
\n\n\nDefaults to 'panel'.
Defaults to: "panel"
This option is a means of applying default settings to all added items whether added through the items\nconfig or via the add or insert methods.
\n\nDefaults are applied to both config objects and instantiated components conditionally so as not to override\nexisting properties in the item (see Ext.applyIf).
\n\nIf the defaults option is specified as a function, then the function will be called using this Container as the\nscope (this reference) and passing the added item as the first parameter. Any resulting object\nfrom that call is then applied to the item as default properties.
For example, to automatically apply padding to the body of each of a set of\ncontained Ext.panel.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.
Usage:
\n\ndefaults: { // defaults are applied to items, not the container\n autoScroll: true\n},\nitems: [\n // default will not be applied here, panel1 will be autoScroll: false\n {\n xtype: 'panel',\n id: 'panel1',\n autoScroll: false\n },\n // this component will have autoScroll: true\n new Ext.panel.Panel({\n id: 'panel2'\n })\n]\nCSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.
\nDefaults to: "x-item-disabled"
A component or series of components to be added as docked items to this panel. The docked items can be docked to\neither the top, right, left or bottom of a panel. This is typically used for things like toolbars or tab bars:
\n\nvar panel = new Ext.panel.Panel({\n dockedItems: [{\n xtype: 'toolbar',\n dock: 'top',\n items: [{\n text: 'Docked to the top'\n }]\n }]\n});\nTrue to allow the window to be dragged by the header bar, false to disable dragging. Note that\nby default the window will be centered in the viewport, so if dragging is disabled the window may need to be\npositioned programmatically after render (e.g., myWindow.setPosition(100, 100);).
\nDefaults to: true
True to always expand the window when it is displayed, false to keep it in its current state (which may be\ncollapsed) when displayed.
\nDefaults to: true
Convenience config used for adding items to the bottom of the panel. Short for Footer Bar.
\n\nfbar: [\n { type: 'button', text: 'Button 1' }\n]\nis equivalent to
\n\ndockedItems: [{\n xtype: 'toolbar',\n dock: 'bottom',\n ui: 'footer',\n defaults: {minWidth: minButtonWidth},\n items: [\n { xtype: 'component', flex: 1 },\n { xtype: 'button', text: 'Button 1' }\n ]\n}]\nThe minButtonWidth is used as the default minWidth for\neach of the buttons in the fbar.
\nImportant: This config is only effective for collapsible Panels which are direct child items of a\nborder layout.
\n\ntrue to allow clicking a collapsed Panel's placeholder to display the Panel floated above the layout,\nfalse to force the user to fully expand a collapsed region by clicking the expand button to see it again.
\nDefaults to: true
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
True to apply a frame to the panel panels header (if 'frame' is true).
\nDefaults to: true
Specify as 'top', 'bottom', 'left' or 'right'.
Defaults to: "top"
true to hide the expand/collapse toggle button when collapsible == true, false to display it.
Defaults to: false
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: ""
CSS class for icon in header. Used for displaying an icon to the left of a title.
\nThe 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 single item, or an array of child Components to be added to this container
\n\n\nUnless configured with a layout, a Container simply renders child Components serially into\nits encapsulating element and performs no sizing or positioning upon them.
\n
Example:
\n// specifying a single item\nitems: {...},\nlayout: 'fit', // The single items is sized to fit\n\n// specifying multiple items\nitems: [{...}, {...}],\nlayout: 'hbox', // The items are arranged horizontally\n Each item may be:
\n- \n
- A Component \n
- A Component configuration object \n
If a configuration object is specified, the actual type of Component to be\ninstantiated my be indicated by using the xtype option.
\nEvery Component class has its own xtype.
\nIf an xtype is not explicitly\nspecified, the defaultType for the Container is used, which by default is usually panel.
Notes:
\nExt uses lazy rendering. Child Components will only be rendered\nshould it become necessary. Items are automatically laid out when they are first\nshown (no sizing is done while hidden), or in response to a doLayout call.
\n\n\nImportant: In order for child items to be correctly sized and\npositioned, typically a layout manager must be specified through\nthe layout configuration option.
The sizing and positioning of child items is the responsibility of\nthe Container's layout manager which creates and manages the type of layout\nyou have in mind. For example:
\n\n\nIf the layout configuration is not explicitly specified for\na general purpose container (e.g. Container or Panel) the\ndefault layout manager will be used\nwhich does nothing but render child components sequentially into the\nContainer (no sizing or positioning will be performed in this situation).
\n\n\nlayout may be specified as either as an Object or as a String:
- \n
- Specify as an Object \n
- Example usage: \n
type\n- Layout specific configuration properties \n
- Specify as a String \n
- Example usage: \n
layout\n
- \n
layout: {\n type: 'vbox',\n align: 'left'\n}\n The layout type to be used for this container. If not specified,\na default Ext.layout.container.Auto will be created and used.
\nValid layout type values are:
Additional layout specific configuration properties may also be\nspecified. For complete details regarding the valid config options for\neach layout type, see the layout class corresponding to the type\nspecified.
- \n
layout: 'vbox'\n The layout type to be used for this container (see list\nof valid layout type values above).
Additional layout specific configuration properties. For complete\ndetails regarding the valid config options for each layout type, see the\nlayout class corresponding to the layout specified.
Convenience config. Short for 'Left Bar' (left-docked, vertical toolbar).
\n\nlbar: [\n { xtype: 'button', text: 'Button 1' }\n]\nis equivalent to
\n\ndockedItems: [{\n xtype: 'toolbar',\n dock: 'left',\n items: [\n { xtype: 'button', text: 'Button 1' }\n ]\n}]\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.
\nTrue to display the 'maximize' tool button and allow the user to maximize the window, false to hide the button\nand disallow maximizing the window. Note that when a window is maximized, the tool button\nwill automatically change to a 'restore' button with the appropriate behavior already built-in that will restore\nthe window to its previous size.
\nDefaults to: false
True to initially display the window in a maximized state.
\nDefaults to: false
Minimum width of all footer toolbar buttons in pixels. If set, this will be used as the default\nvalue for the Ext.button.Button.minWidth config of each Button added to the footer toolbar via the\nfbar or buttons configurations. It will be ignored for buttons that have a minWidth configured\nsome other way, e.g. in their own config object or via the defaults of\ntheir parent container.
\nDefaults to: 75
The 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.
\nTrue to display the 'minimize' tool button and allow the user to minimize the window, false to hide the button\nand disallow minimizing the window. Note that this button provides no implementation -- the\nbehavior of minimizing a window is implementation-specific, so the minimize event must be handled and a custom\nminimize behavior implemented for this option to be useful.
\nDefaults to: false
True to make the window modal and mask everything behind it when displayed, false to display it without\nrestricting access to other UI elements.
\nDefaults to: false
Allows override of the built-in processing for the escape key. Default action is to close the Window (performing\nwhatever action is specified in closeAction. To prevent the Window closing when the escape key is\npressed, specify this as Ext.emptyFn.
\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: ""
True to overlap the header in a panel over the framing of the panel itself. This is needed when frame:true (and\nis done automatically for you). Otherwise it is undefined. If you manually add rounded corners to a panel header\nwhich does not have frame:true, this will need to be set to true.
\nSpecifies 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'.
\nImportant: This config is only effective for collapsible Panels which are direct child items of a\nborder layout when not using the 'header' collapseMode.
Optional. A Component (or config object for a Component) to show in place of this Panel when this Panel is\ncollapsed by a border layout. Defaults to a generated Header containing a Tool to re-expand the Panel.
\nTrue to render the window body with a transparent background so that it will blend into the framing elements,\nfalse to add a lighter background color to visually highlight the body element and separate it more distinctly\nfrom the surrounding frame.
\nDefaults to: false
An 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.
\nPrevent a Header from being created and shown.
\nDefaults to: false
Convenience config. Short for 'Right Bar' (right-docked, vertical toolbar).
\n\nrbar: [\n { xtype: 'button', text: 'Button 1' }\n]\nis equivalent to
\n\ndockedItems: [{\n xtype: 'toolbar',\n dock: 'right',\n items: [\n { xtype: 'button', text: 'Button 1' }\n ]\n}]\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 allow user resizing at each edge and corner of the window, false to disable resizing.
This may also be specified as a config object to Ext.resizer.Resizer
\nDefaults to: true
A valid Ext.resizer.Resizer handles config string. Only applies when resizable = true.
\nDefaults to: "all"
A buffer to be applied if many state events are fired within a short period.
\nDefaults to: 100
Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow, or a string indicating the shadow's display Ext.Shadow.mode. Set to false to disable the\nshadow.
\nDefaults to: "sides"
An array of events that, when fired, should trigger this object to\nsave its state. Defaults to none. stateEvents may be any type\nof event supported by this object, including browser or custom events\n(e.g., ['click', 'customerchange']).
See stateful for an explanation of saving and\nrestoring object state.
The unique id for this object to use for state management purposes.
\n\nSee stateful for an explanation of saving and restoring state.
\n\nA flag which causes the object to attempt to restore the state of\ninternal properties from a saved state on startup. The object must have\na stateId for state to be managed.\nAuto-generated ids are not guaranteed to be stable across page loads and\ncannot be relied upon to save and restore the same state for a object.
\n
For state saving to work, the state manager's provider must have been\nset to an implementation of Ext.state.Provider which overrides the\nset and get\nmethods to save and recall name/value pairs. A built-in implementation,\nExt.state.CookieProvider is available.
\nTo set the state provider for the current page:
\nExt.state.Manager.setProvider(new Ext.state.CookieProvider({\n expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now\n}));\nA stateful object attempts to save state when one of the events\nlisted in the stateEvents configuration fires.
To save state, a stateful object first serializes its state by\ncalling getState. By default, this function does\nnothing. The developer must provide an implementation which returns an\nobject hash which represents the restorable state of the object.
The value yielded by getState is passed to Ext.state.Manager.set\nwhich uses the configured Ext.state.Provider to save the object\nkeyed by the stateId.
During construction, a stateful object attempts to restore\nits state by calling Ext.state.Manager.get passing the\nstateId
The resulting object is passed to applyState.\nThe default implementation of applyState simply copies\nproperties into the object, but a developer may override this to support\nmore behaviour.
You can perform extra processing on state save and restore by attaching\nhandlers to the beforestaterestore, staterestore,\nbeforestatesave and statesave events.
\n\nDefaults to: true
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
If true, suspend calls to doLayout. Useful when batching multiple adds to a container and not passing them\nas multiple arguments or an array.
\nDefaults to: false
Convenience config. Short for 'Top Bar'.
\n\ntbar: [\n { xtype: 'button', text: 'Button 1' }\n]\nis equivalent to
\n\ndockedItems: [{\n xtype: 'toolbar',\n dock: 'top',\n items: [\n { xtype: 'button', text: 'Button 1' }\n ]\n}]\nThe title text to be used to display in the panel header. When a\ntitle is specified the Ext.panel.Header will automatically be created and displayed unless\npreventHeader is set to true.
Defaults to: ""
true to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in\nthe header bar, false) to allow it only by clicking to tool butto).
Defaults to: false
An array of Ext.panel.Tool configs/instances to be added to the header tool area. The tools are stored as\nchild components of the header container. They can be accessed using down and {#query}, as well as the\nother component methods. The toggle tool is automatically created if collapsible is set to true.
\n\nNote that, apart from the toggle tool which is provided when a panel is collapsible, these tools only provide the\nvisual button. Any required functionality must be provided by adding handlers that implement the necessary\nbehavior.
\n\nExample usage:
\n\ntools:[{\n type:'refresh',\n tooltip: 'Refresh form Data',\n // hidden:true,\n handler: function(event, toolEl, panel){\n // refresh logic\n }\n},\n{\n type:'help',\n tooltip: 'Get Help',\n handler: function(event, toolEl, panel){\n // show help here\n }\n}]\nAn Ext.Template, Ext.XTemplate or an array of strings to form an Ext.XTemplate. Used in\nconjunction with the data and tplWriteMode configurations.
The Ext.(X)Template method to use when updating the content area of the Component.\nSee Ext.XTemplate.overwrite for information on default mode.
Defaults to: "overwrite"
A set style for a component. Can be a string or an Array of multiple strings (UIs)
\nDefaults to: "default"
The X position of the left edge of the window on initial showing. Defaults to centering the Window within the\nwidth of the Window's container Element (The Element that the Window is rendered to).
\nThe 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
Button config that displays a single Cancel button
\nButton config that displays a single Cancel button
\nThe CSS class that provides the ERROR icon image
\nThe CSS class that provides the ERROR icon image
\nButton config that displays OK and Cancel buttons
\nButton config that displays OK and Cancel buttons
\nThe CSS class that provides the QUESTION icon image
\nThe CSS class that provides the QUESTION icon image
\nThe CSS class that provides the WARNING icon image
\nThe CSS class that provides the WARNING icon image
\nButton config that displays Yes, No and Cancel buttons
\nButton config that displays Yes, No and Cancel buttons
\nIf this Window is configured draggable, this property will contain an instance of\nExt.util.ComponentDragger (A subclass of DragTracker) which handles dragging\nthe Window's DOM Element, and constraining according to the constrain and constrainHeader .
\n\nThis has implementations of onBeforeStart, onDrag and onEnd which perform the dragging action. If\nextra logic is needed at these points, use createInterceptor or\ncreateSequence to augment the existing implementations.
The default height in pixels of the message box's multiline textarea if displayed.
\nThe default height in pixels of the message box's multiline textarea if displayed.
\nRead-only property indicating whether or not the component can be dragged
\nRead-only property indicating whether or not the component can be dragged
\nOnly present for floating Components which were inserted as descendant items of floating Containers.
\n\nFloating Components that are programatically rendered will not have a floatParent\nproperty.
For floating Components which are child items of a Container, the floatParent will be the floating\nancestor Container which is responsible for the base z-index value of all its floating descendants. It provides\na ZIndexManager which provides z-indexing services for all its descendant floating\nComponents.
\n\nFor example, the dropdown BoundList of a ComboBox which is in a Window will have the\nWindow as its floatParent
See floating and zIndexManager
\nRead-only property indicating the width of any framing elements which were added within the encapsulating element\nto provide graphical, rounded borders. See the frame config.
\n\nThis is an object containing the frame width in pixels for all four sides of the Component containing the\nfollowing properties:
\nThe MixedCollection containing all the child items of this container.
\nThe MixedCollection containing all the child items of this container.
\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.
\nThe minimum width in pixels of the message box if it is a progress-style dialog. This is useful\nfor setting a different minimum width than text-only dialogs may need.
\nThe minimum width in pixels of the message box if it is a prompt dialog. This is useful\nfor setting a different minimum width than text-only dialogs may need.
\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
Adds Component(s) to this Container. ...Adds Component(s) to this Container.
\n\nDescription:
\n\n\n- Fires the beforeadd event before adding.
\n- The Container's default config values will be applied\naccordingly (see
defaults for details). \n- Fires the
add event after the component has been added. \n
\n\n\nNotes:
\n\nIf the Container is already rendered when add\nis called, it will render the newly added Component into its content area.
\n\nIf the Container was configured with a size-managing layout manager, the Container\nwill recalculate its internal layout at this time too.
\n\nNote that the default layout manager simply renders child Components sequentially into the content area and thereafter performs no sizing.
\n\nIf adding multiple new child Components, pass them as an array to the add method, so that only one layout recalculation is performed.
\n\ntb = new Ext.toolbar.Toolbar({\n renderTo: document.body\n}); // toolbar is rendered\ntb.add([{text:'Button 1'}, {text:'Button 2'}]); // add multiple items. (defaultType for Toolbar is 'button')\n
\n\nWarning:
\n\nComponents directly managed by the BorderLayout layout manager\nmay not be removed or added. See the Notes for BorderLayout\nfor more details.
\nParameters
- component : Ext.Component[]/Ext.Component...
Either one or more Components to add or an Array of Components to add.\nSee items for additional information.
\n
Returns
- Ext.Component[]/Ext.Component
The Components that were added.
\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
Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt). ...Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).
\nParameters
- title : String
The title bar text
\n - msg : String
The message box body text
\n - fn : Function (optional)
The callback function invoked after the message box is closed
\n - scope : Object (optional)
The scope (this reference) in which the callback is executed. Defaults to the browser wnidow.
\n
Returns
- Ext.window.MessageBox
this
\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
beforeLayout( )Occurs before componentLayout is run. ...Occurs before componentLayout is run. Returning false from this method will prevent the containerLayout\nfrom being executed.
\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
Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified...Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified function with\neach component. The scope (this reference) of the\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 cascade is stopped on that branch.
\nParameters
- fn : Function
The function to call
\n - scope : Object (optional)
The scope of the function (defaults to current component)
\n - args : Array (optional)
The args to call the function with. The current component always passed as the last argument.
\n
Returns
- Ext.Container
this
\n
Retrieves the first direct child of this container which matches the passed selector. ...Retrieves the first direct child of this container which matches the passed selector.\nThe passed in selector must comply with an Ext.ComponentQuery selector.
\nParameters
- selector : String (optional)
An Ext.ComponentQuery selector. If no selector is\nspecified, the first child will be returned.
\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
close( )Closes the Panel. ...Closes the Panel. By default, this method, removes it from the DOM, destroys the\nPanel object and all its descendant Components. The beforeclose event is fired before the\nclose happens and will cancel the close action if it returns false.
\n\nNote: This method is also affected by the closeAction setting. For more explicit control use\ndestroy and hide methods.
\n Collapses the panel body so that the body becomes hidden. ...Collapses the panel body so that the body becomes hidden. Docked Components parallel to the border towards which\nthe collapse takes place will remain visible. Fires the beforecollapse event which will cancel the\ncollapse action if it returns false.
\nParameters
- direction : String
. The direction to collapse towards. Must be one of
\n\n\n- Ext.Component.DIRECTION_TOP
\n- Ext.Component.DIRECTION_RIGHT
\n- Ext.Component.DIRECTION_BOTTOM
\n- Ext.Component.DIRECTION_LEFT
\n
\n\n - animate : Boolean (optional)
True to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n
Returns
- Ext.panel.Panel
this
\n
Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm). ...Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).\nIf a callback function is passed it will be called after the user clicks either button,\nand the id of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).
\nParameters
- title : String
The title bar text
\n - msg : String
The message box body text
\n - fn : Function (optional)
The callback function invoked after the message box is closed
\n - scope : Object (optional)
The scope (this reference) in which the callback is executed. Defaults to the browser wnidow.
\n
Returns
- Ext.window.MessageBox
this
\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
Manually force this container's layout to be recalculated. ...Manually force this container's layout to be recalculated. The framework uses this internally to refresh layouts\nform most cases.
\nReturns
- Ext.container.Container
this
\n
Retrieves the first descendant of this container which matches the passed selector. ...Retrieves the first descendant of this container which matches the passed selector.\nThe passed in selector must comply with an Ext.ComponentQuery selector.
\nParameters
- selector : String (optional)
An Ext.ComponentQuery selector. If no selector is\nspecified, the first child will be returned.
\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
Expands the panel body so that it becomes visible. ...Expands the panel body so that it becomes visible. Fires the beforeexpand event which will cancel the\nexpand action if it returns false.
\nParameters
- animate : Boolean (optional)
True to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n
Returns
- Ext.panel.Panel
this
\n
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
Return the immediate child Component in which the passed element is located. ...Return the immediate child Component in which the passed element is located.
\nParameters
- el : Ext.Element/HTMLElement/String
The element to test (or ID of element).
\n
Returns
- Ext.Component
The child item which contains the passed element.
\n
Attempts a default component lookup (see Ext.container.Container.getComponent). ...Attempts a default component lookup (see Ext.container.Container.getComponent). If the component is not found in the normal\nitems, the dockedItems are searched and the matched component (if any) returned (see getDockedComponent). Note that docked\nitems will only be matched by component id or itemId -- if you pass a numeric index only non-docked child components will be searched.
\nParameters
Returns
- Ext.Component
The component (if found)
\n
Finds a docked component by id, itemId or position. ...Finds a docked component by id, itemId or position. Also see getDockedItems
\nParameters
- comp : String/Number
The id, itemId or position of the docked component (see getComponent for details)
\n
Returns
- Ext.Component
The docked component (if found)
\n
Retrieve an array of all currently docked Components. ...Retrieve an array of all currently docked Components.
\nParameters
- cqSelector : String
A ComponentQuery selector string to filter the returned items.
\n
Returns
- Ext.Component[]
An array of components.
\n
getFocusEl( )Gets the configured default focus item. ...Gets the configured default focus item. If a defaultFocus is set, it will receive focus, otherwise the\nContainer itself will receive focus.
\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
Returns the layout instance currently associated with this Container. ...Returns the layout instance currently associated with this Container.\nIf a layout has not been instantiated yet, that is done first
\nReturns
- Ext.layout.container.AbstractContainer
The layout
\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
Inserts a Component into this Container at a specified index. ...Inserts a Component into this Container at a specified index. Fires the\nbeforeadd event before inserting, then fires the add event after the\nComponent has been inserted.
\nParameters
- index : Number
The index at which the Component will be inserted\ninto the Container's items collection
\n - component : Ext.Component
The child Component to insert.
\nExt uses lazy rendering, and will only render the inserted Component should\nit become necessary.
\nA Component config object may be passed in order to avoid the overhead of\nconstructing a real Component object if lazy rendering might mean that the\ninserted Component will not be rendered immediately. To take advantage of\nthis 'lazy instantiation', set the Ext.Component.xtype config\nproperty to the registered type of the Component wanted.
\nFor a list of all available xtypes, see Ext.Component.
\n
Returns
- Ext.Component
component The Component (or config object) that was\ninserted with the Container's default config values applied.
\n
insertDocked( Number pos, Object/Object[] component )Inserts docked item(s) to the panel at the indicated position. ...Inserts docked item(s) to the panel at the indicated position.
\nParameters
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
Fits the window within its current container and automatically replaces the 'maximize' tool\nbutton with the 'restore'...Fits the window within its current container and automatically replaces the 'maximize' tool\nbutton with the 'restore' tool button. Also see toggleMaximize.
\nReturns
- Ext.window.Window
this
\n
Placeholder method for minimizing the window. ...Placeholder method for minimizing the window. By default, this method simply fires the minimize event\nsince the behavior of minimizing a window is application-specific. To implement custom minimize behavior, either\nthe minimize event can be handled or this method can be overridden.
\nReturns
- Ext.window.Window
this
\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
Moves a Component within the Container ...Moves a Component within the Container
\nParameters
- fromIdx : Number
The index the Component you wish to move is currently at.
\n - toIdx : Number
The new index for the Component.
\n
Returns
- Ext.Component
component The Component (or config object) that was moved.
\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
Displays a message box with a progress bar. ...Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via updateProgress\nand closing the message box when the process is complete.
\nParameters
- title : String
The title bar text
\n - msg : String
The message box body text
\n - progressText : String (optional)
The text to display inside the progress bar
\nDefaults to: ""
Returns
- Ext.window.MessageBox
this
\n
prompt( String title, String msg, [Function fn], [Object scope], [Boolean/Number multiline], [String value] ) : Ext.window.MessageBoxDisplays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's p...Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).\nThe prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user\nclicks either button, and the id of the button that was clicked (could also be the top-right\nclose button) and the text that was entered will be passed as the two parameters to the callback.
\nParameters
- title : String
The title bar text
\n - msg : String
The message box body text
\n - fn : Function (optional)
The callback function invoked after the message box is closed
\n - scope : Object (optional)
The scope (this reference) in which the callback is executed. Defaults to the browser wnidow.
\n - multiline : Boolean/Number (optional)
True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox/
\nDefaults to: false
- value : String (optional)
Default value of the text input element
\nDefaults to: ""
Returns
- Ext.window.MessageBox
this
\n
Retrieves all descendant components which match the passed selector. ...Retrieves all descendant components which match the passed selector.\nExecutes an Ext.ComponentQuery.query using this container as its root.
\nParameters
- selector : String (optional)
Selector complying to an Ext.ComponentQuery selector.\nIf no selector is specified all items will be returned.
\n
Returns
- Ext.Component[]
Components which matched the selector
\n
relayEvents( Object origin, String[] events, String prefix )Relays selected events from the specified Observable as if the events were fired by this. ... Removes a component from this container. ...Removes a component from this container. Fires the beforeremove event before removing, then fires\nthe remove event after the component has been removed.
\nParameters
- component : Ext.Component/String
The component reference or id to remove.
\n - autoDestroy : Boolean (optional)
True to automatically invoke the removed Component's Ext.Component.destroy function.\nDefaults to the value of this Container's autoDestroy config.
\n
Returns
- Ext.Component
component The Component that was removed.
\n
Removes all components from this container. ...Removes all components from this container.
\nParameters
- autoDestroy : Boolean (optional)
True to automatically invoke the removed Component's Ext.Component.destroy function.\nDefaults to the value of this Container's autoDestroy config.
\n
Returns
- Ext.Component[]
Array of the destroyed components
\n
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
removeDocked( Ext.Component item, [Boolean autoDestroy] )Removes the docked item from the panel. ...Removes the docked item from the panel.
\nParameters
- item : Ext.Component
. The Component to remove.
\n - autoDestroy : Boolean (optional)
Destroy the component after removal.
\n
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
restore( ) : Ext.window.WindowRestores a maximized window back to its original size and position prior to being maximized\nand also replaces the 're...Restores a maximized window back to its original size and position prior to being maximized\nand also replaces the 'restore' tool button with the 'maximize' tool button. Also see toggleMaximize.
\nReturns
- Ext.window.Window
this
\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
Adds the specified icon to the dialog. ...Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default\nstyling, and the class passed in is expected to supply the background image url. Pass in empty string ('')\nto clear any existing icon. This method must be called before the MessageBox is shown.\nThe following built-in icon classes are supported, but you can also pass in a custom class name:
\n\nExt.window.MessageBox.INFO\nExt.window.MessageBox.WARNING\nExt.window.MessageBox.QUESTION\nExt.window.MessageBox.ERROR\n
\n\nParameters
- icon : String
A CSS classname specifying the icon's background image url, or empty string to clear the icon
\n
Returns
- Ext.window.MessageBox
this
\n
setIconCls( String newIconCls )Set the iconCls for the panel's header. ...Set the iconCls for the panel's header. See Ext.panel.Header.iconCls. It will fire the\niconchange event after completion.
\nParameters
- newIconCls : String
The new CSS class name
\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 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
Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. ...Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,\nalthough those calls are basic shortcuts and do not support all of the config options allowed here.
\nParameters
- config : Object
The following config options are supported:
\n- animateTarget : String/ElementAn id or Element from which the message box should animate as it\nopens and closes (defaults to undefined)
\n- buttons : NumberA bitwise button specifier consisting of the sum of any of the following constants:
\n- Ext.window.MessageBox.OK
\n- Ext.window.MessageBox.YES
\n- Ext.window.MessageBox.NO
\n- Ext.window.MessageBox.CANCEL
\n
Or false to not show any buttons (defaults to false) \n- closable : BooleanFalse to hide the top-right close button (defaults to true). Note that\nprogress and wait dialogs will ignore this property and always hide the close button as they can only\nbe closed programmatically.
\n- cls : StringA custom CSS class to apply to the message box's container element
\n- defaultTextHeight : NumberThe default height in pixels of the message box's multiline textarea\nif displayed (defaults to 75)
\n- fn : FunctionA callback function which is called when the dialog is dismissed either\nby clicking on the configured buttons, or on the dialog close button, or by pressing\nthe return button to enter input.\n\n
Progress and wait dialogs will ignore this option since they do not respond to user\nactions and can only be closed programmatically, so any required function should be called\nby the same code after it closes the dialog. Parameters passed:
\n- buttonId : StringThe ID of the button pressed, one of:
\n- ok
\n- yes
\n- no
\n- cancel
\n
\n- text : String
\n- opt : ObjectThe config object passed to show.
\n
\n\n\n \n- scope : ObjectThe scope (
this reference) in which the function will be executed. \n- icon : StringA CSS class that provides a background image to be used as the body icon for the\ndialog (e.g. Ext.window.MessageBox.WARNING or 'custom-class') (defaults to '')
\n- iconCls : StringThe standard Ext.window.Window.iconCls to\nadd an optional header icon (defaults to '')
\n- maxWidth : NumberThe maximum width in pixels of the message box (defaults to 600)
\n- minWidth : NumberThe minimum width in pixels of the message box (defaults to 100)
\n- modal : BooleanFalse to allow user interaction with the page while the message box is\ndisplayed (defaults to true)
\n- msg : StringA string that will replace the existing message box body text (defaults to the\nXHTML-compliant non-breaking space character ' ')
\n- multiline : Boolean\nTrue to prompt the user to enter multi-line text (defaults to false)
\n- progress : BooleanTrue to display a progress bar (defaults to false)
\n- progressText : StringThe text to display inside the progress bar if progress = true (defaults to '')
\n- prompt : BooleanTrue to prompt the user to enter single-line text (defaults to false)
\n- proxyDrag : BooleanTrue to display a lightweight proxy while dragging (defaults to false)
\n- title : StringThe title text
\n- value : StringThe string value to set into the active textbox element if displayed
\n- wait : BooleanTrue to display a progress bar (defaults to false)
\n- waitConfig : ObjectA Ext.ProgressBar.wait config object (applies only if wait = true)
\n- width : NumberThe width of the dialog in pixels
\n
\nExample usage:\n\nExt.Msg.show({\ntitle: 'Address',\nmsg: 'Please enter your address:',\nwidth: 300,\nbuttons: Ext.Msg.OKCANCEL,\nmultiline: true,\nfn: saveAddress,\nanimateTarget: 'addAddressBtn',\nicon: Ext.window.MessageBox.INFO\n});\n
\n\n
Returns
- Ext.window.MessageBox
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
Shortcut for performing an expand or collapse based on the current state of the panel. ...Shortcut for performing an expand or collapse based on the current state of the panel.
\nReturns
- Ext.panel.Panel
this
\n
A shortcut method for toggling between maximize and restore based on the current maximized\nstate of the window. ...A shortcut method for toggling between maximize and restore based on the current maximized\nstate of the window.
\nReturns
- Ext.window.Window
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
Updates a progress-style message box's text and progress bar. ...Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via progress or wait,\nor by calling show with progress: true.
\nParameters
- value : Number (optional)
Any number between 0 and 1 (e.g., .5)
\nDefaults to: 0
- progressText : String (optional)
The progress text to display inside the progress bar.
\nDefaults to: ""
- msg : String (optional)
The message box's body text is replaced with the specified string (defaults to undefined\nso that any existing body text will not get overwritten by default unless a new value is passed in)
\n
Returns
- Ext.window.MessageBox
this
\n
Displays a message box with an infinitely auto-updating progress bar. ...Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.
\nParameters
- msg : String
The message box body text
\n - title : String (optional)
The title bar text
\n - config : Object (optional)
A Ext.ProgressBar.wait config object
\n
Returns
- Ext.window.MessageBox
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.window.Window this, Object eOpts )Fires after the window has been visually activated via setActive. ...Fires after the window has been visually activated via setActive.
\nParameters
- this : Ext.window.Window\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
add( Ext.container.Container this, Ext.Component component, Number index, Object eOpts )@bubbles\nFires after any Ext.Component is added or inserted into the container. ...@bubbles\nFires after any Ext.Component is added or inserted into the container.
\nParameters
- this : Ext.container.Container\n
- component : Ext.Component
The component that was added
\n - index : Number
The index at which the component was added to the container's items collection
\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
afterlayout( Ext.container.Container this, Ext.layout.container.Container layout, Object eOpts )Fires when the components in this container are arranged by the associated layout manager. ...Fires when the components in this container are arranged by the associated layout manager.
\nParameters
- this : Ext.container.Container\n
- layout : Ext.layout.container.Container
The ContainerLayout implementation for this container
\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
beforeadd( Ext.container.Container this, Ext.Component component, Number index, Object eOpts )Fires before any Ext.Component is added or inserted into the container. ...Fires before any Ext.Component is added or inserted into the container.\nA handler can return false to cancel the add.
\nParameters
- this : Ext.container.Container\n
- component : Ext.Component
The component being added
\n - index : Number
The index at which the component will be added to the container's items collection
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
beforeclose( Ext.panel.Panel panel, Object eOpts )Fires before the user closes the panel. ...Fires before the user closes the panel. Return false from any listener to stop the close event being\nfired
\nParameters
- panel : Ext.panel.Panel
The Panel object
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
beforecollapse( Ext.panel.Panel p, String direction, Boolean animate, Object eOpts )Fires before this panel is collapsed. ...Fires before this panel is collapsed. Return false to prevent the collapse.
\nParameters
- p : Ext.panel.Panel
The Panel being collapsed.
\n - direction : String
. The direction of the collapse. One of
\n\n\n- Ext.Component.DIRECTION_TOP
\n- Ext.Component.DIRECTION_RIGHT
\n- Ext.Component.DIRECTION_BOTTOM
\n- Ext.Component.DIRECTION_LEFT
\n
\n\n - animate : Boolean
True if the collapse is animated, else false.
\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
beforeexpand( Ext.panel.Panel p, Boolean animate, Object eOpts )Fires before this panel is expanded. ...Fires before this panel is expanded. Return false to prevent the expand.
\nParameters
- p : Ext.panel.Panel
The Panel being expanded.
\n - animate : Boolean
True if the expand is animated, else false.
\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
beforeremove( Ext.container.Container this, Ext.Component component, Object eOpts )Fires before any Ext.Component is removed from the container. ...Fires before any Ext.Component is removed from the container. A handler can return\nfalse to cancel the remove.
\nParameters
- this : Ext.container.Container\n
- component : Ext.Component
The component being removed
\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
bodyresize( Ext.panel.Panel p, Number width, Number height, Object eOpts )Fires after the Panel has been resized. ...Fires after the Panel has been resized.
\nParameters
- p : Ext.panel.Panel
the Panel which has been resized.
\n - width : Number
The Panel body's new width.
\n - height : Number
The Panel body's new height.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
collapse( Ext.panel.Panel p, Object eOpts )Fires after this Panel hass collapsed. ...Fires after this Panel hass collapsed.
\nParameters
- p : Ext.panel.Panel
The Panel that has been collapsed.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
deactivate( Ext.window.Window this, Object eOpts )Fires after the window has been visually deactivated via setActive. ...Fires after the window has been visually deactivated via setActive.
\nParameters
- this : Ext.window.Window\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
expand( Ext.panel.Panel p, Object eOpts )Fires after this Panel has expanded. ...Fires after this Panel has expanded.
\nParameters
- p : Ext.panel.Panel
The Panel that has been expanded.
\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
iconchange( Ext.panel.Panel p, String newIconCls, String oldIconCls, Object eOpts )Fires after the Panel iconCls has been set or changed. ...Fires after the Panel iconCls has been set or changed.
\nParameters
- p : Ext.panel.Panel
the Panel which has been resized.
\n - newIconCls : String
The new iconCls.
\n - oldIconCls : String
The previous panel iconCls.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
maximize( Ext.window.Window this, Object eOpts )Fires after the window has been maximized. ...Fires after the window has been maximized.
\nParameters
- this : Ext.window.Window\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
minimize( Ext.window.Window this, Object eOpts )Fires after the window has been minimized. ...Fires after the window has been minimized.
\nParameters
- this : Ext.window.Window\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
remove( Ext.container.Container this, Ext.Component component, Object eOpts )@bubbles\nFires after any Ext.Component is removed from the container. ...@bubbles\nFires after any Ext.Component is removed from the container.
\nParameters
- this : Ext.container.Container\n
- component : Ext.Component
The component that was removed
\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.window.Window this, Number width, Number height, Object eOpts )Fires after the window has been resized. ...Fires after the window has been resized.
\nParameters
- this : Ext.window.Window\n
- width : Number
The window's new width
\n - height : Number
The window's new height
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
restore( Ext.window.Window this, Object eOpts )Fires after the window has been restored to its original size after being maximized. ...Fires after the window has been restored to its original size after being maximized.
\nParameters
- this : Ext.window.Window\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
titlechange( Ext.panel.Panel p, String newTitle, String oldTitle, Object eOpts )Fires after the Panel title has been set or changed. ...Fires after the Panel title has been set or changed.
\nParameters
- p : Ext.panel.Panel
the Panel which has been resized.
\n - newTitle : String
The new title.
\n - oldTitle : String
The previous panel title.
\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 Component(s) to this Container.
\n\nDescription:
\n\n- \n
- Fires the beforeadd event before adding. \n
- The Container's default config values will be applied\naccordingly (see
defaultsfor details). \n - Fires the
addevent after the component has been added. \n
Notes:
\n\nIf the Container is already rendered when add\nis called, it will render the newly added Component into its content area.
If the Container was configured with a size-managing layout manager, the Container\nwill recalculate its internal layout at this time too.
\n\nNote that the default layout manager simply renders child Components sequentially into the content area and thereafter performs no sizing.
\n\nIf adding multiple new child Components, pass them as an array to the add method, so that only one layout recalculation is performed.
tb = new Ext.toolbar.Toolbar({\n renderTo: document.body\n}); // toolbar is rendered\ntb.add([{text:'Button 1'}, {text:'Button 2'}]); // add multiple items. (defaultType for Toolbar is 'button')\nWarning:
\n\nComponents directly managed by the BorderLayout layout manager\nmay not be removed or added. See the Notes for BorderLayout\nfor more details.
\nParameters
- component : Ext.Component[]/Ext.Component...
Either one or more Components to add or an Array of Components to add.\nSee
\nitemsfor additional information.
Returns
- Ext.Component[]/Ext.Component
The Components that were added.
\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
Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).
\nParameters
- title : String
The title bar text
\n - msg : String
The message box body text
\n - fn : Function (optional)
The callback function invoked after the message box is closed
\n - scope : Object (optional)
The scope (
\nthisreference) in which the callback is executed. Defaults to the browser wnidow.
Returns
- Ext.window.MessageBox
this
\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
Occurs before componentLayout is run. Returning false from this method will prevent the containerLayout\nfrom being executed.
\nBubbles up the component/container heirarchy, calling the specified function with each component. The scope\n(this) of function call will be the scope provided or the current component. The arguments to the function will\nbe the args provided or the current component. If the function returns false at any point, the bubble is stopped.
\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
Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified function with\neach component. The scope (this reference) of the\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 cascade is stopped on that branch.
Parameters
- fn : Function
The function to call
\n - scope : Object (optional)
The scope of the function (defaults to current component)
\n - args : Array (optional)
The args to call the function with. The current component always passed as the last argument.
\n
Returns
- Ext.Container
this
\n
Retrieves the first direct child of this container which matches the passed selector.\nThe passed in selector must comply with an Ext.ComponentQuery selector.
\nParameters
- selector : String (optional)
An Ext.ComponentQuery selector. If no selector is\nspecified, the first child will be returned.
\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
Closes the Panel. By default, this method, removes it from the DOM, destroys the\nPanel object and all its descendant Components. The beforeclose event is fired before the\nclose happens and will cancel the close action if it returns false.
\n\nNote: This method is also affected by the closeAction setting. For more explicit control use\ndestroy and hide methods.
\nCollapses the panel body so that the body becomes hidden. Docked Components parallel to the border towards which\nthe collapse takes place will remain visible. Fires the beforecollapse event which will cancel the\ncollapse action if it returns false.
\nParameters
- direction : String
. The direction to collapse towards. Must be one of
\n\n- \n
- Ext.Component.DIRECTION_TOP \n
- Ext.Component.DIRECTION_RIGHT \n
- Ext.Component.DIRECTION_BOTTOM \n
- Ext.Component.DIRECTION_LEFT \n
- animate : Boolean (optional)
True to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n
Returns
- Ext.panel.Panel
this
\n
Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).\nIf a callback function is passed it will be called after the user clicks either button,\nand the id of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).
\nParameters
- title : String
The title bar text
\n - msg : String
The message box body text
\n - fn : Function (optional)
The callback function invoked after the message box is closed
\n - scope : Object (optional)
The scope (
\nthisreference) in which the callback is executed. Defaults to the browser wnidow.
Returns
- Ext.window.MessageBox
this
\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
Manually force this container's layout to be recalculated. The framework uses this internally to refresh layouts\nform most cases.
\nReturns
- Ext.container.Container
this
\n
Retrieves the first descendant of this container which matches the passed selector.\nThe passed in selector must comply with an Ext.ComponentQuery selector.
\nParameters
- selector : String (optional)
An Ext.ComponentQuery selector. If no selector is\nspecified, the first child will be returned.
\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
Expands the panel body so that it becomes visible. Fires the beforeexpand event which will cancel the\nexpand action if it returns false.
\nParameters
- animate : Boolean (optional)
True to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n
Returns
- Ext.panel.Panel
this
\n
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
Return the immediate child Component in which the passed element is located.
\nParameters
- el : Ext.Element/HTMLElement/String
The element to test (or ID of element).
\n
Returns
- Ext.Component
The child item which contains the passed element.
\n
Attempts a default component lookup (see Ext.container.Container.getComponent). If the component is not found in the normal\nitems, the dockedItems are searched and the matched component (if any) returned (see getDockedComponent). Note that docked\nitems will only be matched by component id or itemId -- if you pass a numeric index only non-docked child components will be searched.
\nParameters
Returns
- Ext.Component
The component (if found)
\n
Finds a docked component by id, itemId or position. Also see getDockedItems
\nParameters
- comp : String/Number
The id, itemId or position of the docked component (see getComponent for details)
\n
Returns
- Ext.Component
The docked component (if found)
\n
Retrieve an array of all currently docked Components.
\nParameters
- cqSelector : String
A ComponentQuery selector string to filter the returned items.
\n
Returns
- Ext.Component[]
An array of components.
\n
Gets the configured default focus item. If a defaultFocus is set, it will receive focus, otherwise the\nContainer itself will receive focus.
\nRetrieves 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
Returns the layout instance currently associated with this Container.\nIf a layout has not been instantiated yet, that is done first
\nReturns
- Ext.layout.container.AbstractContainer
The layout
\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
Inserts a Component into this Container at a specified index. Fires the\nbeforeadd event before inserting, then fires the add event after the\nComponent has been inserted.
\nParameters
- index : Number
The index at which the Component will be inserted\ninto the Container's items collection
\n - component : Ext.Component
The child Component to insert.
\n
\nExt uses lazy rendering, and will only render the inserted Component should\nit become necessary.
\nA Component config object may be passed in order to avoid the overhead of\nconstructing a real Component object if lazy rendering might mean that the\ninserted Component will not be rendered immediately. To take advantage of\nthis 'lazy instantiation', set the Ext.Component.xtype config\nproperty to the registered type of the Component wanted.
\nFor a list of all available xtypes, see Ext.Component.
Returns
- Ext.Component
component The Component (or config object) that was\ninserted with the Container's default config values applied.
\n
Inserts docked item(s) to the panel at the indicated position.
\nParameters
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
Fits the window within its current container and automatically replaces the 'maximize' tool\nbutton with the 'restore' tool button. Also see toggleMaximize.
\nReturns
- Ext.window.Window
this
\n
Placeholder method for minimizing the window. By default, this method simply fires the minimize event\nsince the behavior of minimizing a window is application-specific. To implement custom minimize behavior, either\nthe minimize event can be handled or this method can be overridden.
\nReturns
- Ext.window.Window
this
\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.
Moves a Component within the Container
\nParameters
- fromIdx : Number
The index the Component you wish to move is currently at.
\n - toIdx : Number
The new index for the Component.
\n
Returns
- Ext.Component
component The Component (or config object) that was moved.
\n
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
Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via updateProgress\nand closing the message box when the process is complete.
\nParameters
- title : String
The title bar text
\n - msg : String
The message box body text
\n - progressText : String (optional)
The text to display inside the progress bar
\nDefaults to:
""
Returns
- Ext.window.MessageBox
this
\n
Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).\nThe prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user\nclicks either button, and the id of the button that was clicked (could also be the top-right\nclose button) and the text that was entered will be passed as the two parameters to the callback.
\nParameters
- title : String
The title bar text
\n - msg : String
The message box body text
\n - fn : Function (optional)
The callback function invoked after the message box is closed
\n - scope : Object (optional)
The scope (
\nthisreference) in which the callback is executed. Defaults to the browser wnidow. - multiline : Boolean/Number (optional)
True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox/
\nDefaults to:
false - value : String (optional)
Default value of the text input element
\nDefaults to:
""
Returns
- Ext.window.MessageBox
this
\n
Retrieves all descendant components which match the passed selector.\nExecutes an Ext.ComponentQuery.query using this container as its root.
\nParameters
- selector : String (optional)
Selector complying to an Ext.ComponentQuery selector.\nIf no selector is specified all items will be returned.
\n
Returns
- Ext.Component[]
Components which matched the selector
\n
Removes a component from this container. Fires the beforeremove event before removing, then fires\nthe remove event after the component has been removed.
\nParameters
- component : Ext.Component/String
The component reference or id to remove.
\n - autoDestroy : Boolean (optional)
True to automatically invoke the removed Component's Ext.Component.destroy function.\nDefaults to the value of this Container's autoDestroy config.
\n
Returns
- Ext.Component
component The Component that was removed.
\n
Removes all components from this container.
\nParameters
- autoDestroy : Boolean (optional)
True to automatically invoke the removed Component's Ext.Component.destroy function.\nDefaults to the value of this Container's autoDestroy config.
\n
Returns
- Ext.Component[]
Array of the destroyed components
\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 the docked item from the panel.
\nParameters
- item : Ext.Component
. The Component to remove.
\n - autoDestroy : Boolean (optional)
Destroy the component after removal.
\n
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
Restores a maximized window back to its original size and position prior to being maximized\nand also replaces the 'restore' tool button with the 'maximize' tool button. Also see toggleMaximize.
\nReturns
- Ext.window.Window
this
\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
Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default\nstyling, and the class passed in is expected to supply the background image url. Pass in empty string ('')\nto clear any existing icon. This method must be called before the MessageBox is shown.\nThe following built-in icon classes are supported, but you can also pass in a custom class name:
\n\nExt.window.MessageBox.INFO\nExt.window.MessageBox.WARNING\nExt.window.MessageBox.QUESTION\nExt.window.MessageBox.ERROR\n\n\n
Parameters
- icon : String
A CSS classname specifying the icon's background image url, or empty string to clear the icon
\n
Returns
- Ext.window.MessageBox
this
\n
Set the iconCls for the panel's header. See Ext.panel.Header.iconCls. It will fire the\niconchange event after completion.
\nParameters
- newIconCls : String
The new CSS class name
\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
Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,\nalthough those calls are basic shortcuts and do not support all of the config options allowed here.
\nParameters
- config : Object
The following config options are supported:
- \n
- animateTarget : String/ElementAn id or Element from which the message box should animate as it\nopens and closes (defaults to undefined)\n
- buttons : NumberA bitwise button specifier consisting of the sum of any of the following constants:
- \n
- Ext.window.MessageBox.OK \n
- Ext.window.MessageBox.YES \n
- Ext.window.MessageBox.NO \n
- Ext.window.MessageBox.CANCEL \n
\n - closable : BooleanFalse to hide the top-right close button (defaults to true). Note that\nprogress and wait dialogs will ignore this property and always hide the close button as they can only\nbe closed programmatically.\n
- cls : StringA custom CSS class to apply to the message box's container element\n
- defaultTextHeight : NumberThe default height in pixels of the message box's multiline textarea\nif displayed (defaults to 75)\n
- fn : FunctionA callback function which is called when the dialog is dismissed either\nby clicking on the configured buttons, or on the dialog close button, or by pressing\nthe return button to enter input.\n\n
Progress and wait dialogs will ignore this option since they do not respond to user\nactions and can only be closed programmatically, so any required function should be called\nby the same code after it closes the dialog. Parameters passed:
- \n
- buttonId : StringThe ID of the button pressed, one of:
- \n
- ok \n
- yes \n
- no \n
- cancel \n
\n - text : String \n
- opt : ObjectThe config object passed to show.\n
\n - buttonId : String
- scope : ObjectThe scope (
thisreference) in which the function will be executed. \n - icon : StringA CSS class that provides a background image to be used as the body icon for the\ndialog (e.g. Ext.window.MessageBox.WARNING or 'custom-class') (defaults to '')\n
- iconCls : StringThe standard Ext.window.Window.iconCls to\nadd an optional header icon (defaults to '')\n
- maxWidth : NumberThe maximum width in pixels of the message box (defaults to 600)\n
- minWidth : NumberThe minimum width in pixels of the message box (defaults to 100)\n
- modal : BooleanFalse to allow user interaction with the page while the message box is\ndisplayed (defaults to true)\n
- msg : StringA string that will replace the existing message box body text (defaults to the\nXHTML-compliant non-breaking space character ' ')\n
- multiline : Boolean\nTrue to prompt the user to enter multi-line text (defaults to false)\n
- progress : BooleanTrue to display a progress bar (defaults to false)\n
- progressText : StringThe text to display inside the progress bar if progress = true (defaults to '')\n
- prompt : BooleanTrue to prompt the user to enter single-line text (defaults to false)\n
- proxyDrag : BooleanTrue to display a lightweight proxy while dragging (defaults to false)\n
- title : StringThe title text\n
- value : StringThe string value to set into the active textbox element if displayed\n
- wait : BooleanTrue to display a progress bar (defaults to false)\n
- waitConfig : ObjectA Ext.ProgressBar.wait config object (applies only if wait = true)\n
- width : NumberThe width of the dialog in pixels\n
\n\nExt.Msg.show({\ntitle: 'Address',\nmsg: 'Please enter your address:',\nwidth: 300,\nbuttons: Ext.Msg.OKCANCEL,\nmultiline: true,\nfn: saveAddress,\nanimateTarget: 'addAddressBtn',\nicon: Ext.window.MessageBox.INFO\n});\n - animateTarget : String/Element
Returns
- Ext.window.MessageBox
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
Shortcut for performing an expand or collapse based on the current state of the panel.
\nReturns
- Ext.panel.Panel
this
\n
A shortcut method for toggling between maximize and restore based on the current maximized\nstate of the window.
\nReturns
- Ext.window.Window
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
Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via progress or wait,\nor by calling show with progress: true.
\nParameters
- value : Number (optional)
Any number between 0 and 1 (e.g., .5)
\nDefaults to:
0 - progressText : String (optional)
The progress text to display inside the progress bar.
\nDefaults to:
"" - msg : String (optional)
The message box's body text is replaced with the specified string (defaults to undefined\nso that any existing body text will not get overwritten by default unless a new value is passed in)
\n
Returns
- Ext.window.MessageBox
this
\n
Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.
\nParameters
- msg : String
The message box body text
\n - title : String (optional)
The title bar text
\n - config : Object (optional)
A Ext.ProgressBar.wait config object
\n
Returns
- Ext.window.MessageBox
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 the window has been visually activated via setActive.
\nParameters
- this : Ext.window.Window\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
@bubbles\nFires after any Ext.Component is added or inserted into the container.
\nParameters
- this : Ext.container.Container\n
- component : Ext.Component
The component that was added
\n - index : Number
The index at which the component was added to the container's items collection
\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 when the components in this container are arranged by the associated layout manager.
\nParameters
- this : Ext.container.Container\n
- layout : Ext.layout.container.Container
The ContainerLayout implementation for this container
\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 any Ext.Component is added or inserted into the container.\nA handler can return false to cancel the add.
\nParameters
- this : Ext.container.Container\n
- component : Ext.Component
The component being added
\n - index : Number
The index at which the component will be added to the container's items collection
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires before the user closes the panel. Return false from any listener to stop the close event being\nfired
\nParameters
- panel : Ext.panel.Panel
The Panel object
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires before this panel is collapsed. Return false to prevent the collapse.
\nParameters
- p : Ext.panel.Panel
The Panel being collapsed.
\n - direction : String
. The direction of the collapse. One of
\n\n- \n
- Ext.Component.DIRECTION_TOP \n
- Ext.Component.DIRECTION_RIGHT \n
- Ext.Component.DIRECTION_BOTTOM \n
- Ext.Component.DIRECTION_LEFT \n
- animate : Boolean
True if the collapse is animated, else false.
\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 this panel is expanded. Return false to prevent the expand.
\nParameters
- p : Ext.panel.Panel
The Panel being expanded.
\n - animate : Boolean
True if the expand is animated, else false.
\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 any Ext.Component is removed from the container. A handler can return\nfalse to cancel the remove.
\nParameters
- this : Ext.container.Container\n
- component : Ext.Component
The component being removed
\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 after the Panel has been resized.
\nParameters
- p : Ext.panel.Panel
the Panel which has been resized.
\n - width : Number
The Panel body's new width.
\n - height : Number
The Panel body's new height.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after this Panel hass collapsed.
\nParameters
- p : Ext.panel.Panel
The Panel that has been collapsed.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the window has been visually deactivated via setActive.
\nParameters
- this : Ext.window.Window\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 this Panel has expanded.
\nParameters
- p : Ext.panel.Panel
The Panel that has been expanded.
\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 Panel iconCls has been set or changed.
\nParameters
- p : Ext.panel.Panel
the Panel which has been resized.
\n - newIconCls : String
The new iconCls.
\n - oldIconCls : String
The previous panel iconCls.
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the window has been maximized.
\nParameters
- this : Ext.window.Window\n
- eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the window has been minimized.
\nParameters
- this : Ext.window.Window\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
@bubbles\nFires after any Ext.Component is removed from the container.
\nParameters
- this : Ext.container.Container\n
- component : Ext.Component
The component that was removed
\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 window has been resized.
\nParameters
- this : Ext.window.Window\n
- width : Number
The window's new width
\n - height : Number
The window's new height
\n - eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n
Fires after the window has been restored to its original size after being maximized.
\nParameters
- this : Ext.window.Window\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
Fires after the Panel title has been set or changed.
\nParameters
- p : Ext.panel.Panel
the Panel which has been resized.
\n - newTitle : String
The new title.
\n - oldTitle : String
The previous panel title.
\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.container.AbstractContainer","template":false,"required":null,"protected":false,"name":"insert","id":"method-insert"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.panel.AbstractPanel","template":false,"required":null,"protected":false,"name":"insertDocked","id":"method-insertDocked"},{"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.window.Window","template":false,"required":null,"protected":false,"name":"maximize","id":"method-maximize"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.window.Window","template":false,"required":null,"protected":false,"name":"minimize","id":"method-minimize"},{"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.container.AbstractContainer","template":false,"required":null,"protected":false,"name":"move","id":"method-move"},{"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.window.MessageBox","template":false,"required":null,"protected":false,"name":"progress","id":"method-progress"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.window.MessageBox","template":false,"required":null,"protected":false,"name":"prompt","id":"method-prompt"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.container.AbstractContainer","template":false,"required":null,"protected":false,"name":"query","id":"method-query"},{"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.container.AbstractContainer","template":false,"required":null,"protected":false,"name":"remove","id":"method-remove"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.container.AbstractContainer","template":false,"required":null,"protected":false,"name":"removeAll","id":"method-removeAll"},{"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.panel.AbstractPanel","template":false,"required":null,"protected":false,"name":"removeDocked","id":"method-removeDocked"},{"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.window.Window","template":false,"required":null,"protected":false,"name":"restore","id":"method-restore"},{"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.window.MessageBox","template":false,"required":null,"protected":false,"name":"setIcon","id":"method-setIcon"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.panel.Panel","template":false,"required":null,"protected":false,"name":"setIconCls","id":"method-setIconCls"},{"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.Panel","template":false,"required":null,"protected":false,"name":"setTitle","id":"method-setTitle"},{"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.window.MessageBox","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.panel.Panel","template":false,"required":null,"protected":false,"name":"toggleCollapse","id":"method-toggleCollapse"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.window.Window","template":false,"required":null,"protected":false,"name":"toggleMaximize","id":"method-toggleMaximize"},{"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"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.window.MessageBox","template":false,"required":null,"protected":false,"name":"updateProgress","id":"method-updateProgress"},{"tagname":"method","deprecated":null,"static":false,"owner":"Ext.window.MessageBox","template":false,"required":null,"protected":false,"name":"wait","id":"method-wait"}],"event":[{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.window.Window","template":null,"required":null,"protected":false,"name":"activate","id":"event-activate"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.container.AbstractContainer","template":null,"required":null,"protected":false,"name":"add","id":"event-add"},{"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.container.AbstractContainer","template":null,"required":null,"protected":false,"name":"afterlayout","id":"event-afterlayout"},{"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.container.AbstractContainer","template":null,"required":null,"protected":false,"name":"beforeadd","id":"event-beforeadd"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.panel.Panel","template":null,"required":null,"protected":false,"name":"beforeclose","id":"event-beforeclose"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.panel.Panel","template":null,"required":null,"protected":false,"name":"beforecollapse","id":"event-beforecollapse"},{"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.panel.Panel","template":null,"required":null,"protected":false,"name":"beforeexpand","id":"event-beforeexpand"},{"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.container.AbstractContainer","template":null,"required":null,"protected":false,"name":"beforeremove","id":"event-beforeremove"},{"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.AbstractPanel","template":null,"required":null,"protected":false,"name":"bodyresize","id":"event-bodyresize"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.panel.Panel","template":null,"required":null,"protected":false,"name":"collapse","id":"event-collapse"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.window.Window","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.panel.Panel","template":null,"required":null,"protected":false,"name":"expand","id":"event-expand"},{"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.panel.Panel","template":null,"required":null,"protected":false,"name":"iconchange","id":"event-iconchange"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.window.Window","template":null,"required":null,"protected":false,"name":"maximize","id":"event-maximize"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.window.Window","template":null,"required":null,"protected":false,"name":"minimize","id":"event-minimize"},{"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.container.AbstractContainer","template":null,"required":null,"protected":false,"name":"remove","id":"event-remove"},{"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.window.Window","template":null,"required":null,"protected":false,"name":"resize","id":"event-resize"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.window.Window","template":null,"required":null,"protected":false,"name":"restore","id":"event-restore"},{"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"},{"tagname":"event","deprecated":null,"static":false,"owner":"Ext.panel.Panel","template":null,"required":null,"protected":false,"name":"titlechange","id":"event-titlechange"}]},"private":false,"component":true,"name":"Ext.window.MessageBox","alternateClassNames":[],"id":"class-Ext.window.MessageBox","mixedInto":[],"xtypes":{"widget":["messagebox"]},"files":[{"href":"MessageBox.html#Ext-window-MessageBox","filename":"MessageBox.js"}]}); \ No newline at end of file