An abstract base class which provides shared methods for Components across the Sencha product line.
- *Please refer to sub class's documentation
+ * An abstract base class which provides shared methods for Components across the Sencha product line. + * + * Please refer to sub class's documentation + * @private */ - Ext.define('Ext.AbstractComponent', { /* Begin Definitions */ + requires: [ + 'Ext.ComponentQuery', + 'Ext.ComponentManager' + ], mixins: { observable: 'Ext.util.Observable', @@ -28,23 +32,20 @@ Ext.define('Ext.AbstractComponent', { state: 'Ext.state.Stateful' }, - requires: [ + // The "uses" property specifies class which are used in an instantiated AbstractComponent. + // They do *not* have to be loaded before this class may be defined - that is what "requires" is for. + uses: [ 'Ext.PluginManager', 'Ext.ComponentManager', - 'Ext.core.Element', - 'Ext.core.DomHelper', + 'Ext.Element', + 'Ext.DomHelper', 'Ext.XTemplate', 'Ext.ComponentQuery', - 'Ext.LoadMask', 'Ext.ComponentLoader', 'Ext.EventManager', 'Ext.layout.Layout', - 'Ext.layout.component.Auto' - ], - - // Please remember to add dependencies whenever you use it - // I had to fix these many times already - uses: [ + 'Ext.layout.component.Auto', + 'Ext.LoadMask', 'Ext.ZIndexManager' ], @@ -63,270 +64,386 @@ Ext.define('Ext.AbstractComponent', { /** * @cfg {String} id - *The unique id of this component instance (defaults to an {@link #getId auto-assigned id}).
- *It should not be necessary to use this configuration except for singleton objects in your application. - * Components created with an id may be accessed globally using {@link Ext#getCmp Ext.getCmp}.
- *Instead of using assigned ids, use the {@link #itemId} config, and {@link Ext.ComponentQuery ComponentQuery} which - * provides selector-based searching for Sencha Components analogous to DOM querying. The {@link Ext.container.Container Container} - * class contains {@link Ext.container.Container#down shortcut methods} to query its descendant Components by selector.
- *Note that this id will also be used as the element id for the containing HTML element - * that is rendered to the page for this component. This allows you to write id-based CSS - * rules to style the specific instance of this component uniquely, and also to select - * sub-elements using this component's id as the parent.
- *Note: to avoid complications imposed by a unique id also see {@link #itemId}.
Note: to access the container of a Component see {@link #ownerCt}.
An itemId can be used as an alternative way to get a reference to a component
- * when no object reference is available. Instead of using an {@link #id} with
- * {@link Ext}.{@link Ext#getCmp getCmp}, use itemId with
+ * An itemId can be used as an alternative way to get a reference to a component when no object reference is
+ * available. Instead of using an `{@link #id}` with {@link Ext}.{@link Ext#getCmp getCmp}, use `itemId` with
* {@link Ext.container.Container}.{@link Ext.container.Container#getComponent getComponent} which will retrieve
- * itemId's or {@link #id}'s. Since itemId's are an index to the
- * container's internal MixedCollection, the itemId is scoped locally to the container --
- * avoiding potential conflicts with {@link Ext.ComponentManager} which requires a unique
- * {@link #id}.
-var c = new Ext.panel.Panel({ //
- {@link Ext.Component#height height}: 300,
- {@link #renderTo}: document.body,
- {@link Ext.container.Container#layout layout}: 'auto',
- {@link Ext.container.Container#items items}: [
- {
- itemId: 'p1',
- {@link Ext.panel.Panel#title title}: 'Panel 1',
- {@link Ext.Component#height height}: 150
- },
- {
- itemId: 'p2',
- {@link Ext.panel.Panel#title title}: 'Panel 2',
- {@link Ext.Component#height height}: 150
- }
- ]
-})
-p1 = c.{@link Ext.container.Container#getComponent getComponent}('p1'); // not the same as {@link Ext#getCmp Ext.getCmp()}
-p2 = p1.{@link #ownerCt}.{@link Ext.container.Container#getComponent getComponent}('p2'); // reference via a sibling
- * Also see {@link #id}, {@link Ext.container.Container#query},
- * {@link Ext.container.Container#down} and {@link Ext.container.Container#child}.
Note: to access the container of an item see {@link #ownerCt}.
- */ - - /** - * This Component's owner {@link Ext.container.Container Container} (defaults to undefined, and is set automatically when - * this Component is added to a Container). Read-only. - *Note: to access items within the Container see {@link #itemId}.
- * @type Ext.Container - * @property ownerCt - */ - - /** - * @private - * Flag set by the container layout to which this Component is added. - * If the layout manages this Component's width, it sets the value to 1. - * If it does NOT manage the width, it sets it to 2. - * If the layout MAY affect the width, but only if the owning Container has a fixed width, this is set to 0. - * @type boolean - * @property layoutManagedWidth - */ - - /** - * @private - * Flag set by the container layout to which this Component is added. - * If the layout manages this Component's height, it sets the value to 1. - * If it does NOT manage the height, it sets it to 2. - * If the layout MAY affect the height, but only if the owning Container has a fixed height, this is set to 0. - * @type boolean - * @property layoutManagedHeight - */ - - /** - * @cfg {Mixed} autoEl - *A tag name or {@link Ext.core.DomHelper DomHelper} spec used to create the {@link #getEl Element} which will - * encapsulate this Component.
- *You do not normally need to specify this. For the base classes {@link Ext.Component} and {@link Ext.container.Container}, - * this defaults to 'div'. The more complex Sencha classes use a more complex - * DOM structure specified by their own {@link #renderTpl}s.
- *This is intended to allow the developer to create application-specific utility Components encapsulated by - * different DOM elements. Example usage:
-{
- xtype: 'component',
- autoEl: {
- tag: 'img',
- src: 'http://www.example.com/example.jpg'
- }
-}, {
- xtype: 'component',
- autoEl: {
- tag: 'blockquote',
- html: 'autoEl is cool!'
- }
-}, {
- xtype: 'container',
- autoEl: 'ul',
- cls: 'ux-unordered-list',
- items: {
- xtype: 'component',
- autoEl: 'li',
- html: 'First list item'
- }
-}
-An {@link Ext.XTemplate XTemplate} used to create the internal structure inside this Component's - * encapsulating {@link #getEl Element}.
- *You do not normally need to specify this. For the base classes {@link Ext.Component}
- * and {@link Ext.container.Container}, this defaults to null which means that they will be initially rendered
- * with no internal structure; they render their {@link #getEl Element} empty. The more specialized ExtJS and Touch classes
- * which use a more complex DOM structure, provide their own template definitions.
This is intended to allow the developer to create application-specific utility Components with customized - * internal structure.
- *Upon rendering, any created child elements may be automatically imported into object properties using the - * {@link #renderSelectors} option.
+ * @property {Boolean} layoutManagedHeight + * @private + * Flag set by the container layout to which this Component is added. + * If the layout manages this Component's height, it sets the value to 1. + * If it does NOT manage the height, it sets it to 2. + * If the layout MAY affect the height, but only if the owning Container has a fixed height, this is set to 0. + */ + + /** + * @cfg {String/Object} autoEl + * A tag name or {@link Ext.DomHelper DomHelper} spec used to create the {@link #getEl Element} which will + * encapsulate this Component. + * + * You do not normally need to specify this. For the base classes {@link Ext.Component} and + * {@link Ext.container.Container}, this defaults to **'div'**. The more complex Sencha classes use a more + * complex DOM structure specified by their own {@link #renderTpl}s. + * + * This is intended to allow the developer to create application-specific utility Components encapsulated by + * different DOM elements. Example usage: + * + * { + * xtype: 'component', + * autoEl: { + * tag: 'img', + * src: 'http://www.example.com/example.jpg' + * } + * }, { + * xtype: 'component', + * autoEl: { + * tag: 'blockquote', + * html: 'autoEl is cool!' + * } + * }, { + * xtype: 'container', + * autoEl: 'ul', + * cls: 'ux-unordered-list', + * items: { + * xtype: 'component', + * autoEl: 'li', + * html: 'First list item' + * } + * } + */ + + /** + * @cfg {Ext.XTemplate/String/String[]} renderTpl + * An {@link Ext.XTemplate XTemplate} used to create the internal structure inside this Component's encapsulating + * {@link #getEl Element}. + * + * You do not normally need to specify this. For the base classes {@link Ext.Component} and + * {@link Ext.container.Container}, this defaults to **`null`** which means that they will be initially rendered + * with no internal structure; they render their {@link #getEl Element} empty. The more specialized ExtJS and Touch + * classes which use a more complex DOM structure, provide their own template definitions. + * + * This is intended to allow the developer to create application-specific utility Components with customized + * internal structure. + * + * Upon rendering, any created child elements may be automatically imported into object properties using the + * {@link #renderSelectors} and {@link #childEls} options. */ renderTpl: null, /** - * @cfg {Object} renderSelectors - -An object containing properties specifying {@link Ext.DomQuery DomQuery} selectors which identify child elements -created by the render process. - -After the Component's internal structure is rendered according to the {@link #renderTpl}, this object is iterated through, -and the found Elements are added as properties to the Component using the `renderSelector` property name. - -For example, a Component which rendered an image, and description into its element might use the following properties -coded into its prototype: - - renderTpl: '<img src="{imageUrl}" class="x-image-component-img"><div class="x-image-component-desc">{description}>/div<', - - renderSelectors: { - image: 'img.x-image-component-img', - descEl: 'div.x-image-component-desc' - } - -After rendering, the Component would have a propertyimage referencing its child `img` Element,
-and a property `descEl` referencing the `div` Element which contains the description.
-
- * @markdown
+ * @cfg {Object} renderData
+ *
+ * The data used by {@link #renderTpl} in addition to the following property values of the component:
+ *
+ * - id
+ * - ui
+ * - uiCls
+ * - baseCls
+ * - componentCls
+ * - frame
+ *
+ * See {@link #renderSelectors} and {@link #childEls} for usage examples.
*/
/**
- * @cfg {Mixed} renderTo
- * Specify the id of the element, a DOM element or an existing Element that this component - * will be rendered into.
See {@link #render} also.
{desc}
' + * ], + * renderData: { + * title: "Error", + * desc: "Something went wrong" + * }, + * renderSelectors: { + * titleEl: 'h1.title', + * descEl: 'p' + * }, + * listeners: { + * afterrender: function(cmp){ + * // After rendering the component will have a titleEl and descEl properties + * cmp.titleEl.setStyle({color: "red"}); + * } + * } + * }); + * + * For a faster, but less flexible, alternative that achieves the same end result (properties for child elements on the + * Component after render), see {@link #childEls} and {@link #addChildEls}. + */ + + /** + * @cfg {Object[]} childEls + * An array describing the child elements of the Component. Each member of the array + * is an object with these properties: + * + * - `name` - The property name on the Component for the child element. + * - `itemId` - The id to combine with the Component's id that is the id of the child element. + * - `id` - The id of the child element. + * + * If the array member is a string, it is equivalent to `{ name: m, itemId: m }`. + * + * For example, a Component which renders a title and body text: + * + * Ext.create('Ext.Component', { + * renderTo: Ext.getBody(), + * renderTpl: [ + * '{msg}
', + * ], + * renderData: { + * title: "Error", + * msg: "Something went wrong" + * }, + * childEls: ["title"], + * listeners: { + * afterrender: function(cmp){ + * // After rendering the component will have a title property + * cmp.title.setStyle({color: "red"}); + * } + * } + * }); + * + * A more flexible, but somewhat slower, approach is {@link #renderSelectors}. + */ + + /** + * @cfg {String/HTMLElement/Ext.Element} renderTo + * Specify the id of the element, a DOM element or an existing Element that this component will be rendered into. + * + * **Notes:** + * + * Do *not* use this option if the Component is to be a child item of a {@link Ext.container.Container Container}. + * It is the responsibility of the {@link Ext.container.Container Container}'s + * {@link Ext.container.Container#layout layout manager} to render and manage its child items. + * + * When using this config, a call to render() is not required. + * + * See `{@link #render}` also. */ /** * @cfg {Boolean} frame - *Specify as true to have the Component inject framing elements within the Component at render time to
- * provide a graphical rounded frame around the Component content.
This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer - * prior to version 9 which do not support rounded corners natively.
- *The extra space taken up by this framing is available from the read only property {@link #frameSize}.
+ * Specify as `true` to have the Component inject framing elements within the Component at render time to provide a + * graphical rounded frame around the Component content. + * + * This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet + * Explorer prior to version 9 which do not support rounded corners natively. + * + * The extra space taken up by this framing is available from the read only property {@link #frameSize}. */ /** - *Read-only property indicating the width of any framing elements which were added within the encapsulating element - * to provide graphical, rounded borders. See the {@link #frame} config.
- *This is an object containing the frame width in pixels for all four sides of the Component containing - * the following properties:
top The width of the top framing element in pixels.right The width of the right framing element in pixels.bottom The width of the bottom framing element in pixels.left The width of the left framing element in pixels.The sizing and positioning of a Component's internal Elements is the responsibility of - * the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.
- *Generally, developers will not use this configuration as all provided Components which need their internal - * elements sizing (Such as {@link Ext.form.field.Base input fields}) come with their own componentLayout managers.
- *The {@link Ext.layout.container.Auto default layout manager} will be used on instances of the base Ext.Component class - * which simply sizes the Component's encapsulating element to the height and width specified in the {@link #setSize} method.
- */ - - /** - * @cfg {Mixed} tpl - * An{@link #data} and
- * {@link #tplWriteMode} configurations.
- */
-
- /**
- * @cfg {Mixed} data
- * The initial set of data to apply to the {@link #tpl} to
- * update the content area of the Component.
- */
-
- /**
- * @cfg {String} tplWriteMode The Ext.(X)Template method to use when
- * updating the content area of the Component. Defaults to 'overwrite'
- * (see {@link Ext.XTemplate#overwrite}).
+ * The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout
+ * manager which sizes a Component's internal structure in response to the Component being sized.
+ *
+ * Generally, developers will not use this configuration as all provided Components which need their internal
+ * elements sizing (Such as {@link Ext.form.field.Base input fields}) come with their own componentLayout managers.
+ *
+ * The {@link Ext.layout.container.Auto default layout manager} will be used on instances of the base Ext.Component
+ * class which simply sizes the Component's encapsulating element to the height and width specified in the
+ * {@link #setSize} method.
+ */
+
+ /**
+ * @cfg {Ext.XTemplate/Ext.Template/String/String[]} tpl
+ * An {@link Ext.Template}, {@link Ext.XTemplate} or an array of strings to form an Ext.XTemplate. Used in
+ * conjunction with the `{@link #data}` and `{@link #tplWriteMode}` configurations.
+ */
+
+ /**
+ * @cfg {Object} data
+ * The initial set of data to apply to the `{@link #tpl}` to update the content area of the Component.
+ */
+
+ /**
+ * @cfg {String} xtype
+ * The `xtype` configuration option can be used to optimize Component creation and rendering. It serves as a
+ * shortcut to the full componet name. For example, the component `Ext.button.Button` has an xtype of `button`.
+ *
+ * You can define your own xtype on a custom {@link Ext.Component component} by specifying the
+ * {@link Ext.Class#alias alias} config option with a prefix of `widget`. For example:
+ *
+ * Ext.define('PressMeButton', {
+ * extend: 'Ext.button.Button',
+ * alias: 'widget.pressmebutton',
+ * text: 'Press Me'
+ * })
+ *
+ * Any Component can be created implicitly as an object config with an xtype specified, allowing it to be
+ * declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is
+ * rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources
+ * until they are actually needed. In complex, nested layouts containing many Components, this can make a
+ * noticeable improvement in performance.
+ *
+ * // Explicit creation of contained Components:
+ * var panel = new Ext.Panel({
+ * ...
+ * items: [
+ * Ext.create('Ext.button.Button', {
+ * text: 'OK'
+ * })
+ * ]
+ * };
+ *
+ * // Implicit creation using xtype:
+ * var panel = new Ext.Panel({
+ * ...
+ * items: [{
+ * xtype: 'button',
+ * text: 'OK'
+ * }]
+ * };
+ *
+ * In the first example, the button will always be created immediately during the panel's initialization. With
+ * many added Components, this approach could potentially slow the rendering of the page. In the second example,
+ * the button will not be created or rendered until the panel is actually displayed in the browser. If the panel
+ * is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and
+ * will never consume any resources whatsoever.
+ */
+
+ /**
+ * @cfg {String} tplWriteMode
+ * The Ext.(X)Template method to use when updating the content area of the Component.
+ * See `{@link Ext.XTemplate#overwrite}` for information on default mode.
*/
tplWriteMode: 'overwrite',
/**
- * @cfg {String} baseCls
- * The base CSS class to apply to this components's element. This will also be prepended to
- * elements within this component like Panel's body will get a class x-panel-body. This means
- * that if you create a subclass of Panel, and you want it to get all the Panels styling for the
- * element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this
- * component.
+ * @cfg {String} [baseCls='x-component']
+ * The base CSS class to apply to this components's element. This will also be prepended to elements within this
+ * component like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and
+ * you want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use
+ * componentCls to add specific styling for this component.
*/
baseCls: Ext.baseCSSPrefix + 'component',
/**
* @cfg {String} componentCls
- * CSS Class to be added to a components root level element to give distinction to it
- * via styling.
+ * CSS Class to be added to a components root level element to give distinction to it via styling.
*/
/**
- * @cfg {String} cls
- * An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be
- * useful for adding customized styles to the component or any of its children using standard CSS rules.
+ * @cfg {String} [cls='']
+ * An optional extra CSS class that will be added to this component's Element. This can be useful
+ * for adding customized styles to the component or any of its children using standard CSS rules.
*/
/**
- * @cfg {String} overCls
- * An optional extra CSS class that will be added to this component's Element when the mouse moves
- * over the Element, and removed when the mouse moves out. (defaults to ''). This can be
- * useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.
+ * @cfg {String} [overCls='']
+ * An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element,
+ * and removed when the mouse moves out. This can be useful for adding customized 'active' or 'hover' styles to the
+ * component or any of its children using standard CSS rules.
*/
/**
- * @cfg {String} disabledCls
+ * @cfg {String} [disabledCls='x-item-disabled']
* CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.
*/
disabledCls: Ext.baseCSSPrefix + 'item-disabled',
/**
- * @cfg {String/Array} ui
+ * @cfg {String/String[]} ui
* A set style for a component. Can be a string or an Array of multiple strings (UIs)
*/
ui: 'default',
/**
- * @cfg {Array} uiCls
+ * @cfg {String[]} uiCls
* An array of of classNames which are currently applied to this component
* @private
*/
@@ -334,31 +451,30 @@ and a property `descEl` referencing the `div` Element which contains the descrip
/**
* @cfg {String} style
- * A custom style specification to be applied to this component's Element. Should be a valid argument to
- * {@link Ext.core.Element#applyStyles}.
- *
- new Ext.panel.Panel({
- title: 'Some Title',
- renderTo: Ext.getBody(),
- width: 400, height: 300,
- layout: 'form',
- items: [{
- xtype: 'textarea',
- style: {
- width: '95%',
- marginBottom: '10px'
- }
- },
- new Ext.button.Button({
- text: 'Send',
- minWidth: '100',
- style: {
- marginBottom: '10px'
- }
- })
- ]
- });
- 'display' : The Component will be hidden using the display: none style.'visibility' : The Component will be hidden using the visibility: hidden style.'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document. This
- * is useful when a hidden Component must maintain measurable dimensions. Hiding using display results
- * in a Component having zero dimensions.'display'.
+ * A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be:
+ *
+ * - `'display'` : The Component will be hidden using the `display: none` style.
+ * - `'visibility'` : The Component will be hidden using the `visibility: hidden` style.
+ * - `'offsets'` : The Component will be hidden by absolutely positioning it out of the visible area of the document.
+ * This is useful when a hidden Component must maintain measurable dimensions. Hiding using `display` results in a
+ * Component having zero dimensions.
*/
hideMode: 'display',
/**
* @cfg {String} contentEl
- * Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content
- * for this component.
{@link Ext.container.Container#layout layout}
- * scheme that the Component may use. It is just HTML. Layouts operate on child {@link Ext.container.Container#items items}.x-hidden or the x-hide-display CSS class to
- * prevent a brief flicker of the content before it is rendered to the panel.The minimum value in pixels which this Component will set its height to.
- *Warning: This will override any size management applied by layout managers.
+ * The minimum value in pixels which this Component will set its height to. + * + * **Warning:** This will override any size management applied by layout managers. */ /** * @cfg {Number} minWidth - *The minimum value in pixels which this Component will set its width to.
- *Warning: This will override any size management applied by layout managers.
+ * The minimum value in pixels which this Component will set its width to. + * + * **Warning:** This will override any size management applied by layout managers. */ /** * @cfg {Number} maxHeight - *The maximum value in pixels which this Component will set its height to.
- *Warning: This will override any size management applied by layout managers.
+ * The maximum value in pixels which this Component will set its height to. + * + * **Warning:** This will override any size management applied by layout managers. */ /** * @cfg {Number} maxWidth - *The maximum value in pixels which this Component will set its width to.
- *Warning: This will override any size management applied by layout managers.
+ * The maximum value in pixels which this Component will set its width to. + * + * **Warning:** This will override any size management applied by layout managers. */ /** * @cfg {Ext.ComponentLoader/Object} loader - * A configuration object or an instance of a {@link Ext.ComponentLoader} to load remote - * content for this Component. + * A configuration object or an instance of a {@link Ext.ComponentLoader} to load remote content for this Component. */ - // @private - allowDomMove: true, - - /** - * @cfg {Boolean} autoShow True to automatically show the component upon creation. - * This config option may only be used for {@link #floating} components or components - * that use {@link #autoRender}. Defaults to false. - */ - autoShow: false, + /** + * @cfg {Boolean} autoShow + * True to automatically show the component upon creation. This config option may only be used for + * {@link #floating} components or components that use {@link #autoRender}. Defaults to false. + */ + autoShow: false, /** - * @cfg {Mixed} autoRender - *This config is intended mainly for {@link #floating} Components which may or may not be shown. Instead - * of using {@link #renderTo} in the configuration, and rendering upon construction, this allows a Component - * to render itself upon first {@link #show}.
- *Specify as true to have this Component render to the document body upon first show.
Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.
- *This defaults to true for the {@link Ext.window.Window Window} class.
Fires after the component rendering is finished.
- *The afterrender event is fired after this Component has been {@link #rendered}, been postprocesed - * by any afterRender method defined for the Component.
+ * Fires after the component rendering is finished. + * + * The afterrender event is fired after this Component has been {@link #rendered}, been postprocesed by any + * afterRender method defined for the Component. * @param {Ext.Component} this */ - 'afterrender', + 'afterrender', /** * @event beforedestroy - * Fires before the component is {@link #destroy}ed. Return false from an event handler to stop the {@link #destroy}. + * Fires before the component is {@link #destroy}ed. Return false from an event handler to stop the + * {@link #destroy}. * @param {Ext.Component} this */ - 'beforedestroy', + 'beforedestroy', /** * @event destroy * Fires after the component is {@link #destroy}ed. * @param {Ext.Component} this */ - 'destroy', + 'destroy', /** * @event resize * Fires after the component is resized. @@ -690,7 +823,7 @@ and a property `descEl` referencing the `div` Element which contains the descrip * @param {Number} adjWidth The box-adjusted width that was set * @param {Number} adjHeight The box-adjusted height that was set */ - 'resize', + 'resize', /** * @event move * Fires after the component is moved. @@ -698,7 +831,7 @@ and a property `descEl` referencing the `div` Element which contains the descrip * @param {Number} x The new x position * @param {Number} y The new y position */ - 'move' + 'move' ); me.getId(); @@ -710,9 +843,7 @@ and a property `descEl` referencing the `div` Element which contains the descrip if (me.plugins) { me.plugins = [].concat(me.plugins); - for (i = 0, len = me.plugins.length; i < len; i++) { - me.plugins[i] = me.constructPlugin(me.plugins[i]); - } + me.constructPlugins(); } me.initComponent(); @@ -759,16 +890,25 @@ and a property `descEl` referencing the `div` Element which contains the descrip // }, - initComponent: Ext.emptyFn, + initComponent: function () { + // This is called again here to allow derived classes to add plugin configs to the + // plugins array before calling down to this, the base initComponent. + this.constructPlugins(); + }, /** - * The supplied default state gathering method for the AbstractComponent class. - * This method returns dimension setings such asflex, anchor, width
- * and height along with collapsed state.
- * Subclasses which implement more complex state should call the superclass's implementation, and apply their state - * to the result if this basic state is to be saved.
- *Note that Component state will only be saved if the Component has a {@link #stateId} and there as a StateProvider - * configured for the document.
+ * The supplied default state gathering method for the AbstractComponent class. + * + * This method returns dimension settings such as `flex`, `anchor`, `width` and `height` along with `collapsed` + * state. + * + * Subclasses which implement more complex state should call the superclass's implementation, and apply their state + * to the result if this basic state is to be saved. + * + * Note that Component state will only be saved if the Component has a {@link #stateId} and there as a StateProvider + * configured for the document. + * + * @return {Object} */ getState: function() { var me = this, @@ -795,7 +935,15 @@ and a property `descEl` referencing the `div` Element which contains the descrip // If we have flex, only store the perpendicular dimension. if (layout && me.flex) { state.flex = me.flex; - state[layout.perpendicularPrefix] = me['get' + layout.perpendicularPrefixCap](); + if (layout.perpendicularPrefix) { + state[layout.perpendicularPrefix] = me['get' + layout.perpendicularPrefixCap](); + } else { + //This method finds the topmost active layout who's processing will eventually determine the size and position of this - * Component.
- *
This method is useful when dynamically adding Components into Containers, and some processing must take place after the - * final sizing and positioning of the Component has been performed.
- * @returns + * This method finds the topmost active layout who's processing will eventually determine the size and position of + * this Component. + * + * This method is useful when dynamically adding Components into Containers, and some processing must take place + * after the final sizing and positioning of the Component has been performed. + * + * @return {Ext.Component} */ findLayoutController: function() { return this.findParentBy(function(c) { @@ -924,6 +1074,23 @@ and a property `descEl` referencing the `div` Element which contains the descrip return plugin; }, + /** + * Ensures that the plugins array contains fully constructed plugin instances. This converts any configs into their + * appropriate instances. + */ + constructPlugins: function() { + var me = this, + plugins = me.plugins, + i, len; + + if (plugins) { + for (i = 0, len = plugins.length; i < len; i++) { + // this just returns already-constructed plugin instances... + plugins[i] = me.constructPlugin(plugins[i]); + } + } + }, + // @private initPlugin : function(plugin) { plugin.init(this); @@ -932,9 +1099,9 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, /** - * Handles autoRender. - * Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that - * ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body + * Handles autoRender. Floating Components may have an ownerCt. If they are asking to be constrained, constrain them + * within that ownerCt, and have their z-index managed locally. Floating Components are always rendered to + * document.body */ doAutoRender: function() { var me = this; @@ -950,6 +1117,11 @@ and a property `descEl` referencing the `div` Element which contains the descrip var me = this; if (!me.rendered && me.fireEvent('beforerender', me) !== false) { + + // Flag set during the render process. + // It can be used to inhibit event-driven layout calls during the render phase + me.rendering = true; + // If this.el is defined, we want to make sure we are dealing with // an Ext Element. if (me.el) { @@ -967,7 +1139,7 @@ and a property `descEl` referencing the `div` Element which contains the descrip // Tell the encapsulating element to hide itself in the way the Component is configured to hide // This means DISPLAY, VISIBILITY or OFFSETS. - me.el.setVisibilityMode(Ext.core.Element[me.hideMode.toUpperCase()]); + me.el.setVisibilityMode(Ext.Element[me.hideMode.toUpperCase()]); if (me.overCls) { me.el.hover(me.addOverCls, me.removeOverCls, me); @@ -993,6 +1165,9 @@ and a property `descEl` referencing the `div` Element which contains the descrip // pass silent so the event doesn't fire the first time. me.disable(true); } + + // Delete the flag once the rendering is done. + delete me.rendering; } return me; }, @@ -1008,10 +1183,10 @@ and a property `descEl` referencing the `div` Element which contains the descrip if (!el) { if (position) { - el = Ext.core.DomHelper.insertBefore(position, me.getElConfig(), true); + el = Ext.DomHelper.insertBefore(position, me.getElConfig(), true); } else { - el = Ext.core.DomHelper.append(container, me.getElConfig(), true); + el = Ext.DomHelper.append(container, me.getElConfig(), true); } } else if (me.allowDomMove !== false) { @@ -1074,9 +1249,17 @@ and a property `descEl` referencing the `div` Element which contains the descrip me.getComponentLayout(); - // Set the size if a size is configured, or if this is the outermost Container - if (!me.ownerCt || (me.height || me.width)) { + // Set the size if a size is configured, or if this is the outermost Container. + // Also, if this is a collapsed Panel, it needs an initial component layout + // to lay out its header so that it can have a height determined. + if (me.collapsed || (!me.ownerCt || (me.height || me.width))) { me.setSize(me.width, me.height); + } else { + // It is expected that child items be rendered before this method returns and + // the afterrender event fires. Since we aren't going to do the layout now, we + // must render the child items. This is handled implicitly above in the layout + // caused by setSize. + me.renderChildren(); } // For floaters, calculate x and y if they aren't defined by aligning @@ -1102,8 +1285,36 @@ and a property `descEl` referencing the `div` Element which contains the descrip } }, + /** + * @private + * Called by Component#doAutoRender + * + * Register a Container configured `floating: true` with this Component's {@link Ext.ZIndexManager ZIndexManager}. + * + * Components added in ths way will not participate in any layout, but will be rendered + * upon first show in the way that {@link Ext.window.Window Window}s are. + */ + registerFloatingItem: function(cmp) { + var me = this; + if (!me.floatingItems) { + me.floatingItems = Ext.create('Ext.ZIndexManager', me); + } + me.floatingItems.register(cmp); + }, + + renderChildren: function () { + var me = this, + layout = me.getComponentLayout(); + + me.suspendLayout = true; + layout.renderChildren(); + delete me.suspendLayout; + }, + frameCls: Ext.baseCSSPrefix + 'frame', + frameIdRegex: /[-]frame\d+[TMB][LCR]$/, + frameElementCls: { tl: [], tc: [], @@ -1118,21 +1329,21 @@ and a property `descEl` referencing the `div` Element which contains the descrip frameTpl: [ 'Creates an array of class names from the configurations to add to this Component's el on render.
Private, but (possibly) used by ComponentQuery for selection by class name if Component is not rendered.
- * @return {Array} An array of class names with which the Component's element will be rendered. + * Creates an array of class names from the configurations to add to this Component's `el` on render. + * + * Private, but (possibly) used by ComponentQuery for selection by class name if Component is not rendered. + * + * @return {String[]} An array of class names with which the Component's element will be rendered. * @private */ initCls: function() { @@ -1429,8 +1646,8 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, /** - * Sets the UI for the component. This will remove any existing UIs on the component. It will also - * loop through any uiCls set on the component and rename them so they include the new UI + * Sets the UI for the component. This will remove any existing UIs on the component. It will also loop through any + * uiCls set on the component and rename them so they include the new UI * @param {String} ui The new UI for the component */ setUI: function(ui) { @@ -1475,10 +1692,10 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, /** - * Adds a cls to the uiCls array, which will also call {@link #addUIClsToElement} and adds - * to all elements of this component. - * @param {String/Array} cls A string or an array of strings to add to the uiCls - * @param (Boolean) skip True to skip adding it to the class and do it later (via the return) + * Adds a cls to the uiCls array, which will also call {@link #addUIClsToElement} and adds to all elements of this + * component. + * @param {String/String[]} cls A string or an array of strings to add to the uiCls + * @param {Object} skip (Boolean) skip True to skip adding it to the class and do it later (via the return) */ addClsWithUI: function(cls, skip) { var me = this, @@ -1506,9 +1723,9 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, /** - * Removes a cls to the uiCls array, which will also call {@link #removeUIClsFromElement} and removes - * it from all elements of this component. - * @param {String/Array} cls A string or an array of strings to remove to the uiCls + * Removes a cls to the uiCls array, which will also call {@link #removeUIClsFromElement} and removes it from all + * elements of this component. + * @param {String/String[]} cls A string or an array of strings to remove to the uiCls */ removeClsWithUI: function(cls, skip) { var me = this, @@ -1546,19 +1763,19 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, /** - * Method which adds a specified UI + uiCls to the components element. - * Can be overridden to remove the UI from more than just the components element. + * Method which adds a specified UI + uiCls to the components element. Can be overridden to remove the UI from more + * than just the components element. * @param {String} ui The UI to remove from the element */ addUIClsToElement: function(cls, force) { var me = this, result = [], frameElementCls = me.frameElementCls; - + result.push(Ext.baseCSSPrefix + cls); result.push(me.baseCls + '-' + cls); result.push(me.baseCls + '-' + me.ui + '-' + cls); - + if (!force && me.frame && !Ext.supports.CSS3BorderRadius) { // define each element of the frame var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'], @@ -1586,19 +1803,19 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, /** - * Method which removes a specified UI + uiCls from the components element. - * The cls which is added to the element will be: `this.baseCls + '-' + ui` + * Method which removes a specified UI + uiCls from the components element. The cls which is added to the element + * will be: `this.baseCls + '-' + ui` * @param {String} ui The UI to add to the element */ removeUIClsFromElement: function(cls, force) { var me = this, result = [], frameElementCls = me.frameElementCls; - + result.push(Ext.baseCSSPrefix + cls); result.push(me.baseCls + '-' + cls); result.push(me.baseCls + '-' + me.ui + '-' + cls); - + if (!force && me.frame && !Ext.supports.CSS3BorderRadius) { // define each element of the frame var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'], @@ -1627,14 +1844,14 @@ and a property `descEl` referencing the `div` Element which contains the descrip addUIToElement: function(force) { var me = this, frameElementCls = me.frameElementCls; - + me.addCls(me.baseCls + '-' + me.ui); - + if (me.frame && !Ext.supports.CSS3BorderRadius) { // define each element of the frame var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'], i, el, cls; - + // loop through each of them, and if they are defined add the ui for (i = 0; i < els.length; i++) { el = me['frame' + els[i].toUpperCase()]; @@ -1657,14 +1874,14 @@ and a property `descEl` referencing the `div` Element which contains the descrip removeUIFromElement: function() { var me = this, frameElementCls = me.frameElementCls; - + me.removeCls(me.baseCls + '-' + me.ui); - + if (me.frame && !Ext.supports.CSS3BorderRadius) { // define each element of the frame var els = ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br'], i, j, el, cls; - + // loop through each of them, and if they are defined add the ui for (i = 0; i < els.length; i++) { el = me['frame' + els[i].toUpperCase()]; @@ -1680,16 +1897,22 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, getElConfig : function() { + if (Ext.isString(this.autoEl)) { + this.autoEl = { + tag: this.autoEl + }; + } + var result = this.autoEl || {tag: 'div'}; result.id = this.id; return result; }, /** - * This function takes the position argument passed to onRender and returns a - * DOM element that you can use in the insertBefore. - * @param {String/Number/Element/HTMLElement} position Index, element id or element you want - * to put this component before. + * This function takes the position argument passed to onRender and returns a DOM element that you can use in the + * insertBefore. + * @param {String/Number/Ext.Element/HTMLElement} position Index, element id or element you want to put this + * component before. * @return {HTMLElement} DOM element that you can use in the insertBefore */ getInsertPosition: function(position) { @@ -1708,7 +1931,7 @@ and a property `descEl` referencing the `div` Element which contains the descrip /** * Adds ctCls to container. - * @return {Ext.core.Element} The initialized container + * @return {Ext.Element} The initialized container * @private */ initContainer: function(container) { @@ -1740,6 +1963,7 @@ and a property `descEl` referencing the `div` Element which contains the descrip var me = this; return Ext.applyIf(me.renderData, { + id: me.id, ui: me.ui, uiCls: me.uiCls, baseCls: me.baseCls, @@ -1795,14 +2019,14 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, /** - * Function description + * Converts style definitions to String. * @return {String} A CSS style string with style, padding, margin and border. * @private */ initStyles: function() { var style = {}, me = this, - Element = Ext.core.Element; + Element = Ext.Element; if (Ext.isString(me.style)) { style = Element.parseStyles(me.style); @@ -1825,8 +2049,7 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, /** - * Initializes this components contents. It checks for the properties - * html, contentEl and tpl/data. + * Initializes this components contents. It checks for the properties html, contentEl and tpl/data. * @private */ initContent: function() { @@ -1836,7 +2059,7 @@ and a property `descEl` referencing the `div` Element which contains the descrip pre; if (me.html) { - target.update(Ext.core.DomHelper.markup(me.html)); + target.update(Ext.DomHelper.markup(me.html)); delete me.html; } @@ -1882,17 +2105,73 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, /** - * Sets references to elements inside the component. E.g body -> x-panel-body + * Adds each argument passed to this method to the {@link #childEls} array. + */ + addChildEls: function () { + var me = this, + childEls = me.childEls || (me.childEls = []); + + childEls.push.apply(childEls, arguments); + }, + + /** + * Removes items in the childEls array based on the return value of a supplied test function. The function is called + * with a entry in childEls and if the test function return true, that entry is removed. If false, that entry is + * kept. + * @param {Function} testFn The test function. + */ + removeChildEls: function (testFn) { + var me = this, + old = me.childEls, + keepers = (me.childEls = []), + n, i, cel; + + for (i = 0, n = old.length; i < n; ++i) { + cel = old[i]; + if (!testFn(cel)) { + keepers.push(cel); + } + } + }, + + /** + * Sets references to elements inside the component. This applies {@link #renderSelectors} + * as well as {@link #childEls}. * @private */ applyRenderSelectors: function() { - var selectors = this.renderSelectors || {}, - el = this.el.dom, - selector; + var me = this, + childEls = me.childEls, + selectors = me.renderSelectors, + el = me.el, + dom = el.dom, + baseId, childName, childId, i, selector; + + if (childEls) { + baseId = me.id + '-'; + for (i = childEls.length; i--; ) { + childName = childId = childEls[i]; + if (typeof(childName) != 'string') { + childId = childName.id || (baseId + childName.itemId); + childName = childName.name; + } else { + childId = baseId + childId; + } + + // We don't use Ext.get because that is 3x (or more) slower on IE6-8. Since + // we know the el's are children of our el we use getById instead: + me[childName] = el.getById(childId); + } + } - for (selector in selectors) { - if (selectors.hasOwnProperty(selector) && selectors[selector]) { - this[selector] = Ext.get(Ext.DomQuery.selectNode(selectors[selector], el)); + // We still support renderSelectors. There are a few places in the framework that + // need them and they are a documented part of the API. In fact, we support mixing + // childEls and renderSelectors (no reason not to). + if (selectors) { + for (selector in selectors) { + if (selectors.hasOwnProperty(selector) && selectors[selector]) { + me[selector] = Ext.get(Ext.DomQuery.selectNode(selectors[selector], dom)); + } } } }, @@ -1907,13 +2186,14 @@ and a property `descEl` referencing the `div` Element which contains the descrip }, /** - *Walks up the ownerCt axis looking for an ancestor Container which matches
- * the passed simple selector.
Example:
-var owningTabPanel = grid.up('tabpanel');
-undefined if no match was found).
+ * Walks up the `ownerCt` axis looking for an ancestor Container which matches the passed simple selector.
+ *
+ * Example:
+ *
+ * var owningTabPanel = grid.up('tabpanel');
+ *
+ * @param {String} [selector] The simple selector to test.
+ * @return {Ext.container.Container} The matching ancestor Container (or `undefined` if no match was found).
*/
up: function(selector) {
var result = this.ownerCt;
@@ -1928,12 +2208,17 @@ var owningTabPanel = grid.up('tabpanel');
},
/**
- * Returns the next sibling of this Component.
- *Optionally selects the next sibling which matches the passed {@link Ext.ComponentQuery ComponentQuery} selector.
- *May also be refered to as next()
Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with {@link #nextNode}
Returns the previous sibling of this Component.
- *Optionally selects the previous sibling which matches the passed {@link Ext.ComponentQuery ComponentQuery} selector.
- *May also be refered to as prev()
Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with {@link #previousNode}
Returns the previous node in the Component tree in tree traversal order.
- *Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will - * walk the tree in reverse order to attempt to find a match. Contrast with {@link #previousSibling}.
- * @param {String} selector Optional. A {@link Ext.ComponentQuery ComponentQuery} selector to filter the preceding nodes. - * @returns The previous node (or the previous node which matches the selector). Returns null if there is no matching node. + * Returns the previous node in the Component tree in tree traversal order. + * + * Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the + * tree in reverse order to attempt to find a match. Contrast with {@link #previousSibling}. + * @param {String} [selector] A {@link Ext.ComponentQuery ComponentQuery} selector to filter the preceding nodes. + * @return {Ext.Component} The previous node (or the previous node which matches the selector). + * Returns null if there is no matching node. */ previousNode: function(selector, includeSelf) { var node = this, @@ -2024,11 +2317,13 @@ var owningTabPanel = grid.up('tabpanel'); }, /** - *Returns the next node in the Component tree in tree traversal order.
- *Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will - * walk the tree to attempt to find a match. Contrast with {@link #nextSibling}.
- * @param {String} selector Optional A {@link Ext.ComponentQuery ComponentQuery} selector to filter the following nodes. - * @returns The next node (or the next node which matches the selector). Returns null if there is no matching node. + * Returns the next node in the Component tree in tree traversal order. + * + * Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the + * tree to attempt to find a match. Contrast with {@link #nextSibling}. + * @param {String} [selector] A {@link Ext.ComponentQuery ComponentQuery} selector to filter the following nodes. + * @return {Ext.Component} The next node (or the next node which matches the selector). + * Returns null if there is no matching node. */ nextNode: function(selector, includeSelf) { var node = this, @@ -2059,8 +2354,8 @@ var owningTabPanel = grid.up('tabpanel'); }, /** - * Retrieves the id of this component. - * Will autogenerate an id if one has not already been set. + * Retrieves the id of this component. Will autogenerate an id if one has not already been set. + * @return {String} */ getId : function() { return this.id || (this.id = 'ext-comp-' + (this.getAutoId())); @@ -2072,6 +2367,7 @@ var owningTabPanel = grid.up('tabpanel'); /** * Retrieves the top level element representing this component. + * @return {Ext.core.Element} */ getEl : function() { return this.el; @@ -2086,21 +2382,24 @@ var owningTabPanel = grid.up('tabpanel'); }, /** - *Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended - * from the xtype (default) or whether it is directly of the xtype specified (shallow = true).
- *If using your own subclasses, be aware that a Component must register its own xtype - * to participate in determination of inherited xtypes.
- *For a list of all available xtypes, see the {@link Ext.Component} header.
- *Example usage:
- *
-var t = new Ext.form.field.Text();
-var isText = t.isXType('textfield'); // true
-var isBoxSubclass = t.isXType('field'); // true, descended from Ext.form.field.Base
-var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.field.Base instance
-Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all - * available xtypes, see the {@link Ext.Component} header.
- *If using your own subclasses, be aware that a Component must register its own xtype - * to participate in determination of inherited xtypes.
- *Example usage:
- *
-var t = new Ext.form.field.Text();
-alert(t.getXTypes()); // alerts 'component/field/textfield'
-Optional. Pass true to interrogate the visibility status of all
- * parent Containers to determine whether this Component is truly visible to the user.
Generally, to determine whether a Component is hidden, the no argument form is needed. For example - * when creating dynamically laid out UIs in a hidden Container before showing them.
+ * + * @param {Boolean} [deep=false] Pass `true` to interrogate the visibility status of all parent Containers to + * determine whether this Component is truly visible to the user. + * + * Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating + * dynamically laid out UIs in a hidden Container before showing them. + * * @return {Boolean} True if this component is visible, false otherwise. */ isVisible: function(deep) { @@ -2235,8 +2537,7 @@ alert(t.getXTypes()); // alerts 'component/field/textfield' /** * Enable the component - * @param {Boolean} silent - * Passing false will supress the 'enable' event from being fired. + * @param {Boolean} [silent=false] Passing true will supress the 'enable' event from being fired. */ enable: function(silent) { var me = this; @@ -2258,8 +2559,7 @@ alert(t.getXTypes()); // alerts 'component/field/textfield' /** * Disable the component. - * @param {Boolean} silent - * Passing true, will supress the 'disable' event from being fired. + * @param {Boolean} [silent=false] Passing true will supress the 'disable' event from being fired. */ disable: function(silent) { var me = this; @@ -2303,7 +2603,7 @@ alert(t.getXTypes()); // alerts 'component/field/textfield' /** * Enable or disable the component. - * @param {Boolean} disabled + * @param {Boolean} disabled True to disable. */ setDisabled : function(disabled) { return this[disabled ? 'disable': 'enable'](); @@ -2340,7 +2640,6 @@ alert(t.getXTypes()); // alerts 'component/field/textfield' }, /** - * @deprecated 4.0 Replaced by {@link #addCls} * Adds a CSS class to the top level element representing this component. * @param {String} cls The CSS class name to add * @return {Ext.Component} Returns the Component to allow method chaining. @@ -2351,7 +2650,8 @@ alert(t.getXTypes()); // alerts 'component/field/textfield' /** * Removes a CSS class from the top level element representing this component. - * @returns {Ext.Component} Returns the Component to allow method chaining. + * @param {Object} className + * @return {Ext.Component} Returns the Component to allow method chaining. */ removeCls : function(className) { var me = this; @@ -2492,7 +2792,7 @@ alert(t.getXTypes()); // alerts 'component/field/textfield' * respective Container, firing an added event. * References are established at add time rather than at render time. * @param {Ext.container.Container} container Container which holds the component - * @param {number} pos Position at which the component was added + * @param {Number} pos Position at which the component was added */ onAdded : function(container, pos) { this.ownerCt = container; @@ -2520,19 +2820,22 @@ alert(t.getXTypes()); // alerts 'component/field/textfield' /** * Sets the width and height of this Component. This method fires the {@link #resize} event. This method can accept - * either width and height as separate arguments, or you can pass a size object like{width:10, height:20}.
- * @param {Mixed} width The new width to set. This may be one of:{width: widthValue, height: heightValue}.undefined to leave the width unchanged.undefined to leave the height unchanged.