![\"Ext.menu.Item](\"doc-resources/Ext.menu.Item/Ext.menu.Item.png\")
A menu object. This is the container to which you may add menu items.
\n\nMenus may contain either menu items, or general Components.\nMenus may also contain docked items because it extends Ext.panel.Panel.
\n\nTo make a contained general Component line up with other menu items,\nspecify iconCls: 'no-icon' or indent: true.\nThis reserves a space for an icon, and indents the Component in line with the other menu items.\nSee Ext.form.field.ComboBox.getListParent for an example.
By default, Menus are absolutely positioned, floating Components. By configuring a Menu with floating:false,\na Menu may be used as a child of a Container.\n
Ext.create('Ext.menu.Menu', {\n width: 100,\n height: 100,\n margin: '0 0 10 0',\n floating: false, // usually you want this set to True (default)\n renderTo: Ext.getBody(), // usually rendered by it's containing component\n items: [{ \n text: 'regular item 1' \n },{\n text: 'regular item 2'\n },{\n text: 'regular item 3' \n }]\n }); \n\n Ext.create('Ext.menu.Menu', {\n width: 100,\n height: 100,\n plain: true,\n floating: false, // usually you want this set to True (default)\n renderTo: Ext.getBody(), // usually rendered by it's containing component\n items: [{ \n text: 'plain item 1' \n },{\n text: 'plain item 2'\n },{\n text: 'plain item 3'\n }]\n });\nA string component id or the numeric index of the component that should be initially activated within the\ncontainer's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first\nitem in the container's collection). activeItem only applies to layout styles that can display\nitems one at a time (like Ext.layout.container.Card and Ext.layout.container.Fit).
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 87, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-cfg-activeItem", + "shortDoc": "A string component id or the numeric index of the component that should be initially activated within the\ncontainer's..." + }, + { + "tagname": "cfg", + "name": "allowOtherMenus", + "member": "Ext.menu.Menu", + "type": "Boolean", + "doc": "True to allow multiple menus to be displayed at the same time. Defaults to false.
true to animate the transition when the panel is collapsed, false to skip the\nanimation (defaults to true if the Ext.fx.Anim class is available, otherwise false).\nMay also be specified as the animation duration in milliseconds.
If true the container will automatically destroy any contained component that is removed from it, else\ndestruction must be handled manually.\nDefaults to true.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 161, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-cfg-autoDestroy", + "shortDoc": "If true the container will automatically destroy any contained component that is removed from it, else\ndestruction mu..." + }, + { + "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.panel.AbstractPanel", + "type": "String", + "doc": "The base CSS class to apply to this panel's element (defaults to 'x-panel').
Convenience method. Short for 'Bottom Bar'.
\n\nbbar: [\n { xtype: 'button', text: 'Button 1' }\n]\nis equivalent to
\n\ndockedItems: [{\n xtype: 'toolbar',\n dock: 'bottom',\n items: [\n { xtype: 'button', text: 'Button 1' }\n ]\n}]\nA shortcut to add or remove the border on the body of a panel. This only applies to a panel which has the frame configuration set to true.\nDefaults to undefined.
A CSS class, space-delimited string of classes, or array of classes to be applied to the panel's body element.\nThe following examples are all valid:
\n\nbodyCls: 'foo'\nbodyCls: 'foo bar'\nbodyCls: ['foo', 'bar']\nA shortcut for setting a padding style on the body element. The value can either be\na number to be applied to all sides, or a normal css string describing padding.\nDefaults to undefined.
Custom CSS styles to be applied to the panel's body element, which can be supplied as a valid CSS style string,\nan object containing style property name/value pairs or a function that returns such a string or object.\nFor example, these two formats are interpreted to be equivalent:
\n\nbodyStyle: 'background:#ffc; padding:10px;'\n\nbodyStyle: {\n background: '#ffc',\n padding: '10px'\n}\nSpecifies the border for this component. The border can be a single numeric value to apply to all sides or\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": "bubbleEvents", + "member": "Ext.container.AbstractContainer", + "type": "Array", + "doc": "An array of events that, when fired, should be bubbled to any parent container.\nSee Ext.util.Observable.enableBubble.\nDefaults to ['add', 'remove'].\n\n",
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js",
+ "linenr": 179,
+ "html_filename": "AbstractContainer.html",
+ "href": "AbstractContainer.html#Ext-container-AbstractContainer-cfg-bubbleEvents",
+ "shortDoc": "An array of events that, when fired, should be bubbled to any parent container.\nSee Ext.util.Observable.enableBubble...."
+ },
+ {
+ "tagname": "cfg",
+ "name": "buttons",
+ "member": "Ext.panel.Panel",
+ "type": "Object/Array",
+ "doc": "
Convenience method used for adding buttons docked to the bottom right of the panel. This is a\nsynonym for the fbar config.
\n\nbuttons: [\n { text: 'Button 1' }\n]\nis equivalent to
\n\ndockedItems: [{\n xtype: 'toolbar',\n dock: 'bottom',\n defaults: {minWidth: minButtonWidth},\n items: [\n { xtype: 'component', flex: 1 },\n { xtype: 'button', text: 'Button 1' }\n ]\n}]\nThe minButtonWidth is used as the default minWidth for\neach of the buttons in the buttons toolbar.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 509, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-buttons", + "shortDoc": "Convenience method used for adding buttons docked to the bottom right of the panel. This is a\nsynonym for the fbar co..." + }, + { + "tagname": "cfg", + "name": "closable", + "member": "Ext.panel.Panel", + "type": "Boolean", + "doc": "True to display the 'close' tool button and allow the user to close the window, false to\nhide the button and disallow closing the window (defaults to false).
By default, when close is requested by clicking the close button in the header, the close\nmethod will be called. This will destroy the Panel and its content\nmeaning that it may not be reused.
\n\n\nTo make closing a Panel hide the Panel so that it may be reused, set\ncloseAction to 'hide'.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 211, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-closable", + "shortDoc": "True to display the 'close' tool button and allow the user to close the window, false to\nhide the button and disallow..." + }, + { + "tagname": "cfg", + "name": "closeAction", + "member": "Ext.panel.Panel", + "type": "String", + "doc": "The action to take when the close header tool is clicked:\n
Note: This behavior has changed! setting *does* affect the close method\nwhich will invoke the approriate closeAction.\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 223, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-closeAction", + "shortDoc": "The action to take when the close header tool is clicked:\n\n'destroy' : Default\nremove the window from the DOM and des..." + }, + { + "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": "collapseDirection", + "member": "Ext.panel.Panel", + "type": "Boolean", + "doc": "The direction to collapse the Panel when the toggle button is clicked.
\n\n\nDefaults to the headerPosition
\n\n\nImportant: This config is ignored for collapsible Panels which are direct child items of a border layout.
\n\n\nSpecify as 'top', 'bottom', 'left' or 'right'.
true to make sure the collapse/expand toggle button always renders first (to the left of)\nany other tools in the panel's title bar, false to render it last (defaults to true).
Important: this config is only effective for collapsible Panels which are direct child items of a border layout.
\n\n\nWhen not a direct child item of a border layout, then the Panel's header remains visible, and the body is collapsed to zero dimensions.\nIf the Panel has no header, then a new header (orientated correctly depending on the collapseDirection) will be inserted to show a the title and a re-expand tool.
\n\n\nWhen a child item of a border layout, this config has two options:\n
undefined/omittedheader : true to render the panel collapsed, false to render it expanded (defaults to\nfalse).
A CSS class to add to the panel's element after it has been collapsed (defaults to\n'collapsed').
True to make the panel collapsible and have an expand/collapse toggle Tool added into\nthe header tool button area. False to keep the panel sized either statically, or by an owning layout manager, with no toggle Tool (defaults to false).
\n\n\nSee collapseMode and collapseDirection
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 195, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-collapsible", + "shortDoc": "True to make the panel collapsible and have an expand/collapse toggle Tool added into\nthe header tool button area. Fa..." + }, + { + "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.
The default Ext.core.Element#getAlignToXY anchor position value for this menu\nrelative to its element of origin. Defaults to 'tl-bl?'.
The default xtype of child Components to create in this Container when\na child item is specified as a raw configuration object, rather than as an instantiated Component.
\n\n\nDefaults to 'panel'.
This option is a means of applying default settings to all added items whether added through the items\nconfig or via the add or insert methods.
\n\n\nIf an added item is a config object, and not an instantiated Component, then the default properties are\nunconditionally applied. If the added item is an instantiated Component, then the default properties are\napplied conditionally so as not to override existing properties in the item.
\n\n\nIf the defaults option is specified as a function, then the function will be called using this Container as the\nscope (this reference) and passing the added item as the first parameter. Any resulting object\nfrom that call is then applied to the item as default properties.
For example, to automatically apply padding to the body of each of a set of\ncontained Ext.panel.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.
Usage:
\n\n\ndefaults: { // defaults are applied to items, not the container\n autoScroll:true\n},\nitems: [\n {\n xtype: 'panel', // defaults do not have precedence over\n id: 'panel1', // options in config objects, so the defaults\n autoScroll: false // will not be applied here, panel1 will be autoScroll:false\n },\n new Ext.panel.Panel({ // defaults do have precedence over options\n id: 'panel2', // options in components, so the defaults\n autoScroll: false // will be applied here, panel2 will be autoScroll:true.\n })\n]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": "dockedItems", + "member": "Ext.panel.Panel", + "type": "Object/Array", + "doc": "A component or series of components to be added as docked items to this panel.\nThe docked items can be docked to either the top, right, left or bottom of a panel.\nThis is typically used for things like toolbars or tab bars:
\n\nvar panel = new Ext.panel.Panel({\n dockedItems: [{\n xtype: 'toolbar',\n dock: 'top',\n items: [{\n text: 'Docked to the top'\n }]\n }]\n});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": "fbar",
+ "member": "Ext.panel.Panel",
+ "type": "Object/Array",
+ "doc": "Convenience method used for adding items to the bottom right of the panel. Short for Footer Bar.
\n\nfbar: [\n { type: 'button', text: 'Button 1' }\n]\nis equivalent to
\n\ndockedItems: [{\n xtype: 'toolbar',\n dock: 'bottom',\n defaults: {minWidth: minButtonWidth},\n items: [\n { xtype: 'component', flex: 1 },\n { xtype: 'button', text: 'Button 1' }\n ]\n}]\nThe minButtonWidth is used as the default minWidth for\neach of the buttons in the fbar.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 541, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-fbar", + "shortDoc": "Convenience method used for adding items to the bottom right of the panel. Short for Footer Bar.\n\nfbar: [\n { type: '..." + }, + { + "tagname": "cfg", + "name": "floatable", + "member": "Ext.panel.Panel", + "type": "Boolean", + "doc": "Important: This config is only effective for collapsible Panels which are direct child items of a border layout.
\n\n\ntrue to allow clicking a collapsed Panel's placeholder to display the Panel floated\nabove the layout, false to force the user to fully expand a collapsed region by\nclicking the expand button to see it again (defaults to true).
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 180, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-floatable", + "shortDoc": "Important: This config is only effective for collapsible Panels which are direct child items of a border layout.\n\n\ntr..." + }, + { + "tagname": "cfg", + "name": "floating", + "member": "Ext.menu.Menu", + "type": "Boolean", + "doc": "A Menu configured as floating: true (the default) will be rendered as an absolutely positioned,\nfloating Component. If configured as floating: false, the Menu may be\nused as a child item of another Container.
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.panel.Panel", + "type": "Boolean", + "doc": "True to apply a frame to the panel.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 269, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-frame" + }, + { + "tagname": "cfg", + "name": "frameHeader", + "member": "Ext.panel.Panel", + "type": "Boolean", + "doc": "True to apply a frame to the panel panels header (if 'frame' is true).
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 275, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-frameHeader" + }, + { + "tagname": "cfg", + "name": "headerPosition", + "member": "Ext.panel.Panel", + "type": "String", + "doc": "Specify as 'top', 'bottom', 'left' or 'right'. Defaults to 'top'.
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.menu.Menu", + "type": "Boolean", + "doc": "True to initially render the Menu as hidden, requiring to be shown manually.\nDefaults to true when floating: true, and defaults to false when floating: false.
true to hide the expand/collapse toggle button when collapsible == true,\nfalse to display it (defaults to false).
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.
True to ignore clicks on any item in this menu that is a parent item (displays a submenu)\nso that the submenu is not dismissed when clicking the parent item. Defaults to false.
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": "items", + "member": "Ext.container.AbstractContainer", + "type": "Object/Array", + "doc": "A single item, or an array of child Components to be added to this container
\n\n\nUnless configured with a layout, a Container simply renders child Components serially into\nits encapsulating element and performs no sizing or positioning upon them.
\n
Example:
\n// specifying a single item\nitems: {...},\nlayout: 'fit', // The single items is sized to fit\n\n// specifying multiple items\nitems: [{...}, {...}],\nlayout: 'hbox', // The items are arranged horizontally\n Each item may be:
\nIf a configuration object is specified, the actual type of Component to be\ninstantiated my be indicated by using the xtype option.
\nEvery Component class has its own xtype.
\nIf an xtype is not explicitly\nspecified, the defaultType for the Container is used, which by default is usually panel.
Notes:
\nExt uses lazy rendering. Child Components will only be rendered\nshould it become necessary. Items are automatically laid out when they are first\nshown (no sizing is done while hidden), or in response to a doLayout call.
\nDo not specify contentEl or \nhtml with items.
*Important: In order for child items to be correctly sized and\npositioned, typically a layout manager must be specified through\nthe layout configuration option.
The sizing and positioning of child items is the responsibility of\n\n\n
the Container's layout manager which creates and manages the type of layout\nyou have in mind. For example:
\n\nIf the layout configuration is not explicitly specified for\na general purpose container (e.g. Container or Panel) the\ndefault layout manager will be used\nwhich does nothing but render child components sequentially into the\nContainer (no sizing or positioning will be performed in this situation).
\n\n\nlayout may be specified as either as an Object or\n\n\n
as a String:
layout: {\n type: 'vbox',\n align: 'left'\n}\n typeThe layout type to be used for this container. If not specified,\na default Ext.layout.container.Auto will be created and used.
\nValid layout type values are:
Additional layout specific configuration properties may also be\nspecified. For complete details regarding the valid config options for\neach layout type, see the layout class corresponding to the type\nspecified.
layout: {\n type: 'vbox',\n padding: '5',\n align: 'left'\n}\n layoutThe layout type to be used for this container (see list\nof valid layout type values above).
Additional layout specific configuration properties. For complete\ndetails regarding the valid config options for each layout type, see the\nlayout class corresponding to the layout specified.
Convenience method. Short for 'Left Bar' (left-docked, vertical toolbar).
\n\nlbar: [
\n\n { xtype: 'button', text: 'Button 1' }\n]
\n\nis equivalent to
\n\ndockedItems: [{
\n\n xtype: 'toolbar',\n dock: 'left',\n items: [\n { xtype: 'button', text: 'Button 1' }\n ]\n}]
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 593, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-lbar", + "shortDoc": "Convenience method. Short for 'Left Bar' (left-docked, vertical toolbar).\n\n lbar: [\n\n { xtype: 'button', text: 'But..." + }, + { + "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": "minButtonWidth", + "member": "Ext.panel.Panel", + "type": "Number", + "doc": "Minimum width of all footer toolbar buttons in pixels (defaults to 75). If set, this will\nbe used as the default value for the Ext.button.Button.minWidth config of\neach Button added to the footer toolbar via the fbar or buttons configurations.\nIt will be ignored for buttons that have a minWidth configured some other way, e.g. in their own config\nobject or via the defaults of their parent container.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 119, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-minButtonWidth", + "shortDoc": "Minimum width of all footer toolbar buttons in pixels (defaults to 75). If set, this will\nbe used as the default valu..." + }, + { + "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.menu.Menu", + "type": "Number", + "doc": "The minimum width of the Menu. Defaults to 120.
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": "overlapHeader", + "member": "Ext.panel.Panel", + "type": "Mixed", + "doc": "True to overlap the header in a panel over the framing of the panel itself. This is needed when frame:true (and is done automatically for you). Otherwise it is undefined.\nIf you manually add rounded corners to a panel header which does not have frame:true, this will need to be set to true.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 189, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-overlapHeader", + "shortDoc": "True to overlap the header in a panel over the framing of the panel itself. This is needed when frame:true (and is do..." + }, + { + "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": "placeholder", + "member": "Ext.panel.Panel", + "type": "Mixed", + "doc": "Important: This config is only effective for collapsible Panels which are direct child items of a border layout\nwhen not using the 'header' collapseMode.
Optional. A Component (or config object for a Component) to show in place of this Panel when this Panel is collapsed by a\nborder layout. Defaults to a generated Header\ncontaining a Tool to re-expand the Panel.
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 171, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-placeholder", + "shortDoc": "Important: This config is only effective for collapsible Panels which are direct child items of a border layout\nwhen ..." + }, + { + "tagname": "cfg", + "name": "plain", + "member": "Ext.menu.Menu", + "type": "Boolean", + "doc": "True to remove the incised line down the left side of the menu and to not\nindent general Component items. Defaults to false.
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": "preventHeader", + "member": "Ext.panel.Panel", + "type": "Boolean", + "doc": "Prevent a Header from being created and shown. Defaults to false.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 259, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-preventHeader" + }, + { + "tagname": "cfg", + "name": "rbar", + "member": "Ext.panel.Panel", + "type": "Object/Array", + "doc": "Convenience method. Short for 'Right Bar' (right-docked, vertical toolbar).
\n\nrbar: [
\n\n { xtype: 'button', text: 'Button 1' }\n]
\n\nis equivalent to
\n\ndockedItems: [{
\n\n xtype: 'toolbar',\n dock: 'right',\n items: [\n { xtype: 'button', text: 'Button 1' }\n ]\n}]
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 619, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-cfg-rbar", + "shortDoc": "Convenience method. Short for 'Right Bar' (right-docked, vertical toolbar).\n\n rbar: [\n\n { xtype: 'button', text: 'B..." + }, + { + "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": "showSeparator", + "member": "Ext.menu.Menu", + "type": "Boolean", + "doc": "True to show the icon separator. (defaults to true).
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/menu/Menu.js", + "linenr": 128, + "html_filename": "Menu2.html", + "href": "Menu2.html#Ext-menu-Menu-cfg-showSeparator" + }, + { + "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": "suspendLayout", + "member": "Ext.container.AbstractContainer", + "type": "Boolean", + "doc": "If true, suspend calls to doLayout. Useful when batching multiple adds to a container and not passing them\nas multiple arguments or an array.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 155, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-cfg-suspendLayout", + "shortDoc": "If true, suspend calls to doLayout. Useful when batching multiple adds to a container and not passing them\nas multip..." + }, + { + "tagname": "cfg", + "name": "tbar", + "member": "Ext.panel.Panel", + "type": "Object/Array", + "doc": "Convenience method. Short for 'Top Bar'.
\n\ntbar: [\n { xtype: 'button', text: 'Button 1' }\n]\nis equivalent to
\n\ndockedItems: [{\n xtype: 'toolbar',\n dock: 'top',\n items: [\n { xtype: 'button', text: 'Button 1' }\n ]\n}]\ntrue to allow expanding and collapsing the panel (when collapsible = true)\nby clicking anywhere in the header bar, false) to allow it only by clicking to tool button\n(defaults to false)).
True to automatically call toFront when the show method is called\non an already visible, floating component (default is true).
An array of Ext.panel.Tool configs/instances to be added to the header tool area. The tools are stored as child\ncomponents of the header container. They can be accessed using down and {#query}, as well as the other\ncomponent methods. The toggle tool is automatically created if collapsible is set to true.
\n\nNote that, apart from the toggle tool which is provided when a panel is collapsible, these\ntools only provide the visual button. Any required functionality must be provided by adding\nhandlers that implement the necessary behavior.
\n\n\nExample usage:
\n\n\ntools:[{\n type:'refresh',\n qtip: 'Refresh form Data',\n // hidden:true,\n handler: function(event, toolEl, panel){\n // refresh logic\n }\n},\n{\n type:'help',\n qtip: 'Get Help',\n handler: function(event, toolEl, panel){\n // show help here\n }\n}]\nAn 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": "Menu", + "member": "Ext.menu.Menu", + "doc": "\n", + "params": [ + { + "type": "Object", + "name": "config", + "doc": "The config object
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/menu/Menu.js", + "linenr": 1, + "html_filename": "Menu2.html", + "href": "Menu2.html#Ext-menu-Menu-method-constructor", + "shortDoc": "\n" + }, + { + "tagname": "method", + "name": "add", + "member": "Ext.container.AbstractContainer", + "doc": "Adds Component(s) to this Container.
\n\ndefaults for details).add event after the component has been added.If the Container is already rendered when add\nis called, it will render the newly added Component into its content area.
If the Container was configured with a size-managing layout manager, the Container\nwill recalculate its internal layout at this time too.
\n\nNote that the default layout manager simply renders child Components sequentially into the content area and thereafter performs no sizing.
\n\nIf adding multiple new child Components, pass them as an array to the add method, so that only one layout recalculation is performed.
tb = new Ext.toolbar.Toolbar({\n renderTo: document.body\n}); // toolbar is rendered\ntb.add([{text:'Button 1'}, {text:'Button 2'}]); // add multiple items. (defaultType for Toolbar is 'button')\nComponents directly managed by the BorderLayout layout manager\nmay not be removed or added. See the Notes for BorderLayout\nfor more details.
\n", + "params": [ + { + "type": "...Object/Array", + "name": "Component", + "doc": "Either one or more Components to add or an Array of Components to add.\nSee items for additional information.
The Components that were added.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 423, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-add", + "shortDoc": "Adds Component(s) to this Container.\n\nDescription:\n\n\nFires the beforeadd event before adding.\nThe Container's default..." + }, + { + "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": "addDocked", + "member": "Ext.panel.AbstractPanel", + "doc": "Adds docked item(s) to the panel.
\n", + "params": [ + { + "type": "Object/Array", + "name": "component", + "doc": "The Component or array of components to add. The components\nmust include a 'dock' parameter on each component to indicate where it should be docked ('top', 'right',\n'bottom', 'left').
\n", + "optional": false + }, + { + "type": "Number", + "name": "pos", + "doc": "(optional) The index at which the Component will be added
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/panel/AbstractPanel.js", + "linenr": 235, + "html_filename": "AbstractPanel.html", + "href": "AbstractPanel.html#Ext-panel-AbstractPanel-method-addDocked", + "shortDoc": "Adds docked item(s) to the panel.
\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 + }, + { + "type": "Function", + "name": "handler", + "doc": "The method the event invokes.
\n", + "optional": false + }, + { + "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.
(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.
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 + }, + { + "type": "Number", + "name": "adjHeight", + "doc": "The box-adjusted height that was set
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "isSetSize", + "doc": "Whether or not the height/width are stored on the component permanently
\n", + "optional": false + }, + { + "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 + }, + { + "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 + }, + { + "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": [ + { + "type": "Object", + "name": "state", + "doc": "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 + }, + { + "type": "Number", + "name": "adjHeight", + "doc": "The box-adjusted height that was set
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "isSetSize", + "doc": "Whether or not the height/width are stored on the component permanently
\n", + "optional": false + }, + { + "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": "beforeLayout", + "member": "Ext.container.AbstractContainer", + "doc": "Occurs before componentLayout is run. Returning false from this method will prevent the containerLayout\nfrom being executed.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 853, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-beforeLayout", + "shortDoc": "Occurs before componentLayout is run. Returning false from this method will prevent the containerLayout\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 + }, + { + "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": "canActivateItem", + "member": "Ext.menu.Menu", + "doc": "Returns whether a menu item can be activated or not.
\n", + "params": [ + { + "type": "Object", + "name": "item", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Boolean", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/menu/Menu.js", + "linenr": 303, + "html_filename": "Menu2.html", + "href": "Menu2.html#Ext-menu-Menu-method-canActivateItem", + "shortDoc": "Returns whether a menu item can be activated or not.
\n" + }, + { + "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.
Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified function with\neach component. The scope (this reference) of the\nfunction call will be the scope provided or the current component. The arguments to the function\nwill be the args provided or the current component. If the function returns false at any point,\nthe cascade is stopped on that branch.
The function to call
\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope of the function (defaults to current component)
\n", + "optional": true + }, + { + "type": "Array", + "name": "args", + "doc": "(optional) The args to call the function with. The current component always passed as the last argument.
\n", + "optional": true + } + ], + "return": { + "type": "Ext.Container", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 717, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-cascade", + "shortDoc": "Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified..." + }, + { + "tagname": "method", + "name": "center", + "member": "Ext.util.Floating", + "doc": "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": "child", + "member": "Ext.container.AbstractContainer", + "doc": "Retrieves the first direct child of this container which matches the passed selector.\nThe passed in selector must comply with an Ext.ComponentQuery selector.
\n", + "params": [ + { + "type": "String", + "name": "selector", + "doc": "An Ext.ComponentQuery selector
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "Ext.Component
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 782, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-child", + "shortDoc": "Retrieves the first direct child of this container which matches the passed selector.\nThe passed in selector must com..." + }, + { + "tagname": "method", + "name": "clearListeners", + "member": "Ext.util.Observable", + "doc": "Removes all listeners for this object including the managed listeners
\n", + "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": [ + + ], + "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": "close", + "member": "Ext.panel.Panel", + "doc": "Closes the Panel. By default, this method, removes it from the DOM, destroys\nthe Panel object and all its descendant Components. The beforeclose\nevent is fired before the close happens and will cancel the close action if it returns false.
\n
Note: This method is not affected by the closeAction setting which\nonly affects the action triggered when clicking the 'close' tool in the header.\nTo hide the Panel without destroying it, call hide.
\n\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 698, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-method-close", + "shortDoc": "Closes the Panel. By default, this method, removes it from the DOM, destroys\nthe Panel object and all its descendant ..." + }, + { + "tagname": "method", + "name": "collapse", + "member": "Ext.panel.Panel", + "doc": "Collapses the panel body so that the body becomes hidden. Docked Components parallel to the\nborder towards which the collapse takes place will remain visible. Fires the beforecollapse event which will\ncancel the collapse action if it returns false.
\n", + "params": [ + { + "type": "Number", + "name": "direction", + "doc": ". The direction to collapse towards. Must be one of
True to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n", + "optional": false + }, + { + "type": "Object", + "name": "internal", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.panel.Panel", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 842, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-method-collapse", + "shortDoc": "Collapses the panel body so that the body becomes hidden. Docked Components parallel to the\nborder towards which the ..." + }, + { + "tagname": "method", + "name": "deactivateActiveItem", + "member": "Ext.menu.Menu", + "doc": "Deactivates the current active item on the menu, if one exists.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/menu/Menu.js", + "linenr": 311, + "html_filename": "Menu2.html", + "href": "Menu2.html#Ext-menu-Menu-method-deactivateActiveItem", + "shortDoc": "Deactivates the current active item on the menu, if one exists.
\n" + }, + { + "tagname": "method", + "name": "destroy", + "member": "Ext.AbstractComponent", + "doc": "Destroys the Component.
\n", + "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": [ + + ], + "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": [ + { + "type": "Object", + "name": "width", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "height", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "isSetSize", + "doc": "\n", + "optional": false + }, + { + "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": "doLayout", + "member": "Ext.container.AbstractContainer", + "doc": "Manually force this container's layout to be recalculated. The framwork uses this internally to refresh layouts\nform most cases.
\n", + "params": [ + + ], + "return": { + "type": "Ext.container.Container", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 321, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-doLayout", + "shortDoc": "Manually force this container's layout to be recalculated. The framwork uses this internally to refresh layouts\nform..." + }, + { + "tagname": "method", + "name": "down", + "member": "Ext.container.AbstractContainer", + "doc": "Retrieves the first descendant of this container which matches the passed selector.\nThe passed in selector must comply with an Ext.ComponentQuery selector.
\n", + "params": [ + { + "type": "String", + "name": "selector", + "doc": "An Ext.ComponentQuery selector
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "Ext.Component
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 792, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-down", + "shortDoc": "Retrieves the first descendant of this container which matches the passed selector.\nThe passed in selector must compl..." + }, + { + "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": "expand", + "member": "Ext.panel.Panel", + "doc": "Expands the panel body so that it becomes visible. Fires the beforeexpand event which will\ncancel the expand action if it returns false.
\n", + "params": [ + { + "type": "Boolean", + "name": "animate", + "doc": "True to animate the transition, else false (defaults to the value of the\nanimCollapse panel config)
\n", + "optional": false + } + ], + "return": { + "type": "Ext.panel.Panel", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 1123, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-method-expand", + "shortDoc": "Expands the panel body so that it becomes visible. Fires the beforeexpand event which will\ncancel the expand action ..." + }, + { + "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": [ + + ], + "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": [ + + ], + "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": 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": [ + { + "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": "getChildByElement", + "member": "Ext.container.Container", + "doc": "Return the immediate child Component in which the passed element is located.
\n", + "params": [ + { + "type": "Object", + "name": "el", + "doc": "The element to test.
\n", + "optional": false + } + ], + "return": { + "type": "Component", + "doc": "The child item which contains the passed element.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/container/Container.js", + "linenr": 162, + "html_filename": "Container.html", + "href": "Container.html#Ext-container-Container-method-getChildByElement", + "shortDoc": "Return the immediate child Component in which the passed element is located.
\n" + }, + { + "tagname": "method", + "name": "getComponent", + "member": "Ext.panel.AbstractPanel", + "doc": "Attempts a default component lookup (see Ext.container.Container.getComponent). If the component is not found in the normal\nitems, the dockedItems are searched and the matched component (if any) returned (see {@loink #getDockedComponent}). Note that docked\nitems will only be matched by component id or itemId -- if you pass a numeric index only non-docked child components will be searched.
\n", + "params": [ + { + "type": "String/Number", + "name": "comp", + "doc": "The component id, itemId or position to find
\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "The component (if found)
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/panel/AbstractPanel.js", + "linenr": 148, + "html_filename": "AbstractPanel.html", + "href": "AbstractPanel.html#Ext-panel-AbstractPanel-method-getComponent", + "shortDoc": "Attempts a default component lookup (see Ext.container.Container.getComponent). If the component is not found in the ..." + }, + { + "tagname": "method", + "name": "getDockedComponent", + "member": "Ext.panel.AbstractPanel", + "doc": "Finds a docked component by id, itemId or position. Also see getDockedItems
\n", + "params": [ + { + "type": "String/Number", + "name": "comp", + "doc": "The id, itemId or position of the docked component (see getComponent for details)
\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "The docked component (if found)
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/panel/AbstractPanel.js", + "linenr": 136, + "html_filename": "AbstractPanel.html", + "href": "AbstractPanel.html#Ext-panel-AbstractPanel-method-getDockedComponent", + "shortDoc": "Finds a docked component by id, itemId or position. Also see getDockedItems
\n" + }, + { + "tagname": "method", + "name": "getDockedItems", + "member": "Ext.panel.AbstractPanel", + "doc": "Retrieve an array of all currently docked Components.
\n", + "params": [ + { + "type": "String", + "name": "cqSelector", + "doc": "A ComponentQuery selector string to filter the returned items.
\n", + "optional": false + } + ], + "return": { + "type": "Array", + "doc": "An array of components.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/panel/AbstractPanel.js", + "linenr": 329, + "html_filename": "AbstractPanel.html", + "href": "AbstractPanel.html#Ext-panel-AbstractPanel-method-getDockedItems", + "shortDoc": "Retrieve an array of all currently docked Components.
\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": [ + + ], + "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": "getLayout", + "member": "Ext.container.AbstractContainer", + "doc": "Returns the layout instance currently associated with this Container.\nIf a layout has not been instantiated yet, that is done first
\n", + "params": [ + + ], + "return": { + "type": "Ext.layout.container.AbstractContainer", + "doc": "The layout
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 307, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-getLayout", + "shortDoc": "Returns the layout instance currently associated with this Container.\nIf a layout has not been instantiated yet, that..." + }, + { + "tagname": "method", + "name": "getLoader", + "member": "Ext.AbstractComponent", + "doc": "Gets the Ext.ComponentLoader for this Component.
\n", + "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": [ + { + "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": [ + + ], + "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": [ + + ], + "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": [ + + ], + "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'\nThe 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'\nThe 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": [ + + ], + "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": [ + { + "type": "String", + "name": "eventName", + "doc": "The 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 + }, + { + "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": "insert", + "member": "Ext.container.AbstractContainer", + "doc": "Inserts a Component into this Container at a specified index. Fires the\nbeforeadd event before inserting, then fires the add event after the\nComponent has been inserted.
\n", + "params": [ + { + "type": "Number", + "name": "index", + "doc": "The index at which the Component will be inserted\ninto the Container's items collection
\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "component", + "doc": "The child Component to insert.
\nExt uses lazy rendering, and will only render the inserted Component should\nit become necessary.
\nA Component config object may be passed in order to avoid the overhead of\nconstructing a real Component object if lazy rendering might mean that the\ninserted Component will not be rendered immediately. To take advantage of\nthis 'lazy instantiation', set the Ext.Component.xtype config\nproperty to the registered type of the Component wanted.
\nFor a list of all available xtypes, see Ext.Component.
component The Component (or config object) that was\ninserted with the Container's default config values applied.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 547, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-insert", + "shortDoc": "Inserts a Component into this Container at a specified index. Fires the\nbeforeadd event before inserting, then fires ..." + }, + { + "tagname": "method", + "name": "insertDocked", + "member": "Ext.panel.AbstractPanel", + "doc": "Inserts docked item(s) to the panel at the indicated position.
\n", + "params": [ + { + "type": "Number", + "name": "pos", + "doc": "The index at which the Component will be inserted
\n", + "optional": false + }, + { + "type": "Object/Array", + "name": "component", + "doc": ". The Component or array of components to add. The components\nmust include a 'dock' paramater on each component to indicate where it should be docked ('top', 'right',\n'bottom', 'left').
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/panel/AbstractPanel.js", + "linenr": 278, + "html_filename": "AbstractPanel.html", + "href": "AbstractPanel.html#Ext-panel-AbstractPanel-method-insertDocked", + "shortDoc": "Inserts docked item(s) to the panel at the indicated position.
\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": [ + + ], + "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": [ + + ], + "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": [ + + ], + "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": [ + + ], + "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": [ + + ], + "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\nThe xtype to check for this Component
\n", + "optional": false + }, + { + "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": "move", + "member": "Ext.container.AbstractContainer", + "doc": "Moves a Component within the Container
\n", + "params": [ + { + "type": "Number", + "name": "fromIdx", + "doc": "The index the Component you wish to move is currently at.
\n", + "optional": false + }, + { + "type": "Number", + "name": "toIdx", + "doc": "The new index for the Component.
\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "component The Component (or config object) that was moved.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 569, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-move", + "shortDoc": "Moves a Component within the Container
\n" + }, + { + "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 + }, + { + "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 + }, + { + "type": "Function", + "name": "handler", + "doc": "The method the event invokes
\n", + "optional": false + }, + { + "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.
(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 + }, + { + "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": "query", + "member": "Ext.container.AbstractContainer", + "doc": "Retrieves all descendant components which match the passed selector.\nExecutes an Ext.ComponentQuery.query using this container as its root.
\n", + "params": [ + { + "type": "String", + "name": "selector", + "doc": "Selector complying to an Ext.ComponentQuery selector
\n", + "optional": false + } + ], + "return": { + "type": "Array", + "doc": "Ext.Component's which matched the selector
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 772, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-query", + "shortDoc": "Retrieves all descendant components which match the passed selector.\nExecutes an Ext.ComponentQuery.query using this ..." + }, + { + "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 + }, + { + "type": "Array", + "name": "events", + "doc": "Array of event names to relay.
\n", + "optional": false + }, + { + "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": "remove", + "member": "Ext.container.AbstractContainer", + "doc": "Removes a component from this container. Fires the beforeremove event before removing, then fires\nthe remove event after the component has been removed.
\n", + "params": [ + { + "type": "Component/String", + "name": "component", + "doc": "The component reference or id to remove.
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "autoDestroy", + "doc": "(optional) True to automatically invoke the removed Component's Ext.Component.destroy function.\nDefaults to the value of this Container's autoDestroy config.
\n", + "optional": true + } + ], + "return": { + "type": "Ext.Component", + "doc": "component The Component that was removed.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 600, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-remove", + "shortDoc": "Removes a component from this container. Fires the beforeremove event before removing, then fires\nthe remove event a..." + }, + { + "tagname": "method", + "name": "removeAll", + "member": "Ext.container.AbstractContainer", + "doc": "Removes all components from this container.
\n", + "params": [ + { + "type": "Boolean", + "name": "autoDestroy", + "doc": "(optional) True to automatically invoke the removed Component's Ext.Component.destroy function.\nDefaults to the value of this Container's autoDestroy config.
\n", + "optional": true + } + ], + "return": { + "type": "Array", + "doc": "Array of the destroyed components
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 653, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-method-removeAll", + "shortDoc": "Removes all components from this container.
\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": "removeDocked", + "member": "Ext.panel.AbstractPanel", + "doc": "Removes the docked item from the panel.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "item", + "doc": ". The Component to remove.
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "autoDestroy", + "doc": "(optional) Destroy the component after removal.
\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/panel/AbstractPanel.js", + "linenr": 289, + "html_filename": "AbstractPanel.html", + "href": "AbstractPanel.html#Ext-panel-AbstractPanel-method-removeDocked", + "shortDoc": "Removes the docked item from the panel.
\n" + }, + { + "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 + }, + { + "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 + }, + { + "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": [ + + ], + "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": [ + { + "type": "Boolean", + "name": "active", + "doc": "True to activate the Component, false to deactivate it (defaults to false)
\n", + "optional": false + }, + { + "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": [ + { + "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": [ + { + "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 + }, + { + "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": "setIconCls", + "member": "Ext.panel.Panel", + "doc": "Set the iconCls for the panel's header. See Ext.panel.Header.iconCls.
\n", + "params": [ + { + "type": "String", + "name": "newIconCls", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 416, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-method-setIconCls", + "shortDoc": "Set the iconCls for the panel's header. See Ext.panel.Header.iconCls.
\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 + }, + { + "type": "Boolean", + "name": "targetEl", + "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", + "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 + }, + { + "type": "Number", + "name": "y", + "doc": "The new y position
\n", + "optional": false + }, + { + "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 + }, + { + "type": "Number", + "name": "top", + "doc": "The new top
\n", + "optional": false + }, + { + "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 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": "setTitle", + "member": "Ext.panel.Panel", + "doc": "Set a title for the panel's header. See Ext.panel.Header.title.
\n", + "params": [ + { + "type": "String", + "name": "newTitle", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 395, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-method-setTitle", + "shortDoc": "Set a title for the panel's header. See Ext.panel.Header.title.
\n" + }, + { + "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": "showBy", + "member": "Ext.menu.Menu", + "doc": "Shows the floating menu by the specified Component or Element.
\n", + "params": [ + { + "type": "Mixed component", + "name": "The", + "doc": "Ext.Component or Ext.core.Element to show the menu by.
\n", + "optional": false + }, + { + "type": "String", + "name": "position", + "doc": "(optional) Alignment position as used by Ext.core.Element.getAlignToXY. Defaults to defaultAlign.
(optional) Alignment offsets as used by Ext.core.Element.getAlignToXY. Defaults to undefined.
This Menu.
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/menu/Menu.js", + "linenr": 518, + "html_filename": "Menu2.html", + "href": "Menu2.html#Ext-menu-Menu-method-showBy", + "shortDoc": "Shows the floating menu by the specified Component or Element.
\n" + }, + { + "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": "toggleCollapse", + "member": "Ext.panel.Panel", + "doc": "Shortcut for performing an expand or collapse based on the current state of the panel.
\n", + "params": [ + + ], + "return": { + "type": "Ext.panel.Panel", + "doc": "this
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 1313, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-method-toggleCollapse", + "shortDoc": "Shortcut for performing an expand or collapse based on the current state of the panel.
\n" + }, + { + "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 + }, + { + "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 + }, + { + "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 + }, + { + "type": "Boolean", + "name": "loadScripts", + "doc": "(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": "dd", + "member": "Ext.panel.Panel", + "type": "Ext.dd.DragSource.", + "doc": "If this Panel is configured draggable, this property will contain\nan instance of Ext.dd.DragSource which handles dragging the Panel.
\n\n\nThe developer must provide implementations of the abstract methods of Ext.dd.DragSource\nin order to supply behaviour for each stage of the drag/drop process. See draggable.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 1336, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-property-dd", + "shortDoc": "If this Panel is configured draggable, this property will contain\nan instance of Ext.dd.DragSource which handles drag..." + }, + { + "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.The MixedCollection containing all the child items of this container.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 273, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-property-items" + }, + { + "tagname": "property", + "name": "maskOnDisable", + "member": "Ext.AbstractComponent", + "type": "Boolean", + "doc": "This is an internal flag that you use when creating custom components.\nBy default this is set to true which means that every component gets a mask when its disabled.\nComponents like FieldContainer, FieldSet, Field, Button, Tab override this property to false\nsince they want to implement custom disable logic.
\n", + "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": "add", + "member": "Ext.container.AbstractContainer", + "doc": "@bubbles\nFires after any Ext.Component is added or inserted into the container.
\n", + "params": [ + { + "type": "Ext.container.Container", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "component", + "doc": "The component that was added
\n", + "optional": false + }, + { + "type": "Number", + "name": "index", + "doc": "The index at which the component was added to the container's items collection
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 215, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-event-add", + "shortDoc": "@bubbles\nFires after any Ext.Component is added or inserted into the container.
\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 + }, + { + "type": "Ext.container.Container", + "name": "container", + "doc": "Parent Container
\n", + "optional": false + }, + { + "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": "afterlayout", + "member": "Ext.container.AbstractContainer", + "doc": "Fires when the components in this container are arranged by the associated layout manager.
\n", + "params": [ + { + "type": "Ext.container.Container", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "ContainerLayout", + "name": "layout", + "doc": "The ContainerLayout implementation for this container
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 191, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-event-afterlayout", + "shortDoc": "Fires when the components in this container are arranged by the associated layout manager.
\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": "beforeadd", + "member": "Ext.container.AbstractContainer", + "doc": "Fires before any Ext.Component is added or inserted into the container.\nA handler can return false to cancel the add.
\n", + "params": [ + { + "type": "Ext.container.Container", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "component", + "doc": "The component being added
\n", + "optional": false + }, + { + "type": "Number", + "name": "index", + "doc": "The index at which the component will be added to the container's items collection
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 198, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-event-beforeadd", + "shortDoc": "Fires before any Ext.Component is added or inserted into the container.\nA handler can return false to cancel the add.
\n" + }, + { + "tagname": "event", + "name": "beforecardswitch", + "member": "Ext.container.AbstractContainer", + "doc": "Fires before this container switches the active card. This event\nis only available if this container uses a CardLayout. Note that\nTabPanel and Carousel both get a CardLayout by default, so both\nwill have this event.\nA handler can return false to cancel the card switch.
\n", + "params": [ + { + "type": "Ext.container.Container", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "newCard", + "doc": "The card that will be switched to
\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "oldCard", + "doc": "The card that will be switched from
\n", + "optional": false + }, + { + "type": "Number", + "name": "index", + "doc": "The index of the card that will be switched to
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "animated", + "doc": "True if this cardswitch will be animated
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 232, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-event-beforecardswitch", + "shortDoc": "Fires before this container switches the active card. This event\nis only available if this container uses a CardLayou..." + }, + { + "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": "beforeremove", + "member": "Ext.container.AbstractContainer", + "doc": "Fires before any Ext.Component is removed from the container. A handler can return\nfalse to cancel the remove.
\n", + "params": [ + { + "type": "Ext.container.Container", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "component", + "doc": "The component being removed
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 207, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-event-beforeremove", + "shortDoc": "Fires before any Ext.Component is removed from the container. A handler can return\nfalse to cancel the remove.
\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": [ + { + "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 + }, + { + "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": "bodyresize", + "member": "Ext.panel.AbstractPanel", + "doc": "Fires after the Panel has been resized.
\n", + "params": [ + { + "type": "Ext.panel.Panel", + "name": "p", + "doc": "the Panel which has been resized.
\n", + "optional": false + }, + { + "type": "Number", + "name": "width", + "doc": "The Panel body's new width.
\n", + "optional": false + }, + { + "type": "Number", + "name": "height", + "doc": "The Panel body's new height.
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/panel/AbstractPanel.js", + "linenr": 93, + "html_filename": "AbstractPanel.html", + "href": "AbstractPanel.html#Ext-panel-AbstractPanel-event-bodyresize", + "shortDoc": "Fires after the Panel has been resized.
\n" + }, + { + "tagname": "event", + "name": "cardswitch", + "member": "Ext.container.AbstractContainer", + "doc": "Fires after this container switches the active card. If the card\nis switched using an animation, this event will fire after the\nanimation has finished. This event is only available if this container\nuses a CardLayout. Note that TabPanel and Carousel both get a CardLayout\nby default, so both will have this event.
\n", + "params": [ + { + "type": "Ext.container.Container", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "newCard", + "doc": "The card that has been switched to
\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "oldCard", + "doc": "The card that has been switched from
\n", + "optional": false + }, + { + "type": "Number", + "name": "index", + "doc": "The index of the card that has been switched to
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "animated", + "doc": "True if this cardswitch was animated
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 246, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-event-cardswitch", + "shortDoc": "Fires after this container switches the active card. If the card\nis switched using an animation, this event will fire..." + }, + { + "tagname": "event", + "name": "click", + "member": "Ext.menu.Menu", + "doc": "Fires when this menu is clicked
\n", + "params": [ + { + "type": "Ext.menu.Menu", + "name": "menu", + "doc": "The menu which has been clicked
\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "item", + "doc": "The menu item that was clicked. undefined if not applicable.
The underlying Ext.EventObject.
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/menu/Menu.js", + "linenr": 154, + "html_filename": "Menu2.html", + "href": "Menu2.html#Ext-menu-Menu-event-click", + "shortDoc": "Fires when this menu is clicked
\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": [ + { + "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": [ + { + "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": [ + { + "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": [ + { + "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": "iconchange", + "member": "Ext.panel.Panel", + "doc": "Fires after the Panel iconCls has been set or changed.
\n", + "params": [ + { + "type": "Ext.panel.Panel", + "name": "p", + "doc": "the Panel which has been resized.
\n", + "optional": false + }, + { + "type": "String", + "name": "newIconCls", + "doc": "The new iconCls.
\n", + "optional": false + }, + { + "type": "String", + "name": "oldIconCls", + "doc": "The previous panel iconCls.
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 323, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-event-iconchange", + "shortDoc": "Fires after the Panel iconCls has been set or changed.
\n" + }, + { + "tagname": "event", + "name": "mouseenter", + "member": "Ext.menu.Menu", + "doc": "Fires when the mouse enters this menu
\n", + "params": [ + { + "type": "Ext.menu.Menu", + "name": "menu", + "doc": "The menu
\n", + "optional": false + }, + { + "type": "Ext.EventObject", + "name": "e", + "doc": "The underlying Ext.EventObject
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/menu/Menu.js", + "linenr": 164, + "html_filename": "Menu2.html", + "href": "Menu2.html#Ext-menu-Menu-event-mouseenter", + "shortDoc": "Fires when the mouse enters this menu
\n" + }, + { + "tagname": "event", + "name": "mouseleave", + "member": "Ext.menu.Menu", + "doc": "Fires when the mouse leaves this menu
\n", + "params": [ + { + "type": "Ext.menu.Menu", + "name": "menu", + "doc": "The menu
\n", + "optional": false + }, + { + "type": "Ext.EventObject", + "name": "e", + "doc": "The underlying Ext.EventObject
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/menu/Menu.js", + "linenr": 173, + "html_filename": "Menu2.html", + "href": "Menu2.html#Ext-menu-Menu-event-mouseleave", + "shortDoc": "Fires when the mouse leaves this menu
\n" + }, + { + "tagname": "event", + "name": "mouseover", + "member": "Ext.menu.Menu", + "doc": "Fires when the mouse is hovering over this menu
\n", + "params": [ + { + "type": "Ext.menu.Menu", + "name": "menu", + "doc": "The menu
\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "item", + "doc": "The menu item that the mouse is over. undefined if not applicable.
The underlying Ext.EventObject
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/menu/Menu.js", + "linenr": 182, + "html_filename": "Menu2.html", + "href": "Menu2.html#Ext-menu-Menu-event-mouseover", + "shortDoc": "Fires when the mouse is hovering over this menu
\n" + }, + { + "tagname": "event", + "name": "move", + "member": "Ext.AbstractComponent", + "doc": "Fires after the component is moved.
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Number", + "name": "x", + "doc": "The new x position
\n", + "optional": false + }, + { + "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": "remove", + "member": "Ext.container.AbstractContainer", + "doc": "@bubbles\nFires after any Ext.Component is removed from the container.
\n", + "params": [ + { + "type": "Ext.container.Container", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.Component", + "name": "component", + "doc": "The component that was removed
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/container/AbstractContainer.js", + "linenr": 224, + "html_filename": "AbstractContainer.html", + "href": "AbstractContainer.html#Ext-container-AbstractContainer-event-remove", + "shortDoc": "@bubbles\nFires after any Ext.Component is removed from the container.
\n" + }, + { + "tagname": "event", + "name": "removed", + "member": "Ext.AbstractComponent", + "doc": "Fires when a component is removed from an Ext.container.Container
\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "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": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Number", + "name": "adjWidth", + "doc": "The box-adjusted width that was set
\n", + "optional": false + }, + { + "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 + }, + { + "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" + }, + { + "tagname": "event", + "name": "titlechange", + "member": "Ext.panel.Panel", + "doc": "Fires after the Panel title has been set or changed.
\n", + "params": [ + { + "type": "Ext.panel.Panel", + "name": "p", + "doc": "the Panel which has been resized.
\n", + "optional": false + }, + { + "type": "String", + "name": "newTitle", + "doc": "The new title.
\n", + "optional": false + }, + { + "type": "String", + "name": "oldTitle", + "doc": "The previous panel title.
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/panel/Panel.js", + "linenr": 315, + "html_filename": "Panel3.html", + "href": "Panel3.html#Ext-panel-Panel-event-titlechange", + "shortDoc": "Fires after the Panel title has been set or changed.
\n" + } + ], + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/menu/Menu.js", + "linenr": 1, + "html_filename": "Menu2.html", + "href": "Menu2.html#Ext-menu-Menu", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": true, + "superclasses": [ + "Ext.AbstractComponent", + "Ext.Component", + "Ext.container.AbstractContainer", + "Ext.container.Container", + "Ext.panel.AbstractPanel", + "Ext.panel.Panel" + ], + "subclasses": [ + "Ext.menu.ColorPicker", + "Ext.menu.DatePicker" + ], + "mixedInto": [ + + ], + "allMixins": [ + "Ext.util.Floating", + "Ext.util.Observable", + "Ext.util.Animate", + "Ext.state.Stateful" + ] +}); \ No newline at end of file