X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.toolbar.Toolbar.Button.js?ds=sidebyside diff --git a/docs/output/Ext.toolbar.Toolbar.Button.js b/docs/output/Ext.toolbar.Toolbar.Button.js new file mode 100644 index 00000000..11c3ed6a --- /dev/null +++ b/docs/output/Ext.toolbar.Toolbar.Button.js @@ -0,0 +1,5195 @@ +Ext.data.JsonP.Ext_toolbar_Toolbar_Button({ + "tagname": "class", + "name": "Ext.toolbar.Toolbar.Button", + "doc": "\n", + "extends": "Ext.button.Button", + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": false, + "private": true, + "cfg": [ + { + "tagname": "cfg", + "name": "allowDepress", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

False to not allow a pressed Button to be depressed (defaults to undefined). Only valid when enableToggle is true.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 224, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-allowDepress" + }, + { + "tagname": "cfg", + "name": "arrowAlign", + "member": "Ext.button.Button", + "type": "String", + "doc": "

(Optional) The side of the Button box to render the arrow if the button has an associated menu.\nTwo values are allowed:

\n\n\n\n\n\n

Defaults to 'right'.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 393, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-arrowAlign", + "shortDoc": "(Optional) The side of the Button box to render the arrow if the button has an associated menu.\nTwo values are allowe..." + }, + { + "tagname": "cfg", + "name": "arrowCls", + "member": "Ext.button.Button", + "type": "String", + "doc": "

(Optional) The className used for the inner arrow element if the button has a menu.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 405, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-arrowCls" + }, + { + "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\n

You 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\n

This 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}\n
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 109, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-autoEl", + "shortDoc": "A tag name or DomHelper spec used to create the Element which will\nencapsulate this Component.\n\n\nYou do not normally ..." + }, + { + "tagname": "cfg", + "name": "autoRender", + "member": "Ext.AbstractComponent", + "type": "Mixed", + "doc": "

This 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\n

Specify as true to have this Component render to the document body upon first show.

\n\n\n

Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.

\n\n\n

This defaults to true for the Window class.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 478, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-autoRender", + "shortDoc": "This config is intended mainly for floating Components which may or may not be shown. Instead\nof using renderTo in th..." + }, + { + "tagname": "cfg", + "name": "autoScroll", + "member": "Ext.Component", + "type": "Boolean", + "doc": "

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).

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 169, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-cfg-autoScroll", + "shortDoc": "true to use overflow:'auto' on the components layout element and show scroll bars automatically when\nnecessary, false..." + }, + { + "tagname": "cfg", + "name": "autoShow", + "member": "Ext.AbstractComponent", + "type": "Boolean", + "doc": "

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": "autoWidth", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

By default, if a width is not specified the button will attempt to stretch horizontally to fit its content.\nIf the button is being managed by a width sizing layout (hbox, fit, anchor), set this to false to prevent\nthe button from doing this automatic sizing.\nDefaults to undefined.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 431, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-autoWidth", + "shortDoc": "By default, if a width is not specified the button will attempt to stretch horizontally to fit its content.\nIf the bu..." + }, + { + "tagname": "cfg", + "name": "baseCls", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The base CSS class to add to all buttons. (Defaults to 'x-btn')

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 296, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-baseCls" + }, + { + "tagname": "cfg", + "name": "baseParams", + "member": "Ext.button.Button", + "type": "Object", + "doc": "

An object literal of parameters to pass to the url when the href property is specified.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 326, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-baseParams" + }, + { + "tagname": "cfg", + "name": "border", + "member": "Ext.AbstractComponent", + "type": "Number/String", + "doc": "

Specifies the border for this component. The border can be a single numeric value to apply to all sides or\nit can be a CSS style specification for each style, for example: '10 5 3 10'.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 339, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-border", + "shortDoc": "Specifies the border for this component. The border can be a single numeric value to apply to all sides or\nit can be ..." + }, + { + "tagname": "cfg", + "name": "clickEvent", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu).\nDefaults to 'click'.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 271, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-clickEvent", + "shortDoc": "The DOM event that will fire the handler of the button. This can be any valid event name (dblclick, contextmenu).\nDef..." + }, + { + "tagname": "cfg", + "name": "cls", + "member": "Ext.button.Button", + "type": "String", + "doc": "

A CSS class string to apply to the button's main element.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 420, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-cls" + }, + { + "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\n

Generally, 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\n

The 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.

\n\n\n\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 401, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-contentEl", + "shortDoc": "Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content\nfor this comp..." + }, + { + "tagname": "cfg", + "name": "data", + "member": "Ext.AbstractComponent", + "type": "Mixed", + "doc": "

The initial set of data to apply to the tpl to\nupdate the content area of the Component.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 239, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-data" + }, + { + "tagname": "cfg", + "name": "disabled", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

True to start disabled (defaults to false)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 203, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-disabled" + }, + { + "tagname": "cfg", + "name": "disabledCls", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "

CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 281, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-disabledCls" + }, + { + "tagname": "cfg", + "name": "draggable", + "member": "Ext.Component", + "type": "Mixed", + "doc": "

Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle.

\n\n\n

This may also be specified as a config object for the ComponentDragger which is instantiated to perform dragging.

\n\n\n

For 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\n

\n\n
new 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": "enableToggle", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

True to enable pressed/not pressed toggling (defaults to false)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 229, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-enableToggle" + }, + { + "tagname": "cfg", + "name": "floating", + "member": "Ext.Component", + "type": "Boolean", + "doc": "

Specify as true to float the Component outside of the document flow using CSS absolute positioning.

\n\n\n

Components such as Windows and Menus are floating\nby default.

\n\n\n

Floating Components that are programatically rendered will register themselves with the global\nZIndexManager

\n\n\n

Floating Components as child items of a Container

\n\n\n

A floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by\nexamining the ownerCt chain.

\n\n\n

When configured as floating, Components acquire, at render time, a ZIndexManager which manages a stack\nof related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when\nthe Component's toFront method is called.

\n\n\n

The ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is floating. This is so that\ndescendant floating Components of floating Containers (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative\nto any siblings, but always above that floating ancestor Container.

\n\n\n

If no floating ancestor is found, a floating Component registers itself with the default ZIndexManager.

\n\n\n

Floating components do not participate in the Container's layout. Because of this, they are not rendered until you explicitly\nshow them.

\n\n\n

After rendering, the ownerCt reference is deleted, and the floatParent property is set to the found floating ancestor Container.\nIf no floating ancestor Container was found the floatParent property will not be set.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 175, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-cfg-floating", + "shortDoc": "Specify as true to float the Component outside of the document flow using CSS absolute positioning.\n\n\nComponents such..." + }, + { + "tagname": "cfg", + "name": "focusCls", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The CSS class to add to a button when it is in the focussed state. (Defaults to 'x-btn-focus')

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 314, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-focusCls" + }, + { + "tagname": "cfg", + "name": "focusOnToFront", + "member": "Ext.util.Floating", + "type": "Boolean", + "doc": "

Specifies whether the floated component should be automatically focused when it is\nbrought to the front. Defaults to true.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 9, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-cfg-focusOnToFront", + "shortDoc": "Specifies whether the floated component should be automatically focused when it is\nbrought to the front. Defaults to ..." + }, + { + "tagname": "cfg", + "name": "frame", + "member": "Ext.AbstractComponent", + "type": "Boolean", + "doc": "

Specify as true to have the Component inject framing elements within the Component at render time to\nprovide a graphical rounded frame around the Component content.

\n\n\n

This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer\nprior to version 9 which do not support rounded corners natively.

\n\n\n

The extra space taken up by this framing is available from the read only property frameSize.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 198, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-frame", + "shortDoc": "Specify as true to have the Component inject framing elements within the Component at render time to\nprovide a graphi..." + }, + { + "tagname": "cfg", + "name": "handleMouseEvents", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 284, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-handleMouseEvents" + }, + { + "tagname": "cfg", + "name": "handler", + "member": "Ext.button.Button", + "type": "Function", + "doc": "

A function called when the button is clicked (can be used instead of click event).\nThe handler is passed the following parameters:

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 182, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-handler", + "shortDoc": "A function called when the button is clicked (can be used instead of click event).\nThe handler is passed the followin..." + }, + { + "tagname": "cfg", + "name": "height", + "member": "Ext.AbstractComponent", + "type": "Number", + "doc": "

The height of this component in pixels.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 334, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-height" + }, + { + "tagname": "cfg", + "name": "hidden", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

True to start hidden (defaults to false)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 199, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-hidden" + }, + { + "tagname": "cfg", + "name": "hideMode", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "

A String which specifies how this Component's encapsulating DOM element will be hidden.\nValues may be

\nDefaults to '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": "icon", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The path to an image to display in the button (the image will be set as the background-image\nCSS property of the button by default, so if you want a mixed icon/text button, set cls:'x-btn-text-icon')

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 177, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-icon", + "shortDoc": "The path to an image to display in the button (the image will be set as the background-image\nCSS property of the butt..." + }, + { + "tagname": "cfg", + "name": "iconAlign", + "member": "Ext.button.Button", + "type": "String", + "doc": "

(Optional) The side of the Button box to render the icon. Four values are allowed:

\n\n\n\n\n\n

Defaults to 'left'.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 380, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-iconAlign", + "shortDoc": "(Optional) The side of the Button box to render the icon. Four values are allowed:\n\n\n\n'top'\n'right'\n'bottom'\n'left'\n\n..." + }, + { + "tagname": "cfg", + "name": "iconCls", + "member": "Ext.button.Button", + "type": "String", + "doc": "

A css class which sets a background image to be used as the icon for this button

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 260, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-iconCls" + }, + { + "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\n

It 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\n

Instead 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\n

Note 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\n

Note: to avoid complications imposed by a unique id also see itemId.

\n\n\n

Note: to access the container of a Component see ownerCt.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 50, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-id", + "shortDoc": "The unique id of this component instance (defaults to an auto-assigned id).\n\n\nIt should not be necessary to use this ..." + }, + { + "tagname": "cfg", + "name": "itemId", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "

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.

\n\n\n
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\n
\n\n\n

Also see id, query, down and child.

\n\n\n

Note: to access the container of an item see ownerCt.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 66, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-itemId", + "shortDoc": "An itemId can be used as an alternative way to get a reference to a component\nwhen no object reference is available. ..." + }, + { + "tagname": "cfg", + "name": "listeners", + "member": "Ext.util.Observable", + "type": "Object", + "doc": "

(optional)

A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\naddListener example for attaching multiple handlers at once.

\n\n

DOM events from ExtJs Components

\n\n\n

While 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:

\n\n
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});\n
\n\n\n

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 103, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-cfg-listeners", + "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. T..." + }, + { + "tagname": "cfg", + "name": "loader", + "member": "Ext.AbstractComponent", + "type": "Ext.ComponentLoader/Object", + "doc": "

A 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\n

Specifies 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\n

Warning: 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\n

Warning: 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": "menu", + "member": "Ext.button.Button", + "type": "Mixed", + "doc": "

Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 243, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-menu", + "shortDoc": "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to unde..." + }, + { + "tagname": "cfg", + "name": "menuActiveCls", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The CSS class to add to a button when it's menu is active. (Defaults to 'x-btn-menu-active')

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 320, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-menuActiveCls" + }, + { + "tagname": "cfg", + "name": "menuAlign", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The position to align the menu to (see Ext.core.Element.alignTo for more details, defaults to 'tl-bl?').

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 248, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-menuAlign" + }, + { + "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\n

Warning: 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.button.Button", + "type": "Number", + "doc": "

The minimum width for this button (used to give a set of buttons a common width).\nSee also Ext.panel.Panel.minButtonWidth.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 190, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-minWidth", + "shortDoc": "The minimum width for this button (used to give a set of buttons a common width).\nSee also Ext.panel.Panel.minButtonW..." + }, + { + "tagname": "cfg", + "name": "overCls", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The CSS class to add to a button when it is in the over (hovered) state. (Defaults to 'x-btn-over')

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 308, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-overCls" + }, + { + "tagname": "cfg", + "name": "overflowText", + "member": "Ext.button.Button", + "type": "String", + "doc": "

If used in a Toolbar, the\ntext to be used if this item is shown in the overflow menu. See also\nExt.toolbar.Item.overflowText.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 254, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-overflowText", + "shortDoc": "If used in a Toolbar, the\ntext to be used if this item is shown in the overflow menu. See also\nExt.toolbar.Item.overf..." + }, + { + "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": "params", + "member": "Ext.button.Button", + "type": "Object", + "doc": "

An object literal of parameters to pass to the url when the href property is specified.\nAny params override baseParams. New params can be set using the setParams method.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 331, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-params", + "shortDoc": "An object literal of parameters to pass to the url when the href property is specified.\nAny params override baseParam..." + }, + { + "tagname": "cfg", + "name": "plugins", + "member": "Ext.AbstractComponent", + "type": "Object/Array", + "doc": "

An object or array of objects that will provide custom functionality for this component. The only\nrequirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.\nWhen a component is created, if any plugins are available, the component will call the init method on each\nplugin, passing a reference to itself. Each plugin can then call methods or respond to events on the\ncomponent as needed to provide its functionality.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 491, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-plugins", + "shortDoc": "An object or array of objects that will provide custom functionality for this component. The only\nrequirement for a ..." + }, + { + "tagname": "cfg", + "name": "pressed", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

True to start pressed (only if enableToggle = true)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 207, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-pressed" + }, + { + "tagname": "cfg", + "name": "pressedCls", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The CSS class to add to a button when it is in the pressed state. (Defaults to 'x-btn-pressed')

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 302, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-pressedCls" + }, + { + "tagname": "cfg", + "name": "preventDefault", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

True to prevent the default action when the clickEvent is processed. Defaults to true.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 278, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-preventDefault" + }, + { + "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\n

After 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.

\n\n

For example, a Component which rendered an image, and description into its element might use the following properties\ncoded into its prototype:

\n\n
renderTpl: '&lt;img src=\"{imageUrl}\" class=\"x-image-component-img\">&lt;div class=\"x-image-component-desc\">{description}&gt;/div&lt;',\n\nrenderSelectors: {\n    image: 'img.x-image-component-img',\n    descEl: 'div.x-image-component-desc'\n}\n
\n\n

After 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.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 158, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-renderSelectors", + "shortDoc": "An object containing properties specifying DomQuery selectors which identify child elements\ncreated by the render pro..." + }, + { + "tagname": "cfg", + "name": "renderTo", + "member": "Ext.AbstractComponent", + "type": "Mixed", + "doc": "

Specify the id of the element, a DOM element or an existing Element that this component\nwill be rendered into.

\n\n\n
\n\n\n

See render also.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 183, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-renderTo", + "shortDoc": "Specify the id of the element, a DOM element or an existing Element that this component\nwill be rendered into.\n\n\n\nNot..." + }, + { + "tagname": "cfg", + "name": "renderTpl", + "member": "Ext.AbstractComponent", + "type": "Mixed", + "doc": "

An XTemplate used to create the internal structure inside this Component's\nencapsulating Element.

\n\n\n

You 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.

\n\n\n

This is intended to allow the developer to create application-specific utility Components with customized\ninternal structure.

\n\n\n

Upon 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": "repeat", + "member": "Ext.button.Button", + "type": "Boolean/Object", + "doc": "

True to repeat fire the click event while the mouse is down. This can also be\na ClickRepeater config object (defaults to false).

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 215, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-repeat", + "shortDoc": "True to repeat fire the click event while the mouse is down. This can also be\na ClickRepeater config object (defaults..." + }, + { + "tagname": "cfg", + "name": "resizable", + "member": "Ext.Component", + "type": "Mixed", + "doc": "

Specify as true to apply a Resizer to this Component\nafter rendering.

\n\n\n

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

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 154, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-cfg-resizable", + "shortDoc": "Specify as true to apply a Resizer to this Component\nafter rendering.\n\n\nMay also be specified as a config object to b..." + }, + { + "tagname": "cfg", + "name": "resizeHandles", + "member": "Ext.Component", + "type": "String", + "doc": "

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": "scale", + "member": "Ext.button.Button", + "type": "String", + "doc": "

(Optional) The size of the Button. Three values are allowed:

\n\n\n\n\n\n

Defaults to 'small'.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 357, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-scale", + "shortDoc": "(Optional) The size of the Button. Three values are allowed:\n\n\n\n'small'Results in the button element being 16px high...." + }, + { + "tagname": "cfg", + "name": "scope", + "member": "Ext.button.Button", + "type": "Object", + "doc": "

The scope (this reference) in which the\nhandler and toggleHandler is\nexecuted. Defaults to this Button.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 374, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-scope" + }, + { + "tagname": "cfg", + "name": "shadow", + "member": "Ext.util.Floating", + "type": "String/Boolean", + "doc": "

Specifies whether the floating component should be given a shadow. Set to\ntrue to automatically create an Ext.Shadow, or a string indicating the\nshadow's display Ext.Shadow.mode. Set to false to disable the shadow.\n(Defaults to 'sides'.)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 16, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-cfg-shadow", + "shortDoc": "Specifies whether the floating component should be given a shadow. Set to\ntrue to automatically create an Ext.Shadow,..." + }, + { + "tagname": "cfg", + "name": "stateEvents", + "member": "Ext.state.Stateful", + "type": "Array", + "doc": "

An array of events that, when fired, should trigger this object to\nsave its state (defaults to none). stateEvents may be any type\nof event supported by this object, including browser or custom events\n(e.g., ['click', 'customerchange']).

\n\n\n

See stateful for an explanation of saving and\nrestoring object state.

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js", + "linenr": 64, + "html_filename": "Stateful.html", + "href": "Stateful.html#Ext-state-Stateful-cfg-stateEvents", + "shortDoc": "An array of events that, when fired, should trigger this object to\nsave its state (defaults to none). stateEvents may..." + }, + { + "tagname": "cfg", + "name": "stateId", + "member": "Ext.state.Stateful", + "type": "String", + "doc": "

The unique id for this object to use for state management purposes.

\n\n

See 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.

\n

To set the state provider for the current page:

\n
Ext.state.Manager.setProvider(new Ext.state.CookieProvider({\n    expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now\n}));\n
\n

A stateful object attempts to save state when one of the events\nlisted in the stateEvents configuration fires.

\n

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.

\n

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

.\n

During construction, a stateful object attempts to restore\nits state by calling Ext.state.Manager.get passing the\nstateId

\n

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.

\n

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     
\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 300, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-style", + "shortDoc": "A custom style specification to be applied to this component's Element. Should be a valid argument to\nExt.core.Eleme..." + }, + { + "tagname": "cfg", + "name": "styleHtmlCls", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "

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": "tabIndex", + "member": "Ext.button.Button", + "type": "Number", + "doc": "

Set a DOM tabIndex for this button (defaults to undefined)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 220, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-tabIndex" + }, + { + "tagname": "cfg", + "name": "text", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The button text to be used as innerHTML (html tags are accepted)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 173, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-text" + }, + { + "tagname": "cfg", + "name": "toFrontOnShow", + "member": "Ext.Component", + "type": "Boolean", + "doc": "

True to automatically call toFront when the show method is called\non an already visible, floating component (default is true).

\n\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 199, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-cfg-toFrontOnShow", + "shortDoc": "True to automatically call toFront when the show method is called\non an already visible, floating component (default ..." + }, + { + "tagname": "cfg", + "name": "toggleGroup", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The group this toggle button is a member of (only 1 per group can be pressed)

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 211, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-toggleGroup" + }, + { + "tagname": "cfg", + "name": "toggleHandler", + "member": "Ext.button.Button", + "type": "Function", + "doc": "

Function called when a Button with enableToggle set to true is clicked. Two arguments are passed:

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 235, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-toggleHandler", + "shortDoc": "Function called when a Button with enableToggle set to true is clicked. Two arguments are passed:\nbutton : Ext.button..." + }, + { + "tagname": "cfg", + "name": "tooltip", + "member": "Ext.button.Button", + "type": "String/Object", + "doc": "

The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config object

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 195, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-tooltip", + "shortDoc": "The tooltip for the button - can be a string to be used as innerHTML (html tags are accepted) or QuickTips config obj..." + }, + { + "tagname": "cfg", + "name": "tooltipType", + "member": "Ext.button.Button", + "type": "String", + "doc": "

The type of tooltip to use. Either 'qtip' (default) for QuickTips or 'title' for title attribute.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 290, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-tooltipType" + }, + { + "tagname": "cfg", + "name": "tpl", + "member": "Ext.AbstractComponent", + "type": "Mixed", + "doc": "

An Ext.Template, Ext.XTemplate\nor an array of strings to form an Ext.XTemplate.\nUsed in conjunction with the data and\ntplWriteMode configurations.

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 231, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-tpl", + "shortDoc": "An Ext.Template, Ext.XTemplate\nor an array of strings to form an Ext.XTemplate.\nUsed in conjunction with the data and..." + }, + { + "tagname": "cfg", + "name": "tplWriteMode", + "member": "Ext.AbstractComponent", + "type": "String", + "doc": "

The Ext.(X)Template method to use when\nupdating the content area of the Component. Defaults to 'overwrite'\n(see Ext.XTemplate.overwrite).

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 245, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-cfg-tplWriteMode", + "shortDoc": "The Ext.(X)Template method to use when\nupdating the content area of the Component. Defaults to 'overwrite'\n(see Ext.X..." + }, + { + "tagname": "cfg", + "name": "type", + "member": "Ext.button.Button", + "type": "String", + "doc": "

submit, reset or button - defaults to 'button'

\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 265, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-cfg-type" + }, + { + "tagname": "cfg", + "name": "ui", + "member": "Ext.AbstractComponent", + "type": "String/Array", + "doc": "

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": "Toolbar.Button", + "member": "Ext.button.Button", + "doc": "

Create a new button

\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/button/Button.js", + "linenr": 1, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-constructor", + "shortDoc": "

Create a new button

\n" + }, + { + "tagname": "method", + "name": "addButton", + "member": "Ext.toolbar.Toolbar.Button", + "doc": "

Adds a button (or buttons). See Ext.button.Button for more info on the config.

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n", + "params": [ + { + "type": "Object/Array", + "name": "config", + "doc": "

A button config or array of configs

\n", + "optional": false + } + ], + "return": { + "type": "Ext.button.Button/Array", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 110, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button-method-addButton", + "shortDoc": "Adds a button (or buttons). See Ext.button.Button for more info on the config.\n\nNote: See the notes within Ext.contai..." + }, + { + "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": "addDom", + "member": "Ext.toolbar.Toolbar.Button", + "doc": "

Adds a new element to the toolbar from the passed Ext.core.DomHelper config

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n", + "params": [ + { + "type": "Object", + "name": "config", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.Toolbar.Item", + "doc": "

The element's item

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 24, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button-method-addDom", + "shortDoc": "Adds a new element to the toolbar from the passed Ext.core.DomHelper config\n\nNote: See the notes within Ext.container..." + }, + { + "tagname": "method", + "name": "addElement", + "member": "Ext.toolbar.Toolbar.Button", + "doc": "

Adds any standard HTML element to the toolbar

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n", + "params": [ + { + "type": "Mixed", + "name": "el", + "doc": "

The element or id of the element to add

\n", + "optional": false + } + ], + "return": { + "type": "Ext.Toolbar.Item", + "doc": "

The element's item

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 90, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button-method-addElement", + "shortDoc": "

Adds any standard HTML element to the toolbar

\n\n

Note: See the notes within Ext.container.Container.add.

\n\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.

\n", + "optional": false + }, + { + "type": "String", + "name": "", + "doc": "

[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:

\n\n
this.addEvents('storeloaded', 'storecleared');\n
\n\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 452, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-addEvents", + "shortDoc": "

Adds the specified events to the list of events which this Observable may fire.

\n" + }, + { + "tagname": "method", + "name": "addField", + "member": "Ext.toolbar.Toolbar.Button", + "doc": "

Adds a dynamically rendered Ext.form field (Text, ComboBox, etc). Note: the field should not have\nbeen rendered yet. For a field that has already been rendered, use addElement.

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n", + "params": [ + { + "type": "Ext.form.field.Field", + "name": "field", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.Toolbar.Item", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 34, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button-method-addField", + "shortDoc": "Adds a dynamically rendered Ext.form field (Text, ComboBox, etc). Note: the field should not have\nbeen rendered yet. ..." + }, + { + "tagname": "method", + "name": "addFill", + "member": "Ext.toolbar.Toolbar.Button", + "doc": "

Forces subsequent additions into the float:right toolbar

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 82, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button-method-addFill", + "shortDoc": "

Forces subsequent additions into the float:right toolbar

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n" + }, + { + "tagname": "method", + "name": "addItem", + "member": "Ext.toolbar.Toolbar.Button", + "doc": "

Adds any Toolbar.Item or subclass

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n", + "params": [ + { + "type": "Ext.Toolbar.Item", + "name": "item", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.Toolbar.Item", + "doc": "

The item

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 100, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button-method-addItem", + "shortDoc": "

Adds any Toolbar.Item or subclass

\n\n

Note: See the notes within Ext.container.Container.add.

\n\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.

\n", + "optional": true + }, + { + "type": "Object", + "name": "options", + "doc": "

(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:


\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});
\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\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.

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.

\n", + "optional": false + }, + { + "type": "Object", + "name": "opt", + "doc": "

Optional. If the ename parameter was an event name, this\nis the addListener options.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 155, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-addManagedListener", + "shortDoc": "

Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n" + }, + { + "tagname": "method", + "name": "addSeparator", + "member": "Ext.toolbar.Toolbar.Button", + "doc": "

Adds a separator

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n", + "params": [ + + ], + "return": { + "type": "Ext.toolbar.Item", + "doc": "

The separator item

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 64, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button-method-addSeparator", + "shortDoc": "

Adds a separator

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n" + }, + { + "tagname": "method", + "name": "addSpacer", + "member": "Ext.toolbar.Toolbar.Button", + "doc": "

Adds a spacer element

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n", + "params": [ + + ], + "return": { + "type": "Ext.Toolbar.Spacer", + "doc": "

The spacer item

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 73, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button-method-addSpacer", + "shortDoc": "

Adds a spacer element

\n\n

Note: See the notes within Ext.container.Container.add.

\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": "addText", + "member": "Ext.toolbar.Toolbar.Button", + "doc": "

Adds text to the toolbar

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n", + "params": [ + { + "type": "String", + "name": "text", + "doc": "

The text to add

\n", + "optional": false + } + ], + "return": { + "type": "Ext.Toolbar.Item", + "doc": "

The element's item

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 14, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button-method-addText", + "shortDoc": "

Adds text to the toolbar

\n\n

Note: See the notes within Ext.container.Container.add.

\n\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.

\n

The 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.

\n

Properties include

\n

Animating an Element

\nWhen animating an Element, the following properties may be specified in from, to, and keyframe objects:\n

Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state\nwill result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to\ndirectly animate certain properties of Components.

\n

Animating a Component

\nWhen animating an Element, the following properties may be specified in from, to, and keyframe objects:\n

For example, to animate a Window to a new size, ensuring that its internal layout, and any shadow is correct:

\n
myWindow = Ext.create('Ext.window.Window', {\n    title: 'Test Component animation',\n    width: 500,\n    height: 300,\n    layout: {\n        type: 'hbox',\n        align: 'stretch'\n    },\n    items: [{\n        title: 'Left: 33%',\n        margins: '5 0 5 5',\n        flex: 1\n    }, {\n        title: 'Left: 66%',\n        margins: '5 5 5 5',\n        flex: 2\n    }]\n});\nmyWindow.show();\nmyWindow.header.el.on('click', function() {\n    myWindow.animate({\n        to: {\n            width: (myWindow.getWidth() == 500) ? 700 : 500,\n            height: (myWindow.getHeight() == 300) ? 400 : 300,\n        }\n    });\n});\n
\n

For performance reasons, by default, the internal layout is only updated when the Window reaches its final \"to\" size. If dynamic updating of the Window's child\nComponents is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.

\n\n", + "params": [ + { + "type": "Object", + "name": "config", + "doc": "

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": "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": "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.

\n", + "optional": true + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 55, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-capture", + "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..." + }, + { + "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": "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": "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\n

By default, this Component is constrained to be within the container it was added to, or the element\nit was rendered to.

\n\n\n

An alternative constraint may be passed.

\n\n", + "params": [ + { + "type": "Mixed", + "name": "constrainTo", + "doc": "

Optional. The Element or Region into which this Component is to be constrained.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/Floating.js", + "linenr": 133, + "html_filename": "Floating.html", + "href": "Floating.html#Ext-util-Floating-method-doConstrain", + "shortDoc": "Moves this floating Component into a constrain region.\n\n\nBy default, this Component is constrained to be within the c..." + }, + { + "tagname": "method", + "name": "enable", + "member": "Ext.AbstractComponent", + "doc": "

Enable the component

\n", + "params": [ + { + "type": "Boolean", + "name": "silent", + "doc": "

Passing false will supress the 'enable' event from being fired.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2055, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-enable", + "shortDoc": "

Enable the component

\n" + }, + { + "tagname": "method", + "name": "enableBubble", + "member": "Ext.util.Observable", + "doc": "

Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.

\n\n\n

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\n

Example:

\n\n\n
Ext.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});\n
\n\n", + "params": [ + { + "type": "String/Array", + "name": "events", + "doc": "

The event name to bubble, or an Array of event names.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 554, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-enableBubble", + "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...." + }, + { + "tagname": "method", + "name": "findLayoutController", + "member": "Ext.AbstractComponent", + "doc": "

This method finds the topmost active layout who's processing will eventually determine the size and position of this\nComponent.

\n

This method is useful when dynamically adding Components into Containers, and some processing must take place after the\nfinal sizing and positioning of the Component has been performed.

\n\n", + "params": [ + + ], + "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\n

See 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\n

See 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\n

An 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": "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": "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": "getPressed", + "member": "Ext.button.Button", + "doc": "

Gets the pressed button in the passed group or null

\n", + "params": [ + { + "type": "String", + "name": "group", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "

Button

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 1316, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-getPressed", + "shortDoc": "

Gets the pressed button in the passed group or null

\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": "getTemplateArgs", + "member": "Ext.button.Button", + "doc": "

This method returns an object which provides substitution parameters for the XTemplate used\nto create this Button's DOM structure.

\n\n\n

Instances or subclasses which use a different Template to create a different DOM structure may need to provide their\nown implementation of this method.

\n\n\n

The default implementation which provides data for the default template returns an Object containing the\nfollowing properties:

\n\n\n
\n\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "

Substitution data for a Template.

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 681, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-getTemplateArgs", + "shortDoc": "This method returns an object which provides substitution parameters for the XTemplate used\nto create this Button's D..." + }, + { + "tagname": "method", + "name": "getText", + "member": "Ext.button.Button", + "doc": "

Gets the text for this Button

\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "

The button text

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 901, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-getText", + "shortDoc": "

Gets the text for this Button

\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\n
var t = new Ext.form.field.Text();\nalert(t.getXType());  // alerts 'textfield'\n
\n\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "

The xtype

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 962, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-method-getXType", + "shortDoc": "Gets the xtype for this component as registered with Ext.ComponentManager. For a list of all\navailable xtypes, see th..." + }, + { + "tagname": "method", + "name": "getXTypes", + "member": "Ext.AbstractComponent", + "doc": "

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all\navailable xtypes, see the Ext.Component header.

\n\n\n

If using your own subclasses, be aware that a Component must register its own xtype\nto participate in determination of inherited xtypes.

\n\n\n

Example usage:

\n\n\n
var t = new Ext.form.field.Text();\nalert(t.getXTypes());  // alerts 'component/field/textfield'\n
\n\n", + "params": [ + + ], + "return": { + "type": "String", + "doc": "

The xtype hierarchy string

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1938, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-getXTypes", + "shortDoc": "Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all\navailable xtypes, see the Ext..." + }, + { + "tagname": "method", + "name": "hasActiveFx", + "member": "Ext.util.Animate", + "doc": "

@deprecated 4.0 Replaced by getActiveAnimation\nReturns thq current animation if this object has any effects actively running or queued, else returns false.

\n", + "params": [ + + ], + "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": "hasVisibleMenu", + "member": "Ext.button.Button", + "doc": "

Returns true if the button has a menu and it is visible

\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 960, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-hasVisibleMenu", + "shortDoc": "

Returns true if the button has a menu and it is visible

\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)

\n", + "optional": false + }, + { + "type": "Function", + "name": "callback", + "doc": "

(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.

\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": 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": "hideMenu", + "member": "Ext.button.Button", + "doc": "

Hide this button's menu (if it has one)

\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 950, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-hideMenu", + "shortDoc": "

Hide this button's menu (if it has one)

\n" + }, + { + "tagname": "method", + "name": "insertButton", + "member": "Ext.toolbar.Toolbar.Button", + "doc": "

Inserts any Ext.toolbar.Item/Ext.button.Button at the specified index.

\n\n

Note: See the notes within Ext.container.Container.add.

\n\n", + "params": [ + { + "type": "Number", + "name": "index", + "doc": "

The index where the item is to be inserted

\n", + "optional": false + }, + { + "type": "Object/Ext.Toolbar.Item/Ext.button.Button/Array", + "name": "item", + "doc": "

The button, or button config object to be\ninserted, or an array of buttons/configs.

\n", + "optional": false + } + ], + "return": { + "type": "Ext.button.Button/Item", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 45, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button-method-insertButton", + "shortDoc": "Inserts any Ext.toolbar.Item/Ext.button.Button at the specified index.\n\nNote: See the notes within Ext.container.Cont..." + }, + { + "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.

\n\n

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\n

If using your own subclasses, be aware that a Component must register its own xtype\nto participate in determination of inherited xtypes.

\n\n\n

For a list of all available xtypes, see the Ext.Component header.

\n\n\n

Example usage:

\n\n\n
var t = new Ext.form.field.Text();\nvar isText = t.isXType('textfield');        // true\nvar isBoxSubclass = t.isXType('field');       // true, descended from Ext.form.field.Base\nvar isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.field.Base instance\n
\n\n", + "params": [ + { + "type": "String", + "name": "xtype", + "doc": "

The 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": "nextNode", + "member": "Ext.AbstractComponent", + "doc": "

Returns the next node in the Component tree in tree traversal order.

\n\n\n

Note 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\n

Optionally selects the next sibling which matches the passed ComponentQuery selector.

\n\n\n

May also be refered to as next()

\n\n\n

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with nextNode

\n\n", + "params": [ + { + "type": "String", + "name": "selector", + "doc": "

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\n

This 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\n

Usage:

\n\n
Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n    console.log('Ajax request made to ' + options.url);\n});\n
\n", + "params": [ + { + "type": "Function", + "name": "c", + "doc": "

The 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.

\n", + "optional": true + }, + { + "type": "Object", + "name": "options", + "doc": "

(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\n

Note 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\n

Optionally selects the previous sibling which matches the passed ComponentQuery selector.

\n\n\n

May also be refered to as prev()

\n\n\n

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with previousNode

\n\n", + "params": [ + { + "type": "String", + "name": "selector", + "doc": "

Optional. A ComponentQuery selector to filter the preceding items.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "

The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1779, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-previousSibling", + "shortDoc": "Returns the previous sibling of this Component.\n\n\nOptionally selects the previous sibling which matches the passed Co..." + }, + { + "tagname": "method", + "name": "relayEvents", + "member": "Ext.util.Observable", + "doc": "

Relays selected events from the specified Observable as if the events were fired by this.

\n", + "params": [ + { + "type": "Object", + "name": "origin", + "doc": "

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.

\n" + }, + { + "tagname": "method", + "name": "releaseCapture", + "member": "Ext.util.Observable", + "doc": "

Removes all added captures from the Observable.

\n", + "params": [ + { + "type": "Observable", + "name": "o", + "doc": "

The Observable to release

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": true, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 46, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-releaseCapture", + "shortDoc": "

Removes all added captures from the Observable.

\n" + }, + { + "tagname": "method", + "name": "removeCls", + "member": "Ext.AbstractComponent", + "doc": "

Removes a CSS class from the top level element representing this component.

\n", + "params": [ + { + "type": "Object", + "name": "className", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.Component", + "doc": "

Returns the Component to allow method chaining.

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 2171, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-removeCls", + "shortDoc": "

Removes a CSS class from the top level element representing this component.

\n" + }, + { + "tagname": "method", + "name": "removeClsWithUI", + "member": "Ext.AbstractComponent", + "doc": "

Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes\nit from all elements of this component.

\n", + "params": [ + { + "type": "String/Array", + "name": "cls", + "doc": "

A string or an array of strings to remove to the uiCls

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1368, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-removeClsWithUI", + "shortDoc": "Removes a cls to the uiCls array, which will also call removeUIClsToElement and removes\nit from all elements of this ..." + }, + { + "tagname": "method", + "name": "removeListener", + "member": "Ext.util.Observable", + "doc": "

Removes an event handler.

\n", + "params": [ + { + "type": "String", + "name": "eventName", + "doc": "

The type of event the handler was associated with.

\n", + "optional": false + }, + { + "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.

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 196, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", + "shortDoc": "

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.

\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js", + "linenr": 502, + "html_filename": "Observable.html", + "href": "Observable.html#Ext-util-Observable-method-resumeEvents", + "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..." + }, + { + "tagname": "method", + "name": "sequenceFx", + "member": "Ext.util.Animate", + "doc": "

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\n

If a Window is superceded by another Window, deactivating it hides its shadow.

\n\n\n

This 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": "setHandler", + "member": "Ext.button.Button", + "doc": "

Assigns this Button's click handler

\n", + "params": [ + { + "type": "Function", + "name": "handler", + "doc": "

The function to call when the button is clicked

\n", + "optional": false + }, + { + "type": "Object", + "name": "scope", + "doc": "

(optional) The scope (this reference) in which the handler function is executed.\nDefaults to this Button.

\n", + "optional": true + } + ], + "return": { + "type": "Ext.button.Button", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 855, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-setHandler", + "shortDoc": "

Assigns this Button's click handler

\n" + }, + { + "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:

\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": 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": "setIcon", + "member": "Ext.button.Button", + "doc": "

Sets the background image (inline style) of the button. This method also changes\nthe value of the icon config internally.

\n", + "params": [ + { + "type": "String", + "name": "icon", + "doc": "

The path to an image to display in the button

\n", + "optional": false + } + ], + "return": { + "type": "Ext.button.Button", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 884, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-setIcon", + "shortDoc": "Sets the background image (inline style) of the button. This method also changes\nthe value of the icon config intern..." + }, + { + "tagname": "method", + "name": "setIconCls", + "member": "Ext.button.Button", + "doc": "

Sets the CSS class that provides a background image to use as the button's icon. This method also changes\nthe value of the iconCls config internally.

\n", + "params": [ + { + "type": "String", + "name": "cls", + "doc": "

The CSS class providing the icon image

\n", + "optional": false + } + ], + "return": { + "type": "Ext.button.Button", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 758, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-setIconCls", + "shortDoc": "Sets the CSS class that provides a background image to use as the button's icon. This method also changes\nthe value ..." + }, + { + "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": "setParams", + "member": "Ext.button.Button", + "doc": "

Only valid if the Button was originally configured with a url

\n\n\n

Sets the href of the link dynamically according to the params passed, and any baseParams configured.

\n\n", + "params": [ + { + "type": "Object", + "name": "params", + "doc": "

Parameters to use in the href URL.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 734, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-setParams", + "shortDoc": "Only valid if the Button was originally configured with a url\n\n\nSets the href of the link dynamically according to th..." + }, + { + "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": "setScale", + "member": "Ext.button.Button", + "doc": "

Method to change the scale of the button. See scale for allowed configurations.

\n", + "params": [ + { + "type": "String", + "name": "scale", + "doc": "

The scale to change to.

\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 1144, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-setScale", + "shortDoc": "

Method to change the scale of the button. See scale for allowed configurations.

\n" + }, + { + "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}.

\n", + "params": [ + { + "type": "Mixed", + "name": "width", + "doc": "

The new width to set. This may be one of:

\n", + "optional": false + }, + { + "type": "Mixed", + "name": "height", + "doc": "

The new height to set (not required if a size object is passed as the first arg).\nThis may be one of:

\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": 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": "setText", + "member": "Ext.button.Button", + "doc": "

Sets this Button's text

\n", + "params": [ + { + "type": "String", + "name": "text", + "doc": "

The button text

\n", + "optional": false + } + ], + "return": { + "type": "Ext.button.Button", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 868, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-setText", + "shortDoc": "

Sets this Button's text

\n" + }, + { + "tagname": "method", + "name": "setTooltip", + "member": "Ext.button.Button", + "doc": "

Sets the tooltip for this Button.

\n", + "params": [ + { + "type": "String/Object", + "name": "tooltip", + "doc": "

. This may be:

\n", + "optional": false + }, + { + "type": "Object", + "name": "initial", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.button.Button", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 777, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-setTooltip", + "shortDoc": "

Sets the tooltip for this Button.

\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:

\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": 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.

\n\n\n

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)

\n", + "optional": false + }, + { + "type": "Function", + "name": "callback", + "doc": "

(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.

\n", + "optional": true + } + ], + "return": { + "type": "Component", + "doc": "

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": "showMenu", + "member": "Ext.button.Button", + "doc": "

Show this button's menu (if it has one)

\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 932, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-showMenu", + "shortDoc": "

Show this button's menu (if it has one)

\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\n

If 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.

\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": 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": "toggle", + "member": "Ext.button.Button", + "doc": "

If a state it passed, it becomes the pressed state otherwise the current state is toggled.

\n", + "params": [ + { + "type": "Boolean", + "name": "state", + "doc": "

(optional) Force a particular state

\n", + "optional": true + }, + { + "type": "Boolean", + "name": "supressEvent", + "doc": "

(optional) True to stop events being fired when calling this method.

\n", + "optional": true + } + ], + "return": { + "type": "Ext.button.Button", + "doc": "

this

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 909, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-method-toggle", + "shortDoc": "

If a state it passed, it becomes the pressed state otherwise the current state is toggled.

\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.

\n\n\n

Example:\n

var owningTabPanel = grid.up('tabpanel');\n
\n\n", + "params": [ + { + "type": "String", + "name": "selector", + "doc": "

Optional. The simple selector to test.

\n", + "optional": false + } + ], + "return": { + "type": "Container", + "doc": "

The matching ancestor Container (or undefined if no match was found).

\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 1728, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-method-up", + "shortDoc": "Walks up the ownerCt axis looking for an ancestor Container which matches\nthe passed simple selector.\n\n\nExample:\nvar ..." + }, + { + "tagname": "method", + "name": "update", + "member": "Ext.AbstractComponent", + "doc": "

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": "disabled", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

Read-only. True if this button is disabled

\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 161, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-property-disabled" + }, + { + "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\n

Floating Components that are programatically rendered will not have a floatParent property.

\n\n\n

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\n

For example, the dropdown BoundList of a ComboBox which is in a Window will have the Window as its\nfloatParent

\n\n\n

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\n

This is an object containing the frame width in pixels for all four sides of the Component containing\nthe following properties:

\n\n\n
\n\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 207, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-property-frameSize", + "shortDoc": "Read-only property indicating the width of any framing elements which were added within the encapsulating element\nto ..." + }, + { + "tagname": "property", + "name": "hidden", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

Read-only. True if this button is hidden

\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 155, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-property-hidden" + }, + { + "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": "menu", + "member": "Ext.button.Button", + "type": "Menu", + "doc": "

The Menu object associated with this Button when configured with the menu config option.

\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 425, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-property-menu" + }, + { + "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\n

Note: 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": "pressed", + "member": "Ext.button.Button", + "type": "Boolean", + "doc": "

Read-only. True if this button is pressed (only if enableToggle = true)

\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 167, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-property-pressed" + }, + { + "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": "template", + "member": "Ext.button.Button", + "type": "Ext.Template", + "doc": "

(Optional)

\n\n

A Template used to create the Button's DOM structure.

\n\n\n

Instances, or subclasses which need a different DOM structure may provide a different\ntemplate layout in conjunction with an implementation of getTemplateArgs.

\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 411, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-property-template", + "shortDoc": "(Optional)\n\nA Template used to create the Button's DOM structure.\n\n\nInstances, or subclasses which need a different D..." + }, + { + "tagname": "property", + "name": "zIndexManager", + "member": "Ext.Component", + "type": "Ext.ZIndexManager", + "doc": "

Optional. Only present for floating Components after they have been rendered.

\n\n\n

A reference to the ZIndexManager which is managing this Component's z-index.

\n\n\n

The 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\n

Floating Components may be brought to the front or sent to the back of the z-index stack.

\n\n\n

This defaults to the global ZIndexManager for floating Components that are programatically\nrendered.

\n\n\n

For 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\n

See floating and floatParent

\n\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/Component.js", + "linenr": 206, + "html_filename": "Component.html", + "href": "Component.html#Ext-Component-property-zIndexManager", + "shortDoc": "Optional. Only present for floating Components after they have been rendered.\n\n\nA reference to the ZIndexManager whic..." + } + ], + "event": [ + { + "tagname": "event", + "name": "activate", + "member": "Ext.AbstractComponent", + "doc": "

Fires after a Component has been visually activated.

\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 540, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-activate", + "shortDoc": "

Fires after a Component has been visually activated.

\n" + }, + { + "tagname": "event", + "name": "added", + "member": "Ext.AbstractComponent", + "doc": "

Fires after a Component had been added to a Container.

\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "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": "afterrender", + "member": "Ext.AbstractComponent", + "doc": "

Fires after the component rendering is finished.

\n\n\n

The afterrender event is fired after this Component has been rendered, been postprocesed\nby any afterRender method defined for the Component.

\n\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 627, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-afterrender", + "shortDoc": "Fires after the component rendering is finished.\n\n\nThe afterrender event is fired after this Component has been rende..." + }, + { + "tagname": "event", + "name": "beforeactivate", + "member": "Ext.AbstractComponent", + "doc": "

Fires before a Component has been visually activated.\nReturning false from an event listener can prevent the activate\nfrom occurring.

\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 532, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforeactivate", + "shortDoc": "Fires before a Component has been visually activated.\nReturning false from an event listener can prevent the activate..." + }, + { + "tagname": "event", + "name": "beforedeactivate", + "member": "Ext.AbstractComponent", + "doc": "

Fires before a Component has been visually deactivated.\nReturning false from an event listener can prevent the deactivate\nfrom occurring.

\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 546, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforedeactivate", + "shortDoc": "Fires before a Component has been visually deactivated.\nReturning false from an event listener can prevent the deacti..." + }, + { + "tagname": "event", + "name": "beforedestroy", + "member": "Ext.AbstractComponent", + "doc": "

Fires before the component is destroyed. Return false from an event handler to stop the destroy.

\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 635, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforedestroy", + "shortDoc": "

Fires before the component is destroyed. Return false from an event handler to stop the destroy.

\n" + }, + { + "tagname": "event", + "name": "beforehide", + "member": "Ext.AbstractComponent", + "doc": "

Fires before the component is hidden when calling the hide method.\nReturn false from an event handler to stop the hide.

\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 593, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforehide", + "shortDoc": "

Fires before the component is hidden when calling the hide method.\nReturn false from an event handler to stop the hide.

\n" + }, + { + "tagname": "event", + "name": "beforerender", + "member": "Ext.AbstractComponent", + "doc": "

Fires before the component is rendered. Return false from an\nevent handler to stop the render.

\n", + "params": [ + { + "type": "Ext.Component", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/AbstractComponent.js", + "linenr": 614, + "html_filename": "AbstractComponent.html", + "href": "AbstractComponent.html#Ext-AbstractComponent-event-beforerender", + "shortDoc": "

Fires before the component is rendered. Return false from an\nevent handler to stop the render.

\n" + }, + { + "tagname": "event", + "name": "beforeshow", + "member": "Ext.AbstractComponent", + "doc": "

Fires before the component is shown when calling the show method.\nReturn false from an event handler to stop the show.

\n", + "params": [ + { + "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": "click", + "member": "Ext.button.Button", + "doc": "

Fires when this button is clicked

\n", + "params": [ + { + "type": "Button", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "EventObject", + "name": "e", + "doc": "

The click event

\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 447, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-event-click", + "shortDoc": "

Fires when this button 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": "menuhide", + "member": "Ext.button.Button", + "doc": "

If this button has a menu, this event fires when it is hidden

\n", + "params": [ + { + "type": "Button", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Menu", + "name": "menu", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 487, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-event-menuhide", + "shortDoc": "

If this button has a menu, this event fires when it is hidden

\n" + }, + { + "tagname": "event", + "name": "menushow", + "member": "Ext.button.Button", + "doc": "

If this button has a menu, this event fires when it is shown

\n", + "params": [ + { + "type": "Button", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Menu", + "name": "menu", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 479, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-event-menushow", + "shortDoc": "

If this button has a menu, this event fires when it is shown

\n" + }, + { + "tagname": "event", + "name": "menutriggerout", + "member": "Ext.button.Button", + "doc": "

If this button has a menu, this event fires when the mouse leaves the menu triggering element

\n", + "params": [ + { + "type": "Button", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Menu", + "name": "menu", + "doc": "\n", + "optional": false + }, + { + "type": "EventObject", + "name": "e", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 504, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-event-menutriggerout", + "shortDoc": "

If this button has a menu, this event fires when the mouse leaves the menu triggering element

\n" + }, + { + "tagname": "event", + "name": "menutriggerover", + "member": "Ext.button.Button", + "doc": "

If this button has a menu, this event fires when the mouse enters the menu triggering element

\n", + "params": [ + { + "type": "Button", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Menu", + "name": "menu", + "doc": "\n", + "optional": false + }, + { + "type": "EventObject", + "name": "e", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 495, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-event-menutriggerover", + "shortDoc": "

If this button has a menu, this event fires when the mouse enters the menu triggering element

\n" + }, + { + "tagname": "event", + "name": "mouseout", + "member": "Ext.button.Button", + "doc": "

Fires when the mouse exits the button

\n", + "params": [ + { + "type": "Button", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Event", + "name": "e", + "doc": "

The event object

\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 471, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-event-mouseout", + "shortDoc": "

Fires when the mouse exits the button

\n" + }, + { + "tagname": "event", + "name": "mouseover", + "member": "Ext.button.Button", + "doc": "

Fires when the mouse hovers over the button

\n", + "params": [ + { + "type": "Button", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Event", + "name": "e", + "doc": "

The event object

\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 463, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-event-mouseover", + "shortDoc": "

Fires when the mouse hovers over the button

\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": "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": "toggle", + "member": "Ext.button.Button", + "doc": "

Fires when the 'pressed' state of this button changes (only if enableToggle = true)

\n", + "params": [ + { + "type": "Button", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Boolean", + "name": "pressed", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/button/Button.js", + "linenr": 455, + "html_filename": "Button.html", + "href": "Button.html#Ext-button-Button-event-toggle", + "shortDoc": "

Fires when the 'pressed' state of this button changes (only if enableToggle = true)

\n" + } + ], + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/toolbar/Toolbar-legacy.js", + "linenr": 1, + "html_filename": "Toolbar-legacy.html", + "href": "Toolbar-legacy.html#Ext-toolbar-Toolbar-Button", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": true, + "superclasses": [ + "Ext.AbstractComponent", + "Ext.Component", + "Ext.button.Button" + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + "Ext.util.Floating", + "Ext.util.Observable", + "Ext.util.Animate", + "Ext.state.Stateful" + ] +}); \ No newline at end of file