The base class that other non-interacting Toolbar Item classes should extend in order to\nget some basic common toolbar item functionality.
\n", - "extends": "Ext.Component", - "mixins": [ - - ], - "alternateClassNames": [ - "Ext.Toolbar.Item" + "allMixins": [ + "Ext.util.Floating", + "Ext.util.Observable", + "Ext.util.Animate", + "Ext.state.Stateful" ], - "xtype": "tbitem", - "author": null, + "deprecated": null, "docauthor": null, - "singleton": false, - "private": false, - "cfg": [ - { - "tagname": "cfg", - "name": "autoEl", - "member": "Ext.AbstractComponent", - "type": "Mixed", - "doc": "A tag name or DomHelper spec used to create the Element which will\nencapsulate this Component.
\n\n\nYou do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container,\nthis defaults to 'div'. The more complex Sencha classes use a more complex\nDOM structure specified by their own renderTpls.
\n\n\nThis is intended to allow the developer to create application-specific utility Components encapsulated by\ndifferent DOM elements. Example usage:
\n\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 floating Components which may or may not be shown. Instead\nof using renderTo in the configuration, and rendering upon construction, this allows a Component\nto render itself upon first show.
\n\n\nSpecify 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 show.
\n\n\nThis defaults to true for the Window class.
true to use overflow:'auto' on the components layout element and show scroll bars automatically when\nnecessary, false to clip any overflowing content (defaults to false).
True to automatically show the component upon creation.\nThis config option may only be used for floating components or components\nthat use autoRender. Defaults to false.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 471, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-autoShow", - "shortDoc": "True to automatically show the component upon creation.\nThis config option may only be used for floating components o..." - }, - { - "tagname": "cfg", - "name": "baseCls", - "member": "Ext.AbstractComponent", - "type": "String", - "doc": "The base CSS class to apply to this components's element. This will also be prepended to\nelements within this component like Panel's body will get a class x-panel-body. This means\nthat if you create a subclass of Panel, and you want it to get all the Panels styling for the\nelement and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this\ncomponent.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 252, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-baseCls", - "shortDoc": "The base CSS class to apply to this components's element. This will also be prepended to\nelements within this compone..." - }, - { - "tagname": "cfg", - "name": "border", - "member": "Ext.AbstractComponent", - "type": "Number/String", - "doc": "Specifies the border for this component. The border can be a single numeric value to apply to all sides or\nit can be a CSS style specification for each style, for example: '10 5 3 10'.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 339, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-border", - "shortDoc": "Specifies the border for this component. The border can be a single numeric value to apply to all sides or\nit can be ..." - }, - { - "tagname": "cfg", - "name": "cls", - "member": "Ext.AbstractComponent", - "type": "String", - "doc": "An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be\nuseful for adding customized styles to the component or any of its children using standard CSS rules.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 268, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-cls", - "shortDoc": "An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be\nuseful for ..." - }, - { - "tagname": "cfg", - "name": "componentCls", - "member": "Ext.AbstractComponent", - "type": "String", - "doc": "CSS Class to be added to a components root level element to give distinction to it\nvia styling.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 262, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-componentCls" - }, - { - "tagname": "cfg", - "name": "componentLayout", - "member": "Ext.AbstractComponent", - "type": "String/Object", - "doc": "The sizing and positioning of a Component's internal Elements is the responsibility of\nthe Component's layout manager which sizes a Component's internal structure in response to the Component being sized.
\n\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\n\nThe default layout manager will be used on instances of the base Ext.Component class\nwhich simply sizes the Component's encapsulating element to the height and width specified in the setSize method.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 221, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-componentLayout", - "shortDoc": "The sizing and positioning of a Component's internal Elements is the responsibility of\nthe Component's layout manager..." - }, - { - "tagname": "cfg", - "name": "contentEl", - "member": "Ext.AbstractComponent", - "type": "String", - "doc": "Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content\nfor this component.
layout\nscheme that the Component may use. It is just HTML. Layouts operate on child items.x-hidden or the x-hide-display CSS class to\nprevent a brief flicker of the content before it is rendered to the panel.The initial set of data to apply to the tpl to\nupdate the content area of the Component.
Defaults to false.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 363, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-disabled" - }, - { - "tagname": "cfg", - "name": "disabledCls", - "member": "Ext.AbstractComponent", - "type": "String", - "doc": "CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 281, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-disabledCls" - }, - { - "tagname": "cfg", - "name": "draggable", - "member": "Ext.Component", - "type": "Mixed", - "doc": "Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle.
\n\n\nThis may also be specified as a config object for the ComponentDragger which is instantiated to perform dragging.
\n\n\nFor example to create a Component which may only be dragged around using a certain internal element as the drag handle,\nuse the delegate option:
\n\n\nnew Ext.Component({\n constrain: true,\n floating:true,\n style: {\n backgroundColor: '#fff',\n border: '1px solid black'\n },\n html: '<h1 style=\"cursor:move\">The title</h1><p>The content</p>',\n draggable: {\n delegate: 'h1'\n }\n}).show();\n\n\n\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js",
- "linenr": 234,
- "html_filename": "Component.html",
- "href": "Component.html#Ext-Component-cfg-draggable",
- "shortDoc": "Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle..."
- },
- {
- "tagname": "cfg",
- "name": "floating",
- "member": "Ext.Component",
- "type": "Boolean",
- "doc": "Specify as true to float the Component outside of the document flow using CSS absolute positioning.
\n\n\nComponents such as Windows and Menus are floating\nby default.
\n\n\nFloating Components that are programatically rendered will register themselves with the global\nZIndexManager
\n\n\nA floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by\nexamining the ownerCt chain.
\n\n\nWhen configured as floating, Components acquire, at render time, a ZIndexManager which manages a stack\nof related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when\nthe Component's toFront method is called.
\n\n\nThe ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is floating. This is so that\ndescendant floating Components of floating Containers (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative\nto any siblings, but always above that floating ancestor Container.
\n\n\nIf no floating ancestor is found, a floating Component registers itself with the default ZIndexManager.
\n\n\nFloating components do not participate in the Container's layout. Because of this, they are not rendered until you explicitly\nshow them.
\n\n\nAfter rendering, the ownerCt reference is deleted, and the floatParent property is set to the found floating ancestor Container.\nIf no floating ancestor Container was found the floatParent property will not be set.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 175, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-cfg-floating", - "shortDoc": "Specify as true to float the Component outside of the document flow using CSS absolute positioning.\n\n\nComponents such..." - }, - { - "tagname": "cfg", - "name": "focusOnToFront", - "member": "Ext.util.Floating", - "type": "Boolean", - "doc": "Specifies whether the floated component should be automatically focused when it is\nbrought to the front. Defaults to true.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", - "linenr": 9, - "html_filename": "Floating.html", - "href": "Floating.html#Ext-util-Floating-cfg-focusOnToFront", - "shortDoc": "Specifies whether the floated component should be automatically focused when it is\nbrought to the front. Defaults to ..." - }, - { - "tagname": "cfg", - "name": "frame", - "member": "Ext.AbstractComponent", - "type": "Boolean", - "doc": "Specify as true to have the Component inject framing elements within the Component at render time to\nprovide a graphical rounded frame around the Component content.
This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer\nprior to version 9 which do not support rounded corners natively.
\n\n\nThe extra space taken up by this framing is available from the read only property frameSize.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 198, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-frame", - "shortDoc": "Specify as true to have the Component inject framing elements within the Component at render time to\nprovide a graphi..." - }, - { - "tagname": "cfg", - "name": "height", - "member": "Ext.AbstractComponent", - "type": "Number", - "doc": "The height of this component in pixels.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 334, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-height" - }, - { - "tagname": "cfg", - "name": "hidden", - "member": "Ext.AbstractComponent", - "type": "Boolean", - "doc": "Defaults to false.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 357, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-hidden" - }, - { - "tagname": "cfg", - "name": "hideMode", - "member": "Ext.AbstractComponent", - "type": "String", - "doc": "A String which specifies how this Component's encapsulating DOM element will be hidden.\nValues may be
'display' : The Component will be hidden using the display: none style.'visibility' : The Component will be hidden using the visibility: hidden style.'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document. This\nis useful when a hidden Component must maintain measurable dimensions. Hiding using display results\nin a Component having zero dimensions.'display'.\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js",
- "linenr": 388,
- "html_filename": "AbstractComponent.html",
- "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-hideMode",
- "shortDoc": "A String which specifies how this Component's encapsulating DOM element will be hidden.\nValues may be\n'display' : The..."
- },
- {
- "tagname": "cfg",
- "name": "html",
- "member": "Ext.AbstractComponent",
- "type": "String/Object",
- "doc": "An HTML fragment, or a DomHelper specification to use as the layout element\ncontent (defaults to ''). The HTML content is added after the component is rendered,\nso the document will not contain this HTML at the time the render event is fired.\nThis content is inserted into the body before any configured contentEl is appended.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 419, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-html", - "shortDoc": "An HTML fragment, or a DomHelper specification to use as the layout element\ncontent (defaults to ''). The HTML conten..." - }, - { - "tagname": "cfg", - "name": "id", - "member": "Ext.AbstractComponent", - "type": "String", - "doc": "The unique id of this component instance (defaults to an auto-assigned id).
\n\n\nIt should not be necessary to use this configuration except for singleton objects in your application.\nComponents created with an id may be accessed globally using Ext.getCmp.
\n\n\nInstead of using assigned ids, use the itemId config, and ComponentQuery which\nprovides selector-based searching for Sencha Components analogous to DOM querying. The Container\nclass contains shortcut methods to query its descendant Components by selector.
\n\n\nNote that this id will also be used as the element id for the containing HTML element\nthat is rendered to the page for this component. This allows you to write id-based CSS\nrules to style the specific instance of this component uniquely, and also to select\nsub-elements using this component's id as the parent.
\n\n\nNote: to avoid complications imposed by a unique id also see itemId.
Note: to access the container of a Component see ownerCt.
An itemId can be used as an alternative way to get a reference to a component\nwhen no object reference is available. Instead of using an id with\nExt.getCmp, use itemId with\nExt.container.Container.getComponent which will retrieve\nitemId's or id's. Since itemId's are an index to the\ncontainer's internal MixedCollection, the itemId is scoped locally to the container --\navoiding potential conflicts with Ext.ComponentManager which requires a unique\nid.
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, query, down and child.
Note: to access the container of an item see ownerCt.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 66, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-itemId", - "shortDoc": "An itemId can be used as an alternative way to get a reference to a component\nwhen no object reference is available. ..." - }, - { - "tagname": "cfg", - "name": "listeners", - "member": "Ext.util.Observable", - "type": "Object", - "doc": "(optional)
A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.
\n\nDOM events from ExtJs Components
\n\n\nWhile some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n
is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the element option to\nidentify the Component property to add a DOM 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\ncontent for this Component.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 462, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-loader" - }, - { - "tagname": "cfg", - "name": "maintainFlex", - "member": "Ext.Component", - "type": "Boolean", - "doc": "Only valid when a sibling element of a Splitter within a VBox or\nHBox layout.
\n\n\nSpecifies that if an immediate sibling Splitter is moved, the Component on the other side is resized, and this\nComponent maintains its configured flex value.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 256, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-cfg-maintainFlex", - "shortDoc": "Only valid when a sibling element of a Splitter within a VBox or\nHBox layout.\n\n\nSpecifies that if an immediate siblin..." - }, - { - "tagname": "cfg", - "name": "margin", - "member": "Ext.AbstractComponent", - "type": "Number/String", - "doc": "Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or\nit can be a CSS style specification for each style, for example: '10 5 3 10'.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 351, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-margin", - "shortDoc": "Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or\nit can be ..." - }, - { - "tagname": "cfg", - "name": "maxHeight", - "member": "Ext.AbstractComponent", - "type": "Number", - "doc": "The maximum value in pixels which this Component will set its height to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 451, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-maxHeight", - "shortDoc": "The maximum value in pixels which this Component will set its height to.\n\n\nWarning: This will override any size manag..." - }, - { - "tagname": "cfg", - "name": "maxWidth", - "member": "Ext.AbstractComponent", - "type": "Number", - "doc": "The maximum value in pixels which this Component will set its width to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 456, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-maxWidth", - "shortDoc": "The maximum value in pixels which this Component will set its width to.\n\n\nWarning: This will override any size manage..." - }, - { - "tagname": "cfg", - "name": "minHeight", - "member": "Ext.AbstractComponent", - "type": "Number", - "doc": "The minimum value in pixels which this Component will set its height to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 441, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-minHeight", - "shortDoc": "The minimum value in pixels which this Component will set its height to.\n\n\nWarning: This will override any size manag..." - }, - { - "tagname": "cfg", - "name": "minWidth", - "member": "Ext.AbstractComponent", - "type": "Number", - "doc": "The minimum value in pixels which this Component will set its width to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 446, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-minWidth", - "shortDoc": "The minimum value in pixels which this Component will set its width to.\n\n\nWarning: This will override any size manage..." - }, - { - "tagname": "cfg", - "name": "overCls", - "member": "Ext.AbstractComponent", - "type": "String", - "doc": "An optional extra CSS class that will be added to this component's Element when the mouse moves\nover the Element, and removed when the mouse moves out. (defaults to ''). This can be\nuseful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 274, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-overCls", - "shortDoc": "An optional extra CSS class that will be added to this component's Element when the mouse moves\nover the Element, and..." - }, - { - "tagname": "cfg", - "name": "overflowText", - "member": "Ext.toolbar.Item", - "type": "String", - "doc": "Text to be used for the menu if the item is overflowed.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Item.js", - "linenr": 18, - "html_filename": "Item2.html", - "href": "Item2.html#Ext-toolbar-Item-cfg-overflowText" - }, - { - "tagname": "cfg", - "name": "padding", - "member": "Ext.AbstractComponent", - "type": "Number/String", - "doc": "Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or\nit can be a CSS style specification for each style, for example: '10 5 3 10'.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 345, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-padding", - "shortDoc": "Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or\nit can b..." - }, - { - "tagname": "cfg", - "name": "plugins", - "member": "Ext.AbstractComponent", - "type": "Object/Array", - "doc": "An object or array of objects that will provide custom functionality for this component. The only\nrequirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.\nWhen a component is created, if any plugins are available, the component will call the init method on each\nplugin, passing a reference to itself. Each plugin can then call methods or respond to events on the\ncomponent as needed to provide its functionality.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 491, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-plugins", - "shortDoc": "An object or array of objects that will provide custom functionality for this component. The only\nrequirement for a ..." - }, - { - "tagname": "cfg", - "name": "renderSelectors", - "member": "Ext.AbstractComponent", - "type": "Object", - "doc": "An 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 rendered an image, and description into its element might use the following properties\ncoded into its prototype:
\n\nrenderTpl: '<img src=\"{imageUrl}\" class=\"x-image-component-img\"><div class=\"x-image-component-desc\">{description}>/div<',\n\nrenderSelectors: {\n image: 'img.x-image-component-img',\n descEl: 'div.x-image-component-desc'\n}\nAfter rendering, the Component would have a property image referencing its child img Element,\nand a property descEl referencing the div Element which contains the description.
Specify the id of the element, a DOM element or an existing Element that this component\nwill be rendered into.
\n\n\nSee render also.
An XTemplate used to create the internal structure inside this Component's\nencapsulating Element.
\n\n\nYou do not normally need to specify this. For the base classes Ext.Component\nand Ext.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 classes\nwhich 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\n\nUpon rendering, any created child elements may be automatically imported into object properties using the\nrenderSelectors option.
\n\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 143, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-renderTpl", - "shortDoc": "An XTemplate used to create the internal structure inside this Component's\nencapsulating Element.\n\n\nYou do not normal..." - }, - { - "tagname": "cfg", - "name": "resizable", - "member": "Ext.Component", - "type": "Mixed", - "doc": "Specify as true to apply a Resizer to this Component\nafter rendering.
May also be specified as a config object to be passed to the constructor of Resizer\nto override any defaults. By default the Component passes its minimum and maximum size, and uses\nExt.resizer.Resizer.dynamic: false
A valid Ext.resizer.Resizer handles config string (defaults to 'all'). Only applies when resizable = true.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 163, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-cfg-resizeHandles" - }, - { - "tagname": "cfg", - "name": "saveBuffer", - "member": "Ext.state.Stateful", - "type": "Number", - "doc": "A buffer to be applied if many state events are fired within\na short period. Defaults to 100.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 74, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-cfg-saveBuffer" - }, - { - "tagname": "cfg", - "name": "shadow", - "member": "Ext.util.Floating", - "type": "String/Boolean", - "doc": "Specifies whether the floating component should be given a shadow. Set to\ntrue to automatically create an Ext.Shadow, or a string indicating the\nshadow's display Ext.Shadow.mode. Set to false to disable the shadow.\n(Defaults to 'sides'.)
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", - "linenr": 16, - "html_filename": "Floating.html", - "href": "Floating.html#Ext-util-Floating-cfg-shadow", - "shortDoc": "Specifies whether the floating component should be given a shadow. Set to\ntrue to automatically create an Ext.Shadow,..." - }, - { - "tagname": "cfg", - "name": "stateEvents", - "member": "Ext.state.Stateful", - "type": "Array", - "doc": "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\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 58, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-cfg-stateId", - "shortDoc": "The unique id for this object to use for state management purposes.\n\nSee stateful for an explanation of saving and re..." - }, - { - "tagname": "cfg", - "name": "stateful", - "member": "Ext.state.Stateful", - "type": "Boolean", - "doc": "A 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\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 18, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-cfg-stateful", - "shortDoc": "A flag which causes the object to attempt to restore the state of\ninternal properties from a saved state on startup. ..." - }, - { - "tagname": "cfg", - "name": "style", - "member": "Ext.AbstractComponent", - "type": "String", - "doc": "A custom style specification to be applied to this component's Element. Should be a valid argument to\nExt.core.Element.applyStyles.
\n\n new 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 });\n The class that is added to the content target when you set styleHtmlContent to true.\nDefaults to 'x-html'
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 434, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlCls" - }, - { - "tagname": "cfg", - "name": "styleHtmlContent", - "member": "Ext.AbstractComponent", - "type": "Boolean", - "doc": "True to automatically style the html inside the content target of this component (body for panels).\nDefaults to false.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 427, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlContent" - }, - { - "tagname": "cfg", - "name": "toFrontOnShow", - "member": "Ext.Component", - "type": "Boolean", - "doc": "True to automatically call toFront when the show method is called\non an already visible, floating component (default is true).
An data and\ntplWriteMode configurations.
The Ext.(X)Template method to use when\nupdating the content area of the Component. Defaults to 'overwrite'\n(see Ext.XTemplate.overwrite).
A set style for a component. Can be a string or an Array of multiple strings (UIs)
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 287, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-ui" - }, - { - "tagname": "cfg", - "name": "width", - "member": "Ext.AbstractComponent", - "type": "Number", - "doc": "The width of this component in pixels.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 329, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-width" - } - ], - "method": [ - { - "tagname": "method", - "name": "Item", - "member": "Ext.toolbar.Item", - "doc": "Creates a new Item
\n", - "params": [ - { - "type": "HTMLElement", - "name": "el", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Item.js", - "linenr": 1, - "html_filename": "Item2.html", - "href": "Item2.html#Ext-toolbar-Item-method-constructor", - "shortDoc": "Creates a new Item
\n" - }, - { - "tagname": "method", - "name": "addClass", - "member": "Ext.AbstractComponent", - "doc": "@deprecated 4.0 Replaced by addCls\nAdds a CSS class to the top level element representing this component.
\n", - "params": [ - { - "type": "String", - "name": "cls", - "doc": "The CSS class name to add
\n", - "optional": false - } - ], - "return": { - "type": "Ext.Component", - "doc": "Returns the Component to allow method chaining.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2161, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-addClass", - "shortDoc": "@deprecated 4.0 Replaced by addCls\nAdds a CSS class to the top level element representing this component.
\n" - }, - { - "tagname": "method", - "name": "addCls", - "member": "Ext.AbstractComponent", - "doc": "Adds a CSS class to the top level element representing this component.
\n", - "params": [ - { - "type": "String", - "name": "cls", - "doc": "The CSS class name to add
\n", - "optional": false - } - ], - "return": { - "type": "Ext.Component", - "doc": "Returns the Component to allow method chaining.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2139, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-addCls", - "shortDoc": "Adds a CSS class to the top level element representing this component.
\n" - }, - { - "tagname": "method", - "name": "addClsWithUI", - "member": "Ext.AbstractComponent", - "doc": "Adds a cls to the uiCls array, which will also call addUIClsToElement and adds\nto all elements of this component.
\n", - "params": [ - { - "type": "String/Array", - "name": "cls", - "doc": "A string or an array of strings to add to the uiCls
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1346, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-addClsWithUI", - "shortDoc": "Adds a cls to the uiCls array, which will also call addUIClsToElement and adds\nto all elements of this component.
\n" - }, - { - "tagname": "method", - "name": "addEvents", - "member": "Ext.util.Observable", - "doc": "Adds the specified events to the list of events which this Observable may fire.
\n", - "params": [ - { - "type": "Object/String", - "name": "o", - "doc": "Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.
[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:
\n\nthis.addEvents('storeloaded', 'storecleared');\nAdds the specified events to the list of events which this Observable may fire.
\n" - }, - { - "tagname": "method", - "name": "addListener", - "member": "Ext.util.Observable", - "doc": "Appends an event handler to this object.
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to listen for. May also be an object who's property names are event names. See
\n", - "optional": false + "members": { + "cfg": [ + { + "type": "Mixed", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-autoEl", + "shortDoc": "A tag name or DomHelper spec used to create the Element which will\nencapsulate this Component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "autoEl", + "owner": "Ext.AbstractComponent", + "doc": "A tag name or DomHelper spec used to create the Element which will\nencapsulate this Component.
\n\n\nYou do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container,\nthis defaults to 'div'. The more complex Sencha classes use a more complex\nDOM structure specified by their own renderTpls.
\n\n\nThis is intended to allow the developer to create application-specific utility Components encapsulated by\ndifferent DOM elements. Example usage:
\n\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 floating Components which may or may not be shown. Instead\nof using renderTo in the configuration, and rendering upon construction, this allows a Component\nto render itself upon first show.
\n\n\nSpecify 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 show.
\n\n\nThis defaults to true for the Window class.
true to use overflow:'auto' on the components layout element and show scroll bars automatically when\nnecessary, false to clip any overflowing content (defaults to false).
True to automatically show the component upon creation.\nThis config option may only be used for floating components or components\nthat use autoRender. Defaults to false.
\n", + "linenr": 492, + "html_filename": "AbstractComponent.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-baseCls", + "shortDoc": "The base CSS class to apply to this components's element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "baseCls", + "owner": "Ext.AbstractComponent", + "doc": "The base CSS class to apply to this components's element. This will also be prepended to\nelements within this component like Panel's body will get a class x-panel-body. This means\nthat if you create a subclass of Panel, and you want it to get all the Panels styling for the\nelement and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this\ncomponent.
\n", + "linenr": 273, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Number/String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-border", + "shortDoc": "Specifies the border for this component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "border", + "owner": "Ext.AbstractComponent", + "doc": "Specifies the border for this component. The border can be a single numeric value to apply to all sides or\nit can be a CSS style specification for each style, for example: '10 5 3 10'.
\n", + "linenr": 360, + "html_filename": "AbstractComponent.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-cls", + "shortDoc": "An optional extra CSS class that will be added to this component's Element (defaults to ''). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "cls", + "owner": "Ext.AbstractComponent", + "doc": "An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be\nuseful for adding customized styles to the component or any of its children using standard CSS rules.
\n", + "linenr": 289, + "html_filename": "AbstractComponent.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-componentCls", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "componentCls", + "owner": "Ext.AbstractComponent", + "doc": "CSS Class to be added to a components root level element to give distinction to it\nvia styling.
\n", + "linenr": 283, + "html_filename": "AbstractComponent.html" + }, + { + "type": "String/Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-componentLayout", + "shortDoc": "The sizing and positioning of a Component's internal Elements is the responsibility of\nthe Component's layout manager...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "componentLayout", + "owner": "Ext.AbstractComponent", + "doc": "The sizing and positioning of a Component's internal Elements is the responsibility of\nthe Component's layout manager which sizes a Component's internal structure in response to the Component being sized.
\n\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\n\nThe default layout manager will be used on instances of the base Ext.Component class\nwhich simply sizes the Component's encapsulating element to the height and width specified in the setSize method.
\n\n", + "linenr": 242, + "html_filename": "AbstractComponent.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-contentEl", + "shortDoc": "Optional. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "contentEl", + "owner": "Ext.AbstractComponent", + "doc": "Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content\nfor this component.
layout\nscheme that the Component may use. It is just HTML. Layouts operate on child items.x-hidden or the x-hide-display CSS class to\nprevent a brief flicker of the content before it is rendered to the panel.The initial set of data to apply to the tpl to\nupdate the content area of the Component.
Defaults to false.
\n", + "linenr": 384, + "html_filename": "AbstractComponent.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-disabledCls", + "shortDoc": "CSS class to add when the Component is disabled. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "disabledCls", + "owner": "Ext.AbstractComponent", + "doc": "CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.
\n", + "linenr": 302, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Mixed", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Component2.html#Ext-Component-cfg-draggable", + "shortDoc": "Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", + "private": false, + "name": "draggable", + "owner": "Ext.Component", + "doc": "Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle.
\n\n\nThis may also be specified as a config object for the ComponentDragger which is instantiated to perform dragging.
\n\n\nFor example to create a Component which may only be dragged around using a certain internal element as the drag handle,\nuse the delegate option:
\n\n\nnew Ext.Component({\n constrain: true,\n floating:true,\n style: {\n backgroundColor: '#fff',\n border: '1px solid black'\n },\n html: '<h1 style=\"cursor:move\">The title</h1><p>The content</p>',\n draggable: {\n delegate: 'h1'\n }\n}).show();\n\n\n\n\n",
+ "linenr": 237,
+ "html_filename": "Component2.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Component2.html#Ext-Component-cfg-floating",
+ "shortDoc": "Specify as true to float the Component outside of the document flow using CSS absolute positioning. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js",
+ "private": false,
+ "name": "floating",
+ "owner": "Ext.Component",
+ "doc": "Specify as true to float the Component outside of the document flow using CSS absolute positioning.
\n\n\nComponents such as Windows and Menus are floating\nby default.
\n\n\nFloating Components that are programatically rendered will register themselves with the global\nZIndexManager
\n\n\nA floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by\nexamining the ownerCt chain.
\n\n\nWhen configured as floating, Components acquire, at render time, a ZIndexManager which manages a stack\nof related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when\nthe Component's toFront method is called.
\n\n\nThe ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is floating. This is so that\ndescendant floating Components of floating Containers (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative\nto any siblings, but always above that floating ancestor Container.
\n\n\nIf no floating ancestor is found, a floating Component registers itself with the default ZIndexManager.
\n\n\nFloating components do not participate in the Container's layout. Because of this, they are not rendered until you explicitly\nshow them.
\n\n\nAfter rendering, the ownerCt reference is deleted, and the floatParent property is set to the found floating ancestor Container.\nIf no floating ancestor Container was found the floatParent property will not be set.
\n\n", + "linenr": 178, + "html_filename": "Component2.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Floating.html#Ext-util-Floating-cfg-focusOnToFront", + "shortDoc": "Specifies whether the floated component should be automatically focused when it is\nbrought to the front. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", + "private": false, + "name": "focusOnToFront", + "owner": "Ext.util.Floating", + "doc": "Specifies whether the floated component should be automatically focused when it is\nbrought to the front. Defaults to true.
\n", + "linenr": 9, + "html_filename": "Floating.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-frame", + "shortDoc": "Specify as true to have the Component inject framing elements within the Component at render time to\nprovide a graphi...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "frame", + "owner": "Ext.AbstractComponent", + "doc": "Specify as true to have the Component inject framing elements within the Component at render time to\nprovide a graphical rounded frame around the Component content.
This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer\nprior to version 9 which do not support rounded corners natively.
\n\n\nThe extra space taken up by this framing is available from the read only property frameSize.
\n\n", + "linenr": 219, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-height", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "height", + "owner": "Ext.AbstractComponent", + "doc": "The height of this component in pixels.
\n", + "linenr": 355, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-hidden", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "hidden", + "owner": "Ext.AbstractComponent", + "doc": "Defaults to false.
\n", + "linenr": 378, + "html_filename": "AbstractComponent.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-hideMode", + "shortDoc": "A String which specifies how this Component's encapsulating DOM element will be hidden. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "hideMode", + "owner": "Ext.AbstractComponent", + "doc": "A String which specifies how this Component's encapsulating DOM element will be hidden.\nValues may be
'display' : The Component will be hidden using the display: none style.'visibility' : The Component will be hidden using the visibility: hidden style.'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document. This\nis useful when a hidden Component must maintain measurable dimensions. Hiding using display results\nin a Component having zero dimensions.'display'.\n",
+ "linenr": 409,
+ "html_filename": "AbstractComponent.html"
+ },
+ {
+ "type": "String/Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-html",
+ "shortDoc": "An HTML fragment, or a DomHelper specification to use as the layout element\ncontent (defaults to ''). ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js",
+ "private": false,
+ "name": "html",
+ "owner": "Ext.AbstractComponent",
+ "doc": "An HTML fragment, or a DomHelper specification to use as the layout element\ncontent (defaults to ''). The HTML content is added after the component is rendered,\nso the document will not contain this HTML at the time the render event is fired.\nThis content is inserted into the body before any configured contentEl is appended.
\n", + "linenr": 440, + "html_filename": "AbstractComponent.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-id", + "shortDoc": "The unique id of this component instance (defaults to an auto-assigned id). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "id", + "owner": "Ext.AbstractComponent", + "doc": "The unique id of this component instance (defaults to an auto-assigned id).
\n\n\nIt should not be necessary to use this configuration except for singleton objects in your application.\nComponents created with an id may be accessed globally using Ext.getCmp.
\n\n\nInstead of using assigned ids, use the itemId config, and ComponentQuery which\nprovides selector-based searching for Sencha Components analogous to DOM querying. The Container\nclass contains shortcut methods to query its descendant Components by selector.
\n\n\nNote that this id will also be used as the element id for the containing HTML element\nthat is rendered to the page for this component. This allows you to write id-based CSS\nrules to style the specific instance of this component uniquely, and also to select\nsub-elements using this component's id as the parent.
\n\n\nNote: to avoid complications imposed by a unique id also see itemId.
Note: to access the container of a Component see ownerCt.
An itemId can be used as an alternative way to get a reference to a component\nwhen no object reference is available. Instead of using an id with\nExt.getCmp, use itemId with\nExt.container.Container.getComponent which will retrieve\nitemId's or id's. Since itemId's are an index to the\ncontainer's internal MixedCollection, the itemId is scoped locally to the container --\navoiding potential conflicts with Ext.ComponentManager which requires a unique\nid.
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,\nExt.container.Container.down and Ext.container.Container.child.
Note: to access the container of an item see ownerCt.
\n\n", + "linenr": 66, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Observable.html#Ext-util-Observable-cfg-listeners", + "shortDoc": "A config object containing one or more event handlers to be added to this object during initialization. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "name": "listeners", + "owner": "Ext.util.Observable", + "doc": "A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.
\n\nDOM events from ExtJS Components
\n\nWhile some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:
new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\nA configuration object or an instance of a Ext.ComponentLoader to load remote\ncontent for this Component.
\n", + "linenr": 483, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Component2.html#Ext-Component-cfg-maintainFlex", + "shortDoc": "Only valid when a sibling element of a Splitter within a VBox or\nHBox layout. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", + "private": false, + "name": "maintainFlex", + "owner": "Ext.Component", + "doc": "Only valid when a sibling element of a Splitter within a VBox or\nHBox layout.
\n\n\nSpecifies that if an immediate sibling Splitter is moved, the Component on the other side is resized, and this\nComponent maintains its configured flex value.
\n\n", + "linenr": 259, + "html_filename": "Component2.html" + }, + { + "type": "Number/String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-margin", + "shortDoc": "Specifies the margin for this component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "margin", + "owner": "Ext.AbstractComponent", + "doc": "Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or\nit can be a CSS style specification for each style, for example: '10 5 3 10'.
\n", + "linenr": 372, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-maxHeight", + "shortDoc": "The maximum value in pixels which this Component will set its height to. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "maxHeight", + "owner": "Ext.AbstractComponent", + "doc": "The maximum value in pixels which this Component will set its height to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", + "linenr": 472, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-maxWidth", + "shortDoc": "The maximum value in pixels which this Component will set its width to. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "maxWidth", + "owner": "Ext.AbstractComponent", + "doc": "The maximum value in pixels which this Component will set its width to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", + "linenr": 477, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-minHeight", + "shortDoc": "The minimum value in pixels which this Component will set its height to. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "minHeight", + "owner": "Ext.AbstractComponent", + "doc": "The minimum value in pixels which this Component will set its height to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", + "linenr": 462, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-minWidth", + "shortDoc": "The minimum value in pixels which this Component will set its width to. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "minWidth", + "owner": "Ext.AbstractComponent", + "doc": "The minimum value in pixels which this Component will set its width to.
\n\n\nWarning: This will override any size management applied by layout managers.
\n\n", + "linenr": 467, + "html_filename": "AbstractComponent.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-overCls", + "shortDoc": "An optional extra CSS class that will be added to this component's Element when the mouse moves\nover the Element, and...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "overCls", + "owner": "Ext.AbstractComponent", + "doc": "An optional extra CSS class that will be added to this component's Element when the mouse moves\nover the Element, and removed when the mouse moves out. (defaults to ''). This can be\nuseful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.
\n", + "linenr": 295, + "html_filename": "AbstractComponent.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Item.html#Ext-toolbar-Item-cfg-overflowText", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/toolbar/Item.js", + "private": false, + "name": "overflowText", + "owner": "Ext.toolbar.Item", + "doc": "Text to be used for the menu if the item is overflowed.
\n", + "linenr": 14, + "html_filename": "Item.html" + }, + { + "type": "Number/String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-padding", + "shortDoc": "Specifies the padding for this component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "padding", + "owner": "Ext.AbstractComponent", + "doc": "Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or\nit can be a CSS style specification for each style, for example: '10 5 3 10'.
\n", + "linenr": 366, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Object/Array", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-plugins", + "shortDoc": "An object or array of objects that will provide custom functionality for this component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "plugins", + "owner": "Ext.AbstractComponent", + "doc": "An object or array of objects that will provide custom functionality for this component. The only\nrequirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.\nWhen a component is created, if any plugins are available, the component will call the init method on each\nplugin, passing a reference to itself. Each plugin can then call methods or respond to events on the\ncomponent as needed to provide its functionality.
\n", + "linenr": 512, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-renderSelectors", + "shortDoc": "An object containing properties specifying DomQuery selectors which identify child elements\ncreated by the render pro...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "renderSelectors", + "owner": "Ext.AbstractComponent", + "doc": "An 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 rendered an image, and description into its element might use the following properties\ncoded into its prototype:
\n\nrenderTpl: '<img src=\"{imageUrl}\" class=\"x-image-component-img\"><div class=\"x-image-component-desc\">{description}>/div<',\n\nrenderSelectors: {\n image: 'img.x-image-component-img',\n descEl: 'div.x-image-component-desc'\n}\nAfter rendering, the Component would have a property image referencing its child img Element,\nand a property descEl referencing the div Element which contains the description.
Specify the id of the element, a DOM element or an existing Element that this component\nwill be rendered into.
\n\n\nSee render also.
An XTemplate used to create the internal structure inside this Component's\nencapsulating Element.
\n\n\nYou do not normally need to specify this. For the base classes Ext.Component\nand Ext.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 classes\nwhich 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\n\nUpon rendering, any created child elements may be automatically imported into object properties using the\nrenderSelectors option.
\n\n", + "linenr": 164, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Mixed", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Component2.html#Ext-Component-cfg-resizable", + "shortDoc": "Specify as true to apply a Resizer to this Component\nafter rendering. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", + "private": false, + "name": "resizable", + "owner": "Ext.Component", + "doc": "Specify as true to apply a Resizer to this Component\nafter rendering.
May also be specified as a config object to be passed to the constructor of Resizer\nto override any defaults. By default the Component passes its minimum and maximum size, and uses\nExt.resizer.Resizer.dynamic: false
A valid Ext.resizer.Resizer handles config string (defaults to 'all'). Only applies when resizable = true.
\n", + "linenr": 166, + "html_filename": "Component2.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Stateful.html#Ext-state-Stateful-cfg-saveBuffer", + "shortDoc": "A buffer to be applied if many state events are fired within\na short period. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", + "private": false, + "name": "saveBuffer", + "owner": "Ext.state.Stateful", + "doc": "A buffer to be applied if many state events are fired within\na short period. Defaults to 100.
\n", + "linenr": 74, + "html_filename": "Stateful.html" + }, + { + "type": "String/Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Floating.html#Ext-util-Floating-cfg-shadow", + "shortDoc": "Specifies whether the floating component should be given a shadow. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", + "private": false, + "name": "shadow", + "owner": "Ext.util.Floating", + "doc": "Specifies whether the floating component should be given a shadow. Set to\ntrue to automatically create an Ext.Shadow, or a string indicating the\nshadow's display Ext.Shadow.mode. Set to false to disable the shadow.\n(Defaults to 'sides'.)
\n", + "linenr": 16, + "html_filename": "Floating.html" + }, + { + "type": "Array", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Stateful.html#Ext-state-Stateful-cfg-stateEvents", + "shortDoc": "An array of events that, when fired, should trigger this object to\nsave its state (defaults to none). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", + "private": false, + "name": "stateEvents", + "owner": "Ext.state.Stateful", + "doc": "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\n", + "linenr": 58, + "html_filename": "Stateful.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Stateful.html#Ext-state-Stateful-cfg-stateful", + "shortDoc": "A flag which causes the object to attempt to restore the state of\ninternal properties from a saved state on startup. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", + "private": false, + "name": "stateful", + "owner": "Ext.state.Stateful", + "doc": "A 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\n", + "linenr": 18, + "html_filename": "Stateful.html" + }, + { + "type": "String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-style", + "shortDoc": "A custom style specification to be applied to this component's Element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "style", + "owner": "Ext.AbstractComponent", + "doc": "A custom style specification to be applied to this component's Element. Should be a valid argument to\nExt.core.Element.applyStyles.
\n\n new 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 });\n The class that is added to the content target when you set styleHtmlContent to true.\nDefaults to 'x-html'
\n", + "linenr": 455, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-styleHtmlContent", + "shortDoc": "True to automatically style the html inside the content target of this component (body for panels). ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "styleHtmlContent", + "owner": "Ext.AbstractComponent", + "doc": "True to automatically style the html inside the content target of this component (body for panels).\nDefaults to false.
\n", + "linenr": 448, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "Component2.html#Ext-Component-cfg-toFrontOnShow", + "shortDoc": "True to automatically call toFront when the show method is called\non an already visible, floating component (default ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", + "private": false, + "name": "toFrontOnShow", + "owner": "Ext.Component", + "doc": "True to automatically call toFront when the show method is called\non an already visible, floating component (default is true).
An data and\ntplWriteMode configurations.
The Ext.(X)Template method to use when\nupdating the content area of the Component. Defaults to 'overwrite'\n(see Ext.XTemplate.overwrite).
A set style for a component. Can be a string or an Array of multiple strings (UIs)
\n", + "linenr": 308, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Number", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-width", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "width", + "owner": "Ext.AbstractComponent", + "doc": "The width of this component in pixels.
\n", + "linenr": 350, + "html_filename": "AbstractComponent.html" + } + ], + "method": [ + { + "deprecated": null, + "alias": null, + "href": "Component2.html#Ext-Component-method-constructor", + "tagname": "method", + "protected": false, + "shortDoc": "Creates new Component. ...", + "static": false, + "params": [ + { + "type": "Ext.core.Element/String/Object", + "optional": false, + "doc": "The configuration options may be specified as either:
\n\nit is set as the internal element and its id used as the component id
it is assumed to be the id of an existing element and is used as the component id
it is assumed to be a standard config object and is applied to the component
Creates new Component.
\n", + "owner": "Ext.Component", + "name": "Item", + "html_filename": "Component2.html", + "return": { + "type": "Object", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes.
\n", - "optional": false + "linenr": 1 + }, + { + "deprecated": { + "version": "4.0", + "text": "Replaced by addCls
\n\n\n\n", + "tagname": "deprecated", + "doc": "Adds a CSS class to the top level element representing this component." }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
The CSS class name to add
\n", + "name": "cls" + } + ], + "name": "addClass", + "owner": "Ext.AbstractComponent", + "doc": "Adds a CSS class to the top level element representing this component.
\n", + "linenr": 2328, + "return": { + "type": "Ext.Component", + "doc": "Returns the Component to allow method chaining.
\n" }, - { - "type": "Object", - "name": "options", - "doc": "(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:
this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.This option is useful during Component construction to add DOM event listeners to elements of Components which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n
new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nWhen added in this way, the options available are the options applicable to Ext.core.Element.addListener
\n\n\n\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n
myGridPanel.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", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 271, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-addListener", - "shortDoc": "
Appends an event handler to this object.
\n" - }, - { - "tagname": "method", - "name": "addManagedListener", - "member": "Ext.util.Observable", - "doc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n", - "params": [ - { - "type": "Observable/Element", - "name": "item", - "doc": "
The item to which to add a listener/listeners.
\n", - "optional": false - }, - { - "type": "Object/String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
The CSS class name to add
\n", + "name": "cls" + } + ], + "name": "addCls", + "owner": "Ext.AbstractComponent", + "doc": "Adds a CSS class to the top level element representing this component.
\n", + "linenr": 2306, + "return": { + "type": "Ext.Component", + "doc": "Returns the Component to allow method chaining.
\n" }, - { - "type": "Object", - "name": "opt", - "doc": "Optional. If the ename parameter was an event name, this\nis the addListener options.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n" - }, - { - "tagname": "method", - "name": "addStateEvents", - "member": "Ext.state.Stateful", - "doc": "
Add events that will trigger the state to be saved.
\n", - "params": [ - { - "type": "String/Array", - "name": "events", - "doc": "The event name or an array of event names.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 159, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-method-addStateEvents", - "shortDoc": "Add events that will trigger the state to be saved.
\n" - }, - { - "tagname": "method", - "name": "afterComponentLayout", - "member": "Ext.AbstractComponent", - "doc": "\n", - "params": [ - { - "type": "Number", - "name": "adjWidth", - "doc": "The box-adjusted width that was set
\n", - "optional": false + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-addClsWithUI", + "shortDoc": "Adds a cls to the uiCls array, which will also call addUIClsToElement and adds\nto all elements of this component. ...", + "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 add to the uiCls
\n", + "name": "cls" + }, + { + "type": "Object", + "optional": false, + "doc": "(Boolean) skip True to skip adding it to the class and do it later (via the return)
\n", + "name": "skip" + } + ], + "name": "addClsWithUI", + "owner": "Ext.AbstractComponent", + "doc": "Adds a cls to the uiCls array, which will also call addUIClsToElement and adds\nto all elements of this component.
\n", + "linenr": 1463, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Number", - "name": "adjHeight", - "doc": "The box-adjusted height that was set
\n", - "optional": false + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addEvents", + "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Object/String", + "optional": false, + "doc": "Either an object with event names as properties with a value of true or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\nOptional additional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\nAdds the specified events to the list of events which this Observable may fire.
\n", + "linenr": 494, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Boolean", - "name": "isSetSize", - "doc": "Whether or not the height/width are stored on the component permanently
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addListener", + "shortDoc": "Appends an event handler to this object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The name of the event to listen for. May also be an object who's property names are\nevent names.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.
(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nCombining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\nAppends an event handler to this object.
\n", + "linenr": 278, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Ext.Component", - "name": "layoutOwner", - "doc": "Component which sent the layout. Only used when isSetSize is false.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2481, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-afterComponentLayout", - "shortDoc": "\n" - }, - { - "tagname": "method", - "name": "alignTo", - "member": "Ext.util.Floating", - "doc": "Aligns this floating Component to the specified element
\n", - "params": [ - { - "type": "Mixed", - "name": "element", - "doc": "The element or Ext.Component to align to. If passing a component, it must\nbe a omponent instance. If a string id is passed, it will be used as an element id.
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-addManagedListener", + "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable/Element", + "optional": false, + "doc": "The item to which to add a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "(optional) If the ename parameter was an event name, this is the handler function.
(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
(optional) If the ename parameter was an event name, this is the\naddListener options.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", + "linenr": 156, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "String", - "name": "position", - "doc": "(optional, defaults to \"tl-bl?\") The position to align to (see Ext.core.Element.alignTo for more details).
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Stateful.html#Ext-state-Stateful-method-addStateEvents", + "shortDoc": "Add events that will trigger the state to be saved. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", + "private": false, + "params": [ + { + "type": "String/Array", + "optional": false, + "doc": "The event name or an array of event names.
\n", + "name": "events" + } + ], + "name": "addStateEvents", + "owner": "Ext.state.Stateful", + "doc": "Add events that will trigger the state to be saved.
\n", + "linenr": 159, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Array", - "name": "offsets", - "doc": "(optional) Offset the positioning by [x, y]
\n", - "optional": true - } - ], - "return": { - "type": "Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", - "linenr": 171, - "html_filename": "Floating.html", - "href": "Floating.html#Ext-util-Floating-method-alignTo", - "shortDoc": "Aligns this floating Component to the specified element
\n" - }, - { - "tagname": "method", - "name": "animate", - "member": "Ext.util.Animate", - "doc": "Perform custom animation on this object.
\n
This method is applicable to both the the Component class and the Element class.\nIt performs animated transitions of certain properties of this object over a specified timeline.
\nThe sole parameter is an object which specifies start property values, end property values, and properties which\ndescribe the timeline. Of the properties listed below, only to is mandatory.
Properties include
from to durationeasing \n- ease
\n- easeIn
\n- easeOut
\n- easeInOut
\n- backIn
\n- backOut
\n- elasticIn
\n- elasticOut
\n- bounceIn
\n- bounceOut
\n
keyframes listeners beforeanimate event or the afteranimate event.from, to, and keyframe objects:x y left left value. Units must be supplied.top top value. Units must be supplied.width width value. Units must be supplied.height height value. Units must be supplied.scrollLeft scrollLeft value.scrollTop scrollLeft value.opacity opacity value. This must be a value between 0 and 1.Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state\nwill result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to\ndirectly animate certain properties of Components.
\nfrom, to, and keyframe objects:x y left left value in pixels.top top value in pixels.width width value in pixels.width width value in pixels.dynamic For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:
\nmyWindow = Ext.create('Ext.window.Window', {\n title: 'Test Component animation',\n width: 500,\n height: 300,\n layout: {\n type: 'hbox',\n align: 'stretch'\n },\n items: [{\n title: 'Left: 33%',\n margins: '5 0 5 5',\n flex: 1\n }, {\n title: 'Left: 66%',\n margins: '5 5 5 5',\n flex: 2\n }]\n});\nmyWindow.show();\nmyWindow.header.el.on('click', function() {\n myWindow.animate({\n to: {\n width: (myWindow.getWidth() == 500) ? 700 : 500,\n height: (myWindow.getHeight() == 300) ? 400 : 300,\n }\n });\n});\nFor performance reasons, by default, the internal layout is only updated when the Window reaches its final \"to\" size. If dynamic updating of the Window's child\nComponents is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.
An object containing properties which describe the animation's start and end states, and the timeline of the animation.
\n", - "optional": false - } - ], - "return": { - "type": "Object", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", - "linenr": 207, - "html_filename": "Animate.html", - "href": "Animate.html#Ext-util-Animate-method-animate", - "shortDoc": "Perform custom animation on this object.\nThis method is applicable to both the the Component class and the Element cl..." - }, - { - "tagname": "method", - "name": "applyState", - "member": "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", - "params": [ - { + "html_filename": "Stateful.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-addStatics", + "shortDoc": "Add / override static properties of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "addStatics", + "owner": "Ext.Base", + "doc": "Add / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\nthis
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-addUIClsToElement", + "shortDoc": "Method which adds a specified UI + uiCls to 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 remove from the element
\n", + "name": "ui" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "force" + } + ], + "name": "addUIClsToElement", + "owner": "Ext.AbstractComponent", + "doc": "Method which adds a specified UI + uiCls to the components element.\nCan be overridden to remove the UI from more than just the components element.
\n", + "linenr": 1534, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-afterComponentLayout", + "shortDoc": " ...", + "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 the layout. Only used when isSetSize is false.
\n", + "name": "callingContainer" + } + ], + "name": "afterComponentLayout", + "owner": "Ext.AbstractComponent", + "doc": "\n", + "linenr": 2699, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Floating.html#Ext-util-Floating-method-alignTo", + "shortDoc": "Aligns this floating Component to the specified element ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", + "private": false, + "params": [ + { + "type": "Mixed", + "optional": false, + "doc": "The element or Ext.Component to align to. If passing a component, it must\nbe a omponent instance. If a string id is passed, it will be used as an element id.
\n", + "name": "element" + }, + { + "type": "String", + "optional": false, + "doc": "(optional, defaults to \"tl-bl?\") The position to align to (see Ext.core.Element.alignTo for more details).
\n", + "name": "position" + }, + { + "type": "Array", + "optional": true, + "doc": "(optional) Offset the positioning by [x, y]
\n", + "name": "offsets" + } + ], + "name": "alignTo", + "owner": "Ext.util.Floating", + "doc": "Aligns this floating Component to the specified element
\n", + "linenr": 173, + "return": { + "type": "Component", + "doc": "this
\n" + }, + "html_filename": "Floating.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Animate.html#Ext-util-Animate-method-animate", + "shortDoc": "Perform custom animation on this object. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Animate.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "An object containing properties which describe the animation's start and end states, and the timeline of the animation.
\n", + "name": "config" + } + ], + "name": "animate", + "owner": "Ext.util.Animate", + "doc": "Perform custom animation on this object.
\n
This method is applicable to both the Component class and the Element class.\nIt performs animated transitions of certain properties of this object over a specified timeline.
\nThe sole parameter is an object which specifies start property values, end property values, and properties which\ndescribe the timeline. Of the properties listed below, only to is mandatory.
Properties include
from to durationeasing \n- ease
\n- easeIn
\n- easeOut
\n- easeInOut
\n- backIn
\n- backOut
\n- elasticIn
\n- elasticOut
\n- bounceIn
\n- bounceOut
\n
keyframes listeners beforeanimate event or the afteranimate event.from, to, and keyframe objects:x y left left value. Units must be supplied.top top value. Units must be supplied.width width value. Units must be supplied.height height value. Units must be supplied.scrollLeft scrollLeft value.scrollTop scrollLeft value.opacity opacity value. This must be a value between 0 and 1.Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state\nwill result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to\ndirectly animate certain properties of Components.
\nfrom, to, and keyframe objects:x y left left value in pixels.top top value in pixels.width width value in pixels.width width value in pixels.dynamic For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:
\nmyWindow = Ext.create('Ext.window.Window', {\n title: 'Test Component animation',\n width: 500,\n height: 300,\n layout: {\n type: 'hbox',\n align: 'stretch'\n },\n items: [{\n title: 'Left: 33%',\n margins: '5 0 5 5',\n flex: 1\n }, {\n title: 'Left: 66%',\n margins: '5 5 5 5',\n flex: 2\n }]\n});\nmyWindow.show();\nmyWindow.header.el.on('click', function() {\n myWindow.animate({\n to: {\n width: (myWindow.getWidth() == 500) ? 700 : 500,\n height: (myWindow.getHeight() == 300) ? 400 : 300,\n }\n });\n});\nFor performance reasons, by default, the internal layout is only updated when the Window reaches its final \"to\" size. If dynamic updating of the Window's child\nComponents is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.
The state
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 225, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-method-applyState", - "shortDoc": "Applies the state to the object. This should be overridden in subclasses to do\nmore complex state operations. By defa..." - }, - { - "tagname": "method", - "name": "beforeComponentLayout", - "member": "Ext.AbstractComponent", - "doc": "Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout\nfrom being executed.
\n", - "params": [ - { - "type": "Number", - "name": "adjWidth", - "doc": "The box-adjusted width that was set
\n", - "optional": false + "doc": "this
\n" }, - { - "type": "Number", - "name": "adjHeight", - "doc": "The box-adjusted height that was set
\n", - "optional": false + "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" }, - { - "type": "Boolean", - "name": "isSetSize", - "doc": "Whether or not the height/width are stored on the component permanently
\n", - "optional": false + "html_filename": "Stateful.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-beforeComponentLayout", + "shortDoc": "Occurs before componentLayout is run. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "The box-adjusted width that was set
\n", + "name": "adjWidth" + }, + { + "type": "Number", + "optional": false, + "doc": "The box-adjusted height that was set
\n", + "name": "adjHeight" + }, + { + "type": "Boolean", + "optional": false, + "doc": "Whether or not the height/width are stored on the component permanently
\n", + "name": "isSetSize" + }, + { + "type": "Ext.Component", + "optional": false, + "doc": "Container requesting sent the layout. Only used when isSetSize is false.
\n", + "name": "callingContainer" + } + ], + "name": "beforeComponentLayout", + "owner": "Ext.AbstractComponent", + "doc": "Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout\nfrom being executed.
\n", + "linenr": 2709, + "return": { + "type": "void", + "doc": "\n" }, - { + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Component2.html#Ext-Component-method-bubble", + "shortDoc": "Bubbles up the component/container heirarchy, calling the specified function with each component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", + "private": false, + "params": [ + { + "type": "Function", + "optional": false, + "doc": "The function to call
\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope of the function (defaults to current node)
\n", + "name": "scope" + }, + { + "type": "Array", + "optional": true, + "doc": "(optional) The args to call the function with (default to passing the current component)
\n", + "name": "args" + } + ], + "name": "bubble", + "owner": "Ext.Component", + "doc": "Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of\nfunction call will be the scope provided or the current component. The arguments to the function\nwill be the args provided or the current component. If the function returns false at any point,\nthe bubble is stopped.
\n", + "linenr": 1007, + "return": { "type": "Ext.Component", - "name": "layoutOwner", - "doc": "Component which sent the layout. Only used when isSetSize is false.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2491, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-beforeComponentLayout", - "shortDoc": "Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout\nfrom being ex..." - }, - { - "tagname": "method", - "name": "bubble", - "member": "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", - "params": [ - { - "type": "Function", - "name": "fn", - "doc": "The function to call
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope of the function (defaults to current node)
\n", - "optional": true + "doc": "this
\n" }, - { - "type": "Array", - "name": "args", - "doc": "(optional) The args to call the function with (default to passing the current component)
\n", - "optional": true - } - ], - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 1004, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-bubble", - "shortDoc": "Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of..." - }, - { - "tagname": "method", - "name": "capture", - "member": "Ext.util.Observable", - "doc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "The Observable to capture events from.
\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "The function to call when an event is fired.
\n", - "optional": false - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.
Center this Component in its container.
\n", - "params": [ - - ], - "return": { - "type": "Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", - "linenr": 249, - "html_filename": "Floating.html", - "href": "Floating.html#Ext-util-Floating-method-center", - "shortDoc": "Center this Component in its container.
\n" - }, - { - "tagname": "method", - "name": "clearListeners", - "member": "Ext.util.Observable", - "doc": "Removes all listeners for this object including the managed listeners
\n", - "params": [ + "html_filename": "Component2.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callOverridden", + "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n constructo...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "The arguments, either an array or the arguments object
Call the original method that was previously overridden with Ext.Base.override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\nReturns the result after calling the overridden method
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-callParent", + "shortDoc": "Call the parent's overridden method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Array/Arguments", + "optional": false, + "doc": "The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
Call the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\nReturns the result from the superclass' method
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-capture", + "shortDoc": "Starts capture on the specified Observable. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable", + "optional": false, + "doc": "The Observable to capture events from.
\n", + "name": "o" + }, + { + "type": "Function", + "optional": false, + "doc": "The function to call when an event is fired.
\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to\nthe Observable firing the event.
Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event before the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", + "linenr": 54, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Floating.html#Ext-util-Floating-method-center", + "shortDoc": "Center this Component in its container. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 383, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-clearListeners", - "shortDoc": "Removes all listeners for this object including the managed listeners
\n" - }, - { - "tagname": "method", - "name": "clearManagedListeners", - "member": "Ext.util.Observable", - "doc": "Removes all managed listeners for this object.
\n", - "params": [ + ], + "name": "center", + "owner": "Ext.util.Floating", + "doc": "Center this Component in its container.
\n", + "linenr": 251, + "return": { + "type": "Component", + "doc": "this
\n" + }, + "html_filename": "Floating.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-clearListeners", + "shortDoc": "Removes all listeners for this object including the managed listeners ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 412, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", - "shortDoc": "Removes all managed listeners for this object.
\n" - }, - { - "tagname": "method", - "name": "cloneConfig", - "member": "Ext.Component", - "doc": "Clone the current component using the original config values passed into this instance by default.
\n", - "params": [ - { - "type": "Object", - "name": "overrides", - "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", - "optional": false - } - ], - "return": { - "type": "Ext.Component", - "doc": "clone The cloned copy of this component
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 944, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-cloneConfig", - "shortDoc": "Clone the current component using the original config values passed into this instance by default.
\n" - }, - { - "tagname": "method", - "name": "destroy", - "member": "Ext.AbstractComponent", - "doc": "Destroys the Component.
\n", - "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": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2672, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-destroy", - "shortDoc": "Destroys the Component.
\n" - }, - { - "tagname": "method", - "name": "disable", - "member": "Ext.AbstractComponent", - "doc": "Disable the component.
\n", - "params": [ - { - "type": "Boolean", - "name": "silent", - "doc": "Passing true, will supress the 'disable' event from being fired.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2078, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-disable", - "shortDoc": "Disable the component.
\n" - }, - { - "tagname": "method", - "name": "doAutoRender", - "member": "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", - "params": [ + ], + "name": "clearManagedListeners", + "owner": "Ext.util.Observable", + "doc": "Removes all managed listeners for this object.
\n", + "linenr": 454, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Component2.html#Ext-Component-method-cloneConfig", + "shortDoc": "Clone the current component using the original config values passed into this instance by default. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "A new config containing any properties to override in the cloned version.\nAn id property can be passed on this object, otherwise one will be generated to avoid duplicates.
\n", + "name": "overrides" + } + ], + "name": "cloneConfig", + "owner": "Ext.Component", + "doc": "Clone the current component using the original config values passed into this instance by default.
\n", + "linenr": 947, + "return": { + "type": "Ext.Component", + "doc": "clone The cloned copy of this component
\n" + }, + "html_filename": "Component2.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-create", + "shortDoc": "Create a new instance of this Class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 816, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-doAutoRender", - "shortDoc": "Handles autoRender.\nFloating Components may have an ownerCt. If they are asking to be constrained, constrain them wit..." - }, - { - "tagname": "method", - "name": "doComponentLayout", - "member": "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", - "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", - "name": "width", - "doc": "\n", - "optional": false + "doc": "the created instance.
\n" }, - { - "type": "Object", - "name": "height", - "doc": "\n", - "optional": false + "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" }, - { - "type": "Object", - "name": "ownerCt", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Ext.container.Container", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2437, - "html_filename": "AbstractComponent.html", - "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..." - }, - { - "tagname": "method", - "name": "doConstrain", - "member": "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", - "params": [ - { - "type": "Mixed", - "name": "constrainTo", - "doc": "Optional. The Element or Region into which this Component is to be constrained.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", - "linenr": 133, - "html_filename": "Floating.html", - "href": "Floating.html#Ext-util-Floating-method-doConstrain", - "shortDoc": "Moves this floating Component into a constrain region.\n\n\nBy default, this Component is constrained to be within the c..." - }, - { - "tagname": "method", - "name": "enable", - "member": "Ext.AbstractComponent", - "doc": "Enable the component
\n", - "params": [ - { - "type": "Boolean", - "name": "silent", - "doc": "Passing false will supress the 'enable' event from being fired.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2055, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-enable", - "shortDoc": "Enable the component
\n" - }, - { - "tagname": "method", - "name": "enableBubble", - "member": "Ext.util.Observable", - "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.
\n\n\nExample:
\n\n\nExt.override(Ext.form.field.Base, {\n// Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : 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.\ngetBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n ...\n}],\nlisteners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n}\n});\nThe event name to bubble, or an Array of event names.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 554, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-enableBubble", - "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...." - }, - { - "tagname": "method", - "name": "findLayoutController", - "member": "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", - "params": [ + "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": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 772, - "html_filename": "AbstractComponent.html", - "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..." - }, - { - "tagname": "method", - "name": "findParentBy", - "member": "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", - "params": [ - { - "type": "Function", - "name": "fn", - "doc": "The custom function to call with the arguments (container, this component).
\n", - "optional": false - } - ], - "return": { - "type": "Ext.container.Container", - "doc": "The first Container for which the custom function returns true
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 975, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-findParentBy", - "shortDoc": "Find a container above this component at any level by a custom function. If the passed function returns\ntrue, the con..." - }, - { - "tagname": "method", - "name": "findParentByType", - "member": "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", - "params": [ - { - "type": "String/Class", - "name": "xtype", - "doc": "The xtype string for a component, or the class of the component directly
\n", - "optional": false - } - ], - "return": { - "type": "Ext.container.Container", - "doc": "The first Container which matches the given xtype or class
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 989, - "html_filename": "Component.html", - "href": "Component.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.
\n\n" - }, - { - "tagname": "method", - "name": "fireEvent", - "member": "Ext.util.Observable", - "doc": "Fires the specified event with the passed parameters (minus the event name).
\n\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.
\n\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to fire.
\n", - "optional": false - }, - { - "type": "Object...", - "name": "args", - "doc": "Variable number of parameters are passed to handlers.
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 232, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-fireEvent", - "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..." - }, - { - "tagname": "method", - "name": "focus", - "member": "Ext.Component", - "doc": "Try to focus this component.
\n", - "params": [ - { - "type": "Boolean", - "name": "selectText", - "doc": "(optional) If applicable, true to also select the text in this component
\n", - "optional": true - }, - { - "type": "Boolean/Number", - "name": "delay", - "doc": "(optional) Delay the focus this number of milliseconds (true for 10 milliseconds).
\n", - "optional": true - } - ], - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 853, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-focus", - "shortDoc": "Try to focus this component.
\n" - }, - { - "tagname": "method", - "name": "getActiveAnimation", - "member": "Ext.util.Animate", - "doc": "Returns thq current animation if this object has any effects actively running or queued, else returns false.
\n", - "params": [ + ], + "name": "doAutoRender", + "owner": "Ext.AbstractComponent", + "doc": "Handles autoRender.\nFloating Components may have an ownerCt. If they are asking to be constrained, constrain them within that\nownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body
\n", + "linenr": 920, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-doComponentLayout", + "shortDoc": "This method needs to be called whenever you change something on this component that requires the Component's\nlayout t...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "width" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "height" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "isSetSize" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "callingContainer" + } + ], + "name": "doComponentLayout", + "owner": "Ext.AbstractComponent", + "doc": "This method needs to be called whenever you change something on this component that requires the Component's\nlayout to be recalculated.
\n", + "linenr": 2630, + "return": { + "type": "Ext.container.Container", + "doc": "this
\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Floating.html#Ext-util-Floating-method-doConstrain", + "shortDoc": "Moves this floating Component into a constrain region. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", + "private": false, + "params": [ + { + "type": "Mixed", + "optional": false, + "doc": "Optional. The Element or Region into which this Component is to be constrained.
\n", + "name": "constrainTo" + } + ], + "name": "doConstrain", + "owner": "Ext.util.Floating", + "doc": "Moves this floating Component into a constrain region.
\n\n\nBy default, this Component is constrained to be within the container it was added to, or the element\nit was rendered to.
\n\n\nAn alternative constraint may be passed.
\n\n", + "linenr": 135, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Floating.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-enable", + "shortDoc": "Enable the component ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Boolean", + "optional": false, + "doc": "Passing false will supress the 'enable' event from being fired.
\n", + "name": "silent" + } + ], + "name": "enable", + "owner": "Ext.AbstractComponent", + "doc": "Enable the component
\n", + "linenr": 2222, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-enableBubble", + "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String/[String]", + "optional": false, + "doc": "The event name to bubble, or an Array of event names.
\n", + "name": "events" + } + ], + "name": "enableBubble", + "owner": "Ext.util.Observable", + "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\nanim if element has active effects, else false
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", - "linenr": 377, - "html_filename": "Animate.html", - "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.
\n" - }, - { - "tagname": "method", - "name": "getBox", - "member": "Ext.Component", - "doc": "Gets the current box measurements of the component's underlying element.
\n", - "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", - "name": "local", - "doc": "(optional) If true the element's left and top are returned instead of page XY (defaults to false)
\n", - "optional": true - } - ], - "return": { - "type": "Object", - "doc": "box An object in the format {x, y, width, height}
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 538, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-getBox", - "shortDoc": "Gets the current box measurements of the component's underlying element.
\n" - }, - { - "tagname": "method", - "name": "getBubbleTarget", - "member": "Ext.AbstractComponent", - "doc": "Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.
\n", - "params": [ - - ], - "return": { - "type": "Ext.container.Container", - "doc": "the Container which owns this Component.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2276, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getBubbleTarget", - "shortDoc": "Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.
\n" - }, - { - "tagname": "method", - "name": "getEl", - "member": "Ext.AbstractComponent", - "doc": "Retrieves the top level element representing this component.
\n", - "params": [ - - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1892, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getEl", - "shortDoc": "Retrieves the top level element representing this component.
\n" - }, - { - "tagname": "method", - "name": "getHeight", - "member": "Ext.AbstractComponent", - "doc": "Gets the current height of the component's underlying element.
\n", - "params": [ - - ], - "return": { - "type": "Number", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2579, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getHeight", - "shortDoc": "Gets the current height of the component's underlying element.
\n" - }, - { - "tagname": "method", - "name": "getId", - "member": "Ext.AbstractComponent", - "doc": "Retrieves the id of this component.\nWill autogenerate an id if one has not already been set.
\n", - "params": [ + "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": [ - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1880, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getId", - "shortDoc": "Retrieves the id of this component.\nWill autogenerate an id if one has not already been set.
\n" - }, - { - "tagname": "method", - "name": "getInsertPosition", - "member": "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", - "params": [ - { - "type": "String/Number/Element/HTMLElement", - "name": "position", - "doc": "Index, element id or element you want\nto put this component before.
\n", - "optional": false - } - ], - "return": { - "type": "HTMLElement", - "doc": "DOM element that you can use in the insertBefore
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1513, - "html_filename": "AbstractComponent.html", - "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..." - }, - { - "tagname": "method", - "name": "getLoader", - "member": "Ext.AbstractComponent", - "doc": "Gets the Ext.ComponentLoader for this Component.
\n", - "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": [ - ], - "return": { - "type": "Ext.ComponentLoader", - "doc": "The loader instance, null if it doesn't exist.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2587, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getLoader", - "shortDoc": "Gets the Ext.ComponentLoader for this Component.
\n" - }, - { - "tagname": "method", - "name": "getPlugin", - "member": "Ext.AbstractComponent", - "doc": "Retrieves a plugin by its pluginId which has been bound to this\ncomponent.
\n", - "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", - "name": "pluginId", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Ext.AbstractPlugin", - "doc": "pluginInstance
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2715, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getPlugin", - "shortDoc": "Retrieves a plugin by its pluginId which has been bound to this\ncomponent.
\n" - }, - { - "tagname": "method", - "name": "getPosition", - "member": "Ext.Component", - "doc": "Gets the current XY position of the component's underlying element.
\n", - "params": [ - { - "type": "Boolean", - "name": "local", - "doc": "(optional) If true the element's left and top are returned instead of page XY (defaults to false)
\n", - "optional": true - } - ], - "return": { - "type": "Array", - "doc": "The XY position of the element (e.g., [100, 200])
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 603, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-getPosition", - "shortDoc": "Gets the current XY position of the component's underlying element.
\n" - }, - { - "tagname": "method", - "name": "getSize", - "member": "Ext.AbstractComponent", - "doc": "Gets the current size of the component's underlying element.
\n", - "params": [ - - ], - "return": { - "type": "Object", - "doc": "An object containing the element's size {width: (element width), height: (element height)}
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2563, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getSize", - "shortDoc": "Gets the current size of the component's underlying element.
\n" - }, - { - "tagname": "method", - "name": "getState", - "member": "Ext.state.Stateful", - "doc": "Gets the current state of the object. By default this function returns null,\nit should be overridden in subclasses to implement methods for getting the state.
\n", - "params": [ + "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": [ - ], - "return": { - "type": "Object", - "doc": "The current state
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 216, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-method-getState", - "shortDoc": "Gets the current state of the object. By default this function returns null,\nit should be overridden in subclasses to..." - }, - { - "tagname": "method", - "name": "getStateId", - "member": "Ext.state.Stateful", - "doc": "Gets the state id for this object.
\n", - "params": [ + ], + "name": "getBubbleTarget", + "owner": "Ext.AbstractComponent", + "doc": "Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.
\n", + "linenr": 2443, + "return": { + "type": "Ext.container.Container", + "doc": "the Container which owns this Component.
\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getEl", + "shortDoc": "Retrieves the top level element representing this component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ - ], - "return": { - "type": "String", - "doc": "The state id, null if not found.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 237, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-method-getStateId", - "shortDoc": "Gets the state id for this object.
\n" - }, - { - "tagname": "method", - "name": "getWidth", - "member": "Ext.AbstractComponent", - "doc": "Gets the current width of the component's underlying element.
\n", - "params": [ + ], + "name": "getEl", + "owner": "Ext.AbstractComponent", + "doc": "Retrieves the top level element representing this component.
\n", + "linenr": 2059, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getHeight", + "shortDoc": "Gets the current height of the component's underlying element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ - ], - "return": { - "type": "Number", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2571, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getWidth", - "shortDoc": "Gets the current width of the component's underlying element.
\n" - }, - { - "tagname": "method", - "name": "getXType", - "member": "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'\nGets 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": [ - ], - "return": { - "type": "String", - "doc": "The xtype
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 962, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-getXType", - "shortDoc": "Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all\navailable xtypes, see th..." - }, - { - "tagname": "method", - "name": "getXTypes", - "member": "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'\nRetrieves the id of this component.\nWill autogenerate an id if one has not already been set.
\n", + "linenr": 2047, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getInsertPosition", + "shortDoc": "This function takes the position argument passed to onRender and returns a\nDOM element that you can use in the insert...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "String/Number/Element/HTMLElement", + "optional": false, + "doc": "Index, element id or element you want\nto put this component before.
\n", + "name": "position" + } + ], + "name": "getInsertPosition", + "owner": "Ext.AbstractComponent", + "doc": "This function takes the position argument passed to onRender and returns a\nDOM element that you can use in the insertBefore.
\n", + "linenr": 1674, + "return": { + "type": "HTMLElement", + "doc": "DOM element that you can use in the insertBefore
\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getLoader", + "shortDoc": "Gets the Ext.ComponentLoader for this Component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ - ], - "return": { - "type": "String", - "doc": "The xtype hierarchy string
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1938, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-getXTypes", - "shortDoc": "Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all\navailable xtypes, see the Ext..." - }, - { - "tagname": "method", - "name": "hasActiveFx", - "member": "Ext.util.Animate", - "doc": "@deprecated 4.0 Replaced by getActiveAnimation\nReturns thq current animation if this object has any effects actively running or queued, else returns false.
\n", - "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": [ - ], - "return": { - "type": "Mixed", - "doc": "anim if element has active effects, else false
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", - "linenr": 369, - "html_filename": "Animate.html", - "href": "Animate.html#Ext-util-Animate-method-hasActiveFx", - "shortDoc": "@deprecated 4.0 Replaced by getActiveAnimation\nReturns thq current animation if this object has any effects actively ..." - }, - { - "tagname": "method", - "name": "hasListener", - "member": "Ext.util.Observable", - "doc": "Checks to see if this object has any listeners for a specified event
\n", - "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'\nThe name of the event to check for
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "True if the event is being listened for, else false
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 480, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-hasListener", - "shortDoc": "Checks to see if this object has any listeners for a specified event
\n" - }, - { - "tagname": "method", - "name": "hasUICls", - "member": "Ext.AbstractComponent", - "doc": "Checks if there is currently a specified uiCls
\n", - "params": [ - { - "type": "String", - "name": "cls", - "doc": "The cls to check
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1389, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-hasUICls", - "shortDoc": "Checks if there is currently a specified uiCls
\n" - }, - { - "tagname": "method", - "name": "hide", - "member": "Ext.Component", - "doc": "Hides this Component, setting it to invisible using the configured hideMode.
\n", - "params": [ - { - "type": "String/Element/Component", - "name": "animateTarget", - "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", - "optional": true - }, - { + "doc": "className
\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", - "name": "scope", - "doc": "(optional) The scope (this reference) in which the callback is executed. Defaults to this Component.
this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 748, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-hide", - "shortDoc": "Hides this Component, setting it to invisible using the configured hideMode.
\n" - }, - { - "tagname": "method", - "name": "is", - "member": "Ext.AbstractComponent", - "doc": "Tests whether this Component matches the selector string.
\n", - "params": [ - { - "type": "String", - "name": "selector", - "doc": "The selector string to test against.
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "True if this Component matches the selector.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1719, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-is", - "shortDoc": "Tests whether this Component matches the selector string.
\n" - }, - { - "tagname": "method", - "name": "isDescendantOf", - "member": "Ext.AbstractComponent", - "doc": "Determines whether this component is the descendant of a particular container.
\n", - "params": [ - { - "type": "Ext.Container", - "name": "container", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "isDescendant
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2731, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDescendantOf", - "shortDoc": "Determines whether this component is the descendant of a particular container.
\n" - }, - { - "tagname": "method", - "name": "isDisabled", - "member": "Ext.AbstractComponent", - "doc": "Method to determine whether this Component is currently disabled.
\n", - "params": [ + "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": [ - ], - "return": { - "type": "Boolean", - "doc": "the disabled state of this Component.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2115, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDisabled", - "shortDoc": "Method to determine whether this Component is currently disabled.
\n" - }, - { - "tagname": "method", - "name": "isDraggable", - "member": "Ext.AbstractComponent", - "doc": "Method to determine whether this Component is draggable.
\n", - "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": [ - ], - "return": { - "type": "Boolean", - "doc": "the draggable state of this component.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2292, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDraggable", - "shortDoc": "Method to determine whether this Component is draggable.
\n" - }, - { - "tagname": "method", - "name": "isDroppable", - "member": "Ext.AbstractComponent", - "doc": "Method to determine whether this Component is droppable.
\n", - "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": [ - ], - "return": { - "type": "Boolean", - "doc": "the droppable state of this component.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2300, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isDroppable", - "shortDoc": "Method to determine whether this Component is droppable.
\n" - }, - { - "tagname": "method", - "name": "isFloating", - "member": "Ext.AbstractComponent", - "doc": "Method to determine whether this Component is floating.
\n", - "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": [ - ], - "return": { - "type": "Boolean", - "doc": "the floating state of this component.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2284, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isFloating", - "shortDoc": "Method to determine whether this Component is floating.
\n" - }, - { - "tagname": "method", - "name": "isHidden", - "member": "Ext.AbstractComponent", - "doc": "Method to determine whether this Component is currently set to hidden.
\n", - "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": [ - ], - "return": { - "type": "Boolean", - "doc": "the hidden state of this Component.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2131, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isHidden", - "shortDoc": "Method to determine whether this Component is currently set to hidden.
\n" - }, - { - "tagname": "method", - "name": "isVisible", - "member": "Ext.AbstractComponent", - "doc": "Returns true if this component is visible.
\n", - "params": [ - { - "type": "Boolean", - "name": "deep", - "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", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "True if this component is visible, false otherwise.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2015, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isVisible", - "shortDoc": "Returns true if this component is visible.
\n" - }, - { - "tagname": "method", - "name": "isXType", - "member": "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\nReturns 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 to check for this Component
\n", - "optional": false + "doc": "The xtype hierarchy string
\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": { + "version": "4.0", + "text": "Replaced by getActiveAnimation
\n\n\n\n", + "tagname": "deprecated", + "doc": "Returns thq current animation if this object has any effects actively running or queued, else returns false." + }, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Animate.html#Ext-util-Animate-method-hasActiveFx", + "shortDoc": "Returns thq current animation if this object has any effects actively running or queued, else returns false. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Animate.js", + "private": false, + "params": [ + + ], + "name": "hasActiveFx", + "owner": "Ext.util.Animate", + "doc": "Returns thq current animation if this object has any effects actively running or queued, else returns false.
\n", + "linenr": 369, + "return": { + "type": "Mixed", + "doc": "anim if element has active effects, else false
\n" }, - { + "html_filename": "Animate.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-hasListener", + "shortDoc": "Checks to see if this object has any listeners for a specified event ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The name of the event to check for
\n", + "name": "eventName" + } + ], + "name": "hasListener", + "owner": "Ext.util.Observable", + "doc": "Checks to see if this object has any listeners for a specified event
\n", + "linenr": 530, + "return": { "type": "Boolean", - "name": "shallow", - "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", - "optional": true - } - ], - "return": { - "type": "Boolean", - "doc": "True if this component descends from the specified xtype, false otherwise.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1907, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-isXType", - "shortDoc": "Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended\nfrom th..." - }, - { - "tagname": "method", - "name": "nextNode", - "member": "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 pnextSibling.
\n\n", - "params": [ - { - "type": "String", - "name": "selector", - "doc": "Optional A ComponentQuery selector to filter the following nodes.
\n", - "optional": false + "doc": "True if the event is being listened for, else false
\n" }, - { - "type": "Object", - "name": "includeSelf", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "The next node (or the next node which matches the selector). Returns null if there is no matching node.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1845, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-nextNode", - "shortDoc": "Returns the next node in the Component tree in tree traversal order.\n\n\nNote that this is not limited to siblings, and..." - }, - { - "tagname": "method", - "name": "nextSibling", - "member": "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
Optional A ComponentQuery selector to filter the following items.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1749, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-nextSibling", - "shortDoc": "Returns the next sibling of this Component.\n\n\nOptionally selects the next sibling which matches the passed ComponentQ..." - }, - { - "tagname": "method", - "name": "observe", - "member": "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 class constructor to make observable.
\n", - "optional": false - }, - { - "type": "Object", - "name": "listeners", - "doc": "An object containing a series of listeners to add. See addListener.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 69, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-observe", - "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..." - }, - { - "tagname": "method", - "name": "on", - "member": "Ext.util.Observable", - "doc": "Appends an event handler to this object (shorthand for addListener.)
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event to listen for
\n", - "optional": false + "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" }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes
\n", - "optional": false + "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" }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
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'\n(optional) An object containing handler configuration.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 616, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-on", - "shortDoc": "Appends an event handler to this object (shorthand for addListener.)
\n" - }, - { - "tagname": "method", - "name": "previousNode", - "member": "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", - "params": [ - { - "type": "String", - "name": "selector", - "doc": "Optional. A ComponentQuery selector to filter the preceding nodes.
\n", - "optional": false + "doc": "mixins The mixin prototypes as key - value pairs
\n" }, - { - "type": "Object", - "name": "includeSelf", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "The previous node (or the previous node which matches the selector). Returns null if there is no matching node.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1809, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-previousNode", - "shortDoc": "Returns the previous node in the Component tree in tree traversal order.\n\n\nNote that this is not limited to siblings,..." - }, - { - "tagname": "method", - "name": "previousSibling", - "member": "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
Optional. A ComponentQuery selector to filter the preceding items.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1779, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-previousSibling", - "shortDoc": "Returns the previous sibling of this Component.\n\n\nOptionally selects the previous sibling which matches the passed Co..." - }, - { - "tagname": "method", - "name": "relayEvents", - "member": "Ext.util.Observable", - "doc": "Relays selected events from the specified Observable as if the events were fired by this.
The Observable whose events this object is to relay.
\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-is", + "shortDoc": "Tests whether this Component matches the selector string. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The selector string to test against.
\n", + "name": "selector" + } + ], + "name": "is", + "owner": "Ext.AbstractComponent", + "doc": "Tests whether this Component matches the selector string.
\n", + "linenr": 1886, + "return": { + "type": "Boolean", + "doc": "True if this Component matches the selector.
\n" }, - { - "type": "Array", - "name": "events", - "doc": "Array of event names to relay.
\n", - "optional": false + "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" }, - { - "type": "Object", - "name": "prefix", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 520, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-relayEvents", - "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this.
Removes all added captures from the Observable.
\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "The Observable to release
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": true, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 46, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-releaseCapture", - "shortDoc": "Removes all added captures from the Observable.
\n" - }, - { - "tagname": "method", - "name": "removeCls", - "member": "Ext.AbstractComponent", - "doc": "Removes a CSS class from the top level element representing this component.
\n", - "params": [ - { - "type": "Object", - "name": "className", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Ext.Component", - "doc": "Returns the Component to allow method chaining.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2171, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-removeCls", - "shortDoc": "Removes a CSS class from the top level element representing this component.
\n" - }, - { - "tagname": "method", - "name": "removeClsWithUI", - "member": "Ext.AbstractComponent", - "doc": "Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes\nit from all elements of this component.
\n", - "params": [ - { - "type": "String/Array", - "name": "cls", - "doc": "A string or an array of strings to remove to the uiCls
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1368, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-removeClsWithUI", - "shortDoc": "Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes\nit from all elements of this ..." - }, - { - "tagname": "method", - "name": "removeListener", - "member": "Ext.util.Observable", - "doc": "Removes an event handler.
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event the handler was associated with.
\n", - "optional": false + "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" }, - { - "type": "Function", - "name": "handler", - "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", - "optional": false + "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" }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope originally specified for the handler.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 352, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-removeListener", - "shortDoc": "Removes an event handler.
\n" - }, - { - "tagname": "method", - "name": "removeManagedListener", - "member": "Ext.util.Observable", - "doc": "Removes listeners that were added by the mon method.
\n", - "params": [ - { - "type": "Observable|Element", - "name": "item", - "doc": "The item from which to remove a listener/listeners.
\n", - "optional": false - }, - { - "type": "Object|String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\n", - "optional": false - }, - { - "type": "Function", - "name": "fn", - "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
Removes listeners that were added by the mon method.
\n" - }, - { - "tagname": "method", - "name": "resumeEvents", - "member": "Ext.util.Observable", - "doc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during 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", - "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": [ - ], - "return": { - "type": "Object", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", - "linenr": 357, - "html_filename": "Animate.html", - "href": "Animate.html#Ext-util-Animate-method-sequenceFx", - "shortDoc": "Ensures that all effects queued after sequenceFx is called on this object are\nrun in sequence. This is the opposite ..." - }, - { - "tagname": "method", - "name": "setActive", - "member": "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", - "params": [ - { + ], + "name": "isFloating", + "owner": "Ext.AbstractComponent", + "doc": "Method to determine whether this Component is floating.
\n", + "linenr": 2451, + "return": { "type": "Boolean", - "name": "active", - "doc": "True to activate the Component, false to deactivate it (defaults to false)
\n", - "optional": false + "doc": "the floating state of this component.
\n" }, - { - "type": "Component", - "name": "newActive", - "doc": "The newly active Component which is taking over topmost zIndex position.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", - "linenr": 216, - "html_filename": "Floating.html", - "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..." - }, - { - "tagname": "method", - "name": "setAutoScroll", - "member": "Ext.Component", - "doc": "Sets the overflow on the content element of the component.
\n", - "params": [ - { + "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", - "name": "scroll", - "doc": "True to allow the Component to auto scroll.
\n", - "optional": false - } - ], - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 359, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-setAutoScroll", - "shortDoc": "Sets the overflow on the content element of the component.
\n" - }, - { - "tagname": "method", - "name": "setDisabled", - "member": "Ext.AbstractComponent", - "doc": "Enable or disable the component.
\n", - "params": [ - { + "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", - "name": "disabled", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2123, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setDisabled", - "shortDoc": "Enable or disable the component.
\n" - }, - { - "tagname": "method", - "name": "setDocked", - "member": "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", - "params": [ - { - "type": "Object", - "name": "dock", - "doc": "\n", - "optional": false + "doc": "True if this component is visible, false otherwise.
\n" }, - { - "type": "Object", - "name": "layoutParent", - "doc": "\n", - "optional": false - } - ], - "return": { - "type": "Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2646, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setDocked", - "shortDoc": "Sets the dock position of this component in its parent panel. Note that\nthis only has effect if this item is part of ..." - }, - { - "tagname": "method", - "name": "setHeight", - "member": "Ext.AbstractComponent", - "doc": "Sets the height of the component. This method fires the resize event.
\n", - "params": [ - { - "type": "Number", - "name": "height", - "doc": "The new height to set. This may be one of:
this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2550, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setHeight", - "shortDoc": "Sets the height of the component. This method fires the resize event.
\n" - }, - { - "tagname": "method", - "name": "setLoading", - "member": "Ext.AbstractComponent", - "doc": "This method allows you to show or hide a LoadMask on top of this component.
\n", - "params": [ - { - "type": "Boolean/Object/String", - "name": "load", - "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", - "optional": false - }, - { + "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 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", - "optional": false - } - ], - "return": { - "type": "Ext.LoadMask", - "doc": "The LoadMask instance that has just been shown.
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2611, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setLoading", - "shortDoc": "This method allows you to show or hide a LoadMask on top of this component.
\n" - }, - { - "tagname": "method", - "name": "setPagePosition", - "member": "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", - "params": [ - { - "type": "Number", - "name": "x", - "doc": "The new x position
\n", - "optional": false + "doc": "True if this component descends from the specified xtype, false otherwise.
\n" }, - { - "type": "Number", - "name": "y", - "doc": "The new y position
\n", - "optional": false + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addManagedListener" }, - { - "type": "Mixed", - "name": "animate", - "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", - "optional": false - } - ], - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 501, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-setPagePosition", - "shortDoc": "Sets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the ..." - }, - { - "tagname": "method", - "name": "setPosition", - "member": "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", - "params": [ - { - "type": "Number", - "name": "left", - "doc": "The new left
\n", - "optional": false + "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" }, - { - "type": "Number", - "name": "top", - "doc": "The new top
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeManagedListener" }, - { - "type": "Mixed", - "name": "animate", - "doc": "If true, the Component is animated into its new position. You may also pass an animation configuration.
\n", - "optional": false - } - ], - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 417, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-setPosition", - "shortDoc": "Sets the left and top of the component. To set the page XY position instead, use setPagePosition.\nThis method fires ..." - }, - { - "tagname": "method", - "name": "setSize", - "member": "Ext.AbstractComponent", - "doc": "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}.
The new width to set. This may be one of:
{width: widthValue, height: heightValue}.undefined to leave the width unchanged.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" }, - { - "type": "Mixed", - "name": "height", - "doc": "The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
undefined to leave the height unchanged.this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2340, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setSize", - "shortDoc": "Sets the width and height of this Component. This method fires the resize event. This method can accept\neither width ..." - }, - { - "tagname": "method", - "name": "setUI", - "member": "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", - "params": [ - { - "type": "String", - "name": "ui", - "doc": "The new UI for the component
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1309, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setUI", - "shortDoc": "Sets the UI for the component. This will remove any existing UIs on the component. It will also\nloop through any uiCl..." - }, - { - "tagname": "method", - "name": "setVisible", - "member": "Ext.AbstractComponent", - "doc": "Convenience function to hide or show this component by boolean.
\n", - "params": [ - { - "type": "Boolean", - "name": "visible", - "doc": "True to show, false to hide
\n", - "optional": false - } - ], - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2006, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setVisible", - "shortDoc": "Convenience function to hide or show this component by boolean.
\n" - }, - { - "tagname": "method", - "name": "setWidth", - "member": "Ext.AbstractComponent", - "doc": "Sets the width of the component. This method fires the resize event.
\n", - "params": [ - { - "type": "Number", - "name": "width", - "doc": "The new width to setThis may be one of:
this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 2538, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-setWidth", - "shortDoc": "Sets the width of the component. This method fires the resize event.
\n" - }, - { - "tagname": "method", - "name": "show", - "member": "Ext.Component", - "doc": "Shows this Component, rendering it first if autoRender or {"floating are true.
After being shown, a floating Component (such as a Ext.window.Window), is activated it and brought to the front of\nits z-index stack.
\n\n", - "params": [ - { - "type": "String/Element", - "name": "animateTarget", - "doc": "Optional, and only valid for floating Components such as\nWindows or ToolTips, or regular Components which have been configured\nwith floating: true. The target from which the Component should\nanimate from while opening (defaults to null with no animation)
(optional) A callback function to call after the Component is displayed. Only necessary if animation was specified.
\n", - "optional": true - }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this reference) in which the callback is executed. Defaults to this Component.
this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 645, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-show", - "shortDoc": "Shows this Component, rendering it first if autoRender or {"floating are true.\n\n\nAfter being shown, a floating C..." - }, - { - "tagname": "method", - "name": "stopAnimation", - "member": "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", - "params": [ - - ], - "return": { - "type": "Ext.core.Element", - "doc": "The Element
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", - "linenr": 335, - "html_filename": "Animate.html", - "href": "Animate.html#Ext-util-Animate-method-stopAnimation", - "shortDoc": "Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that ..." - }, - { - "tagname": "method", - "name": "stopFx", - "member": "Ext.util.Animate", - "doc": "@deprecated 4.0 Replaced by stopAnimation\nStops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\n", - "params": [ - - ], - "return": { - "type": "Ext.core.Element", - "doc": "The Element
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", - "linenr": 326, - "html_filename": "Animate.html", - "href": "Animate.html#Ext-util-Animate-method-stopFx", - "shortDoc": "@deprecated 4.0 Replaced by stopAnimation\nStops any running effects and clears this object's internal effects queue i..." - }, - { - "tagname": "method", - "name": "suspendEvents", - "member": "Ext.util.Observable", - "doc": "Suspend the firing of all events. (see resumeEvents)
\n", - "params": [ - { - "type": "Boolean", - "name": "queueSuspended", - "doc": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 490, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-suspendEvents", - "shortDoc": "Suspend the firing of all events. (see resumeEvents)
\n" - }, - { - "tagname": "method", - "name": "syncFx", - "member": "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", - "params": [ - - ], - "return": { - "type": "Object", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Animate.js", - "linenr": 345, - "html_filename": "Animate.html", - "href": "Animate.html#Ext-util-Animate-method-syncFx", - "shortDoc": "Ensures that all effects queued after syncFx is called on this object are\nrun concurrently. This is the opposite of ..." - }, - { - "tagname": "method", - "name": "toBack", - "member": "Ext.util.Floating", - "doc": "Sends this Component to the back of (lower z-index than) any other visible windows
\n", - "params": [ - - ], - "return": { - "type": "Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", - "linenr": 240, - "html_filename": "Floating.html", - "href": "Floating.html#Ext-util-Floating-method-toBack", - "shortDoc": "Sends this Component to the back of (lower z-index than) any other visible windows
\n" - }, - { - "tagname": "method", - "name": "toFront", - "member": "Ext.util.Floating", - "doc": "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", - "params": [ - { - "type": "Boolean", - "name": "preventFocus", - "doc": "(optional) Specify true to prevent the Component from being focused.
this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", - "linenr": 188, - "html_filename": "Floating.html", - "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..." - }, - { - "tagname": "method", - "name": "un", - "member": "Ext.util.Observable", - "doc": "Removes an event handler (shorthand for removeListener.)
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event the handler was associated with.
\n", - "optional": false + "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" }, - { - "type": "Function", - "name": "handler", - "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", - "optional": false + "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" }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope originally specified for the handler.
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", - "linenr": 608, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-un", - "shortDoc": "Removes an event handler (shorthand for removeListener.)
\n" - }, - { - "tagname": "method", - "name": "up", - "member": "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');\nOptional. The simple selector to test.
\n", - "optional": false - } - ], - "return": { - "type": "Container", - "doc": "The matching ancestor Container (or undefined if no match was found).
Update the content area of a component.
\n", - "params": [ - { - "type": "Mixed", - "name": "htmlOrData", - "doc": "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", - "optional": false + "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});\n(optional) Only legitimate when using the html configuration. Defaults to false
\n", - "optional": true - }, - { - "type": "Function", - "name": "callback", - "doc": "(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
\n", - "optional": true - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 1974, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-method-update", - "shortDoc": "Update the content area of a component.
\n" - }, - { - "tagname": "method", - "name": "updateBox", - "member": "Ext.Component", - "doc": "Sets the current box measurements of the component's underlying element.
\n", - "params": [ - { - "type": "Object", - "name": "box", - "doc": "An object in the format {x, y, width, height}
\n", - "optional": false - } - ], - "return": { - "type": "Ext.Component", - "doc": "this
\n" - }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 551, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-method-updateBox", - "shortDoc": "Sets the current box measurements of the component's underlying element.
\n" - } - ], - "property": [ - { - "tagname": "property", - "name": "draggable", - "member": "Ext.AbstractComponent", - "type": "Boolean", - "doc": "Read-only property indicating whether or not the component can be dragged
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 374, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-property-draggable" - }, - { - "tagname": "property", - "name": "floatParent", - "member": "Ext.Component", - "type": "Ext.Container", - "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", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 221, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-property-floatParent", - "shortDoc": "Optional. Only present for floating Components which were inserted as descendant items of floating Containers.\n\n\nFloa..." - }, - { - "tagname": "property", - "name": "frameSize", - "member": "Ext.AbstractComponent", - "type": "Object", - "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\ntop The width of the top framing element in pixels.right The width of the right framing element in pixels.bottom The width of the bottom framing element in pixels.left The width of the left framing element in pixels.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", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 513, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-property-maskOnDisable", - "shortDoc": "This is an internal flag that you use when creating custom components.\nBy default this is set to true which means tha..." - }, - { - "tagname": "property", - "name": "ownerCt", - "member": "Ext.AbstractComponent", - "type": "Ext.Container", - "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", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 101, - "html_filename": "AbstractComponent.html", - "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..." - }, - { - "tagname": "property", - "name": "rendered", - "member": "Ext.AbstractComponent", - "type": "Boolean", - "doc": "Read-only property indicating whether or not the component has been rendered.
\n", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 500, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-property-rendered" - }, - { - "tagname": "property", - "name": "zIndexManager", - "member": "Ext.Component", - "type": "Ext.ZIndexManager", - "doc": "Optional. 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", - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", - "linenr": 206, - "html_filename": "Component.html", - "href": "Component.html#Ext-Component-property-zIndexManager", - "shortDoc": "Optional. Only present for floating Components after they have been rendered.\n\n\nA reference to the ZIndexManager whic..." - } - ], - "event": [ - { - "tagname": "event", - "name": "activate", - "member": "Ext.AbstractComponent", - "doc": "Fires after a Component has been visually activated.
\n", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 540, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-activate", - "shortDoc": "Fires after a Component has been visually activated.
\n" - }, - { - "tagname": "event", - "name": "added", - "member": "Ext.AbstractComponent", - "doc": "Fires after a Component had been added to a Container.
\n", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addListener" }, - { - "type": "Ext.container.Container", - "name": "container", - "doc": "Parent Container
\n", - "optional": false + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-on", + "shortDoc": "Shorthand for addListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The name of the event to listen for. May also be an object who's property names are\nevent names.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.
(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nCombining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\nShorthand for addListener.
\n\nAppends an event handler to this object.
\n", + "linenr": 669, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Number", - "name": "pos", - "doc": "position of Component
\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 560, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-added", - "shortDoc": "Fires after a Component had been added to a Container.
\n" - }, - { - "tagname": "event", - "name": "afterrender", - "member": "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", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 627, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-afterrender", - "shortDoc": "Fires after the component rendering is finished.\n\n\nThe afterrender event is fired after this Component has been rende..." - }, - { - "tagname": "event", - "name": "beforeactivate", - "member": "Ext.AbstractComponent", - "doc": "Fires before a Component has been visually activated.\nReturning false from an event listener can prevent the activate\nfrom occurring.
\n", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 532, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforeactivate", - "shortDoc": "Fires before a Component has been visually activated.\nReturning false from an event listener can prevent the activate..." - }, - { - "tagname": "event", - "name": "beforedeactivate", - "member": "Ext.AbstractComponent", - "doc": "Fires before a Component has been visually deactivated.\nReturning false from an event listener can prevent the deactivate\nfrom occurring.
\n", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 546, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforedeactivate", - "shortDoc": "Fires before a Component has been visually deactivated.\nReturning false from an event listener can prevent the deacti..." - }, - { - "tagname": "event", - "name": "beforedestroy", - "member": "Ext.AbstractComponent", - "doc": "Fires before the component is destroyed. Return false from an event handler to stop the destroy.
\n", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 635, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforedestroy", - "shortDoc": "Fires before the component is destroyed. Return false from an event handler to stop the destroy.
\n" - }, - { - "tagname": "event", - "name": "beforehide", - "member": "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", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 593, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforehide", - "shortDoc": "Fires before the component is hidden when calling the hide method.\nReturn false from an event handler to stop the hide.
\n" - }, - { - "tagname": "event", - "name": "beforerender", - "member": "Ext.AbstractComponent", - "doc": "Fires before the component is rendered. Return false from an\nevent handler to stop the render.
\n", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 614, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforerender", - "shortDoc": "Fires before the component is rendered. Return false from an\nevent handler to stop the render.
\n" - }, - { - "tagname": "event", - "name": "beforeshow", - "member": "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", - "params": [ - { + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-override", + "shortDoc": "Override prototype members of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "override", + "owner": "Ext.Base", + "doc": "Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\nthis
\n" + }, + "html_filename": "Base3.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-previousNode", + "shortDoc": "Returns the previous node in the Component tree in tree traversal order. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "Optional. A ComponentQuery selector to filter the preceding nodes.
\n", + "name": "selector" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "includeSelf" + } + ], + "name": "previousNode", + "owner": "Ext.AbstractComponent", + "doc": "Returns the previous node in the Component tree in tree traversal order.
\n\n\nNote that this is not limited to siblings, and if invoked upon a node with no matching siblings, will\nwalk the tree in reverse order to attempt to find a match. Contrast with previousSibling.
\n\n", + "linenr": 1976, + "return": { + "type": "void", + "doc": "The previous node (or the previous node which matches the selector). Returns null if there is no matching node.
\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-previousSibling", + "shortDoc": "Returns the previous sibling of this Component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "Optional. A ComponentQuery selector to filter the preceding items.
\n", + "name": "selector" + } + ], + "name": "previousSibling", + "owner": "Ext.AbstractComponent", + "doc": "Returns the previous sibling of this Component.
\n\n\nOptionally selects the previous sibling which matches the passed ComponentQuery selector.
\n\n\nMay also be refered to as prev()
Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with previousNode
The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.
\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-relayEvents", + "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "The Observable whose events this object is to relay.
\n", + "name": "origin" + }, + { + "type": "[String]", + "optional": false, + "doc": "Array of event names to relay.
\n", + "name": "events" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "prefix" + } + ], + "name": "relayEvents", + "owner": "Ext.util.Observable", + "doc": "Relays selected events from the specified Observable as if the events were fired by this.
The Observable to release
\n", + "name": "o" + } + ], + "name": "releaseCapture", + "owner": "Ext.util.Observable", + "doc": "Removes all added captures from the Observable.
\n", + "linenr": 44, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-removeCls", + "shortDoc": "Removes a CSS class from the top level element representing this component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "className" + } + ], + "name": "removeCls", + "owner": "Ext.AbstractComponent", + "doc": "Removes a CSS class from the top level element representing this component.
\n", + "linenr": 2338, + "return": { "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 580, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforeshow", - "shortDoc": "Fires before the component is shown when calling the show method.\nReturn false from an event handler to stop the show.
\n" - }, - { - "tagname": "event", - "name": "beforestaterestore", - "member": "Ext.state.Stateful", - "doc": "Fires before the state of the object is restored. Return false from an event handler to stop the restore.
\n", - "params": [ - { - "type": "Ext.state.Stateful", - "name": "this", - "doc": "\n", - "optional": false - }, - { - "type": "Object", - "name": "state", - "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", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 101, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-event-beforestaterestore", - "shortDoc": "Fires before the state of the object is restored. Return false from an event handler to stop the restore.
\n" - }, - { - "tagname": "event", - "name": "beforestatesave", - "member": "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", - "params": [ - { - "type": "Ext.state.Stateful", - "name": "this", - "doc": "\n", - "optional": false - }, - { + "doc": "Returns the Component to allow method chaining.
\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-removeClsWithUI", + "shortDoc": "Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes\nit from all elements of thi...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "String/Array", + "optional": false, + "doc": "A string or an array of strings to remove to the uiCls
\n", + "name": "cls" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "skip" + } + ], + "name": "removeClsWithUI", + "owner": "Ext.AbstractComponent", + "doc": "Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes\nit from all elements of this component.
\n", + "linenr": 1494, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-removeListener", + "shortDoc": "Removes an event handler. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The type of event the handler was associated with.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope originally specified for the handler.
\n", + "name": "scope" + } + ], + "name": "removeListener", + "owner": "Ext.util.Observable", + "doc": "Removes an event handler.
\n", + "linenr": 392, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", + "shortDoc": "Removes listeners that were added by the mon method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Observable|Element", + "optional": false, + "doc": "The item from which to remove a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "Optional. If the ename parameter was an event name, this is the handler function.
Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
Removes listeners that were added by the mon method.
\n", + "linenr": 197, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-removeUIClsFromElement", + "shortDoc": "Method which removes a specified UI + uiCls from the components element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The UI to add to the element
\n", + "name": "ui" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "force" + } + ], + "name": "removeUIClsFromElement", + "owner": "Ext.AbstractComponent", + "doc": "Method which removes a specified UI + uiCls from the components element.\nThe cls which is added to the element will be: this.baseCls + '-' + ui
Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the **queueSuspended** parameter, then all events fired\nduring event suspension will be sent to any listeners now.
Ensures that all effects queued after sequenceFx is called on this object are\nrun in sequence. This is the opposite of syncFx.
\n", + "linenr": 357, + "return": { "type": "Object", - "name": "state", - "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", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 122, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-event-beforestatesave", - "shortDoc": "Fires before the state of the object is saved to the configured state provider. Return false to stop the save.
\n" - }, - { - "tagname": "event", - "name": "deactivate", - "member": "Ext.AbstractComponent", - "doc": "Fires after a Component has been visually deactivated.
\n", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 554, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-deactivate", - "shortDoc": "Fires after a Component has been visually deactivated.
\n" - }, - { - "tagname": "event", - "name": "destroy", - "member": "Ext.AbstractComponent", - "doc": "Fires after the component is destroyed.
\n", - "params": [ - { + "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", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 641, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-destroy", - "shortDoc": "Fires after the component is destroyed.
\n" - }, - { - "tagname": "event", - "name": "disable", - "member": "Ext.AbstractComponent", - "doc": "Fires after the component is disabled.
\n", - "params": [ - { + "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:
Sets the height of the component. This method fires the resize event.
\n", + "linenr": 2769, + "return": { "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 568, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-disable", - "shortDoc": "Fires after the component is disabled.
\n" - }, - { - "tagname": "event", - "name": "enable", - "member": "Ext.AbstractComponent", - "doc": "Fires after the component is enabled.
\n", - "params": [ - { + "doc": "this
\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-setLoading", + "shortDoc": "This method allows you to show or hide a LoadMask on top of this component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Boolean/Object/String", + "optional": false, + "doc": "True to show the default LoadMask, a config object\nthat will be passed to the LoadMask constructor, or a message String to show. False to\nhide the current LoadMask.
\n", + "name": "load" + }, + { + "type": "Boolean", + "optional": false, + "doc": "True to mask the targetEl of this Component instead of the this.el.\nFor example, setting this to true on a Panel will cause only the body to be masked. (defaults to false)
\n", + "name": "targetEl" + } + ], + "name": "setLoading", + "owner": "Ext.AbstractComponent", + "doc": "This method allows you to show or hide a LoadMask on top of this component.
\n", + "linenr": 2830, + "return": { + "type": "Ext.LoadMask", + "doc": "The LoadMask instance that has just been shown.
\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Component2.html#Ext-Component-method-setPagePosition", + "shortDoc": "Sets the page XY position of the component. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", + "private": false, + "params": [ + { + "type": "Number", + "optional": false, + "doc": "The new x position
\n", + "name": "x" + }, + { + "type": "Number", + "optional": false, + "doc": "The new y position
\n", + "name": "y" + }, + { + "type": "Mixed", + "optional": false, + "doc": "If passed, the Component is animated into its new position. If this parameter\nis a number, it is used as the animation duration in milliseconds.
\n", + "name": "animate" + } + ], + "name": "setPagePosition", + "owner": "Ext.Component", + "doc": "Sets the page XY position of the component. To set the left and top instead, use setPosition.\nThis method fires the move event.
\n", + "linenr": 504, + "return": { "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 574, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-enable", - "shortDoc": "Fires after the component is enabled.
\n" - }, - { - "tagname": "event", - "name": "hide", - "member": "Ext.AbstractComponent", - "doc": "Fires after the component is hidden.\nFires after the component is hidden when calling the hide method.
\n", - "params": [ - { + "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", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 600, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-hide", - "shortDoc": "Fires after the component is hidden.\nFires after the component is hidden when calling the hide method.
\n" - }, - { - "tagname": "event", - "name": "move", - "member": "Ext.AbstractComponent", - "doc": "Fires after the component is moved.
\n", - "params": [ - { + "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:
{width: widthValue, height: heightValue}.undefined to leave the width unchanged.The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:
undefined to leave the height unchanged.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" }, - { - "type": "Number", - "name": "x", - "doc": "The new x position
\n", - "optional": false + "html_filename": "AbstractComponent.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" }, - { - "type": "Number", - "name": "y", - "doc": "The new y position
\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 655, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-move", - "shortDoc": "Fires after the component is moved.
\n" - }, - { - "tagname": "event", - "name": "removed", - "member": "Ext.AbstractComponent", - "doc": "Fires when a component is removed from an Ext.container.Container
\n", - "params": [ - { + "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", - "name": "this", - "doc": "\n", - "optional": false + "doc": "this
\n" }, - { - "type": "Ext.container.Container", - "name": "ownerCt", - "doc": "Container which holds the component
\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 607, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-removed", - "shortDoc": "Fires when a component is removed from an Ext.container.Container
\n" - }, - { - "tagname": "event", - "name": "render", - "member": "Ext.AbstractComponent", - "doc": "Fires after the component markup is rendered.
\n", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 621, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-render", - "shortDoc": "Fires after the component markup is rendered.
\n" - }, - { - "tagname": "event", - "name": "resize", - "member": "Ext.AbstractComponent", - "doc": "Fires after the component is resized.
\n", - "params": [ - { + "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:
Sets the width of the component. This method fires the resize event.
\n", + "linenr": 2757, + "return": { "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false + "doc": "this
\n" }, - { - "type": "Number", - "name": "adjWidth", - "doc": "The box-adjusted width that was set
\n", - "optional": false + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Component2.html#Ext-Component-method-show", + "shortDoc": "Shows this Component, rendering it first if autoRender or floating are true. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", + "private": false, + "params": [ + { + "type": "String/Element", + "optional": false, + "doc": "Optional, and only valid for floating Components such as\nWindows or ToolTips, or regular Components which have been configured\nwith floating: true. The target from which the Component should\nanimate from while opening (defaults to null with no animation)
(optional) A callback function to call after the Component is displayed. Only necessary if animation was specified.
\n", + "name": "callback" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope (this reference) in which the callback is executed. Defaults to this Component.
Shows this Component, rendering it first if autoRender or floating are true.
After being shown, a floating Component (such as a Ext.window.Window), is activated it and brought to the front of\nits z-index stack.
\n\n", + "linenr": 648, + "return": { + "type": "Component", + "doc": "this
\n" }, - { - "type": "Number", - "name": "adjHeight", - "doc": "The box-adjusted height that was set
\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 647, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-resize", - "shortDoc": "Fires after the component is resized.
\n" - }, - { - "tagname": "event", - "name": "show", - "member": "Ext.AbstractComponent", - "doc": "Fires after the component is shown when calling the show method.
\n", - "params": [ - { - "type": "Ext.Component", - "name": "this", - "doc": "\n", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", - "linenr": 587, - "html_filename": "AbstractComponent.html", - "href": "AbstractComponent.html#Ext-AbstractComponent-event-show", - "shortDoc": "Fires after the component is shown when calling the show method.
\n" - }, - { - "tagname": "event", - "name": "staterestore", - "member": "Ext.state.Stateful", - "doc": "Fires after the state of the object is restored.
\n", - "params": [ - { - "type": "Ext.state.Stateful", - "name": "this", - "doc": "\n", - "optional": false - }, - { - "type": "Object", - "name": "state", - "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", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 112, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-event-staterestore", - "shortDoc": "Fires after the state of the object is restored.
\n" - }, - { - "tagname": "event", - "name": "statesave", - "member": "Ext.state.Stateful", - "doc": "Fires after the state of the object is saved to the configured state provider.
\n", - "params": [ - { - "type": "Ext.state.Stateful", - "name": "this", - "doc": "\n", - "optional": false - }, - { + "html_filename": "Component2.html" + }, + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-statics", + "shortDoc": "Get the reference to the class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + + ], + "name": "statics", + "owner": "Ext.Base", + "doc": "Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base.self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\nStops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\n", + "linenr": 335, + "return": { + "type": "Ext.core.Element", + "doc": "The Element
\n" + }, + "html_filename": "Animate.html" + }, + { + "deprecated": { + "version": "4.0", + "text": "Replaced by stopAnimation
\n\n\n\n", + "tagname": "deprecated", + "doc": "Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet." + }, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Animate.html#Ext-util-Animate-method-stopFx", + "shortDoc": "Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Animate.js", + "private": false, + "params": [ + + ], + "name": "stopFx", + "owner": "Ext.util.Animate", + "doc": "Stops any running effects and clears this object's internal effects queue if it contains\nany additional effects that haven't started yet.
\n", + "linenr": 326, + "return": { + "type": "Ext.core.Element", + "doc": "The Element
\n" + }, + "html_filename": "Animate.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-suspendEvents", + "shortDoc": "Suspends the firing of all events. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "Boolean", + "optional": false, + "doc": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n", + "name": "queueSuspended" + } + ], + "name": "suspendEvents", + "owner": "Ext.util.Observable", + "doc": "Suspends the firing of all events. (see resumeEvents)
\n", + "linenr": 541, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Animate.html#Ext-util-Animate-method-syncFx", + "shortDoc": "Ensures that all effects queued after syncFx is called on this object are\nrun concurrently. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Animate.js", + "private": false, + "params": [ + + ], + "name": "syncFx", + "owner": "Ext.util.Animate", + "doc": "Ensures that all effects queued after syncFx is called on this object are\nrun concurrently. This is the opposite of sequenceFx.
\n", + "linenr": 345, + "return": { "type": "Object", - "name": "state", - "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", - "optional": false - } - ], - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", - "linenr": 133, - "html_filename": "Stateful.html", - "href": "Stateful.html#Ext-state-Stateful-event-statesave", - "shortDoc": "Fires after the state of the object is saved to the configured state provider.
\n" - } - ], - "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Item.js", - "linenr": 1, - "html_filename": "Item2.html", - "href": "Item2.html#Ext-toolbar-Item", - "cssVar": [ + "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": [ - ], - "cssMixin": [ + ], + "name": "toBack", + "owner": "Ext.util.Floating", + "doc": "Sends this Component to the back of (lower z-index than) any other visible windows
\n", + "linenr": 242, + "return": { + "type": "Component", + "doc": "this
\n" + }, + "html_filename": "Floating.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Floating.html#Ext-util-Floating-method-toFront", + "shortDoc": "Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/Floating.js", + "private": false, + "params": [ + { + "type": "Boolean", + "optional": true, + "doc": "(optional) Specify true to prevent the Component from being focused.
Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManager
\n\n\nIf this Component is modal, inserts the modal mask just below this Component in the z-index stack.
\n\n", + "linenr": 190, + "return": { + "type": "Component", + "doc": "this
\n" + }, + "html_filename": "Floating.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeListener" + }, + "protected": false, + "tagname": "method", + "href": "Observable.html#Ext-util-Observable-method-un", + "shortDoc": "Shorthand for removeListener. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "The type of event the handler was associated with.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope originally specified for the handler.
\n", + "name": "scope" + } + ], + "name": "un", + "owner": "Ext.util.Observable", + "doc": "Shorthand for removeListener.
\n\nRemoves an event handler.
\n", + "linenr": 675, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-up", + "shortDoc": "Walks up the ownerCt axis looking for an ancestor Container which matches\nthe passed simple selector. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "String", + "optional": false, + "doc": "Optional. The simple selector to test.
\n", + "name": "selector" + } + ], + "name": "up", + "owner": "Ext.AbstractComponent", + "doc": "Walks up the ownerCt axis looking for an ancestor Container which matches\nthe passed simple selector.
Example:\n
var owningTabPanel = grid.up('tabpanel');\nThe matching ancestor Container (or undefined if no match was found).
If this component has been configured with a template via the tpl config\nthen it will use this argument as data to populate the template.\nIf this component was not configured with a template, the components\ncontent area will be updated via Ext.core.Element update
\n", + "name": "htmlOrData" + }, + { + "type": "Boolean", + "optional": true, + "doc": "(optional) Only legitimate when using the html configuration. Defaults to false
\n", + "name": "loadScripts" + }, + { + "type": "Function", + "optional": true, + "doc": "(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading
\n", + "name": "callback" + } + ], + "name": "update", + "owner": "Ext.AbstractComponent", + "doc": "Update the content area of a component.
\n", + "linenr": 2141, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Component2.html#Ext-Component-method-updateBox", + "shortDoc": "Sets the current box measurements of the component's underlying element. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "An object in the format {x, y, width, height}
\n", + "name": "box" + } + ], + "name": "updateBox", + "owner": "Ext.Component", + "doc": "Sets the current box measurements of the component's underlying element.
\n", + "linenr": 554, + "return": { + "type": "Ext.Component", + "doc": "this
\n" + }, + "html_filename": "Component2.html" + } + ], + "property": [ + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "AbstractComponent.html#Ext-AbstractComponent-property-draggable", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "draggable", + "owner": "Ext.AbstractComponent", + "doc": "Read-only property indicating whether or not the component can be dragged
\n", + "linenr": 395, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Ext.Container", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "Component2.html#Ext-Component-property-floatParent", + "shortDoc": "Optional. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/Component.js", + "private": false, + "name": "floatParent", + "owner": "Ext.Component", + "doc": "Optional. Only present for floating Components which were inserted as descendant items of floating Containers.
\n\n\nFloating Components that are programatically rendered will not have a floatParent property.
For floating Components which are child items of a Container, the floatParent will be the floating ancestor Container which is\nresponsible for the base z-index value of all its floating descendants. It provides a ZIndexManager which provides\nz-indexing services for all its descendant floating Components.
\n\n\nFor example, the dropdown BoundList of a ComboBox which is in a Window will have the Window as its\nfloatParent
See floating and zIndexManager
\n\n", + "linenr": 224, + "html_filename": "Component2.html" + }, + { + "type": "Object", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "AbstractComponent.html#Ext-AbstractComponent-property-frameSize", + "shortDoc": "Read-only property indicating the width of any framing elements which were added within the encapsulating element\nto ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "frameSize", + "owner": "Ext.AbstractComponent", + "doc": "Read-only property indicating the width of any framing elements which were added within the encapsulating element\nto provide graphical, rounded borders. See the frame config.
\n\n\nThis is an object containing the frame width in pixels for all four sides of the Component containing\nthe following properties:
\n\n\ntop The width of the top framing element in pixels.right The width of the right framing element in pixels.bottom The width of the bottom framing element in pixels.left The width of the left framing element in pixels.This is an internal flag that you use when creating custom components.\nBy default this is set to true which means that every component gets a mask when its disabled.\nComponents like FieldContainer, FieldSet, Field, Button, Tab override this property to false\nsince they want to implement custom disable logic.
\n", + "linenr": 534, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Ext.Container", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "AbstractComponent.html#Ext-AbstractComponent-property-ownerCt", + "shortDoc": "This Component's owner Container (defaults to undefined, and is set automatically when\nthis Component is added to a C...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "ownerCt", + "owner": "Ext.AbstractComponent", + "doc": "This Component's owner Container (defaults to undefined, and is set automatically when\nthis Component is added to a Container). Read-only.
\n\nNote: to access items within the Container see itemId.
\n\n", + "linenr": 102, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "property", + "href": "AbstractComponent.html#Ext-AbstractComponent-property-rendered", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "name": "rendered", + "owner": "Ext.AbstractComponent", + "doc": "Read-only property indicating whether or not the component has been rendered.
\n", + "linenr": 521, + "html_filename": "AbstractComponent.html" + }, + { + "type": "Class", + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "property", + "href": "Base3.html#Ext-Base-property-self", + "shortDoc": "Get the reference to the current class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "name": "self", + "owner": "Ext.Base", + "doc": "Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nOptional. Only present for floating Components after they have been rendered.
\n\n\nA reference to the ZIndexManager which is managing this Component's z-index.
\n\n\nThe ZIndexManager maintains a stack of floating Component z-indices, and also provides a single modal\nmask which is insert just beneath the topmost visible modal floating Component.
\n\n\nFloating Components may be brought to the front or sent to the back of the z-index stack.
\n\n\nThis defaults to the global ZIndexManager for floating Components that are programatically\nrendered.
\n\n\nFor floating Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found\nwhich is floating, or if not found the global ZIndexManager is used.
\n\n\nSee floating and floatParent
\n\n", + "linenr": 209, + "html_filename": "Component2.html" + } + ], + "cssVar": [ - ], - "component": true, + ], + "cssMixin": [ + + ], + "event": [ + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-activate", + "shortDoc": "Fires after a Component has been visually activated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "activate", + "owner": "Ext.AbstractComponent", + "doc": "Fires after a Component has been visually activated.
\n", + "linenr": 565, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-added", + "shortDoc": "Fires after a Component had been added to a Container. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Ext.container.Container", + "optional": false, + "doc": "Parent Container
\n", + "name": "container" + }, + { + "type": "Number", + "optional": false, + "doc": "position of Component
\n", + "name": "pos" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "added", + "owner": "Ext.AbstractComponent", + "doc": "Fires after a Component had been added to a Container.
\n", + "linenr": 585, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-afterrender", + "shortDoc": "Fires after the component rendering is finished. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "afterrender", + "owner": "Ext.AbstractComponent", + "doc": "Fires after the component rendering is finished.
\n\n\nThe afterrender event is fired after this Component has been rendered, been postprocesed\nby any afterRender method defined for the Component.
\n\n", + "linenr": 652, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforeactivate", + "shortDoc": "Fires before a Component has been visually activated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforeactivate", + "owner": "Ext.AbstractComponent", + "doc": "Fires before a Component has been visually activated.\nReturning false from an event listener can prevent the activate\nfrom occurring.
\n", + "linenr": 557, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforedeactivate", + "shortDoc": "Fires before a Component has been visually deactivated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforedeactivate", + "owner": "Ext.AbstractComponent", + "doc": "Fires before a Component has been visually deactivated.\nReturning false from an event listener can prevent the deactivate\nfrom occurring.
\n", + "linenr": 571, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforedestroy", + "shortDoc": "Fires before the component is destroyed. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforedestroy", + "owner": "Ext.AbstractComponent", + "doc": "Fires before the component is destroyed. Return false from an event handler to stop the destroy.
\n", + "linenr": 660, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforehide", + "shortDoc": "Fires before the component is hidden when calling the hide method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforehide", + "owner": "Ext.AbstractComponent", + "doc": "Fires before the component is hidden when calling the hide method.\nReturn false from an event handler to stop the hide.
\n", + "linenr": 618, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforerender", + "shortDoc": "Fires before the component is rendered. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforerender", + "owner": "Ext.AbstractComponent", + "doc": "Fires before the component is rendered. Return false from an\nevent handler to stop the render.
\n", + "linenr": 639, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforeshow", + "shortDoc": "Fires before the component is shown when calling the show method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforeshow", + "owner": "Ext.AbstractComponent", + "doc": "Fires before the component is shown when calling the show method.\nReturn false from an event handler to stop the show.
\n", + "linenr": 605, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "Stateful.html#Ext-state-Stateful-event-beforestaterestore", + "shortDoc": "Fires before the state of the object is restored. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", + "private": false, + "params": [ + { + "type": "Ext.state.Stateful", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "The hash of state values returned from the StateProvider. If this\nevent is not vetoed, then the state object is passed to applyState. By default,\nthat simply copies property values into this object. The method maybe overriden to\nprovide custom state restoration.
\n", + "name": "state" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforestaterestore", + "owner": "Ext.state.Stateful", + "doc": "Fires before the state of the object is restored. Return false from an event handler to stop the restore.
\n", + "linenr": 101, + "html_filename": "Stateful.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "Stateful.html#Ext-state-Stateful-event-beforestatesave", + "shortDoc": "Fires before the state of the object is saved to the configured state provider. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", + "private": false, + "params": [ + { + "type": "Ext.state.Stateful", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "The hash of state values. This is determined by calling\ngetState() on the object. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, Ext.state.Stateful\nhas a null implementation.
\n", + "name": "state" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforestatesave", + "owner": "Ext.state.Stateful", + "doc": "Fires before the state of the object is saved to the configured state provider. Return false to stop the save.
\n", + "linenr": 122, + "html_filename": "Stateful.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-deactivate", + "shortDoc": "Fires after a Component has been visually deactivated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "deactivate", + "owner": "Ext.AbstractComponent", + "doc": "Fires after a Component has been visually deactivated.
\n", + "linenr": 579, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-destroy", + "shortDoc": "Fires after the component is destroyed. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "destroy", + "owner": "Ext.AbstractComponent", + "doc": "Fires after the component is destroyed.
\n", + "linenr": 666, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-disable", + "shortDoc": "Fires after the component is disabled. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "disable", + "owner": "Ext.AbstractComponent", + "doc": "Fires after the component is disabled.
\n", + "linenr": 593, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-enable", + "shortDoc": "Fires after the component is enabled. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "enable", + "owner": "Ext.AbstractComponent", + "doc": "Fires after the component is enabled.
\n", + "linenr": 599, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-hide", + "shortDoc": "Fires after the component is hidden. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "hide", + "owner": "Ext.AbstractComponent", + "doc": "Fires after the component is hidden.\nFires after the component is hidden when calling the hide method.
\n", + "linenr": 625, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-move", + "shortDoc": "Fires after the component is moved. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Number", + "optional": false, + "doc": "The new x position
\n", + "name": "x" + }, + { + "type": "Number", + "optional": false, + "doc": "The new y position
\n", + "name": "y" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "move", + "owner": "Ext.AbstractComponent", + "doc": "Fires after the component is moved.
\n", + "linenr": 680, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-removed", + "shortDoc": "Fires when a component is removed from an Ext.container.Container ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Ext.container.Container", + "optional": false, + "doc": "Container which holds the component
\n", + "name": "ownerCt" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "removed", + "owner": "Ext.AbstractComponent", + "doc": "Fires when a component is removed from an Ext.container.Container
\n", + "linenr": 632, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-render", + "shortDoc": "Fires after the component markup is rendered. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "render", + "owner": "Ext.AbstractComponent", + "doc": "Fires after the component markup is rendered.
\n", + "linenr": 646, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-resize", + "shortDoc": "Fires after the component is resized. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Number", + "optional": false, + "doc": "The box-adjusted width that was set
\n", + "name": "adjWidth" + }, + { + "type": "Number", + "optional": false, + "doc": "The box-adjusted height that was set
\n", + "name": "adjHeight" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "resize", + "owner": "Ext.AbstractComponent", + "doc": "Fires after the component is resized.
\n", + "linenr": 672, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-show", + "shortDoc": "Fires after the component is shown when calling the show method. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/AbstractComponent.js", + "private": false, + "params": [ + { + "type": "Ext.Component", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "show", + "owner": "Ext.AbstractComponent", + "doc": "Fires after the component is shown when calling the show method.
\n", + "linenr": 612, + "html_filename": "AbstractComponent.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "Stateful.html#Ext-state-Stateful-event-staterestore", + "shortDoc": "Fires after the state of the object is restored. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", + "private": false, + "params": [ + { + "type": "Ext.state.Stateful", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "The hash of state values returned from the StateProvider. This is passed\nto applyState. By default, that simply copies property values into this\nobject. The method maybe overriden to provide custom state restoration.
\n", + "name": "state" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "staterestore", + "owner": "Ext.state.Stateful", + "doc": "Fires after the state of the object is restored.
\n", + "linenr": 112, + "html_filename": "Stateful.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "event", + "href": "Stateful.html#Ext-state-Stateful-event-statesave", + "shortDoc": "Fires after the state of the object is saved to the configured state provider. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/state/Stateful.js", + "private": false, + "params": [ + { + "type": "Ext.state.Stateful", + "optional": false, + "doc": "\n", + "name": "this" + }, + { + "type": "Object", + "optional": false, + "doc": "The hash of state values. This is determined by calling\ngetState() on the object. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, Ext.state.Stateful\nhas a null implementation.
\n", + "name": "state" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "statesave", + "owner": "Ext.state.Stateful", + "doc": "Fires after the state of the object is saved to the configured state provider.
\n", + "linenr": 133, + "html_filename": "Stateful.html" + } + ] + }, + "singleton": false, + "alias": null, "superclasses": [ + "Ext.Base", "Ext.AbstractComponent", "Ext.Component" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "Item.html#Ext-toolbar-Item", "subclasses": [ "Ext.toolbar.Separator", - "Ext.toolbar.Spacer", - "Ext.toolbar.TextItem" + "Ext.toolbar.TextItem", + "Ext.toolbar.Spacer" + ], + "static": false, + "author": null, + "component": true, + "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/toolbar/Item.js", + "private": false, + "alternateClassNames": [ + "Ext.Toolbar.Item" ], + "name": "Ext.toolbar.Item", + "doc": "The base class that other non-interacting Toolbar Item classes should extend in order to\nget some basic common toolbar item functionality.
\n", "mixedInto": [ ], - "allMixins": [ - "Ext.util.Floating", - "Ext.util.Observable", - "Ext.util.Animate", - "Ext.state.Stateful" - ] + "linenr": 1, + "xtypes": [ + "tbitem" + ], + "html_filename": "Item.html", + "extends": "Ext.Component" }); \ No newline at end of file