/**
* @class Ext.container.AbstractContainer
* @extends Ext.Component
* <p>An abstract base class which provides shared methods for Containers across the Sencha product line.</p>
@@ -17,7 +34,7 @@ Ext.define('Ext.container.AbstractContainer', {
],
/* End Definitions */
- /**
+ /**
* @cfg {String/Object} layout
* <p><b>*Important</b>: In order for child items to be correctly sized and
* positioned, typically a layout manager <b>must</b> be specified through
@@ -84,14 +101,14 @@ layout: {
* </ul></div></ul></div>
*/
- /**
+ /**
* @cfg {String/Number} activeItem
* A string component id or the numeric index of the component that should be initially activated within the
* container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first
* item in the container's collection). activeItem only applies to layout styles that can display
* items one at a time (like {@link Ext.layout.container.Card} and {@link Ext.layout.container.Fit}).
*/
- /**
+ /**
* @cfg {Object/Array} items
* <p>A single item, or an array of child Components to be added to this container</p>
* <p><b>Unless configured with a {@link #layout}, a Container simply renders child Components serially into
@@ -123,7 +140,7 @@ layout: 'hbox', // The items are arranged horizontally
* <p>Do not specify <code>{@link Ext.panel.Panel#contentEl contentEl}</code> or
* <code>{@link Ext.panel.Panel#html html}</code> with <code>items</code>.</p>
*/
- /**
+ /**
* @cfg {Object|Function} defaults
* <p>This option is a means of applying default settings to all added items whether added through the {@link #items}
* config or via the {@link #add} or {@link #insert} methods.</p>
@@ -152,20 +169,20 @@ items: [
]</code></pre>
*/
- /** @cfg {Boolean} suspendLayout
+ /** @cfg {Boolean} suspendLayout
* If true, suspend calls to doLayout. Useful when batching multiple adds to a container and not passing them
* as multiple arguments or an array.
*/
suspendLayout : false,
- /** @cfg {Boolean} autoDestroy
+ /** @cfg {Boolean} autoDestroy
* If true the container will automatically destroy any contained component that is removed from it, else
* destruction must be handled manually.
* Defaults to true.
*/
autoDestroy : true,
- /** @cfg {String} defaultType
+ /** @cfg {String} defaultType
* <p>The default {@link Ext.Component xtype} of child Components to create in this Container when
* a child item is specified as a raw configuration object, rather than as an instantiated Component.</p>
* <p>Defaults to <code>'panel'</code>.</p>
@@ -176,7 +193,7 @@ items: [
baseCls: Ext.baseCSSPrefix + 'container',
- /**
+ /**
* @cfg {Array} bubbleEvents
* <p>An array of events that, when fired, should be bubbled to any parent container.
* See {@link Ext.util.Observable#enableBubble}.
@@ -188,14 +205,14 @@ items: [
initComponent : function(){
var me = this;
me.addEvents(
- /**
+ /**
* @event afterlayout
* Fires when the components in this container are arranged by the associated layout manager.
* @param {Ext.container.Container} this
* @param {ContainerLayout} layout The ContainerLayout implementation for this container
*/
'afterlayout',
- /**
+ /**
* @event beforeadd
* Fires before any {@link Ext.Component} is added or inserted into the container.
* A handler can return false to cancel the add.
@@ -204,7 +221,7 @@ items: [
* @param {Number} index The index at which the component will be added to the container's items collection
*/
'beforeadd',
- /**
+ /**
* @event beforeremove
* Fires before any {@link Ext.Component} is removed from the container. A handler can return
* false to cancel the remove.
@@ -212,7 +229,7 @@ items: [
* @param {Ext.Component} component The component being removed
*/
'beforeremove',
- /**
+ /**
* @event add
* @bubbles
* Fires after any {@link Ext.Component} is added or inserted into the container.
@@ -221,7 +238,7 @@ items: [
* @param {Number} index The index at which the component was added to the container's items collection
*/
'add',
- /**
+ /**
* @event remove
* @bubbles
* Fires after any {@link Ext.Component} is removed from the container.
@@ -229,7 +246,7 @@ items: [
* @param {Ext.Component} component The component that was removed
*/
'remove',
- /**
+ /**
* @event beforecardswitch
* Fires before this container switches the active card. This event
* is only available if this container uses a CardLayout. Note that
@@ -243,7 +260,7 @@ items: [
* @param {Boolean} animated True if this cardswitch will be animated
*/
'beforecardswitch',
- /**
+ /**
* @event cardswitch
* Fires after this container switches the active card. If the card
* is switched using an animation, this event will fire after the
@@ -270,7 +287,7 @@ items: [
var me = this,
items = me.items;
- /**
+ /**
* The MixedCollection containing all the child items of this container.
* @property items
* @type Ext.util.MixedCollection
@@ -304,7 +321,7 @@ items: [
layout.setOwner(this);
},
- /**
+ /**
* Returns the {@link Ext.layout.container.AbstractContainer layout} instance currently associated with this Container.
* If a layout has not been instantiated yet, that is done first
* @return {Ext.layout.container.AbstractContainer} The layout
@@ -318,7 +335,7 @@ items: [
return me.layout;
},
- /**
+ /**
* Manually force this container's layout to be recalculated. The framwork uses this internally to refresh layouts
* form most cases.
* @return {Ext.container.Container} this
@@ -420,7 +437,7 @@ items: [
return comp.getItemId();
},
- /**
+ /**
Adds {@link Ext.Component Component}(s) to this Container.
@@ -525,7 +542,7 @@ for more details.
return cmp;
},
- /**
+ /**
* @private
* <p>Called by Component#doAutoRender</p>
* <p>Register a Container configured <code>floating: true</code> with this Container's {@link Ext.ZIndexManager ZIndexManager}.</p>
@@ -544,7 +561,7 @@ for more details.
onAdd : Ext.emptyFn,
onRemove : Ext.emptyFn,
- /**
+ /**
* Inserts a Component into this Container at a specified index. Fires the
* {@link #beforeadd} event before inserting, then fires the {@link #add} event after the
* Component has been inserted.
@@ -566,7 +583,7 @@ for more details.
return this.add(index, comp);
},
- /**
+ /**
* Moves a Component within the Container
* @param {Number} fromIdx The index the Component you wish to move is currently at.
* @param {Number} toIdx The new index for the Component.
@@ -597,7 +614,7 @@ for more details.
}
},
- /**
+ /**
* Removes a component from this container. Fires the {@link #beforeremove} event before removing, then fires
* the {@link #remove} event after the component has been removed.
* @param {Component/String} component The component reference or id to remove.
@@ -650,7 +667,7 @@ for more details.
}
},
- /**
+ /**
* Removes all components from this container.
* @param {Boolean} autoDestroy (optional) True to automatically invoke the removed Component's {@link Ext.Component#destroy} function.
* Defaults to the value of this Container's {@link #autoDestroy} config.
@@ -714,7 +731,7 @@ for more details.
return result;
},
- /**
+ /**
* Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified function with
* each component. The scope (<code>this</code> reference) of the
* function call will be the scope provided or the current component. The arguments to the function
@@ -748,7 +765,7 @@ for more details.
return this;
},
- /**
+ /**
* Examines this container's <code>{@link #items}</code> <b>property</b>
* and gets a direct child component of this container.
* @param {String/Number} comp This parameter may be any of the following:
@@ -769,7 +786,7 @@ for more details.
return this.items.get(comp);
},
- /**
+ /**
* Retrieves all descendant components which match the passed selector.
* Executes an Ext.ComponentQuery.query using this container as its root.
* @param {String} selector Selector complying to an Ext.ComponentQuery selector
@@ -779,7 +796,7 @@ for more details.
return Ext.ComponentQuery.query(selector, this);
},
- /**
+ /**
* Retrieves the first direct child of this container which matches the passed selector.
* The passed in selector must comply with an Ext.ComponentQuery selector.
* @param {String} selector An Ext.ComponentQuery selector
@@ -789,7 +806,7 @@ for more details.
return this.query('> ' + selector)[0] || null;
},
- /**
+ /**
* Retrieves the first descendant of this container which matches the passed selector.
* The passed in selector must comply with an Ext.ComponentQuery selector.
* @param {String} selector An Ext.ComponentQuery selector
@@ -850,7 +867,7 @@ for more details.
this.callParent();
},
- /**
+ /**
* Occurs before componentLayout is run. Returning false from this method will prevent the containerLayout
* from being executed.
*/
@@ -876,4 +893,6 @@ for more details.
);
me.callParent();
}
-});