docs/output/Ext.CompositeElement.js

   1 Ext.data.JsonP.Ext_CompositeElement({
   2   "allMixins": [
   3
   4   ],
   5   "deprecated": null,
   6   "docauthor": null,
   7   "members": {
   8     "cfg": [
   9
  10     ],
  11     "method": [
  12       {
  13         "deprecated": null,
  14         "alias": null,
  15         "protected": false,
  16         "tagname": "method",
  17         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-add",
  18         "shortDoc": "Adds elements to this Composite object. ...",
  19         "static": false,
  20         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
  21         "private": false,
  22         "params": [
  23           {
  24             "type": "Mixed",
  25             "optional": false,
  26             "doc": "<p>Either an Array of DOM elements to add, or another Composite object who's elements should be added.</p>\n",
  27             "name": "els"
  28           },
  29           {
  30             "type": "Object",
  31             "optional": false,
  32             "doc": "\n",
  33             "name": "root"
  34           }
  35         ],
  36         "name": "add",
  37         "owner": "Ext.CompositeElementLite",
  38         "doc": "<p>Adds elements to this Composite object.</p>\n",
  39         "linenr": 75,
  40         "return": {
  41           "type": "CompositeElement",
  42           "doc": "<p>This Composite object.</p>\n"
  43         },
  44         "html_filename": "CompositeElementLite.html"
  45       },
  46       {
  47         "deprecated": null,
  48         "alias": null,
  49         "protected": false,
  50         "tagname": "method",
  51         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-clear",
  52         "shortDoc": "Removes all elements. ...",
  53         "static": false,
  54         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
  55         "private": false,
  56         "params": [
  57
  58         ],
  59         "name": "clear",
  60         "owner": "Ext.CompositeElementLite",
  61         "doc": "<p>Removes all elements.</p>\n",
  62         "linenr": 246,
  63         "return": {
  64           "type": "void",
  65           "doc": "\n"
  66         },
  67         "html_filename": "CompositeElementLite.html"
  68       },
  69       {
  70         "deprecated": null,
  71         "alias": null,
  72         "protected": false,
  73         "tagname": "method",
  74         "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-contains",
  75         "shortDoc": "Returns true if this composite contains the passed element ...",
  76         "static": false,
  77         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js",
  78         "private": false,
  79         "params": [
  80           {
  81             "type": "Object",
  82             "optional": false,
  83             "doc": "<p>{Mixed} The id of an element, or an <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a>, or an HtmlElement to find within the composite collection.</p>\n",
  84             "name": "el"
  85           }
  86         ],
  87         "name": "contains",
  88         "owner": "Ext.CompositeElementLite",
  89         "doc": "<p>Returns true if this composite contains the passed element</p>\n",
  90         "linenr": 35,
  91         "return": {
  92           "type": "void",
  93           "doc": "<p>Boolean</p>\n"
  94         },
  95         "html_filename": "CompositeElementLite-more.html"
  96       },
  97       {
  98         "deprecated": null,
  99         "alias": null,
 100         "protected": false,
 101         "tagname": "method",
 102         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-each",
 103         "shortDoc": "Calls the passed function for each element in this composite. ...",
 104         "static": false,
 105         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 106         "private": false,
 107         "params": [
 108           {
 109             "type": "Function",
 110             "optional": false,
 111             "doc": "<p>The function to call. The function is passed the following parameters:<ul>\n<li><b>el</b> : Element<div class=\"sub-desc\">The current Element in the iteration.\n<b>This is the flyweight (shared) <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a> instance, so if you require a\na reference to the dom node, use el.dom.</b></div></li>\n<li><b>c</b> : Composite<div class=\"sub-desc\">This Composite object.</div></li>\n<li><b>idx</b> : Number<div class=\"sub-desc\">The zero-based index in the iteration.</div></li>\n</ul></p>\n",
 112             "name": "fn"
 113           },
 114           {
 115             "type": "Object",
 116             "optional": true,
 117             "doc": "<p>(optional) The scope (<i>this</i> reference) in which the function is executed. (defaults to the Element)</p>\n",
 118             "name": "scope"
 119           }
 120         ],
 121         "name": "each",
 122         "owner": "Ext.CompositeElementLite",
 123         "doc": "<p>Calls the passed function for each element in this composite.</p>\n\n",
 124         "linenr": 145,
 125         "return": {
 126           "type": "CompositeElement",
 127           "doc": "<p>this</p>\n"
 128         },
 129         "html_filename": "CompositeElementLite.html"
 130       },
 131       {
 132         "deprecated": null,
 133         "alias": null,
 134         "protected": false,
 135         "tagname": "method",
 136         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-fill",
 137         "shortDoc": "Clears this Composite and adds the elements passed. ...",
 138         "static": false,
 139         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 140         "private": false,
 141         "params": [
 142           {
 143             "type": "Mixed",
 144             "optional": false,
 145             "doc": "<p>Either an array of DOM elements, or another Composite from which to fill this Composite.</p>\n",
 146             "name": "els"
 147           }
 148         ],
 149         "name": "fill",
 150         "owner": "Ext.CompositeElementLite",
 151         "doc": "<p>Clears this Composite and adds the elements passed.</p>\n",
 152         "linenr": 175,
 153         "return": {
 154           "type": "CompositeElement",
 155           "doc": "<p>this</p>\n"
 156         },
 157         "html_filename": "CompositeElementLite.html"
 158       },
 159       {
 160         "deprecated": null,
 161         "alias": null,
 162         "protected": false,
 163         "tagname": "method",
 164         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-filter",
 165         "shortDoc": "Filters this composite to only elements that match the passed selector. ...",
 166         "static": false,
 167         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 168         "private": false,
 169         "params": [
 170           {
 171             "type": "String/Function",
 172             "optional": false,
 173             "doc": "<p>A string CSS selector or a comparison function.\nThe comparison function will be called with the following arguments:<ul>\n<li><code>el</code> : Ext.core.Element<div class=\"sub-desc\">The current DOM element.</div></li>\n<li><code>index</code> : Number<div class=\"sub-desc\">The current index within the collection.</div></li>\n</ul></p>\n",
 174             "name": "selector"
 175           }
 176         ],
 177         "name": "filter",
 178         "owner": "Ext.CompositeElementLite",
 179         "doc": "<p>Filters this composite to only elements that match the passed selector.</p>\n",
 180         "linenr": 187,
 181         "return": {
 182           "type": "CompositeElement",
 183           "doc": "<p>this</p>\n"
 184         },
 185         "html_filename": "CompositeElementLite.html"
 186       },
 187       {
 188         "deprecated": null,
 189         "alias": null,
 190         "protected": false,
 191         "tagname": "method",
 192         "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-first",
 193         "shortDoc": "Returns the first Element ...",
 194         "static": false,
 195         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js",
 196         "private": false,
 197         "params": [
 198
 199         ],
 200         "name": "first",
 201         "owner": "Ext.CompositeElementLite",
 202         "doc": "<p>Returns the first Element</p>\n",
 203         "linenr": 19,
 204         "return": {
 205           "type": "Ext.core.Element",
 206           "doc": "\n"
 207         },
 208         "html_filename": "CompositeElementLite-more.html"
 209       },
 210       {
 211         "deprecated": null,
 212         "alias": null,
 213         "protected": false,
 214         "tagname": "method",
 215         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-getCount",
 216         "shortDoc": "Returns the number of elements in this Composite. ...",
 217         "static": false,
 218         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 219         "private": false,
 220         "params": [
 221
 222         ],
 223         "name": "getCount",
 224         "owner": "Ext.CompositeElementLite",
 225         "doc": "<p>Returns the number of elements in this Composite.</p>\n",
 226         "linenr": 68,
 227         "return": {
 228           "type": "void",
 229           "doc": "<p>Number</p>\n"
 230         },
 231         "html_filename": "CompositeElementLite.html"
 232       },
 233       {
 234         "deprecated": null,
 235         "alias": null,
 236         "protected": false,
 237         "tagname": "method",
 238         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-indexOf",
 239         "shortDoc": "Find the index of the passed element within the composite collection. ...",
 240         "static": false,
 241         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 242         "private": false,
 243         "params": [
 244           {
 245             "type": "Object",
 246             "optional": false,
 247             "doc": "<p>{Mixed} The id of an element, or an <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a>, or an HtmlElement to find within the composite collection.</p>\n",
 248             "name": "el"
 249           }
 250         ],
 251         "name": "indexOf",
 252         "owner": "Ext.CompositeElementLite",
 253         "doc": "<p>Find the index of the passed element within the composite collection.</p>\n",
 254         "linenr": 214,
 255         "return": {
 256           "type": "void",
 257           "doc": "<p>Number The index of the passed <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a> in the composite collection, or -1 if not found.</p>\n"
 258         },
 259         "html_filename": "CompositeElementLite.html"
 260       },
 261       {
 262         "deprecated": null,
 263         "alias": null,
 264         "protected": false,
 265         "tagname": "method",
 266         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-item",
 267         "shortDoc": "Returns a flyweight Element of the dom element object at the specified index ...",
 268         "static": false,
 269         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 270         "private": false,
 271         "params": [
 272           {
 273             "type": "Number",
 274             "optional": false,
 275             "doc": "\n",
 276             "name": "index"
 277           }
 278         ],
 279         "name": "item",
 280         "owner": "Ext.CompositeElementLite",
 281         "doc": "<p>Returns a flyweight Element of the dom element object at the specified index</p>\n",
 282         "linenr": 115,
 283         "return": {
 284           "type": "Ext.core.Element",
 285           "doc": "\n"
 286         },
 287         "html_filename": "CompositeElementLite.html"
 288       },
 289       {
 290         "deprecated": null,
 291         "alias": null,
 292         "protected": false,
 293         "tagname": "method",
 294         "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-last",
 295         "shortDoc": "Returns the last Element ...",
 296         "static": false,
 297         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js",
 298         "private": false,
 299         "params": [
 300
 301         ],
 302         "name": "last",
 303         "owner": "Ext.CompositeElementLite",
 304         "doc": "<p>Returns the last Element</p>\n",
 305         "linenr": 27,
 306         "return": {
 307           "type": "Ext.core.Element",
 308           "doc": "\n"
 309         },
 310         "html_filename": "CompositeElementLite-more.html"
 311       },
 312       {
 313         "deprecated": null,
 314         "alias": null,
 315         "protected": false,
 316         "tagname": "method",
 317         "href": "CompositeElementLite-more.html#Ext-CompositeElementLite-method-removeElement",
 318         "shortDoc": "Removes the specified element(s). ...",
 319         "static": false,
 320         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite-more.js",
 321         "private": false,
 322         "params": [
 323           {
 324             "type": "Mixed",
 325             "optional": false,
 326             "doc": "<p>The id of an element, the Element itself, the index of the element in this composite\nor an array of any of those.</p>\n",
 327             "name": "el"
 328           },
 329           {
 330             "type": "Boolean",
 331             "optional": true,
 332             "doc": "<p>(optional) True to also remove the element from the document</p>\n",
 333             "name": "removeDom"
 334           }
 335         ],
 336         "name": "removeElement",
 337         "owner": "Ext.CompositeElementLite",
 338         "doc": "<p>Removes the specified element(s).</p>\n",
 339         "linenr": 44,
 340         "return": {
 341           "type": "CompositeElement",
 342           "doc": "<p>this</p>\n"
 343         },
 344         "html_filename": "CompositeElementLite-more.html"
 345       },
 346       {
 347         "deprecated": null,
 348         "alias": null,
 349         "protected": false,
 350         "tagname": "method",
 351         "href": "CompositeElementLite.html#Ext-CompositeElementLite-method-replaceElement",
 352         "shortDoc": "Replaces the specified element with the passed element. ...",
 353         "static": false,
 354         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 355         "private": false,
 356         "params": [
 357           {
 358             "type": "Mixed",
 359             "optional": false,
 360             "doc": "<p>The id of an element, the Element itself, the index of the element in this composite\nto replace.</p>\n",
 361             "name": "el"
 362           },
 363           {
 364             "type": "Mixed",
 365             "optional": false,
 366             "doc": "<p>The id of an element or the Element itself.</p>\n",
 367             "name": "replacement"
 368           },
 369           {
 370             "type": "Boolean",
 371             "optional": false,
 372             "doc": "<p>(Optional) True to remove and replace the element in the document too.</p>\n",
 373             "name": "domReplace"
 374           }
 375         ],
 376         "name": "replaceElement",
 377         "owner": "Ext.CompositeElementLite",
 378         "doc": "<p>Replaces the specified element with the passed element.</p>\n",
 379         "linenr": 223,
 380         "return": {
 381           "type": "CompositeElement",
 382           "doc": "<p>this</p>\n"
 383         },
 384         "html_filename": "CompositeElementLite.html"
 385       }
 386     ],
 387     "property": [
 388       {
 389         "type": "Object",
 390         "deprecated": null,
 391         "alias": null,
 392         "protected": false,
 393         "tagname": "property",
 394         "href": "CompositeElement2.html#Ext-CompositeElement-property-",
 395         "static": false,
 396         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElement.js",
 397         "private": false,
 398         "name": "",
 399         "owner": "Ext.CompositeElement",
 400         "doc": "<p>Iterates each <code>element</code> in this <code>composite</code> calling the supplied function using <a href=\"#/api/Ext-method-each\" rel=\"Ext-method-each\" class=\"docClass\">Ext.each</a>.</p>\n",
 401         "linenr": 52,
 402         "html_filename": "CompositeElement2.html"
 403       },
 404       {
 405         "type": "Array",
 406         "deprecated": null,
 407         "alias": null,
 408         "protected": false,
 409         "tagname": "property",
 410         "href": "CompositeElementLite.html#Ext-CompositeElementLite-property-elements",
 411         "shortDoc": "The Array of DOM elements which this CompositeElement encapsulates. ...",
 412         "static": false,
 413         "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElementLite.js",
 414         "private": false,
 415         "name": "elements",
 416         "owner": "Ext.CompositeElementLite",
 417         "doc": "<p>The Array of DOM elements which this CompositeElement encapsulates. Read-only.</p>\n\n\n<p>This will not <i>usually</i> be accessed in developers' code, but developers wishing\nto augment the capabilities of the CompositeElementLite class may use it when adding\nmethods to the class.</p>\n\n\n<p>For example to add the <code>nextAll</code> method to the class to <b>add</b> all\nfollowing siblings of selected elements, the code would be</p>\n\n\n<p><code></p>\n\n<pre>Ext.override(Ext.CompositeElementLite, {\n    nextAll: function() {\n        var els = this.elements, i, l = els.length, n, r = [], ri = -1;\n\n//      Loop through all elements in this Composite, accumulating\n//      an Array of all siblings.\n        for (i = 0; i < l; i++) {\n            for (n = els[i].nextSibling; n; n = n.nextSibling) {\n                r[++ri] = n;\n            }\n        }\n\n//      Add all found siblings to this Composite\n        return this.add(r);\n    }\n});</pre>\n\n\n<p></code></p>\n",
 418         "linenr": 20,
 419         "html_filename": "CompositeElementLite.html"
 420       }
 421     ],
 422     "cssVar": [
 423
 424     ],
 425     "cssMixin": [
 426
 427     ],
 428     "event": [
 429
 430     ]
 431   },
 432   "singleton": false,
 433   "alias": null,
 434   "superclasses": [
 435     "Ext.CompositeElementLite"
 436   ],
 437   "protected": false,
 438   "tagname": "class",
 439   "mixins": [
 440
 441   ],
 442   "href": "CompositeElement2.html#Ext-CompositeElement",
 443   "subclasses": [
 444
 445   ],
 446   "static": false,
 447   "author": null,
 448   "component": false,
 449   "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/dom/CompositeElement.js",
 450   "private": false,
 451   "alternateClassNames": [
 452
 453   ],
 454   "name": "Ext.CompositeElement",
 455   "doc": "<p>This class encapsulates a <i>collection</i> of DOM elements, providing methods to filter\nmembers, or to perform collective actions upon the whole set.</p>\n\n\n<p>Although they are not listed, this class supports all of the methods of <a href=\"#/api/Ext.core.Element\" rel=\"Ext.core.Element\" class=\"docClass\">Ext.core.Element</a> and\n<a href=\"#/api/Ext.fx.Anim\" rel=\"Ext.fx.Anim\" class=\"docClass\">Ext.fx.Anim</a>. The methods from these classes will be performed on all the elements in this collection.</p>\n\n\n<p>All methods return <i>this</i> and can be chained.</p>\n\n\n<p>Usage:</p>\n\n<pre><code>var els = Ext.select(\"#some-el div.some-class\", true);\n// or select directly from an existing element\nvar el = Ext.get('some-el');\nel.select('div.some-class', true);\n\nels.setWidth(100); // all elements become 100 width\nels.hide(true); // all elements fade out and hide\n// or\nels.setWidth(100).hide(true);\n</code></pre>\n\n",
 456   "mixedInto": [
 457
 458   ],
 459   "linenr": 1,
 460   "xtypes": [
 461
 462   ],
 463   "html_filename": "CompositeElement2.html",
 464   "extends": "Ext.CompositeElementLite"
 465 });