Upgrade to ExtJS 3.3.1 - Released 11/30/2010

[extjs.git] / docs / source / Component.html
diff --git a/docs/source/Component.html b/docs/source/Component.html

index 36f3513..d043dc5 100644 (file)
--- a/docs/source/Component.html
+++ b/docs/source/Component.html
@@ -7,10 +7,10 @@
  </head>
  <body  onload="prettyPrint();">
      <pre class="prettyprint lang-js">/*!
- * Ext JS Library 3.2.0
- * Copyright(c) 2006-2010 Ext JS, Inc.
- * licensing@extjs.com
- * http://www.extjs.com/license
+ * Ext JS Library 3.3.1
+ * Copyright(c) 2006-2010 Sencha Inc.
+ * licensing@sencha.com
+ * http://www.sencha.com/license
   */
  <div id="cls-Ext.Component"></div>/**
   * @class Ext.Component
@@ -45,10 +45,11 @@ editorgrid       {@link Ext.grid.EditorGridPanel}
  flash            {@link Ext.FlashComponent}
  grid             {@link Ext.grid.GridPanel}
  listview         {@link Ext.ListView}
+multislider      {@link Ext.slider.MultiSlider}
  panel            {@link Ext.Panel}
  progress         {@link Ext.ProgressBar}
  propertygrid     {@link Ext.grid.PropertyGrid}
-slider           {@link Ext.Slider}
+slider           {@link Ext.slider.SingleSlider}
  spacer           {@link Ext.Spacer}
  splitbutton      {@link Ext.SplitButton}
  tabpanel         {@link Ext.TabPanel}
@@ -85,6 +86,7 @@ form             {@link Ext.form.FormPanel}
  checkbox         {@link Ext.form.Checkbox}
  checkboxgroup    {@link Ext.form.CheckboxGroup}
  combo            {@link Ext.form.ComboBox}
+compositefield   {@link Ext.form.CompositeField}
  datefield        {@link Ext.form.DateField}
  displayfield     {@link Ext.form.DisplayField}
  field            {@link Ext.form.Field}
@@ -1384,7 +1386,7 @@ new Ext.Panel({
          if(delay){
              this.focusTask = new Ext.util.DelayedTask(this.focus, this, [selectText, false]);
              this.focusTask.delay(Ext.isNumber(delay) ? delay : 10);
-            return;
+            return this;
          }
          if(this.rendered && !this.isDestroyed){
              this.el.focus();
@@ -1567,7 +1569,13 @@ var isText = t.isXType('textfield');        // true
  var isBoxSubclass = t.isXType('box');       // true, descended from BoxComponent
  var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance
  </code></pre>
-     * @param {String} xtype The xtype to check for this Component
+     * @param {String/Ext.Component/Class} xtype The xtype to check for this Component. Note that the the component can either be an instance
+     * or a component class:
+     * <pre><code>
+var c = new Ext.Component();
+console.log(c.isXType(c));
+console.log(c.isXType(Ext.Component)); 
+</code></pre>
       * @param {Boolean} shallow (optional) False to check whether this Component is descended from the xtype (this is
       * the default), or true to check whether this Component is directly of the specified xtype.
       * @return {Boolean} True if this component descends from the specified xtype, false otherwise.
@@ -1622,17 +1630,37 @@ alert(t.getXTypes());  // alerts 'component/box/field/textfield'
  
      <div id="method-Ext.Component-findParentByType"></div>/**
       * Find a container above this component at any level by xtype or class
-     * @param {String/Class} xtype The xtype string for a component, or the class of the component directly
+     * @param {String/Ext.Component/Class} xtype The xtype to check for this Component. Note that the the component can either be an instance
+     * or a component class:
+     * @param {Boolean} shallow (optional) False to check whether this Component is descended from the xtype (this is
+     * the default), or true to check whether this Component is directly of the specified xtype.
       * @return {Ext.Container} The first Container which matches the given xtype or class
       */
-    findParentByType : function(xtype) {
-        return Ext.isFunction(xtype) ?
-            this.findParentBy(function(p){
-                return p.constructor === xtype;
-            }) :
-            this.findParentBy(function(p){
-                return p.constructor.xtype === xtype;
-            });
+    findParentByType : function(xtype, shallow){
+        return this.findParentBy(function(c){
+            return c.isXType(xtype, shallow);
+        });
+    },
+    
+    <div id="method-Ext.Component-bubble"></div>/**
+     * Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (<i>this</i>) of
+     * function call will be the scope provided or the current component. The arguments to the function
+     * will be the args provided or the current component. If the function returns false at any point,
+     * the bubble is stopped.
+     * @param {Function} fn The function to call
+     * @param {Object} scope (optional) The scope of the function (defaults to current node)
+     * @param {Array} args (optional) The args to call the function with (default to passing the current component)
+     * @return {Ext.Component} this
+     */
+    bubble : function(fn, scope, args){
+        var p = this;
+        while(p){
+            if(fn.apply(scope || p, args || [p]) === false){
+                break;
+            }
+            p = p.ownerCt;
+        }
+        return this;
      },
  
      // protected
@@ -1778,6 +1806,7 @@ myGridPanel.mon(myGridPanel.getSelectionModel(), {
      }
  });
  
-Ext.reg('component', Ext.Component);</pre>    
+Ext.reg('component', Ext.Component);
+</pre>    
  </body>
  </html>
 \ No newline at end of file